Role Name

A short description of what the role does.

Requirements

List any necessary pre-requisites that Ansible or the role does not cover. 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, including those in defaults/main.yml, vars/main.yml, and any that can be set as parameters. Also mention any variables that come from other roles or the overall environment (like hostvars or group vars).

Dependencies

Provide a list of other roles available on Galaxy that this role depends on, along with any parameters or variables that need to be configured for those roles.

Example Playbook

An example of how to use your role, including passing variables as parameters, is helpful for users:

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

License

BSD

Author Information

An optional section for the authors to share their contact details or a website (HTML format not allowed).