aboutsummaryrefslogtreecommitdiffhomepage
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md44
1 files changed, 44 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..bc57b4c
--- /dev/null
+++ b/README.md
@@ -0,0 +1,44 @@
1Role Name
2=========
3
4Installs rabbitmq https://www.rabbitmq.com/
5
6Requirements
7------------
8
9Any 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.
10
11Role Variables
12--------------
13
14````
15enable_rabbitmq_clustering: false #defines if setting up a rabbitmq cluster
16config_rabbitmq_ha: false #defines if rabbitmq ha should be configured
17````
18
19Dependencies
20------------
21
22A 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.
23
24Example Playbook
25----------------
26
27Including an example of how to use your role (for instance, with variables passed in as parameters) is always nice for users too:
28
29 - hosts: servers
30 roles:
31 - { role: mrlesmithjr.rabbitmq }
32
33License
34-------
35
36BSD
37
38Author Information
39------------------
40
41Larry Smith Jr.
42- @mrlesmithjr
43- http://everythingshouldbevirtual.com
44- mrlesmithjr [at] gmail.com