openstack
/
charm-rabbitmq-server
Code Issues Proposed changes
Juju Charm - RabbitMQ
1,002 Commits 24 Branches 5 Tags 6.3 MiB
Python 99.5%
Shell 0.5%
Go to file
Alex Kavanagh 4b8608cc8f Updates for stable branch creation 
Set default branch for git review/gerrit.

Switch tests to stable.

Switch to using stable charm-helpers branch.

Switch to using stable charm.openstack branch.

Change-Id: Ia50ffa650da951e9cb2943e1f08aeda15780fe2b
 		2020-08-13 11:40:05 +01:00
actions Add `force-boot` action 2020-06-22 13:04:11 +03:00
charmhelpers Release sync for 20.08 2020-07-27 20:59:24 +01:00
files Noop Flake8 update 2020-06-02 10:32:26 -07:00
hooks Revert "Add workload message when waiting for clustering" 2020-07-07 15:34:15 +00:00
lib Update tox.ini files from release-tools gold copy 2016-09-19 09:33:20 +01:00
templates Change charm to py3 2018-10-24 14:50:35 +01:00
tests Updates for stable branch creation 2020-08-13 11:40:05 +01:00
unit_tests Add `force-boot` action 2020-06-22 13:04:11 +03:00
.gitignore Forget cluster node as an action 2020-06-09 08:48:13 -07:00
.gitreview Updates for stable branch creation 2020-08-13 11:40:05 +01:00
.stestr.conf Fix lint in unit tests re: py3-first and py2 compat 2018-11-01 21:57:56 -05:00
.zuul.yaml Switch to Ussuri jobs 2019-12-26 18:29:33 +08:00
LICENSE Re-license charm as Apache-2.0 2016-07-01 18:06:36 +01:00
Makefile Port Charm RabbitMQ func tests from Amulet to Zaza 2019-10-10 13:05:09 +11:00
README.md Review README 2020-04-09 14:17:34 -04:00
actions.yaml Add `force-boot` action 2020-06-22 13:04:11 +03:00
charm-helpers-hooks.yaml Updates for stable branch creation 2020-08-13 11:40:05 +01:00
config.yaml Review README 2020-04-09 14:17:34 -04:00
copyright Re-license charm as Apache-2.0 2016-07-01 18:06:36 +01:00
hardening.yaml Add hardening support 2016-03-24 11:38:33 +00:00
icon.svg Added icon.svg 2013-04-25 14:23:14 -04:00
metadata.yaml Updates for 20.08 cycle start for groovy and libs 2020-06-02 14:37:04 +01:00
requirements.txt Release sync for 20.08 2020-07-27 20:59:24 +01:00
revision Added stats cronjob and queue monitoring nagios plugin 2014-05-07 10:52:24 +01:00
setup.cfg Add Python 3 Train unit tests 2019-07-30 10:20:48 -04:00
test-requirements.txt Release sync for 20.08 2020-07-27 20:59:24 +01:00
tox.ini Release sync for 20.08 2020-07-27 20:59:24 +01:00

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 configuration options. See file config.yaml for the full list of options, along with their descriptions and default values.

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 appendix OpenStack upgrades in the OpenStack Charms Deployment Guide.

ssl

The ssl option enables encryption for client-server communication. It can take on several values:

  • 'off': disables SSL (the default)
  • 'on': enables SSL for compatible clients
  • 'only': enforces SSL

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

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

To deploy a three-node cluster:

juju deploy -n 3 --config min-cluster-size=3 rabbitmq-server

SSL

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

  1. with Vault
  2. manually (via openssl commands and 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.

Enable SSL by passing the ssl option (see description above) to the deployed rabbitmq-server application:

juju config rabbitmq-server ssl=only

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 rabbitmq-server. If the charm is not deployed then see file actions.yaml.

Bugs

Please report bugs on Launchpad.

For general charm questions refer to the OpenStack Charm Guide.