Role Name

This is a short summary of what the role does.

Requirements

Here, mention anything needed before using this role that isn't covered by Ansible. For example, if this role uses the EC2 module, you should say that the boto package is needed.

Role Variables

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

Dependencies

List any other roles from Galaxy that this role depends on, and include any necessary parameters or variables needed from these other roles.

Example Playbook

It’s helpful to provide an example of how to use this role, especially with variables passed in, like this:

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

License

BSD

Author Information

This is an optional part where authors can share their contact info or a website (HTML is not allowed).