summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorFlorian Dold <florian@dold.me>2023-10-16 20:20:44 +0200
committerFlorian Dold <florian@dold.me>2023-10-16 20:20:44 +0200
commit102d0c5ed9298731e97708416c43e586cf7a7080 (patch)
tree39b03ed6c5c8abc1a26461dd8e72c994846b6e4c
parentca6387acbbb9bc0e2888c9a6802a45fd743bea75 (diff)
downloaddeployment-102d0c5ed9298731e97708416c43e586cf7a7080.tar.gz
deployment-102d0c5ed9298731e97708416c43e586cf7a7080.tar.bz2
deployment-102d0c5ed9298731e97708416c43e586cf7a7080.zip
WIP
-rw-r--r--sandcastle-ng/README.md45
1 files changed, 43 insertions, 2 deletions
diff --git a/sandcastle-ng/README.md b/sandcastle-ng/README.md
index 662b25a..c0f77da 100644
--- a/sandcastle-ng/README.md
+++ b/sandcastle-ng/README.md
@@ -1,10 +1,13 @@
# Introduction
-The sandcastle is a containerized deployment of GNU Taler. It uses podman.
+The sandcastle is a containerized deployment of GNU Taler
+
+It uses podman to build an image and run a single container that
+has systemd running inside.
# Prerequisites
-You need:
+You need (on your host system):
* podman
* bash
@@ -16,8 +19,46 @@ You need:
# Configuring the Deployment
+It is recommended that for each deployment, you clone the deployment.git
+repository and create a branch with deployment-specific changes.
+
+Currently there is not much configuration.
+
+The main adjustments to be made are:
+
+* scripts/setup-sandcastle.sh has the currency on top of the file
+* run-container has variables for the port that'll be exposed ("published") on
+ the host. They can be overwritten with environment variables
+ (``TALER_SANDCASTLE_PORT_$COMPONENT``).
+
# Running the Deployment
+Run ``./run-container`` to run the single container. The container will be
+called taler-sandcastle.
+
# Poking Around
+You can poke around in a running sandcastle instance by running
+
+```
+podman exec -it taler-sandcastle /bin/bash
+```
+
+This will drop you into a shell inside the running container,
+where you have access to systemd, journalctl, etc.
+
+# Data Storage
+
+All persistent data is stored in a podman volume called
+talerdata. You can see where it is in your filesystem
+by running ``podman volume inspect talerdata``.
+
+# Provisioning Details
+
+The whole deployment is configured by the script ``scripts/setup-sandcastle.sh``.
+This script will be run as a oneshot systemd service and will disable itself after
+the first success.
+
+To troubleshoot, run `journalctl -u setup-sandcastle.service`.
+To run the container without any automatic provisioning, run XXX.