update readme for ansible

This commit is contained in:
nazunalika 2020-12-11 03:47:36 -07:00
parent 3ab07302dd
commit b0c2eb1abb

View File

@ -1,12 +1,12 @@
# Ansible
Ansible playbooks, roles, modules, etc will come here. Documentation to come soon.
Ansible playbooks, roles, modules, etc will come here. This wiki will reflect the layout, structure, and potential standards that should be followed when making playbooks and roles.
Each playbook should have comments or a name descripter that explains what the playbook does or how it is used. If not available, README-... files can be used in place.
Each playbook should have comments or a name descriptor that explains what the playbook does or how it is used. If not available, README-... files can be used in place, especially in the case of adhoc playbooks that take input. Documentation for each playbook/role does not have to be on this wiki. Comments or README's should be sufficient.
## Management Node Structure
Loosely copied from the CentOS ansible infrastructure. This structure is represented in this repository.
Loosely copied from the CentOS ansible infrastructure.
```
.
@ -93,6 +93,10 @@ At a minimum, there should be `pre_tasks` and `post_tasks` that can judge whethe
state: touch
```
### Comments
Each playbook should have comments or a name descriptor that explains what the playbook does or how it is used. If not available, README-... files can be used in place, especially in the case of adhoc playbooks that take input. Documentation for each playbook/role does not have to be on this wiki. Comments or README's should be sufficient.
### Roles
If you are using roles that are not part of this repository in the `roles` directory, you will need to list them in the `requirements.yml`. For example, we use the IPA role.