Rabbitmq Server

Channel Revision Published Runs on
latest/edge 186 16 May 2024
Ubuntu 23.10 Ubuntu 23.04 Ubuntu 22.04 Ubuntu 20.04
3.9/stable 185 16 May 2024
Ubuntu 22.04 Ubuntu 20.04
3.8/stable 176 21 May 2023
Ubuntu 20.04 Ubuntu 18.04
3.6/edge 135 25 Feb 2022
Ubuntu 20.04 Ubuntu 16.04
juju deploy rabbitmq-server --channel 3.9/stable
Show information


22.04 20.04


RabbitMQ is an implementation of AMQP, the emerging standard for high performance enterprise messaging. The RabbitMQ server is a robust and scalable implementation of an AMQP broker.

The rabbitmq-server charm deploys RabbitMQ server and provides AMQP services to those charms that support the rabbitmq interface. The current list of such charms can be obtained from the Charm Store (the charms officially supported by the OpenStack Charms project are published by ‘openstack-charmers’).

Important: This documentation supports version 3.x of the Juju client. See the OpenStack Charm guide if you are using the 2.9.x client.



This section covers common and/or important configuration options. See file config.yaml for the full list of options, along with their descriptions and default values. See the Juju documentation for details on configuring applications.


The min-cluster-size option sets the number of rabbitmq-server units required to form its cluster. It is best practice to use this option as doing so ensures that the charm will wait until the cluster is up before accepting relations from other client applications.


The source option sets an alternate software source and can be passed during or after deployment. The default behaviour is to use the Ubuntu package archive for the underlying machine series. The most common value is a UCA cloud pocket (e.g. ‘cloud:bionic-train’). In the case of a non-OpenStack project, there is no guarantee that a candidate will be found in the stated UCA pocket.

Note: Changing the value of this option post-deployment will trigger a software upgrade. See OpenStack upgrade in the OpenStack Charms Deployment Guide.


To deploy a single rabbitmq-server unit:

juju deploy rabbitmq-server

To make use of AMQP services, simply add a relation between rabbitmq-server and an application that supports the rabbitmq interface. For instance:

juju integrate rabbitmq-server:amqp nova-cloud-controller:amqp


To collect RabbitMQ metrics, add a relation between rabbitmq-server and an application that supports the scrape interface. For instance:

juju integrate rabbitmq-server:scrape prometheus:scrape

Note: The scrape relation is only supported when the RabbitMQ version is >= 3.8.

The charm can be related to a dashboard charm like grafana to view visualization metrics:

juju integrate rabbitmq-server:dashboards grafana:dashboards

To get alerts of RabbitMQ split-brain events, add a relation between rabbitmq-server and an application that supports the prometheus-rules interface. For instance:

juju integrate rabbitmq-server:prometheus-rules prometheus:prometheus-rules

High availability

When more than one unit is deployed the charm will bring up a native RabbitMQ HA active/active cluster. The min-cluster-size option should be used (see description above).

See Infrastructure high availability in the OpenStack Charms Deployment Guide for details.


Communication between the AMQP message queue and client services (OpenStack applications) can be TLS-encrypted. There are two methods for managing keys and certificates:

  1. with Vault
  2. manually (via charm options)

Vault can set up private keys and server certificates for an application. It also stores a central CA certificate for the cloud. See the vault charm for more information.

Vault is the recommended method and is what will be covered here.

The private key and server certificate (and its signing) are managed via a relation made to the vault application:

juju integrate rabbitmq-server:certificates vault:certificates


This section lists Juju actions supported by the charm. Actions allow specific operations to be performed on a per-unit basis.

  • check-queues
  • cluster-status
  • complete-cluster-series-upgrade
  • list-unconsumed-queues
  • pause
  • resume

To display action descriptions run juju actions --schema rabbitmq-server. If the charm is not deployed then see file actions.yaml.


The OpenStack Charms project maintains two documentation guides:


For general charm questions refer to the OpenStack Charm Guide.

Help improve this document in the forum (guidelines). Last updated 8 months ago.