Role Name

This is a short description of what the role does.

Requirements

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

Role Variables

Describe the variables that can be set for this role. This includes variables in defaults/main.yml, vars/main.yml, and any that can or should be set as parameters for the role. Also, mention any variables that are pulled from other roles or the global context (like hostvars, group vars, etc.).

Dependencies

Provide a list of other roles available on Galaxy, along with any important information about parameters that need to be set for those roles, or variables that are utilized from them.

Example Playbook

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

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

License

BSD

Author Information

This is an optional section where role authors can share their contact details or website (HTML is not allowed).