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	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 advanced image pull secret configuration instructions instead.
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:[e-mail]:PORT Or, if you are using TLS: rediss://username:[e-mail]: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".
serviceAccountName	Under which ServiceAccount should the Cobrowse pods run.
account_creators	RegEx of email addresses allowed to sign up for a new account.
allowed_usernames	RegEx of email addresses that should receive magic link emails.
cluster_domain	The cluster domain, used to form FQDN on sockets internal hostnames.

Dependencies

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

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

2. MongoDB - we require access to a MongoDB cluster. We recommend using a hosted service such as MongoDB Atlas whenever possible. Alternatively MongoDB provide a helm chart for deploying to your own infrastructure.

3. NFS storage class - we require that the cluster provides an NFS storage provisioner for the storage class that is by default called "nfs". You can configure the name of the storage class by setting storage.class.

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

Azure / AKS

SSL Generation

We support SSL certificate generation in Azure via CertManager. You must install CertManager 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.

Other Common Dependencies for AKS

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

GCP / GKE

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

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

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.

pageManaging your deployment