Helm chart
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.
1
> helm repo add cobrowse-enterprise https://cobrowseio.github.io/cobrowse-enterprise-helm/packages
2
> helm install cobrowse cobrowse-enterprise/cobrowse-enterprise
Copied!

Common Parameters

Parameter Name
Required
Description
imageCredentials.password
Yes
The docker password required to access the Cobrowse images (provided by Cobrowse.io)
license
Yes
Your Cobrowse enterprise license (provided by Cobrowse.io)
domain
Yes
The domain name for your deployment
superusers
No
RegEx to specify superuser email addresses
mongo.url
Yes
Your MongoDB connection URL
redis.url
Yes
Your Redis cluster connection URL
ingress.class
Yes
The ingress class name to use
ingress.annotations
No
Extra annotations to add to the Kubernetes ingress.
storage.size
No
Amount of storage to provision for recordings. Default is 50Gb.
storage.class
No
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.
    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
GCP / GKE

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.
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.

Managing your deployment

Next, learn about managing and upgrading your deployment.
Last modified 17d ago