The following is a README template that can be used to create documentation around any Ansible automation.
Note
Runs on RHEL9 Only
Tip
Refresh between pulls
Important
Ensure no security data is hardcoded
Warning
Don't push to master without approval
Caution
May crash if variables aren't correct
This code is used for doing very complicated things, such as solving a Rubik's cube. It is important to have the following background information about why the code is needed for the project. Project 2 is scheduled to play Tetris on Mondays, if the Rubik's cube isn't completed, the Tetris will fail.
| Info | About |
|---|---|
| Version | v1.1 |
| GitHub | [criticalserver/topsecret/supersecret] |
| Documentation | [documentation/supersecret.pdf] |
| Environment | Dev |
| Code Owner | John Smith - john.smith@example.com |
- Boilerplate file to help give structure
- Ran in the test environment
- Whatever quick easy to read info you think would help to understand what it does/how it works etc
Anything info about vars entered here
| Setting | Parameters | Additional Info |
|---|---|---|
| File List | sequential-files | List of Files to Remove |
Under condition A the expected output is B. If input B = 1 output B defaults to 2
# roles/example/tasks/main.yml
- name: Install the correct web server for RHEL
import_tasks: redhat.yml
when: ansible_facts['os_family']|lower == 'redhat'
- name: Install the correct web server for Debian
import_tasks: debian.yml
when: ansible_facts['os_family']|lower == 'debian'
# roles/example/tasks/redhat.yml
- name: Install web server
ansible.builtin.yum:
name: "httpd"
state: present
# roles/example/tasks/debian.yml
- name: Install web server
ansible.builtin.apt:
name: "apache2"
state: presentTo get support
- Contact Team A
- Contact Product Owner
Process Flow for Further Support
flowchart LR
A[Go to Service Now] --> B[Raise Ticket Under 'Project A']
B --> C{Issue Resolved?}
C -->|Yes| D[Good]
C -->|No| E[Contact PM]
| Name | Role | Team | Orginisation | |
|---|---|---|---|---|
| John Smith | Engineer | Project A Team | Company A | John.Smith@example.com |
| Sherlock Smith | Tester | Project B Team | Red Hat | Sherlock.Smith@example.com |