Cobrowse.io Docs
  • Getting started
  • SDK Installation
    • Web
    • iOS
    • Android
    • React Native
    • Flutter
    • .NET Mobile
    • macOS
    • Windows
  • SDK Features
    • Account config
    • Identify your devices
    • Use 6-digit codes
    • Redact sensitive data
    • Viewing PDFs
    • Universal Cobrowse
    • Customize the interface
      • Active session controls
      • 6-digit code screen
      • User consent dialog
      • Remote control consent dialog
      • Full device consent dialog
      • Localization / translation
    • Initiate sessions with push
    • Listening for events
    • Full device capabilities
      • Full device screen sharing
      • Full device remote control
      • Managing full device mode
    • Advanced configuration
      • Starting and stopping the SDK
      • Declaring capabilities
      • Intercepting mobile SDK network requests
      • Web
        • IFrames support
        • IE 11 polyfills
        • Cross-domain session support
        • Ignore Views
      • iOS
        • Alternate render method
        • Custom touch handling
      • Android
        • Backporting TLS to older Android versions
  • Agent-side integrations
    • Agent-side overview
    • Platform integrations
      • Zendesk
      • Salesforce
        • Migrating from legacy to v2
        • Salesforce (Legacy)
      • Genesys
        • Genesys Cloud
        • Engage Workspace Web Edition (WWE)
        • Engage Workspace Desktop Edition (WDE)
      • Intercom
      • Freshworks
      • Talkdesk
      • NICE
    • Custom integrations
    • Agent SDK
      • API Reference
      • Sample code snippets
    • Authentication (JWTs)
      • JWT Policies
    • Authentication (SAML 2.0)
    • IFrame embeds
  • Enterprise self-hosting
    • Self-hosting overview
    • Docker Compose
    • Helm chart
      • Image Pull Secret
      • Environment Variables
      • Optional recording components
      • Pod Annotations
    • AWS terraform
      • AWS metrics configuration
    • Azure terraform
      • Azure metrics configuration
    • GCP terraform
      • GCP metrics configuration
    • Sizing guidelines
    • Running your instance
      • Adding a superuser
      • Limiting account creation
      • Limiting magic link recipients
      • Configuring SMTP
      • Managing your deployment
    • Monitoring your instance
      • Available metrics
      • Self-Hosted Prometheus
    • Advanced configuration
      • Air gap configuration
      • Pin web SDK version
      • L7 firewall configuration
      • Docker proxy configuration
    • Troubleshooting
Powered by GitBook
On this page
  • Initial Setup
  • Installation
  • Common Parameters
  • Dependencies
  • Scaling the infrastructure
  • Managing your deployment

Was this helpful?

  1. Enterprise self-hosting

Helm chart

Learn how to use Helm to set up Cobrowse Enterprise in your Kubernetes cluster.

This is the documentation for how to use Helm to set up Cobrowse Enterprise in your Kubernetes cluster.

Initial Setup

Make sure you have installed (on your local machine) the required tools to manage and deploy the Cobrowse infrastructure to your Kubernetes cluster. You'll need these installed before running the setup:

  • Helm

Installation

Run the following commands to add our helm repository.

helm repo add cobrowse-enterprise https://cobrowseio.github.io/cobrowse-enterprise-helm/packages
helm install cobrowse cobrowse-enterprise/cobrowse-enterprise

Common Parameters

Parameter Name
Description

imageCredentials.password

required

license

required

Your Cobrowse enterprise license. (Provided by Cobrowse.io)

domain

required

The domain name for your deployment.

superusers

RegEx to specify superuser email addresses.

mongo.url

required

Your MongoDB connection URL.

redis.url

required

Your Redis cluster connection URL in the format:

redis://username:password@your-redis-host.com:PORT

Or, if you are using TLS:

rediss://username:password@your-redis-host.com:PORT

(note the double s in rediss://)

Note: redis must be configured in cluster mode.

ingress.class

required

The ingress class name to use

ingress.annotations

Extra annotations to add to the Kubernetes ingress.

storage.size

Amount of storage to provision for recordings. Default is 50Gb.

storage.class

A storage class available in the cluster that supports "ReadWriteMany" access. Default is "nfs".

Dependencies

For all deployments there are some dependencies that must be configured outside of the Cobrowse Helm chart:

  1. NFS storage - we require that the cluster provides an NFS storage. A dynamic provisioner can be used by by setting storage.class, that is by default called "nfs". Alternatively an existing PVC can be used and set through sockets.storage.persistentVolumeClaimName and recording.storage.persistentVolumeClaimName.

There's also some extra configuration available for some cloud providers.

SSL Generation

Other Common Dependencies for AKS

SSL Generation

If you use the GCE ingress (set ingress.class to gce), we will automatically provision a certificate using a GCP ManagedCertificate. You do not need install anything extra to use this.

Scaling the infrastructure

The individual service replica counts should be set according to your load and availability requirements, for example api.replicas = 3sets 3 replicas of the api service.

Managing your deployment

Next, learn about managing and upgrading your deployment.

PreviousDocker ComposeNextImage Pull Secret

Last updated 7 months ago

Was this helpful?

The docker password required to access the Cobrowse images (provided by Cobrowse.io). Note: If you do not wish for the Helm chart to manage your cobrowse image pull secret, consider using the instead.

Redis - we require access to a redis cluster. It must be running in cluster mode. Bitnami provide an easy to use .

MongoDB - we require access to a MongoDB cluster. We recommend using a hosted service such as whenever possible. Alternatively Bitnami provides a that is tested with Cobrowse deployments.

We support SSL certificate generation in Azure via CertManager. You must install in addition to the Cobrowse Helm chart. You can then set ssl.generator to cert-manager in the Cobrowse Helm chart configuration to allow Cobrowse generate and renew and SSL certs automatically.

To use Azure Application Gateway, you will need to enable and either via Helm chart or AKS addon.

By default we only run one replica per service as can be seen in our public file. This should be changed for high availability (HA) setups.

Helm chart
MongoDB Atlas
helm chart
CertManager
AGIC
AAD pod-identity
values.yaml
Managing your deployment
advanced image pull secret configuration instructions