Role Name

Here, you can describe what the role does briefly.

Requirements

List any prerequisites that are not 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. Include details about variables in defaults/main.yml, vars/main.yml, and any that can be set when using 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 that this role depends on. Include any specific parameters that need to be set for those roles or any variables that are used from them.

Example Playbook

It's helpful to include an example of how to use your role. For instance, show how to pass variables as parameters:

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

License

BSD

Author Information

Use this optional section to provide contact information or a website for the role authors (HTML is not allowed).