You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Jonathan Golder 31c4e7db67 Rename template to make its use more clear 8 years ago
defaults Improve docs and set licence headers 8 years ago
handlers Initial structure 8 years ago
meta Initial structure 8 years ago
tasks Rename template to make its use more clear 8 years ago
templates Rename template to make its use more clear 8 years ago
tests Initial structure 8 years ago
vars Improve docs and set licence headers 8 years ago
.travis.yml Initial structure 8 years ago
GPLv3.txt Improve docs and set licence headers 8 years ago
README.md Improve docs and set licence headers 8 years ago

README.md

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

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

GPLv3

Author Information

An optional section for the role authors to include contact information, or a website (HTML is not allowed).