github/deprecated-helm-charts
1
0
Fork 0
mirror of https://github.com/helm/charts.git synced 2026-08-23 22:37:45 +00:00
Code Issues Packages Projects Releases Wiki Activity

[stable/rocketchat] Update README with HA configuration info (#16780)

Browse Source 
* update README
Signed-off-by: Sing Li <sing.li@rocket.chat>

* bump chart version
Signed-off-by: Sing Li <sing.li@rocket.chat>

* Revert PV callout
Signed-off-by: Sing Li <sing.li@rocket.chat>
This commit is contained in:
SingLi
2019-09-04 15:54:22 -07:00
committed by Kubernetes Prow Robot
parent be0dbfa9da
commit c269166347
2 changed files with 18 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files
stable/rocketchat/Chart.yaml
+1 -1
View File
@@ -1,6 +1,6 @@
apiVersion: v1
name: rocketchat
version: 1.1.11
version: 1.1.12
appVersion: 1.3.1
description: Prepare to take off with the ultimate chat platform, experience the next level of team communications
keywords:
stable/rocketchat/README.md
+17 -7
View File
@@ -13,7 +13,8 @@ $ helm install stable/rocketchat --set mongodb.mongodbPassword=$(echo -n $(opens
## Introduction
This chart bootstraps a [Rocket.Chat](https://rocket.chat/) Deployment on a [Kubernetes](https://kubernetes.io) cluster using the [Helm](https://helm.sh) package manager. It provisions a fully featured Rocket.Chat installation.
For more information on Rocket.Chat and its capabilities, see its [documentation](https://rocket.chat/docs/).
In addition, this chart supports scaling of Rocket.Chat for increased server capacity and high availability. For more information on Rocket.Chat and its capabilities, see its [documentation](https://rocket.chat/docs/).
## Prerequisites Details
@@ -88,16 +89,12 @@ Alternatively, a YAML file that specifies the values for the parameters can be p
$ helm install --name rocketchat -f values.yaml stable/rocketchat
```
### HA Setup
To run Rocket.Chat with multiple replicas, you need a MongoDB replicaset. Additionally to setting `replicaCount` > 1, you also need to define the `MONGO_OPLOG_URL` env var via the `extraEnvs` parameter. See the [documentation](https://rocket.chat/docs/installation/docker-containers/high-availability-install/#guide-to-install-rocketchat-as-ha-with-mongodb-replicaset-as-backend) for more details.
### Database Setup
Rocket.Chat uses a MongoDB instance to presist its data.
By default, the [MongoDB](https://github.com/kubernetes/charts/tree/master/stable/mongodb) chart is deployed and configured as database.
By default, the [MongoDB](https://github.com/kubernetes/charts/tree/master/stable/mongodb) chart is deployed and a single MongoDB instance is created as the primary in a replicaset.
Please refer to this chart for additional MongoDB configuration options.
Make sure to set at least the `mongodb.mongodbRootPassword`, `mongodb.mongodbUsername` and `mongodb.mongodbPassword` values. Enabling MongoDB ReplicaSet is required for Rocket.Chat version 1.x.
If you are using chart defaults, make sure to set at least the `mongodb.mongodbRootPassword`, `mongodb.mongodbUsername` and `mongodb.mongodbPassword` values.
> **WARNING**: The root credentials are used to connect to the MongoDB OpLog
#### Using an External Database
@@ -111,6 +108,19 @@ extraEnv: |
- name: MONGO_OPTIONS
value: '{"ssl": "true"}'
```
### Increasing Server Capacity and HA Setup
To increase the capacity of the server, you can scale up the number of Rocket.Chat server instances across available computing resources in your cluster, for example,
```bash
$ kubectl scale --replicas=3 deployment/rocketchat
```
By default, this chart creates one MongoDB instance as a Primary in a replicaset. This is the minimum requirement to run Rocket.Chat 1.x+. You can also scale up the capacity and availability of the MongoDB cluster independently. Please see the [MongoDB chart](https://github.com/kubernetes/charts/tree/master/stable/mongodb) for configuration information.
For information on running Rocket.Chat in scaled configurations, see the [documentation](https://rocket.chat/docs/installation/docker-containers/high-availability-install/#guide-to-install-rocketchat-as-ha-with-mongodb-replicaset-as-backend) for more details.
## Upgrading
### To 1.1.0