Juju Charm - RabbitMQ
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
Zuul d79095f6b5 Merge "Rabbitmq metrics and splitbrain detection" 6 days ago
actions Merge "Modify the output to action "cluster-status" to make it user friendly (rabbitmq)" 1 month ago
charmhelpers Add yoga bundles and release-tool syncs 2 months ago
files Rabbitmq metrics and splitbrain detection 7 days ago
hooks Merge "Rabbitmq metrics and splitbrain detection" 6 days ago
lib Update tox.ini files from release-tools gold copy 5 years ago
templates Restrict TLS versions 2 months ago
tests Add yoga bundles and release-tool syncs 2 months ago
unit_tests Merge "Rabbitmq metrics and splitbrain detection" 6 days ago
.gitignore Forget cluster node as an action 2 years ago
.gitreview OpenDev Migration Patch 3 years ago
.stestr.conf Fix lint in unit tests re: py3-first and py2 compat 3 years ago
.zuul.yaml Use unittest.mock instead of mock 1 month ago
LICENSE Re-license charm as Apache-2.0 6 years ago
Makefile Port Charm RabbitMQ func tests from Amulet to Zaza 2 years ago
README.md Rabbitmq metrics and splitbrain detection 7 days ago
actions.yaml Implementation of deferred restarts 10 months ago
charm-helpers-hooks.yaml Updates to flip all libraries back to master 9 months ago
config.yaml Switch to enabling the managment plugin by default 2 months ago
copyright Re-license charm as Apache-2.0 6 years ago
hardening.yaml Add hardening support 6 years ago
icon.svg Added icon.svg 9 years ago
metadata.yaml Rabbitmq metrics and splitbrain detection 7 days ago
osci.yaml Add yoga bundles and release-tool syncs 2 months ago
pip.sh Add xena bundles 4 months ago
requirements.txt Sync release-tools 6 months ago
revision Added stats cronjob and queue monitoring nagios plugin 8 years ago
setup.cfg Add Python 3 Train unit tests 3 years ago
test-requirements.txt Use unittest.mock instead of mock 1 month ago
tox.ini Add yoga bundles and release-tool syncs 2 months ago

README.md

Overview

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').

Usage

Configuration

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.

min-cluster-size

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.

source

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.

Deployment

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 add-relation rabbitmq-server:amqp nova-cloud-controller:amqp

Monitoring

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

juju add-relation 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 add-relation 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 add-relation 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.

TLS

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 add-relation rabbitmq-server:certificates vault:certificates

Actions

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.

Documentation

The OpenStack Charms project maintains two documentation guides:

Bugs

For general charm questions refer to the OpenStack Charm Guide.