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 14f946c9c31fde7ebb6c7751a5133747df273c4d..15f9cdf38d2ce9cc5fee633b352662483d106265 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,44 +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 -->
 
-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.
+# ansible-rabbitmq
 
-Role Variables
---------------
+An [Ansible](https://www.ansible.com) role to install/configure [RabbitMQ](https://www.rabbitmq.com/)
 
-````
-enable_rabbitmq_clustering: false  #defines if setting up a rabbitmq cluster
-config_rabbitmq_ha: false  #defines if rabbitmq ha should be configured
-````
+## Build Status
 
-Dependencies
-------------
+[![Build Status](https://travis-ci.org/mrlesmithjr/ansible-rabbitmq.svg?branch=master)](https://travis-ci.org/mrlesmithjr/ansible-rabbitmq)
 
-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.
+## Requirements
 
-Example Playbook
-----------------
+Ensure hostnames are resolvable prior to clustering...either update /etc/hosts
+or ensure DNS is working.
 
-Including an example of how to use your role (for instance, with variables passed in as parameters) is always nice for users too:
+## Vagrant
 
-    - hosts: servers
-      roles:
-         - { role: mrlesmithjr.rabbitmq }
+Spin up a 3 node HA Cluster for testing...
+Install Ansible role on your host:
 
-License
--------
+```bash
+sudo ansible-galaxy install -r requirements.yml -f
+```
 
-BSD
+Now spin up your environment...
 
-Author Information
-------------------
+```bash
+vagrant up
+```
+
+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)