Kubernetes with Helm
Deploy on a kubernetes cluster using our official helm chart
WARNING: Upgrading to chart version 1.1.0 (Rocket.Chat 1.0.3) might require extra steps to retain the MongoDB data. See Upgrading for more details.
Helm is a tool that streamlines installing and managing Kubernetes applications. Think of it like apt/yum/homebrew for Kubernetes, helm uses a packaging format called charts. A chart is a collection of files that describe a related set of Kubernetes resources. The Rocket.Chat helm chart packages Rocket.Chat server and mongodb. Options for the Rocket.Chat helm chart can be found here.
NOTE: Helm 3 no long includes a default chart repository. Make sure you add the stable chart repository to your Helm 3 instance.
Default Settings for Rocket.Chat Helm Chart
- Rocket.Chat chart installs rocketchat server (stable/rocketchat)
- Rocket.Chat chart installs mongodb chart (stable/mongodb)
- Authentication for mongodb is enabled by default (usePassword : true)
- Two persistent volumes will be created, one for mongodb that will store Rocket.Chat data and one for Rocket.Chat uploads
- If not set, a random password will be generated for the root user in mongodb, and no custom user, password and database will be created for Rocket.Chat so we recommend installing this chart setting those parameters.
Install Rocket.Chat chart and configure mongodbUsername, mongodbPassword, mongodbDatabase and mongodbRootPassword:
1
$ helm install --set mongodb.mongodbUsername=rocketchat,mongodb.mongodbPassword=changeme,mongodb.mongodbDatabase=rocketchat,mongodb.mongodbRootPassword=root-changeme my-rocketchat stable/rocketchat
Copied!
- mongodbUsername: This user will have access to the rocketchat database (mongodbDatabase) and is authenticated using mongodbDatabase.
- mongodbPassword: Password for accessing your Rocket.Chat data.
- mongodbDatabase: Database used to store Rocket.Chat application and authenticate the mongodbUsername.
- mongodbRootPassword: The password for the root user, administrator of the mongodb statefulset and authenticated using the admin database.
Is possible to check both passwords, mongodbPassword and mongodbRootPassword, in mongodb secret, use
kubectl get secrets.If you would like to install a different image than the default for this chart, add to the command the image you would like to install:
1
$ helm install --set mongodb.mongodbUsername=rocketchat,mongodb.mongodbPassword=changeme,mongodb.mongodbDatabase=rocketchat,mongodb.mongodbRootPassword=root-changeme,repository=<image-wanted> my-rocketchat stable/rocketchat
Copied!
And if you only would like to install another version of rocket.chat image, add tag value to the command:
1
$ helm install --set mongodb.mongodbUsername=rocketchat,mongodb.mongodbPassword=changeme,mongodb.mongodbDatabase=rocketchat,mongodb.mongodbRootPassword=root-changeme,image.pullPolicy=Always,image.tag=3.7.0 my-rocketchat stable/rocketchat
Copied!
Check rocketchat values.yaml file for more details and adjust to your needs, after you can install Rocket.Chat chart using this command, remember to set mongodbUsername, mongodbPassword, mongodbDatabase and mongodbRootPassword:
1
$ helm install --name my-rocketchat -f values.yaml stable/rocketchat
Copied!
Typical k8s/Helm Deployment on AWS EKS
This is an example of how Rocket.Chat instances can be deployed in a very scalable, fault-tolerant and backed up configuration, suitable for critical production services.
.svg?alt=media)
Multi Instance k8s/Helm Deployment on AWS EKS
Upgrading
Rocket.Chat version 1.x requires a MongoDB ReplicaSet to be configured. When using the dependent
stable/mongodb chart (mongodb.enabled=true), enabling ReplicaSet will drop the PVC and create new ones, therefore loosing the database content, check instructions on how to manually upgrade below.Backwards compatibility is not guaranteed unless you modify the labels used on the chart's deployments. Use the workaround below to upgrade from versions previous to 1.0.0. The following example assumes that the release name is my-rocketchat:
1
$ kubectl delete deployment my-rocketchat-rocketchat --cascade=false
Copied!
Follow these steps to manually upgrade:
We recommend setting up another set of k8s resources, test that the upgrade is correct and then remove resources from previous version.
- Create a backup of the Rocket.Chat database:
1
$ kubectl exec <my-rocketchat-mongodb-pod> -- sh -c 'mongodump -u<mongodbUsername> -p<mongodbPassword> --archive=/tmp/rocketchat-db-bkup.gz --gzip --db <mongodbDatabase>'
Copied!
- Copy the backup file to working directory:
1
$ kubectl cp <my-rocketchat-mongodb-pod>:/tmp/rocketchat-db-bkup.gz .
Copied!
- Install the new helm chart with Rocket.Chat version > 1.0 following instructions below, use a different name but keep your previously configured mongodbUsername, mongodbPassword and mongodbDatabase:
1
$ helm install --set mongodb.mongodbUsername=rocketchat,mongodb.mongodbPassword=changeme,mongodb.mongodbDatabase=rocketchat,mongodb.mongodbRootPassword=root-changeme --name my-rocketchat-1 stable/rocketchat
Copied!
- Copy the database backup file from working directory to the new mongodb pod:
1
$ kubectl cp rocketchat-db-bkup.gz my-rocketchat-1-mongodb-primary-0:/tmp
Copied!
- Restore the database:
1
$ kubectl exec my-rocketchat-1-mongodb-primary-0 -- sh -c 'mongorestore -u<mongodbUsername> -p<mongodbPassword> --archive=/tmp/rocketchat-db-bkup.gz --gzip --db <mongodbDatabase>'
Copied!
- Check that the database was restored successfully:
1
kubectl exec my-rocketchat-1-mongodb-primary-0 -- sh -c 'mongo <mongodbDatabase> -u<mongodbUsername> -p<mongodbPassword> --eval="printjson(db.runCommand( { listCollections: 1.0, nameOnly: true } ))"'
Copied!
Last modified 2d ago