Merge "README update"
diff --git a/README.rst b/README.rst
index bab7652..b011af8 100644
--- a/README.rst
+++ b/README.rst
@@ -1,8 +1,9 @@
=========================
-RabbitMQ messaging system
+Usage
=========================
-RabbitMQ is a complete and highly reliable enterprise messaging system based on the emerging AMQP standard.
+RabbitMQ is a complete and highly reliable enterprise messaging
+system based on the emerging AMQP standard.
Sample pillars
==============
@@ -10,7 +11,7 @@
Standalone Broker
-----------------
-RabbitMQ as AMQP broker with admin user and vhosts
+RabbitMQ as AMQP broker with admin user and vhosts:
.. code-block:: yaml
@@ -33,7 +34,7 @@
user: 'monitor'
password: 'password'
-RabbitMQ as a Stomp broker
+RabbitMQ as a Stomp broker:
.. code-block:: yaml
@@ -56,7 +57,7 @@
RabbitMQ cluster
----------------
-RabbitMQ as base cluster node
+RabbitMQ as base cluster node:
.. code-block:: yaml
@@ -80,7 +81,7 @@
- name: openstack2
host: 10.10.10.213
-HA Queues definition
+HA Queues definition:
.. code-block:: yaml
@@ -98,11 +99,11 @@
pattern: '^(?!amq\.).*'
definition: '{"ha-mode": "all"}'
-
Enable TLS support
------------------
-To enable support of TLS for rabbitmq-server you need to provide a path to cacert, server cert and private key :
+To enable support of TLS for rabbitmq-server you need to provide
+a path to cacert, server cert and private key:
.. code-block:: yaml
@@ -116,7 +117,8 @@
cert_file: /etc/rabbitmq/ssl/cert.pem
ca_file: /etc/rabbitmq/ssl/ca.pem
-To manage content of these files you can either use the following options:
+To manage content of these files you can either use the following
+options:
.. code-block:: yaml
@@ -147,7 +149,10 @@
Or you can use the `salt.minion.cert` salt state which
-creates all required files according to defined reclass model [1]. In this case you need just to enable ssl and nothing more:
+creates all required files according to defined reclass model.
+See
+https://github.com/Mirantis/reclass-system-salt-model/tree/master/salt/minion/cert/rabbitmq
+for details. In this case you need just to enable ssl and nothing more:
.. code-block:: yaml
@@ -158,9 +163,7 @@
ssl:
enabled: True
---
-
-Defaut port for TLS is **5671**:
+Defaut port for TLS is ``5671``:
.. code-block:: yaml
@@ -170,15 +173,11 @@
ssl:
port: 5671
-
-1. https://github.com/Mirantis/reclass-system-salt-model/tree/master/salt/minion/cert/rabbitmq
-
-
-
Usage
=====
-Check cluster status, example shows running cluster with 3 nodes: ctl-1, ctl-2, ctl-3
+Check cluster status, example shows running cluster with 3 nodes:
+ctl-1, ctl-2, ctl-3
.. code-block:: yaml
@@ -190,7 +189,7 @@
{partitions,[]}]
...done.
-Setup management user.
+Setup management user:
.. code-block:: yaml
@@ -199,8 +198,16 @@
> rabbitmqctl set_permissions -p vhost user ".*" ".*" ".*"
> rabbitmqctl set_user_tags user management
-EPD process is Erlang Port Mapper Daemon. It's a feature of the Erlang runtime that helps Erlang nodes to find each other. It's a pretty tiny thing and doesn't contain much state (other than "what Erlang nodes are running on this system?") so it's not a huge deal for it to still be running.
-Although it's running as user rabbitmq, it was started automatically by the Erlang VM when we started. We've considered adding "epmd -kill" to our shutdown script - but that would break any other Erlang apps running on the system; it's more "global" than RabbitMQ.
+EPD process is Erlang Port Mapper Daemon. It's a feature of the
+Erlang runtime that helps Erlang nodes to find each other. It's a
+pretty tiny thing and doesn't contain much state (other than "what
+Erlang nodes are running on this system?") so it's not a huge deal for
+it to still be running.
+
+Although it's running as user rabbitmq, it was started automatically
+by the Erlang VM when we started. We've considered adding "epmd -kill"
+to our shutdown script - but that would break any other Erlang apps
+running on the system; it's more "global" than RabbitMQ.
Read more
=========
@@ -222,32 +229,25 @@
Documentation and Bugs
======================
-To learn how to install and update salt-formulas, consult the documentation
-available online at:
+* http://salt-formulas.readthedocs.io/
+ Learn how to install and update salt-formulas
- http://salt-formulas.readthedocs.io/
+* https://github.com/salt-formulas/salt-formula-rabbitmq/issues
+ In the unfortunate event that bugs are discovered, report the issue to the
+ appropriate issue tracker. Use the Github issue tracker for a specific salt
+ formula
-In the unfortunate event that bugs are discovered, they should be reported to
-the appropriate issue tracker. Use Github issue tracker for specific salt
-formula:
+* https://launchpad.net/salt-formulas
+ For feature requests, bug reports, or blueprints affecting the entire
+ ecosystem, use the Launchpad salt-formulas project
- https://github.com/salt-formulas/salt-formula-rabbitmq/issues
+* https://launchpad.net/~salt-formulas-users
+ Join the salt-formulas-users team and subscribe to mailing list if required
-For feature requests, bug reports or blueprints affecting entire ecosystem,
-use Launchpad salt-formulas project:
+* https://github.com/salt-formulas/salt-formula-rabbitmq
+ Develop the salt-formulas projects in the master branch and then submit pull
+ requests against a specific formula
- https://launchpad.net/salt-formulas
-
-You can also join salt-formulas-users team and subscribe to mailing list:
-
- https://launchpad.net/~salt-formulas-users
-
-Developers wishing to work on the salt-formulas projects should always base
-their work on master branch and submit pull request against specific formula.
-
- https://github.com/salt-formulas/salt-formula-rabbitmq
-
-Any questions or feedback is always welcome so feel free to join our IRC
-channel:
-
- #salt-formulas @ irc.freenode.net
+* #salt-formulas @ irc.freenode.net
+ Use this IRC channel in case of any questions or feedback which is always
+ welcome