Role Name

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

Requirements

List any additional tools or packages needed for this role that aren't included with Ansible. For example, if the role requires the EC2 module, mention that the boto package is necessary.

Role Variables

Here, 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 passed as parameters. Also, mention any variables that come from other roles or general settings (like hostvars or group vars).

Dependencies

List any other roles available on Galaxy that this role depends on, along with details on any required parameters or variables from those supporting roles.

Example Playbook

Providing an example of how to use your role, including how to pass in variables, is helpful for users:

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

License

BSD

Author Information

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