A brief description of the role goes here.
Any pre-requisites that may not be covered by Ansible itself or the role should be mentioned here. For instance, if the role uses the EC2 module or depends on other Ansible roles, it may be a good idea to mention in this section that the boto package is required.
A description of the settable variables for this role should go here, including any variables that are in defaults/main.yml, vars/main.yml, and any variables that can/should be set via parameters to the role. Any variables that are read from other roles and/or the global scope (ie. hostvars, group vars, etc.) should be mentioned here as well.
Don't forget to indent the markdown table so it is readable even if not rendered.
| Name | Required/Default | Description |
|---|---|---|
example1 |
✔️ | Lorem ipsum dolor sit amet, consetetur sadipscing elitr, |
example2 |
✖️ | Sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. |
example3 |
True |
Stet clita kasd gubergren |
example4 |
5 |
No sea takimata sanctus est Lorem ipsum dolor sit amet. |
Including an example of how to use your role (for instance, with variables passed in as parameters) is always nice for users too:
This work is licensed under the MIT License.
- [Author Name (nickname)](github profile) givenname.familyname at stuvus.uni-stuttgart.de