Role Name

This is a short description of the role.

Requirements

List any required tools or packages that are not included in 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 configurable variables for this role. Include variables from defaults/main.yml, vars/main.yml, and those that can be set when calling the role. Also, mention any variables that are accessed from other roles or global settings (like hostvars, group vars, etc.).

Dependencies

Provide a list of other roles from Galaxy that this role depends on along with any required parameters or variables from those roles.

Example Playbook

It’s helpful to include an example of how to use your role. Here’s a basic format:

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

License

BSD

Author Information

Optionally, include contact details or a website for the author(s). (HTML is not allowed.)