Role Name

This section gives a short overview of the role.

Requirements

Here, list any requirements that are not part of 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 that can be set for this role. This includes those found in defaults/main.yml, vars/main.yml, and any other variables that can be defined when using the role. Also, note any variables sourced from other roles or global settings (like hostvars or group vars).

Dependencies

List other roles available on Galaxy that this role depends on, along with any necessary parameters or variables needed for those roles.

Example Playbook

Provide an example showing how to use the role, including any variables passed as parameters:

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

License

BSD

Author Information

An optional section for authors to share contact details or a website (HTML is not permitted).