Fix README
This commit is contained in:
parent
5dd2a1eb5a
commit
b4f95e4ea8
2
.gitmodules
vendored
2
.gitmodules
vendored
@ -1,3 +1,3 @@
|
||||
[submodule "roles"]
|
||||
path = roles
|
||||
url = ssh://git@git.wojciechkozlowski.eu:2770/the-nine-worlds/ansible-roles.git
|
||||
url = ../ansible-roles.git
|
||||
|
14
README.md
14
README.md
@ -43,7 +43,7 @@ ansible-playbook -i inventory/testing main.yml
|
||||
|
||||
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
|
||||
[`playbooks/system`](playbooks/system) playbook, run:
|
||||
[`playbooks/system.yml`](playbooks/system.yml) playbook, run:
|
||||
|
||||
``` sh
|
||||
ansible-playbook playbooks/system.yml
|
||||
@ -57,7 +57,7 @@ ansible-playbook main.yml --tags "system"
|
||||
|
||||
### Roles
|
||||
|
||||
Playbooks are composed of roles defined in the [`roles`](roles) submodule and
|
||||
Playbooks are composed of roles defined in the [`roles`](../ansible-roles) submodule and
|
||||
[`playbooks/roles`](playbooks/roles).
|
||||
|
||||
To play a specific role, e.g., `system/base/sshd` in the playbook `system`, run:
|
||||
@ -82,14 +82,14 @@ ansible-playbook main.yml --tags "system:base"
|
||||
## Testing virtual machines
|
||||
|
||||
The scripts for starting, stopping, and reverting the testing virtual machines is located in
|
||||
`scripts/testing/vmgr.py`.
|
||||
[`scripts/testing/vmgr.py`](scripts/testing/vmgr.py).
|
||||
|
||||
## Managing backup buckets
|
||||
|
||||
The `scripts/restic/restic.py` script provides a wrapper around restic to manage the backup buckets.
|
||||
The script collects the credentials from the OS keyring and constructs the restic command with the
|
||||
correct endpoint. It allows the user to focus on the actual command to be executed rather than
|
||||
authentication and bucket URLs.
|
||||
The [`scripts/restic/restic.py`](scripts/restic/restic.py) script provides a wrapper around restic
|
||||
to manage the backup buckets. The script collects the credentials from the OS keyring and constructs
|
||||
the restic command with the correct endpoint. It allows the user to focus on the actual command to
|
||||
be executed rather than authentication and bucket URLs.
|
||||
|
||||
The `scripts/restic/restic.py` requires the following entries in the keyring:
|
||||
- `scaleway`: `access_key` (Scaleway project ID),
|
||||
|
Loading…
Reference in New Issue
Block a user