[DOCS] Cleanup the role docs for consistency and clarity
Utilizing RST includes to reduce duplication of documentation effort. All contents of the Ansible defaults/main.yml are now included in the documentation directly. Change-Id: Ib5224208259bc50b80cff2613f487ecbe461719a
This commit is contained in:
Travis Truman
parent
e4b7ae1787
commit
5bc9647ebb
@ -1,51 +1,61 @@
|
||||
rabbitmq_server
|
||||
########
|
||||
OpenStack-Ansible RabbitMQ Server
|
||||
#################################
|
||||
:tags: openstack, cloud, ansible
|
||||
:category: \*nix
|
||||
|
||||
contributor guidelines
|
||||
Contributor Guidelines
|
||||
^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
Filing Bugs
|
||||
-----------
|
||||
|
||||
Bugs should be filed on Launchpad, not GitHub: "https://bugs.launchpad.net/openstack-ansible"
|
||||
Bugs should be filed on Launchpad, not GitHub: "https://bugs.launchpad.net
|
||||
/openstack-ansible"
|
||||
|
||||
|
||||
When submitting a bug, or working on a bug, please ensure the following criteria are met:
|
||||
* The description clearly states or describes the original problem or root cause of the problem.
|
||||
When submitting a bug, or working on a bug, please ensure the following
|
||||
criteria are met:
|
||||
* The description clearly states or describes the original problem or root
|
||||
cause of the problem.
|
||||
* Include historical information on how the problem was identified.
|
||||
* Any relevant logs are included.
|
||||
* The provided information should be totally self-contained. External access to web services/sites should not be needed.
|
||||
* The provided information should be totally self-contained. External
|
||||
access to web services/sites should not be needed.
|
||||
* Steps to reproduce the problem if possible.
|
||||
|
||||
|
||||
Submitting Code
|
||||
---------------
|
||||
|
||||
Changes to the project should be submitted for review via the Gerrit tool, following
|
||||
the workflow documented at: "http://docs.openstack.org/infra/manual/developers.html#development-workflow"
|
||||
Changes to the project should be submitted for review via the Gerrit tool,
|
||||
following the workflow documented at:
|
||||
"http://docs.openstack.org/infra/manual/developers.html#development-workflow"
|
||||
|
||||
Pull requests submitted through GitHub will be ignored and closed without regard.
|
||||
Pull requests submitted through GitHub will be ignored and closed without
|
||||
regard.
|
||||
|
||||
|
||||
Extra
|
||||
-----
|
||||
|
||||
Tags:
|
||||
If it's a bug that needs fixing in a branch in addition to Master, add a '\<release\>-backport-potential' tag (eg ``juno-backport-potential``). There are predefined tags that will autocomplete.
|
||||
Tags: If it's a bug that needs fixing in a branch in addition to Master, add a
|
||||
'\<release\>-backport-potential' tag (eg ``juno-backport-potential``).
|
||||
There are predefined tags that will autocomplete.
|
||||
|
||||
Status:
|
||||
Please leave this alone, it should be New till someone triages the issue.
|
||||
|
||||
Importance:
|
||||
Should only be touched if it is a Blocker/Gating issue. If it is, please set to High, and only use Critical if you have found a bug that can take down whole infrastructures.
|
||||
Should only be touched if it is a Blocker/Gating issue. If it is, please
|
||||
set to High, and only use Critical if you have found a bug that can take
|
||||
down whole infrastructures.
|
||||
|
||||
|
||||
Style guide
|
||||
-----------
|
||||
|
||||
When creating tasks and other roles for use in Ansible please create then using the YAML dictionary format.
|
||||
When creating tasks and other roles for use in Ansible please create then
|
||||
using the YAML dictionary format.
|
||||
|
||||
Example YAML dictionary format:
|
||||
.. code-block:: yaml
|
||||
@ -69,17 +79,22 @@ Example **NOT** in YAML dictionary format:
|
||||
- some-other-tag
|
||||
|
||||
|
||||
Usage of the ">" and "|" operators should be limited to Ansible conditionals and command modules such as the ansible ``shell`` module.
|
||||
Usage of the ">" and "|" operators should be limited to Ansible conditionals
|
||||
and command modules such as the ansible ``shell`` module.
|
||||
|
||||
|
||||
Issues
|
||||
------
|
||||
|
||||
When submitting an issue, or working on an issue please ensure the following criteria are met:
|
||||
* The description clearly states or describes the original problem or root cause of the problem.
|
||||
When submitting an issue, or working on an issue please ensure the following
|
||||
criteria are met:
|
||||
* The description clearly states or describes the original problem or root
|
||||
cause of the problem.
|
||||
* Include historical information on how the problem was identified.
|
||||
* Any relevant logs are included.
|
||||
* If the issue is a bug that needs fixing in a branch other than Master, add the ‘backport potential’ tag TO THE ISSUE (not the PR).
|
||||
* The provided information should be totally self-contained. External access to web services/sites should not be needed.
|
||||
* If the issue is a bug that needs fixing in a branch other than Master,
|
||||
add the ‘backport potential’ tag TO THE ISSUE (not the PR).
|
||||
* The provided information should be totally self-contained. External
|
||||
access to web services/sites should not be needed.
|
||||
* If the issue is needed for a hotfix release, add the 'expedite' label.
|
||||
* Steps to reproduce the problem if possible.
|
||||
|
||||
29
README.rst
29
README.rst
@ -1,18 +1,33 @@
|
||||
OpenStack rabbitmq server
|
||||
#########################
|
||||
:tags: openstack, rabbitmq, server, cloud, ansible
|
||||
:category: \*nix
|
||||
OpenStack-Ansible RabbitMQ Server
|
||||
#################################
|
||||
|
||||
Role to deploy rabbitmq and cluster it when there are more than one nodes.
|
||||
This Ansible role deploys RabbitMQ. When multiple hosts are present in the
|
||||
rabbitmq_all inventory group a cluster will be created.
|
||||
|
||||
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
|
||||
================
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
- name: Install rabbitmq server
|
||||
hosts: rabbitmq_all
|
||||
max_fail_percentage: 20
|
||||
user: root
|
||||
roles:
|
||||
- { role: "rabbitmq_server", tags: [ "rabbitmq-server" ] }
|
||||
vars:
|
||||
rabbitmq_cookie_token: secrete
|
||||
container_address: "{{ ansible_ssh_host }}"
|
||||
|
||||
@ -1,31 +1 @@
|
||||
rabbitmq_server Docs
|
||||
====================
|
||||
|
||||
Install clustered RabbitMQ
|
||||
|
||||
|
||||
Basic Role Example
|
||||
^^^^^^^^^^^^^^^^^^
|
||||
|
||||
.. code-block:: yaml
|
||||
|
||||
- name: Install rabbitmq server
|
||||
hosts: rabbitmq_all
|
||||
max_fail_percentage: 20
|
||||
user: root
|
||||
roles:
|
||||
- { role: "rabbitmq_server", tags: [ "rabbitmq-server" ] }
|
||||
vars:
|
||||
rabbitmq_cookie_token: secrete
|
||||
container_address: "{{ ansible_ssh_host }}"
|
||||
|
||||
|
||||
Role overrides
|
||||
^^^^^^^^^^^^^^
|
||||
|
||||
rabbitmq_async_threads
|
||||
This override defaults to 128 threads for IO operations inside the erlang VM
|
||||
|
||||
rabbitmq_process_limit
|
||||
This override defaults to 1048576 for number of concurrent processes inside the erlang VM
|
||||
Each network connection and file handle does need its own process inside erlang
|
||||
.. include:: ../../README.rst
|
||||
Loading…
Reference in New Issue
Block a user