Role Name

This section provides a short description of the role.

Requirements

List any necessary prerequisites that are not covered by Ansible or the role. 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, including those in defaults/main.yml, vars/main.yml, and any variables that can be set through role parameters. Also, include any variables that are used from other roles or from the global scope (e.g., hostvars, group vars).

Dependencies

Provide a list of other roles available on Galaxy, along with any necessary details about parameters that need to be set for these roles or variables that they use.

Example Playbook

It's helpful to include an example of how to use your role, such as how to pass in variables as parameters:

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

License

BSD

Author Information

This optional section allows role authors to include their contact information or a website (HTML is not permitted).