The Rocket.Chat Helm chart provides various options to customize your deployment. You can add or update your desired parameter in the values.yaml file.
After making changes, apply them using this command:
helm upgrade rocketchat -f values.yaml rocketchat/rocketchat -n rocketchatThis performs a rolling update, replacing pods one by one to ensure zero downtime.
Below is a summary of key configurable parameters and their default values:
Parameter | Description | Default |
|---|---|---|
| Image repository |
|
| Image tag |
|
| Image pull policy |
|
| Hostname for Rocket.Chat. Also used for ingress (if enabled) |
|
| Number of replicas to run |
|
| Enable SMTP for sending mails |
|
| Use existing secret for SMTP account |
|
| Username of the SMTP account |
|
| Password of the SMTP account |
|
| Hostname of the SMTP server |
|
| Port of the SMTP server |
|
| Extra environment variables for Rocket.Chat. Used with |
|
| Extra volumes allowing inclusion of certificates or any sort of file that might be required (see bellow) |
|
| Where the aforementioned extra volumes should be mounted inside the container |
|
| Pod anti-affinity can prevent the scheduler from placing RocketChat replicas on the same node. The default value "soft" means that the scheduler should prefer to not schedule two replica pods onto the same node but no guarantee is provided. The value "hard" means that the scheduler is required to not schedule two replica pods onto the same node. The value "" will disable pod anti-affinity so that no anti-affinity rules will be configured. |
|
| If anti-affinity is enabled sets the topologyKey to use for anti-affinity. This can be changed to, for example |
|
| Assign custom affinity rules to the RocketChat instance https://kubernetes.io/docs/concepts/configuration/assign-pod-node/ |
|
| Minimum number / percentage of pods that should remain scheduled |
|
| An already existing secret containing MongoDB Connection URL |
|
| MongoDB URL if using an externally provisioned MongoDB |
|
| MongoDB OpLog URL if using an externally provisioned MongoDB. Required if |
|
| Enable persistence using a PVC. This is not necessary if you're using the default GridFS file storage |
|
| Storage class of the PVC to use |
|
| Access mode of the PVC |
|
| Size of the PVC |
|
| An existing PVC name for rocketchat volume |
|
| Pod resource requests and limits |
|
| Enable security context for the pod |
|
| User to run the pod as |
|
| fs group to use for the pod |
|
| Specifies whether a ServiceAccount should be created |
|
| Name of the ServiceAccount to use. If not set and create is true, a name is generated using the fullname template |
|
| If |
|
| Sets the value for pathType for the created Ingress resource |
|
| Annotations for the ingress |
|
| Path of the ingress |
|
| A list of IngressTLS items |
|
| Contents of the license file, if applicable |
|
| Turn on and off /metrics endpoint for Prometheus scraping |
|
| Port to use for the metrics for Prometheus to scrap on |
|
| Create ServiceMonitor resource(s) for scraping metrics using PrometheusOperator (prometheusScraping should be enabled) |
|
| The interval at which metrics should be scraped |
|
| The port name at which container exposes Prometheus metrics |
|
| Turn on and off liveness probe |
|
| Delay before liveness probe is initiated |
|
| How often to perform the probe |
|
| When the probe times out |
|
| Minimum consecutive failures for the probe |
|
| Minimum consecutive successes for the probe |
|
| Use microservices architecture |
|
| Number of replicas to run for the given service |
|
| Idem |
|
| Idem |
|
| Idem |
|
| Idem |
|
| Turn on and off readiness probe |
|
| Delay before readiness probe is initiated |
|
| How often to perform the probe |
|
| When the probe times out |
|
| Minimum consecutive failures for the probe |
|
| Minimum consecutive successes for the probe |
|
| Registration token for Rocket.Chat Cloud | "" |
| Annotations for the Rocket.Chat service |
|
| Additional labels for the Rocket.Chat service |
|
| The service type to use |
|
| The service port |
|
| The node port used if the service is of type |
|
| Enable or disable PDB for RC deployment |
|
| Additional pod labels for the Rocket.Chat pods |
|
| Additional pod annotations for the Rocket.Chat pods |
|
You can also refer to the GitHub repository to explore all the available configuration options.