Role Name

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

Requirements

List any prerequisites that are needed but not included by Ansible or the role itself. For example, if the role requires the EC2 module, mention here that you need to install the boto package.

Role Variables

Describe the variables you can set for this role. Include those found in defaults/main.yml, vars/main.yml, and any variables that can be passed as parameters. Also, mention any variables that come from other roles or the overall environment (like hostvars, group vars, etc.).

Dependencies

Provide a list of other roles available on Galaxy and any specific parameters or variables that need to be set for those roles.

Example Playbook

It's helpful to show an example of how to use your role, including how to pass in variables:

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

License

BSD

Author Information

This optional section allows the authors to share contact details or a website (HTML is not allowed).