ansible-examples
ansible-examples copied to clipboard
Input parameters for the example playbooks are undocumented
I looked at some example playbooks and they all seem to be using variables deep inside some role, but there is no documentation about that.
Are there any best practices on how to document:
- the input and output parameters of roles?
- the input parameters of playbooks?
Try one of these:
- https://redhat-cop.github.io/automation-good-practices/#_roles_good_practices_for_ansible
- https://docs.ansible.com/ansible/latest/tips_tricks/index.html
- https://ansible.readthedocs.io/projects/lint/rules/