Fixed missing become on task

[github/fretlink/ansible-rabbitmq.git] / README.md

diff --git a/README.md b/README.md
index 88f3c941398260a97a37b5f441aa9bcadfc24c4a..b3b03adcea64556071421c27b9ee12a3ed1cbda6 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,46 +1,50 @@
 Role Name
 =========
 
-Installs rabbitmq https://www.rabbitmq.com/ (Configurable...HA and Clustering ready)
+An [Ansible] role to install/configure [RabbitMQ]
+
+Build Status
+------------
+
+[![Build Status](https://travis-ci.org/mrlesmithjr/ansible-rabbitmq.svg?branch=master)](https://travis-ci.org/mrlesmithjr/ansible-rabbitmq)
 
 Requirements
 ------------
 
-Any pre-requisites that may not be covered by Ansible itself or the role should be mentioned here. For instance, if the role uses the EC2 module, it may be a good idea to mention in this section that the boto package is required.
+Ensure hostnames are resolvable prior to clustering...either update /etc/hosts
+or ensure DNS is working.
+
+Vagrant
+-------
+
+Spin up a 3 node HA Cluster for testing...  
+Install Ansible role on your host:  
+```
+sudo ansible-galaxy install -r requirements.yml -f
+```
+Now spin up your environment...  
+```
+vagrant up
+```
+When you are done testing, tear it all down...  
+```
+./cleanup.sh
+```
 
 Role Variables
 --------------
-define in one host_vars/host config to designate the master_rabbit_node
-````
-master_rabbit_node: true
-````
-
-````
-enable_rabbitmq_clustering: false  #defines if setting up a rabbitmq cluster...define here or in group_vars/group
-config_rabbitmq_ha: false  #defines if rabbitmq ha should be configured...define here or in group_vars/group
-master_rabbit_node: false  #defines if node should be considered master...define as true in one host in host_vars/host out of all nodes to be part of cluster
-rabbitmq_config:
-  - queue_name: logstash
-    durable: true
-    exchange_name: logstash
-    type: fanout
-    routing_key: logstash
-    tags: 'ha-mode=all,ha-sync-mode=automatic'
-````
+
+[Role Defaults](./defaults/main.yml)
 
 Dependencies
 ------------
 
-A list of other roles hosted on Galaxy should go here, plus any details in regards to parameters that may need to be set for other roles, or variables that are used from other roles.
+None
 
 Example Playbook
 ----------------
 
-Including an example of how to use your role (for instance, with variables passed in as parameters) is always nice for users too:
-
-    - hosts: servers
-      roles:
-         - { role: mrlesmithjr.rabbitmq }
+[Example Playbook](./playbook.yml)
 
 License
 -------
@@ -51,6 +55,11 @@ Author Information
 ------------------
 
 Larry Smith Jr.
-- @mrlesmithjr
+- [@mrlesmithjr]
 - http://everythingshouldbevirtual.com
 - mrlesmithjr [at] gmail.com
+
+[@mrlesmithjr]: <https://www.twitter.com/mrlesmithjr>
+
+[Ansible]: <https://www.ansible.com>
+[RabbitMQ]: <https://www.rabbitmq.com/>