⚠️ DEPRECATED - RabbitMQ High Available

This chart is deprecated and no longer maintained. It is recommended to use the Bitnami maintained RabbitMQ chart which has a similar feature set, including high availability.

RabbitMQ is an open source message broker software that implements the Advanced Message Queuing Protocol (AMQP).

TL;DR;

$ helm install stable/rabbitmq-ha

Introduction

This chart bootstraps a RabbitMQ deployment on a Kubernetes cluster using the Helm package manager.

Prerequisites

• Kubernetes 1.9+ with Beta APIs enabled
• PV provisioner support in the underlying infrastructure

Installing the Chart

To install the chart with the release name my-release:

$ helm install --name my-release stable/rabbitmq-ha

The command deploys RabbitMQ on the Kubernetes cluster in the default configuration. The configuration section lists the parameters that can be configured during installation.

Tip: List all releases using helm list

Upgrading the Chart

To upgrade the chart, you need to make sure that you are using the same value of the rabbitmqErlangCookie amongst the releases. If you didn't define it at the first place, you can upgrade using the following command:

$ export ERLANGCOOKIE=$(kubectl get secrets -n <NAMESPACE> <HELM_RELEASE_NAME>-rabbitmq-ha -o jsonpath="{.data.rabbitmq-erlang-cookie}" | base64 --decode)
$ helm upgrade \
    --set rabbitmqErlangCookie=$ERLANGCOOKIE \
    <HELM_RELEASE_NAME> stable/rabbitmq-ha

Uninstalling the Chart

To uninstall/delete the my-release deployment:

$ helm delete my-release

The command removes all the Kubernetes components associated with the chart and deletes the release.

Configuration

The following table lists the configurable parameters of the RabbitMQ chart and their default values.

Specify each parameter using the --set key=value[,key=value] argument to helm install. For example,

$ helm install --name my-release \
  --set rabbitmqUsername=admin,rabbitmqPassword=secretpassword,managementPassword=anothersecretpassword,rabbitmqErlangCookie=secretcookie \
    stable/rabbitmq-ha

The above command sets the RabbitMQ admin username and password to admin and secretpassword respectively. Additionally the management user password is set to anothersecretpassword and the secure erlang cookie is set to secretcookie.

Alternatively, a YAML file that specifies the values for the parameters can be provided while installing the chart. For example,

$ helm install --name my-release -f values.yaml stable/rabbitmq-ha

Tip: You can use the default values.yaml

Custom ConfigMap

When creating a new chart with this chart as a dependency, existingConfigMap can be used to override the default configmap.yaml provided. It also allows for providing additional configuration files that will be mounted into /etc/definitions. In the parent chart's values.yaml, set the value to true and provide the file [templates/configmap.yaml][] for your use case.

Example of using RabbitMQ definition to setup users, permissions or policies:

apiVersion: v1
kind: ConfigMap
metadata:
  name: my-release-rabbitmq-ha
data:
  enabled_plugins: |
    [
      rabbitmq_consistent_hash_exchange,
      rabbitmq_federation,
      rabbitmq_federation_management,
      rabbitmq_management,
      rabbitmq_peer_discovery_k8s,
      rabbitmq_shovel,
      rabbitmq_shovel_management
    ].
  rabbitmq.conf: |
    # ....
    management.load_definitions = /etc/definitions/definitions.json
  definitions.json: |
    {
      "permissions": [],
      "users": [],
      "policies: []
    }

Then, install the chart with the above configuration:

$ helm install --name my-release --set existingConfigMap=true stable/rabbitmq-ha

Custom Secret

Similar to custom ConfigMap, existingSecret can be used to override the default secret.yaml provided, and rabbitmqCert.existingSecret can be used to override the default certificates. The custom secret must provide the following keys:

• rabbitmq-username
• rabbitmq-password
• rabbitmq-management-username
• rabbitmq-management-password
• rabbitmq-erlang-cookie
• definitions.json (the name can be altered by setting the definitionsSource)

Prometheus Monitoring & Alerts

As of RabbitMQ 3.8.0, it is possible to enable Prometheus metrics natively, no need to run an external exporter. To enable native Prometheus metrics, set rabbitmqPrometheusPlugin.enabled to true. This will expose all RabbitMQ node metrics via the <<rabbitmqhost>>:15692/metrics URL. Since all metrics are node local, they add the least pressure on RabbitMQ and will be available for as long as RabbitMQ is running, regardless of inter-node pressure or other nodes in the cluster going away.

To learn more about RabbitMQ's native support for Prometheus, please refer to the official Monitoring with Prometheus & Grafana guide.

Team RabbitMQ manages Grafana dashboards that are meant to be used with the native Prometheus support. They are publicly available at grafana.com/orgs/rabbitmq.

To enable metrics via the traditional rabbitmq_exporter sidecar container, set prometheus.enabled to true. See values.yaml file for more details and configuration options.

Usage of the tpl Function

The tpl function allows us to pass values from values.yaml through the templating engine. It is used for the following values:

• extraContainers
• extraInitContainers
• persistentVolume.annotations
• persistentVolume.labels
• service.annotations