Added support for CentOS and Vagrant

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

diff --git a/README.md b/README.md
index a4a7c45efa0b8b1791decf71aabdd61134b54dd8..8685452161300fc8ace4e08c4395a81279a17a8e 100644 (file)
--- a/README.md
+++ b/README.md
@@ -8,14 +8,33 @@ Requirements
 
 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
 --------------
 
 ````
+---
+# defaults file for ansible-rabbitmq
 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
-erlang_cookie_file: /var/lib/rabbitmq/.erlang.cookie
+erlang_cookie: 'LSKNKBELKPSTDBBCHETL'  #define erlang cookie for cluster...define here or in group_vars/group
+erlang_cookie_file: '/var/lib/rabbitmq/.erlang.cookie'
 rabbitmq_config:
   - queue_name: logstash
     durable: true
@@ -23,7 +42,21 @@ rabbitmq_config:
     type: direct
     routing_key: logstash
     tags: 'ha-mode=all,ha-sync-mode=automatic'
+rabbitmq_debian_repo: 'deb http://www.rabbitmq.com/debian/ testing main'
+rabbitmq_debian_repo_key: 'http://www.rabbitmq.com/rabbitmq-signing-key-public.asc'
 rabbitmq_master: []  #defines the inventory host that should be considered master...define here or in group_vars/group
+rabbitmq_redhat_repo_key: 'https://www.rabbitmq.com/rabbitmq-signing-key-public.asc'
+rabbitmq_redhat_package: 'rabbitmq-server-{{ rabbitmq_redhat_version }}-1.noarch.rpm'
+rabbitmq_redhat_url: 'http://www.rabbitmq.com/releases/rabbitmq-server/v{{ rabbitmq_redhat_version }}'
+rabbitmq_redhat_version: '3.6.1'
+rabbitmq_users:  #define admin user to create in order to login to WebUI
+  - name: rabbitmqadmin
+    password: rabbitmqadmin
+    vhost: /
+    configure_priv: '.*'
+    read_priv: '.*'
+    write_priv: '.*'
+    tags: 'administrator'  #define comma separated list of tags to assign to user....management,policymaker,monitoring,administrator...required for management plugin. https://www.rabbitmq.com/management.html
 ````
 
 example...
@@ -38,16 +71,38 @@ rabbitmq_master: ans-test-1
 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: all
+  become: true
+  vars:
+    - pri_domain_name: 'test.vagrant.local'
+  roles:
+  tasks:
+    - name: updating /etc/hosts
+      lineinfile:
+        dest: /etc/hosts
+        regexp: "^{{ hostvars[item].ansible_ssh_host }} {{ item }} {{ item }}.{{ pri_domain_name }}"
+        line: "{{ hostvars[item].ansible_ssh_host }} {{ item }} {{ item }}.{{ pri_domain_name }}"
+        state: present
+      with_items: groups['all']
 
-    - hosts: servers
-      roles:
-         - { role: mrlesmithjr.rabbitmq }
+- hosts: all
+  become: true
+  vars:
+    - config_rabbitmq_ha: true
+    - enable_rabbitmq_clustering: true
+    - pri_domain_name: 'test.vagrant.local'
+    - rabbitmq_master: 'node0'
+  roles:
+    - role: ansible-rabbitmq
+  tasks:
+````
 
 License
 -------