Role Name

Here’s a short description of what the role does.

Requirements

List any necessary items that aren’t 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

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

Dependencies

Provide a list of other roles available on Galaxy that this role depends on. Include any parameters that may need to be set for these other roles, or variables that are shared between them.

Example Playbook

It’s helpful to show users how to use your role, especially with examples of input variables:

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

License

BSD

Author Information

Optionally add contact details or a website for the authors (HTML is not allowed).