Role Name

This is a short description of what the role does.

Requirements

List any necessary prerequisites that are not included with 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 you can set for this role. Include those found in defaults/main.yml, vars/main.yml, and any that can be set as parameters. Also, mention any variables pulled from other roles or global settings (like hostvars, group vars, etc.).

Dependencies

Provide a list of other roles on Galaxy that this role depends on, along with any 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 any variables set as parameters:

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

License

BSD

Author Information

An optional section for the authors to include their contact details or a website (HTML is not allowed).