Fix README

This commit is contained in:
Wojciech Kozlowski 2023-11-04 22:50:08 +01:00
parent 97ea02c904
commit 5dd2a1eb5a

View File

@ -26,23 +26,24 @@ ansible-playbook --vault-id @vault-keyring-client.py ...
### Production and testing ### Production and testing
The inventory files are split into [`production`](production) and [`testing`](testing). The inventory files are split into [`inventory/production`](inventory/production) and
[`inventory/testing`](inventory/testing).
To run the `main.yml` playbook on production hosts: To run the `main.yml` playbook on production hosts:
``` sh ``` sh
ansible-playbook main.yml -i inventory/production ansible-playbook -i inventory/production main.yml
``` ```
To run the `main.yml` playbook on testing hosts: To run the `main.yml` playbook on testing hosts:
``` sh ``` sh
ansible-playbook main.yml -i inventory/testing ansible-playbook -i inventory/testing main.yml
``` ```
### Playbooks ### Playbooks
The Ansible Edda playbook is composed of smaller [`playbooks`](playbooks). To run a single playbook, The Ansible Edda playbook is composed of smaller [`playbooks`](playbooks). To run a single playbook,
invoke the relevant playbook directly from the playbook directory. For example, to run the invoke the relevant playbook directly from the playbook directory. For example, to run the
[`system`](system) playbook, run: [`playbooks/system`](playbooks/system) playbook, run:
``` sh ``` sh
ansible-playbook playbooks/system.yml ansible-playbook playbooks/system.yml
@ -56,8 +57,8 @@ ansible-playbook main.yml --tags "system"
### Roles ### Roles
Playbooks are composed of roles defined in the `roles` submodule, [`roles`](roles), and the Playbooks are composed of roles defined in the [`roles`](roles) submodule and
`playbooks/roles` directory, [`playbooks/roles`](playbooks/roles). [`playbooks/roles`](playbooks/roles).
To play a specific role, e.g., `system/base/sshd` in the playbook `system`, run: To play a specific role, e.g., `system/base/sshd` in the playbook `system`, run:
``` sh ``` sh
@ -70,7 +71,7 @@ ansible-playbook playbooks/system.yml --tags "system:base"
``` ```
Some roles, e.g., `services/setup/user`, have sub-tasks which can also be invoked individually. To Some roles, e.g., `services/setup/user`, have sub-tasks which can also be invoked individually. To
find the relevant tag, see the role's `main.yml`. find the relevant tag, see the role's `tasks/main.yml`.
In all cases, the roles can be also invoked from the main playbook: In all cases, the roles can be also invoked from the main playbook:
``` sh ``` sh