Update readme to document inventory and tag usage
This commit is contained in:
parent
9843677655
commit
80d622a6a4
40
README.md
40
README.md
@ -8,3 +8,43 @@ Ansible playbooks for provisioning The Nine Worlds.
|
||||
- Decrypt with: ```ansible-vault decrypt secrets.yml```
|
||||
- Print secrets to STDOUT: ```ansible-vault decrypt --output - secrets.yml```
|
||||
- Run a playbook with ```ansible-playbook --vault-id @prompt playbook.yml```
|
||||
|
||||
## Main
|
||||
|
||||
The main entrypoint for The Nine Worlds is [`main.yml`](main.yml).
|
||||
|
||||
### Production and testing
|
||||
|
||||
The inventory files are split into [`production`](production) and [`testing`](testing).
|
||||
|
||||
To run the `main.yml` play on production hosts:
|
||||
``` sh
|
||||
ansible-playbook main.yml -i production
|
||||
```
|
||||
|
||||
To run the `main.yml` play on production hosts:
|
||||
``` sh
|
||||
ansible-playbook main.yml -i testing
|
||||
```
|
||||
|
||||
### Roles
|
||||
|
||||
The plays are composed of roles defined in [`plays/roles`](plays/roles).
|
||||
|
||||
To play only a specific role, e.g. `system_base`, run:
|
||||
|
||||
``` sh
|
||||
ansible-playbook --tags "role:system_base"
|
||||
```
|
||||
|
||||
### Role sub-tasks
|
||||
|
||||
Some roles are split into smaller groups of tasks. This can be checked by looking at the
|
||||
`tasks/main.yml` file of a role, e.g.
|
||||
[`plays/roles/system_base/tasks/main.yml`](plays/roles/system_base/tasks/main.yml).
|
||||
|
||||
To play only a particular group within a role, e.g. `sshd` in `system_base`, run:
|
||||
|
||||
``` sh
|
||||
ansible-playbook --tags "role:system_base:sshd"
|
||||
```
|
||||
|
Loading…
Reference in New Issue
Block a user