Migrate documentation to discourse
Documentation about this charm has been moved discourse to help improve user experience by centralizing charm's documentations in a single place. Change-Id: Ifd0ad1a1b39c32984670eb6e627d6a7a536c49c0
This commit is contained in:
Guillaume Boutry
parent
09c507dd21
commit
62f1436e85
137
README.md
137
README.md
|
|
@ -1,137 +1,12 @@
|
|||
# Overview
|
||||
# RabbitMQ-server
|
||||
|
||||
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.
|
||||
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][charms-requires-rabbitmq] (the
|
||||
charms officially supported by the OpenStack Charms project are published by
|
||||
'openstack-charmers').
|
||||
The rabbitmq-server charm deploys RabbitMQ server and provides AMQP services to those charms that support the rabbitmq interface.
|
||||
|
||||
# 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][juju-docs-config-apps] 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][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][cdg-upgrade-openstack] in the
|
||||
[OpenStack Charms Deployment Guide][cdg].
|
||||
|
||||
## 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][cdg-ha-rabbitmq] in the [OpenStack Charms
|
||||
Deployment Guide][cdg] 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
|
||||
1. 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][vault-charm] 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][juju-docs-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:
|
||||
|
||||
* [OpenStack Charm Guide][cg]: for project information, including development
|
||||
and support notes
|
||||
* [OpenStack Charms Deployment Guide][cdg]: for charm usage information
|
||||
|
||||
# Bugs
|
||||
|
||||
For general charm questions refer to the [OpenStack Charm Guide][cg].
|
||||
The charm's documentation is viewed on [Charmhub][charm-docs] and its bugs are tracked on [Launchpad][charm-bugs].
|
||||
|
||||
<!-- LINKS -->
|
||||
|
||||
[cg]: https://docs.openstack.org/charm-guide
|
||||
[cdg]: https://docs.openstack.org/project-deploy-guide/charm-deployment-guide
|
||||
[cdg-upgrade-openstack]: https://docs.openstack.org/project-deploy-guide/charm-deployment-guide/latest/upgrade-openstack.html
|
||||
[lp-bugs-charm-rabbitmq-server]: https://bugs.launchpad.net/charm-rabbitmq-server/+filebug
|
||||
[juju-docs-actions]: https://jaas.ai/docs/actions
|
||||
[charms-requires-rabbitmq]: https://jaas.ai/search?requires=rabbitmq
|
||||
[vault-charm]: https://jaas.ai/vault
|
||||
[uca]: https://wiki.ubuntu.com/OpenStack/CloudArchive
|
||||
[cdg-ha-rabbitmq]: https://docs.openstack.org/project-deploy-guide/charm-deployment-guide/latest/app-ha.html#rabbitmq
|
||||
[juju-docs-config-apps]: https://juju.is/docs/configuring-applications
|
||||
[charm-docs]: https://discourse.charmhub.io/t/rabbitmq-server-docs-index/10546
|
||||
[charm-bugs]: https://bugs.launchpad.net/charm-rabbitmq-server/+filebug
|
||||
|
|
|
|||
|
|
@ -1,6 +1,7 @@
|
|||
name: rabbitmq-server
|
||||
summary: An AMQP server written in Erlang
|
||||
maintainer: OpenStack Charmers <openstack-charmers@lists.ubuntu.com>
|
||||
docs: https://discourse.charmhub.io/t/rabbitmq-server-docs-index/10546
|
||||
description: |
|
||||
RabbitMQ is an implementation of AMQP, the emerging standard for high
|
||||
performance enterprise messaging. The RabbitMQ server is a robust and
|
||||
|
|
|
|||
Loading…
Reference in New Issue