Role Name

This is a short description of what the role does.

Requirements

List any requirements that are not included with Ansible or the role itself. For example, if the role uses the EC2 module, note that the boto package is needed.

Role Variables

Describe the variables that can be set for this role. This includes variables found in defaults/main.yml, vars/main.yml, and any that can be set through role parameters. Also mention any variables that come from other roles or from the global context (like hostvars or group vars).

Dependencies

List other roles available on Galaxy that this role depends on. Include notes on any parameters that need to be configured for those roles or variables that are used from them.

Example Playbook

It's helpful to show an example of how to use your role, including how to pass in variables:

- hosts: servers
  roles:
     - { role: username.rolename, x: 42 }

License

BSD

Author Information

Optionally include contact details for the role authors or a website (HTML is not allowed).