Role Name

This section provides a short description of what the role does.

Requirements

List any necessary tools or packages that are not included with Ansible or the role itself. For example, if the role uses the EC2 module, mention that the boto package is required.

Role Variables

Describe the variables that can be set for this role. Include variables from defaults/main.yml, vars/main.yml, and any that can be set as parameters. Also, mention any variables that come from other roles or global settings like hostvars or group vars.

Dependencies

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

Example Playbook

Provide an example showing how to use the role, including how to pass in 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 authors (HTML not allowed).