Newer
Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
Role Name
=========
A brief description of the role goes here.
Requirements
------------
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.
Role Variables
--------------
::
consul_endpoint: # Endpoint (propably a load-balancer) to join the cluster,
# if not defined then working in a single-node cluster.
consul_cluster_size: 3 # Number of nodes in the cluster, unless an endpoint
# is not defined, then the cluster size is 1.
consul_mode: agent # Consul mode, either server or agent. If an endpoint is
# not defined, defaults to server.
The logic is: if the endpoint is defined then act according to the mode and join
the cluster at the endpoint. If the endpoint is not defined then it's a single
server cluster (probably a dev/ staging environment).
A description of the settable variables for this role should go here, including any variables that are in defaults/main.yml, vars/main.yml, and any variables that can/should be set via parameters to the role. Any variables that are read from other roles and/or the global scope (ie. hostvars, group vars, etc.) should be mentioned here as well.
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.
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: servers
roles:
- { role: username.rolename, x: 42 }
License
-------
MIT
Author Information
------------------
An optional section for the role authors to include contact information, or a website (HTML is not allowed).
To do
-----
- Move config to /etc/default/consul.
- Handle Upstart and SystemD (maybe sysV also).
- webui (https://consul.io/intro/getting-started/ui.html).
- Test variables order of evaluation (maybe setting variables outside of the
role doesn't take effect as expected).
- Set versions as vars (easier upgrade path).
- Metrics.