Role Name

This is a brief description of what the role does.

Requirements

List any necessary pre-requisites that aren't covered by Ansible or the role itself. For example, if the role uses the EC2 module, mention that the boto package is needed.

Role Variables

Describe the variables you can set for this role. Include those in defaults/main.yml, vars/main.yml, and any variables that should be set through role parameters. Also, mention any variables that come from other roles or from the global scope (like hostvars, group vars, etc.).

Dependencies

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

Example Playbook

It's helpful to provide an example of how to use your role, such as how to pass variables as parameters:

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

License

BSD

Author Information

This optional section can include contact details or a website for the role's authors (HTML is not allowed).