From 92d8d3672d44357807e92c3fb4b05e1e74c25ce7 Mon Sep 17 00:00:00 2001
From: Marc Cataford <mcat@riseup.net>
Date: Fri, 15 Dec 2023 12:40:14 -0500
Subject: [PATCH] feat(services): bookstack (#33)

* feat(bookstack): working example bookstack instance

* build(taskfiles): add Taskfile to handle start+stop

* fix: ensure that network exists without erroring

* chore(git): ignore Task bin

* docs: notes on volumes, task commands

* build(taskfiles): add build command, centralized user-supplied env

* refactor(taskfiles): split away internal tasks

* refactor(taskfiles): move environment variables into shared env.yml
---
 .gitignore                                  |  2 +
 README.md                                   | 23 +++++++++++
 Taskfile.internal.yml                       | 18 +++++++++
 Taskfile.yml                                | 41 ++++++++++++++++++++
 script/bootstrap-tasks                      | 18 +++++++++
 services/bookstack/Dockerfile-bookstack-app |  1 +
 services/bookstack/Dockerfile-bookstack-db  |  1 +
 services/bookstack/README.md                | 43 +++++++++++++++++++++
 services/bookstack/build.sh                 |  6 +++
 services/bookstack/constants.sh             |  8 ++++
 services/bookstack/start.sh                 | 22 +++++++++++
 services/bookstack/stop.sh                  |  6 +++
 12 files changed, 189 insertions(+)
 create mode 100644 Taskfile.internal.yml
 create mode 100644 Taskfile.yml
 create mode 100644 script/bootstrap-tasks
 create mode 100644 services/bookstack/Dockerfile-bookstack-app
 create mode 100644 services/bookstack/Dockerfile-bookstack-db
 create mode 100644 services/bookstack/README.md
 create mode 100644 services/bookstack/build.sh
 create mode 100644 services/bookstack/constants.sh
 create mode 100644 services/bookstack/start.sh
 create mode 100644 services/bookstack/stop.sh

diff --git a/.gitignore b/.gitignore
index 7388990..4c83c1d 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,5 +1,7 @@
 spadinaistan.venv
 
+env.yml
+bin
 services.yml
 **/*.env
 **/.env
diff --git a/README.md b/README.md
index f0eca3f..3a7b6ef 100644
--- a/README.md
+++ b/README.md
@@ -10,3 +10,26 @@ anyone else.
 Use `. script/bootstrap` to set up the Python environment needed for the invoke and pyinfra tooling to work.
 
 This expects `pyenv` to be set up on your system.
+
+## Configuration
+
+### Environment provided to tasks
+
+The task runner requires a `env.yml` file to exist at the top level. This should define a few global variables that are
+specific to the environment:
+
+```
+version: '3'
+
+env:
+    # Path to the application data storage root.
+    APP_DATA_DIR: ...
+    # Prefix to all container names.
+    CONTAINER_NAME_PREFIX: ...
+    # Path to the app-specific dotenv files.
+    ENV_FILE_DIR: ...
+    # Name of the network associated with the tunnel exposing services.
+    SHARED_NETWORK_NAME: ...
+```
+
+The `env.yml` file is ignored by version-control.
diff --git a/Taskfile.internal.yml b/Taskfile.internal.yml
new file mode 100644
index 0000000..a063027
--- /dev/null
+++ b/Taskfile.internal.yml
@@ -0,0 +1,18 @@
+version: '3'
+
+output: prefixed
+internal: true
+
+tasks:
+  build-images:
+    prefix: "build image: {{ .SERVICE }}"
+    dir: services/{{ .SERVICE }}
+    cmd: . ./build.sh
+  start-service:
+    prefix: "start: {{ .SERVICE }}"
+    dir: services/{{ .SERVICE }}
+    cmd: . ./start.sh
+  stop-service:
+    prefix: "stop: {{ .SERVICE }}"
+    dir: services/{{ .SERVICE }}
+    cmd: . ./stop.sh
diff --git a/Taskfile.yml b/Taskfile.yml
new file mode 100644
index 0000000..05895f0
--- /dev/null
+++ b/Taskfile.yml
@@ -0,0 +1,41 @@
+version: '3'
+
+includes:
+  # This file should be supplied by the environment and is not committed.
+  global-env:
+    taskfile: ./env.yml
+    internal: true
+  internal:
+    taskfile: ./Taskfile.internal.yml
+    internal: true
+
+output: prefixed
+
+tasks:
+  build:
+    desc: "Builds images for one or more services. Include service names as a space-separated list."
+    cmds:
+      - for: { var: CLI_ARGS }
+        task: internal:build-images
+        vars:
+          SERVICE: "{{ .ITEM }}"
+    prefix: "build: {{ .CLI_ARGS }}"
+    dir: services
+  start:
+    desc: "Starts one or more services. Include service names as a space-separated list."
+    cmds:
+      - for: { var: CLI_ARGS }
+        task: internal:start-service
+        vars:
+          SERVICE: "{{ .ITEM }}"
+    prefix: "start: {{ .CLI_ARGS }}"
+    dir: services
+  stop:
+    desc: "Stops one or more services. Include service names as a space-separated list."
+    cmds:
+      - for: { var: CLI_ARGS }
+        task: internal:stop-service
+        vars:
+          SERVICE: "{{ .ITEM }}"
+    prefix: "stop: {{ .CLI_ARGS }}"
+    dir: services
diff --git a/script/bootstrap-tasks b/script/bootstrap-tasks
new file mode 100644
index 0000000..a3b3a8c
--- /dev/null
+++ b/script/bootstrap-tasks
@@ -0,0 +1,18 @@
+#!/bin/bash
+
+TASK_VERSION="v3.28.0"
+BIN_PATH=$PWD/bin
+
+if [[ ! -f $BIN_PATH/task || -z "$($BIN_PATH/task --version | grep $TASK_VERSION)" ]]; then
+    sh -c "$(curl --location https://taskfile.dev/install.sh)" -- $TASK_VERSION -d
+fi
+
+BIN_PATH=$PWD/bin
+BIN_MATCH=$(echo $PATH | grep "\:$BIN_PATH")
+
+if [[ -z $BIN_MATCH ]]; then
+    echo "Adding Task to \$PATH."
+    export PATH=$PATH:$BIN_PATH
+fi
+
+echo "All done!"
diff --git a/services/bookstack/Dockerfile-bookstack-app b/services/bookstack/Dockerfile-bookstack-app
new file mode 100644
index 0000000..f73e6f5
--- /dev/null
+++ b/services/bookstack/Dockerfile-bookstack-app
@@ -0,0 +1 @@
+FROM linuxserver/bookstack:23.10.4
diff --git a/services/bookstack/Dockerfile-bookstack-db b/services/bookstack/Dockerfile-bookstack-db
new file mode 100644
index 0000000..b4abaa0
--- /dev/null
+++ b/services/bookstack/Dockerfile-bookstack-db
@@ -0,0 +1 @@
+FROM mariadb:10.6
diff --git a/services/bookstack/README.md b/services/bookstack/README.md
new file mode 100644
index 0000000..2448c5a
--- /dev/null
+++ b/services/bookstack/README.md
@@ -0,0 +1,43 @@
+# Bookstack
+
+Sets up and manages a [Bookstack](https://www.bookstackapp.com/) instance.
+
+## Getting started
+
+- `start.sh` starts the database and application.
+- `stop.sh` stops the database and application.
+- `build.sh` builds images for the database and application and should be run _before_ starting anything.
+
+Any commitable constant can be defined in `constants.sh` and will be injected in all of the scripts above.
+
+__The `task` commands should be used to interact with the service.__
+
+## Volumes
+
+This expects two volumes to exist at `$APP_DATA_DIR`: `bookstack-app` and `bookstack-db`.
+
+## Note on dotenv files
+
+dotenv files are expected to exist at `$ENV_FILE_DIR` under `bookstack-db.env` and `bookstack-app.env`.
+
+See reference:
+
+```
+# bookstack-db-env
+
+MARIADB_USER=...
+MARIADB_PASSWORD=...
+MARIADB_ROOT_PASSWORD=...
+MARIADB_DATABASE=...
+```
+
+```
+# bookstack-app.env
+
+DB_PORT=...
+DB_USER=...
+DB_PASS=...
+DB_DATABASE=...
+DB_HOST=...
+APP_URL=...
+```
diff --git a/services/bookstack/build.sh b/services/bookstack/build.sh
new file mode 100644
index 0000000..d56d161
--- /dev/null
+++ b/services/bookstack/build.sh
@@ -0,0 +1,6 @@
+#!/bin/bash
+
+source constants.sh
+
+docker build -t $DB_IMAGE_NAME:dev -f Dockerfile-bookstack-db .
+docker build -t $APP_IMAGE_NAME:dev -f Dockerfile-bookstack-app .
diff --git a/services/bookstack/constants.sh b/services/bookstack/constants.sh
new file mode 100644
index 0000000..8c68636
--- /dev/null
+++ b/services/bookstack/constants.sh
@@ -0,0 +1,8 @@
+#!/bin/bash
+
+export APP_NAME="bookstack"
+export APP_CONTAINER_NAME=$APP_NAME-app
+export APP_IMAGE_NAME=$CONTAINER_NAME_PREFIX-$APP_CONTAINER_NAME
+export DB_CONTAINER_NAME=$APP_NAME-db
+export DB_IMAGE_NAME=$CONTAINER_NAME_PREFIX-$DB_CONTAINER_NAME
+export NETWORK_NAME=$APP_NAME-local
diff --git a/services/bookstack/start.sh b/services/bookstack/start.sh
new file mode 100644
index 0000000..e8bda88
--- /dev/null
+++ b/services/bookstack/start.sh
@@ -0,0 +1,22 @@
+#!/bin/bash
+
+source constants.sh
+
+docker network create $NETWORK_NAME || echo "Network $NETWORK_NAME already exists"
+
+docker run \
+    --detach \
+    --network $NETWORK_NAME \
+    --name $DB_CONTAINER_NAME \
+    --env-file $ENV_FILE_DIR/bookstack-db.env \
+    --mount type=bind,source=$APP_DATA_DIR/bookstack-db,target=/var/lib/mysql \
+    $DB_IMAGE_NAME:dev
+
+docker run \
+    --detach \
+    --network $NETWORK_NAME \
+    --name $APP_CONTAINER_NAME \
+    --env-file $ENV_FILE_DIR/bookstack-app.env \
+    --publish 6875:80 \
+    --mount type=bind,source=$APP_DATA_DIR/bookstack-app,target=/config \
+    $APP_IMAGE_NAME:dev
diff --git a/services/bookstack/stop.sh b/services/bookstack/stop.sh
new file mode 100644
index 0000000..62c5c50
--- /dev/null
+++ b/services/bookstack/stop.sh
@@ -0,0 +1,6 @@
+#!/bin/bash
+
+source constants.sh
+
+docker rm -f $APP_CONTAINER_NAME
+docker rm -f $DB_CONTAINER_NAME