Role Name

Here is a short description of what the role does.

Requirements

List any necessary software or configurations that are not covered by Ansible or the role itself. For example, if the role uses the EC2 module, mention that the boto package is needed.

Role Variables

Explain the variables that can be set for this role. Include variables from defaults/main.yml, vars/main.yml, and any that can be set through role parameters. Also, mention any variables that come from other roles or general settings (like hostvars and group vars).

Dependencies

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

Example Playbook

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

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

License

BSD

Author Information

This is an optional section where authors can add contact details or a website (no HTML allowed).