Role Name

This section gives a short overview of what the role is about.

Requirements

List here any pre-requisites that are not covered by Ansible or the role itself. For example, if the role uses the EC2 module, mention that you need the boto package.

Role Variables

Describe the variables that can be set for this role. This includes variables from defaults/main.yml, vars/main.yml, and any that can be set through role parameters. Also mention any variables sourced from other roles or global settings (like hostvars and group vars).

Dependencies

List any other roles available on Galaxy that this role depends on. Include details about any parameters or variables that need to be set for those roles.

Example Playbook

It's helpful to provide 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 section is optional, where authors can provide contact details or a website (HTML is not allowed).