Role Name

Here you can write a short description of what the role does.

Requirements

List any necessary prerequisites that aren't included with Ansible or the role itself. For example, if the role needs the EC2 module, mention that the boto package is required.

Role Variables

Describe the variables that can be set for this role. This includes variables in defaults/main.yml, vars/main.yml, and any variables that can be provided as parameters. Also note any variables that come from other roles or the global scope (like hostvars, group vars, etc.).

Dependencies

Provide a list of other roles from Galaxy that this role depends on. Include any necessary details about parameters that may need to be set for these other roles or variables used from them.

Example Playbook

It's helpful to include an example of how to use the role, especially with variables passed as parameters:

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

License

BSD

Author Information

Optionally, include contact information or a website for the authors of the role (HTML is not allowed).