commit 1b3f2c4e101850e97ed0d72fa2982bbf9e501c63
parent 3e9cef01e61115643087fa140e424978caad3d1d
Author: Devan Carpenter <devan@taler.net>
Date: Mon, 18 Nov 2024 16:15:32 +0000
update README to include some info on roles
Diffstat:
| M | README | | | 31 | ++++++++++++++++++++++++++----- |
1 file changed, 26 insertions(+), 5 deletions(-)
diff --git a/README b/README
@@ -1,8 +1,9 @@
-Running the Playbook
-====================
+# Ansible Taler Playbooks
+
+## Running the Playbook
To run the main playbook (playbooks/setup.yml):
----------------------------------------------------
+
```
$ ansible-playbook --verbose -i <host>, --user root playbooks/setup.yml
```
@@ -10,11 +11,31 @@ $ ansible-playbook --verbose -i <host>, --user root playbooks/setup.yml
Instead of specifying the host(s) as arguments (note the trailing comma!)
you can pass an inventory file. See `inventories/`, and update accordingly.
-Testing Locally
-===============
+## Testing Locally
With podman and ansible installed locally one can run `./test.sh`.
This will begin building the Containerfile in this repo, which is a Debian
base with systemd and a paswordless ssh server configured. Then container
will start, binding port 8022 to 127.0.0.1 on the host. Finally
the setup playbook will be run on the container via ssh.
+
+## Roles
+
+### ansible-pull
+
+This role setups an ansible-pull script on the host, as well as cronjob
+which runs the ansible-pull script on regular interval.
+
+NOTE: requires local.yml to exist in root of this repo.
+
+### common_packages
+
+Installs the base system packages we need on all hosts.
+
+### taler-packages
+
+Sets up Taler package repo and installs Taler packages.
+
+### configuration
+
+Configures Taler services. Installs configuration files, etc.
