Role Name

Here is a short description of the role.

Requirements

List any necessary requirements 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

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

Dependencies

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

Example Playbook

It’s helpful to include an example of how to use your role, especially with parameters:

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

License

BSD

Author Information

This section is optional for authors to provide contact details or a website (HTML is not allowed).