Role Name

This is a short description of what the role does.

Requirements

Mention any necessary tools or setups that are not included with Ansible or this role. For example, if the role requires the EC2 module, you should note that the boto package is needed.

Role Variables

Explain the variables that you can set for this role. This includes variables found in defaults/main.yml, vars/main.yml, and any that can be set when you run the role. Also mention any variables that come from other roles or global settings (like hostvars or group vars).

Dependencies

List other roles available on Galaxy that this role depends on. Include any necessary parameters or variables related to those roles.

Example Playbook

It helps users to see an example of how to use your role. For example, with variables included:

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

License

BSD

Author Information

This section is optional. Authors can include contact details or a website here (HTML is not allowed).