X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=README.md;h=15f9cdf38d2ce9cc5fee633b352662483d106265;hb=refs%2Fheads%2Ffretlink-fixes;hp=b3b03adcea64556071421c27b9ee12a3ed1cbda6;hpb=a67dde50f26e0f76d91f0744e8e8341dac95dae2;p=github%2Ffretlink%2Fansible-rabbitmq.git diff --git a/README.md b/README.md index b3b03ad..15f9cdf 100644 --- a/README.md +++ b/README.md @@ -1,65 +1,73 @@ -Role Name -========= + + +**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)* -An [Ansible] role to install/configure [RabbitMQ] +- [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) -Build Status ------------- + + +# ansible-rabbitmq + +An [Ansible](https://www.ansible.com) role to install/configure [RabbitMQ](https://www.rabbitmq.com/) + +## Build Status [![Build Status](https://travis-ci.org/mrlesmithjr/ansible-rabbitmq.svg?branch=master)](https://travis-ci.org/mrlesmithjr/ansible-rabbitmq) -Requirements ------------- +## Requirements Ensure hostnames are resolvable prior to clustering...either update /etc/hosts or ensure DNS is working. -Vagrant -------- +## Vagrant -Spin up a 3 node HA Cluster for testing... -Install Ansible role on your host: -``` +Spin up a 3 node HA Cluster for testing... +Install Ansible role on your host: + +```bash sudo ansible-galaxy install -r requirements.yml -f ``` -Now spin up your environment... -``` + +Now spin up your environment... + +```bash vagrant up ``` -When you are done testing, tear it all down... -``` + +When you are done testing, tear it all down... + +```bash ./cleanup.sh ``` -Role Variables --------------- +## Role Variables [Role Defaults](./defaults/main.yml) -Dependencies ------------- +## Dependencies None -Example Playbook ----------------- +## Example Playbook [Example Playbook](./playbook.yml) -License -------- +## License -BSD +MIT -Author Information ------------------- +## Author Information Larry Smith Jr. -- [@mrlesmithjr] -- http://everythingshouldbevirtual.com -- mrlesmithjr [at] gmail.com - -[@mrlesmithjr]: -[Ansible]: -[RabbitMQ]: +- [@mrlesmithjr](https://www.twitter.com/mrlesmithjr) +- [EverythingShouldBeVirtual](http://everythingshouldbevirtual.com) +- [mrlesmithjr@gmail.com](mailto:mrlesmithjr@gmail.com)