[DOCS] Move RabbitMQ role docs

openstack/openstack-ansible-rabbitmq_server

Code Issues Proposed changes

Update the role documentation to match the new format. Each role project
should maintain the configuration variations for the role project
itself.
Change-Id: I73b061da40b08b327fc3445e073cbd8997920ccd

This commit is contained in:

Robb Romans

2016年08月11日 12:51:49 -05:00

committed by Travis Truman

parent 8adfab58c0

commit 7d3cce02c3

4 changed files with 86 additions and 33 deletions

Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL

Download Patch File Download Diff File Expand all files Collapse all files

36
doc/source/configure-rabbitmq.rst Normal file

View File

@@ -0,0 +1,36 @@

===============================

Scenario - Configuring RabbitMQ

===============================

RabbitMQ provides the messaging broker for various OpenStack services.

The OpenStack-Ansible project configures a plain text listener on port

5672 and a SSL/TLS encrypted listener on port 5671.

Customize your RabbitMQ deployment in

``/etc/openstack_deploy/user_variables.yml``.

Add a TLS encrypted listener to RabbitMQ

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

The OpenStack-Ansible project provides the ability to secure RabbitMQ

communications with self-signed or user-provided SSL certificates.

Refer to "Securing services with SSL certificates" in the OSA Install

Guide for available configuration options.

Enable encrypted connections to RabbitMQ

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

The control of SSL communication between various OpenStack services

and RabbitMQ is via the Ansible variable ``rabbitmq_use_ssl``:

.. code-block:: yaml

rabbitmq_use_ssl:true

Setting this variable to ``true`` adjusts the RabbitMQ port to 5671

(the default SSL/TLS listener port) and enables SSL connectivity

between each OpenStack service and RabbitMQ.

Setting this variable to ``false`` disables SSL encryption between

OpenStack services and RabbitMQ and configures all services to

use the plain text port, 5672.

37
doc/source/index.rst

View File

@@ -1 +1,36 @@

.. include:: ../../README.rst

=================================

OpenStack-Ansible RabbitMQ server

=================================

This Ansible role deploys RabbitMQ. When multiple hosts are present in

the ``rabbitmq_all`` inventory group, a cluster is created.

Table of Contents

~~~~~~~~~~~~~~~~~

.. toctree::

:maxdepth: 2

configure-rabbitmq.rst

Default variables

~~~~~~~~~~~~~~~~~

.. literalinclude:: ../../defaults/main.yml

:language: yaml

:start-after: under the License.

Required variables

~~~~~~~~~~~~~~~~~~

.. code-block:: yaml

# RabbitMQ cluster shared secret

rabbitmq_cookie_token:secrete

Example playbook

~~~~~~~~~~~~~~~~

.. literalinclude:: ../../examples/playbook.yml

:language: yaml