Role Name

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

Requirements

List any necessary tools or packages that are not included with Ansible or this role. For example, if the role requires the EC2 module, mention that you need to install the boto package.

Role Variables

Explain the variables that you can set for this role. Include any variables found in defaults/main.yml, vars/main.yml, and any that can be provided as parameters. Also, mention any variables from other roles or global settings (like hostvars, group vars, etc.) that are used.

Dependencies

Provide a list of other roles from Galaxy that this role depends on. Include any necessary details about setting parameters or using variables from those roles.

Example Playbook

It’s helpful to include an example of how to use this role, such as how to pass variables as parameters:

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

License

BSD

Author Information

You can optionally provide contact information or a website for the authors of this role (HTML is not allowed).