Role Name

This section gives a short overview of the role.

Requirements

List any necessary prerequisites that are not automatically handled by Ansible or the role itself. For example, if the role utilizes the EC2 module, mention here that the boto package is needed.

Role Variables

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

Dependencies

Provide a list of other roles available on Galaxy that this role depends on. Include any required parameters or variables related to those other roles.

Example Playbook

Show an example of how to use your role, including how to pass in variables as parameters:

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

License

BSD

Author Information

Optionally, this section can include the author's contact info or a website (HTML is not allowed).