Role Name

Here is a short description of what this role does.

Requirements

List any necessary prerequisites that the role or Ansible itself does not cover. For example, if the role uses the EC2 module, mention that the boto package is required.

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 come from other roles or the global context (like hostvars or group vars).

Dependencies

Provide a list of other roles available on Galaxy and any specific parameters or variables that need to be set for those roles.

Example Playbook

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

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

License

BSD

Author Information

Optionally, authors can provide contact details or a website (HTML is not allowed).