bitnamicharts/rabbitmq-cluster-operator
Bitnami Helm chart for RabbitMQ Cluster Operator
1M+
The RabbitMQ Cluster Kubernetes Operator automates provisioning, management, and operations of RabbitMQ clusters running on Kubernetes.
Overview of RabbitMQ Cluster Operator
Trademarks: This software listing is packaged by Bitnami. The respective trademarks mentioned in the offering are owned by the respective companies, and use of them does not imply any affiliation or endorsement.
helm install my-release oci://registry-1.docker.io/bitnamicharts/rabbitmq-cluster-operator
Looking to use RabbitMQ Cluster Operator in production? Try VMware Tanzu Application Catalog, the commercial edition of the Bitnami catalog.
Bitnami charts for Helm are carefully engineered, actively maintained and are the quickest and easiest way to deploy containers on a Kubernetes cluster that are ready to handle production workloads.
This chart bootstraps a RabbitMQ Cluster Operator Deployment in a Kubernetes cluster using the Helm package manager.
Bitnami charts can be used with Kubeapps for deployment and management of Helm Charts in clusters.
To install the chart with the release name my-release
:
helm install my-release oci://REGISTRY_NAME/REPOSITORY_NAME/rabbitmq-cluster-operator
Note: You need to substitute the placeholders
REGISTRY_NAME
andREPOSITORY_NAME
with a reference to your Helm chart registry and repository. For example, in the case of Bitnami, you need to useREGISTRY_NAME=registry-1.docker.io
andREPOSITORY_NAME=bitnamicharts
.
The command deploy the RabbitMQ Cluster Kubernetes Operator on the Kubernetes cluster in the default configuration. The Parameters section lists the parameters that can be configured during installation.
Tip: List all releases using
helm list
In the Bitnami catalog we offer both the bitnami/rabbitmq and bitnami/rabbitmq-operator charts. Each solution covers different needs and use cases.
The bitnami/rabbitmq chart deploys a single RabbitMQ installation using a Kubernetes StatefulSet object (together with Services, PVCs, ConfigMaps, etc.). The figure below shows the deployed objects in the cluster after executing helm install:
+--------------+ +-----+
| | | |
Service | RabbitMQ +<------------+ PVC |
<-------------------+ | | |
| StatefulSet | +-----+
| |
+-----------+--+
^ +------------+
| | |
+----------------+ Configmaps |
| Secrets |
+------------+
Its lifecycle is managed using Helm and, at the RabbitMQ container level, the following operations are automated: persistence management, configuration based on environment variables and plugin initialization. The StatefulSet do not require any ServiceAccounts with special RBAC privileges so this solution would fit better in more restricted Kubernetes installations.
The bitnami/rabbitmq-operator chart deploys a RabbitMQ Operator installation using a Kubernetes Deployment. The figure below shows the RabbitMQ operator deployment after executing helm install:
+--------------------+
| | +---------------+
| RabbitMQ Operator | | |
| | | RBAC |
| Deployment | | Privileges |
+-------+------------+ +-------+-------+
^ |
| +-----------------+ |
+---+ Service Account +<----+
+-----------------+
The operator will extend the Kubernetes API with the following object: RabbitmqCluster. From that moment, the user will be able to deploy objects of these kinds and the previously deployed Operator will take care of deploying all the required StatefulSets, ConfigMaps and Services for running a RabbitMQ instance. Its lifecycle is managed using kubectl on the RabbitmqCluster objects. The following figure shows the deployed objects after deploying a RabbitmqCluster object using kubectl:
+--------------------+
| | +---------------+
| RabbitMQ Operator | | |
| | | RBAC |
| Deployment | | Privileges |
+-------+------------+ +-------+-------+
| ^ |
| | +-----------------+ |
| +---+ Service Account +<----+
| +-----------------+
|
|
|
|
| -------------------------------------------------------------------------
| | |
| | +--------------+ +-----+ |
| | | | | | |
|--->| Service | RabbitMQ +<------------+ PVC | |
| <-------------------+ | | | |
| | StatefulSet | +-----+ |
| | | |
| +-----------+--+ |
| ^ +------------+ |
| | | | |
| +----------------+ Configmaps | |
| | Secrets | |
| +------------+ |
| |
| |
-------------------------------------------------------------------------
This solution allows to easily deploy multiple RabbitMQ instances compared to the bitnami/rabbitmq chart. As the operator automatically deploys RabbitMQ installations, the RabbitMQ Operator pods will require a ServiceAccount with privileges to create and destroy multiple Kubernetes objects. This may be problematic for Kubernetes clusters with strict role-based access policies.
Bitnami charts allow setting resource requests and limits for all containers inside the chart deployment. These are inside the resources
value (check parameter table). Setting requests is essential for production workloads and these should be adapted to your specific use case.
To make this process easier, the chart contains the resourcesPreset
values, which automatically sets the resources
section according to different presets. Check these presets in the bitnami/common chart. However, in production workloads using resourcesPreset
is discouraged as it may not fully adapt to your specific needs. Find more information on container resource management in the official Kubernetes documentation.
To back up and restore Helm chart deployments on Kubernetes, you need to back up the persistent volumes from the source deployment and attach them to a new deployment using Velero, a Kubernetes backup/restore tool. Find the instructions for using Velero in this guide.
This chart can be integrated with Prometheus by setting *.metrics.enabled
(under the clusterOperator
and msgTopologyOperator
sections) to true. This will expose the RabbitMQ Cluster Operator and RabbitMQ Messaging Topology Operator native Prometheus ports in the containers. It will also create different metrics
services configurable in *.metrics.service
(under the clusterOperator
and msgTopologyOperator
sections). and services. The services will also have the necessary annotations to be automatically scraped by Prometheus.
Prometheus requirements
It is necessary to have a working installation of Prometheus or Prometheus Operator for the integration to work. Install the Bitnami Prometheus helm chart or the Bitnami Kube Prometheus helm chart to easily have a working Prometheus in your cluster.
Integration with Prometheus Operator
The chart can deploy ServiceMonitor
objects for integration with Prometheus Operator installations. To do so, set the value *.metrics.serviceMonitor.enabled=true
(under the clusterOperator
and msgTopologyOperator
sections). Ensure that the Prometheus Operator CustomResourceDefinitions
are installed in the cluster or it will fail with the following error:
no matches for kind "ServiceMonitor" in version "monitoring.coreos.com/v1"
Install the Bitnami Kube Prometheus helm chart for having the necessary CRDs and the Prometheus Operator.
It is strongly recommended to use immutable tags in a production environment. This ensures your deployment does not change automatically if the same tag is updated with a different image.
Bitnami will release a new chart updating its containers if a new version of the main container, significant changes, or critical vulnerabilities exist.
In case you want to add extra environment variables (useful for advanced operations like custom init scripts), you can use the extraEnvVars
property.
rabbitmq-cluster-operator:
extraEnvVars:
- name: LOG_LEVEL
value: error
Alternatively, you can use a ConfigMap or a Secret with the environment variables. To do so, use the extraEnvVarsCM
or the extraEnvVarsSecret
values.
If additional containers are needed in the same pod as rabbitmq-cluster-operator (such as additional metrics or logging exporters), they can be defined using the sidecars
parameter.
sidecars:
- name: your-image-name
image: your-image
imagePullPolicy: Always
ports:
- name: portname
containerPort: 1234
If these sidecars export extra ports, extra port definitions can be added using the service.extraPorts
parameter (where available), as shown in the example below:
service:
extraPorts:
- name: extraPort
port: 11311
targetPort: 11311
NOTE: This Helm chart already includes sidecar containers for the Prometheus exporters (where applicable). These can be activated by adding the
--enable-metrics=true
parameter at deployment time. Thesidecars
parameter should therefore only be used for any extra sidecar containers.
If additional init containers are needed in the same pod, they can be defined using the initContainers
parameter. Here is an example:
initContainers:
- name: your-image-name
image: your-image
imagePullPolicy: Always
ports:
- name: portname
containerPort: 1234
Learn more about sidecar containers and init containers.
This chart allows you to set your custom affinity using the affinity
parameter. Find more information about Pod affinity in the kubernetes documentation.
As an alternative, use one of the preset configurations for pod affinity, pod anti-affinity, and node affinity available at the bitnami/common chart. To do so, set the podAffinityPreset
, podAntiAffinityPreset
, or nodeAffinityPreset
parameters.
There are cases where you may want to deploy extra objects, such your custom RabbitmqCluster objects. For covering this case, the chart allows adding the full specification of other objects using the extraDeploy
parameter.
For instance, to deploy your custom RabbitmqCluster definition, you can install the RabbitMQ Cluster Operator using the values below:
extraDeploy:
- apiVersion: rabbitmq.com/v1beta1
kind: RabbitmqCluster
metadata:
name: rabbitmq-custom-configuration
spec:
replicas: 1
rabbitmq:
additionalConfig: |
log.console.level = debug
Name | Description | Value |
---|---|---|
global.imageRegistry | Global Docker image registry | "" |
global.imagePullSecrets | Global Docker registry secret names as an array | [] |
global.defaultStorageClass | Global default StorageClass for Persistent Volume(s) | "" |
global.storageClass | DEPRECATED: use global.defaultStorageClass instead | "" |
global.security.allowInsecureImages | Allows skipping image verification | false |
global.compatibility.openshift.adaptSecurityContext | Adapt the securityContext sections of the deployment to make them compatible with Openshift restricted-v2 SCC: remove runAsUser, runAsGroup and fsGroup and let the platform use their allowed default IDs. Possible values: auto (apply if the detected running cluster is Openshift), force (perform the adaptation always), disabled (do not perform adaptation) | auto |
Name | Description | Value |
---|---|---|
kubeVersion | Override Kubernetes version | "" |
nameOverride | String to partially override common.names.fullname | "" |
fullnameOverride | String to fully override common.names.fullname | "" |
commonLabels | Labels to add to all deployed objects | {} |
commonAnnotations | Annotations to add to all deployed objects | {} |
clusterDomain | Kubernetes cluster domain name | cluster.local |
extraDeploy | Array of extra objects to deploy with the release | [] |
diagnosticMode.enabled | Enable diagnostic mode (all probes will be disabled) | false |
Name | Description | Value |
---|---|---|
rabbitmqImage.registry | RabbitMQ Image registry | REGISTRY_NAME |
rabbitmqImage.repository | RabbitMQ Image repository | REPOSITORY_NAME/rabbitmq |
rabbitmqImage.digest | RabbitMQ image digest in the way sha256:aa.... Please note this parameter, if set, will override the tag | "" |
rabbitmqImage.pullSecrets | RabbitMQ Image pull secrets | [] |
credentialUpdaterImage.registry | RabbitMQ Default User Credential Updater image registry | REGISTRY_NAME |
credentialUpdaterImage.repository | RabbitMQ Default User Credential Updater image repository | REPOSITORY_NAME/rmq-default-credential-updater |
credentialUpdaterImage.digest | RabbitMQ Default User Credential Updater image digest in the way sha256:aa.... Please note this parameter, if set, will override the tag | "" |
credentialUpdaterImage.pullSecrets | RabbitMQ Default User Credential Updater image pull secrets | [] |
clusterOperator.image.registry | RabbitMQ Cluster Operator image registry | REGISTRY_NAME |
clusterOperator.image.repository | RabbitMQ Cluster Operator image repository | REPOSITORY_NAME/rabbitmq-cluster-operator |
clusterOperator.image.digest | RabbitMQ Cluster Operator image digest in the way sha256:aa.... Please note this parameter, if set, will override the tag | "" |
clusterOperator.image.pullPolicy | RabbitMQ Cluster Operator image pull policy | IfNotPresent |
clusterOperator.image.pullSecrets | RabbitMQ Cluster Operator image pull secrets | [] |
clusterOperator.revisionHistoryLimit | sets number of replicaset to keep in k8s | 10 |
clusterOperator.watchAllNamespaces | Watch for resources in all namespaces | true |
clusterOperator.watchNamespaces | Watch for resources in the given namespaces (ignored if watchAllNamespaces=true) |
Note: the README for this chart is longer than the DockerHub length limit of 25000, so it has been trimmed. The full README can be found at https://github.com/bitnami/charts/blob/main/bitnami/rabbitmq-cluster-operator/README.md