Merge remote-tracking branch 'gaetanfl/cluster_strategy' into fretlink-fixes

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

diff --git a/README.md b/README.md
index 4d1266aed56b808281ddc07252e869eebfe981f9..15f9cdf38d2ce9cc5fee633b352662483d106265 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,62 +1,73 @@
-Role Name
-=========
+<!-- START doctoc generated TOC please keep comment here to allow auto update -->
+<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
+**Table of Contents**  *generated with [DocToc](https://github.com/thlorenz/doctoc)*
 
-Installs rabbitmq https://www.rabbitmq.com/ (Configurable...HA and Clustering ready)
+- [ansible-rabbitmq](#ansible-rabbitmq)
+  - [Build Status](#build-status)
+  - [Requirements](#requirements)
+  - [Vagrant](#vagrant)
+  - [Role Variables](#role-variables)
+  - [Dependencies](#dependencies)
+  - [Example Playbook](#example-playbook)
+  - [License](#license)
+  - [Author Information](#author-information)
 
-Requirements
-------------
+<!-- END doctoc generated TOC please keep comment here to allow auto update -->
 
-Ensure hostnames are resolvable prior to clustering...either update /etc/hosts or ensure DNS is working.
+# ansible-rabbitmq
 
-Role Variables
---------------
+An [Ansible](https://www.ansible.com) role to install/configure [RabbitMQ](https://www.rabbitmq.com/)
 
-````
-config_rabbitmq_ha: false  #defines if rabbitmq ha should be configured...define here or in group_vars/group
-enable_rabbitmq_clustering: false  #defines if setting up a rabbitmq cluster...define here or in group_vars/group
-erlang_cookie: LSKNKBELKPSTDBBCHETL  #define erlang cookie for cluster...define here or in group_vars/group
-rabbitmq_config:
-  - queue_name: logstash
-    durable: true
-    exchange_name: logstash
-    type: fanout
-    routing_key: logstash
-    tags: 'ha-mode=all,ha-sync-mode=automatic'
-rabbitmq_master: []  #defines the inventory host that should be considered master...define here or in group_vars/group
-````
+## Build Status
 
-example...
-group_vars/rabbitmq-cluster-nodes
-````
----
-enable_rabbitmq_clustering: true
-config_rabbitmq_ha: false
-rabbitmq_master: ans-test-1
-````
+[![Build Status](https://travis-ci.org/mrlesmithjr/ansible-rabbitmq.svg?branch=master)](https://travis-ci.org/mrlesmithjr/ansible-rabbitmq)
 
-Dependencies
-------------
+## Requirements
 
-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.
+Ensure hostnames are resolvable prior to clustering...either update /etc/hosts
+or ensure DNS is working.
 
-Example Playbook
-----------------
+## Vagrant
 
-Including an example of how to use your role (for instance, with variables passed in as parameters) is always nice for users too:
+Spin up a 3 node HA Cluster for testing...
+Install Ansible role on your host:
 
-    - hosts: servers
-      roles:
-         - { role: mrlesmithjr.rabbitmq }
+```bash
+sudo ansible-galaxy install -r requirements.yml -f
+```
 
-License
--------
+Now spin up your environment...
 
-BSD
+```bash
+vagrant up
+```
 
-Author Information
-------------------
+When you are done testing, tear it all down...
+
+```bash
+./cleanup.sh
+```
+
+## Role Variables
+
+[Role Defaults](./defaults/main.yml)
+
+## Dependencies
+
+None
+
+## Example Playbook
+
+[Example Playbook](./playbook.yml)
+
+## License
+
+MIT
+
+## Author Information
 
 Larry Smith Jr.
-- @mrlesmithjr
-- http://everythingshouldbevirtual.com
-- mrlesmithjr [at] gmail.com
+
+- [@mrlesmithjr](https://www.twitter.com/mrlesmithjr)
+- [EverythingShouldBeVirtual](http://everythingshouldbevirtual.com)
+- [mrlesmithjr@gmail.com](mailto:mrlesmithjr@gmail.com)