From 1fcba987c381c41654c8e7bf25fca4fb19887950 Mon Sep 17 00:00:00 2001
From: Sam Rose <hello@samwho.dev>
Date: Tue, 28 Nov 2023 10:19:16 +0000
Subject: [PATCH] Add healthchecking to CouchDB image, remove directory
 settings in Kube.

---
 hosting/couchdb/Dockerfile     |  4 ++++
 hosting/couchdb/healthcheck.sh | 13 +++++++++++++
 hosting/couchdb/runner.sh      | 23 ++++++++++++++++++++++-
 hosting/single/Dockerfile      |  2 +-
 4 files changed, 40 insertions(+), 2 deletions(-)
 create mode 100644 hosting/couchdb/healthcheck.sh

diff --git a/hosting/couchdb/Dockerfile b/hosting/couchdb/Dockerfile
index f83df7038b..254a676f63 100644
--- a/hosting/couchdb/Dockerfile
+++ b/hosting/couchdb/Dockerfile
@@ -29,6 +29,10 @@ WORKDIR /opt/couchdb
 ADD couch/vm.args couch/local.ini ./etc/
 
 WORKDIR /
+ADD healthcheck.sh ./healthcheck.sh
+RUN chmod +x ./healthcheck.sh
+HEALTHCHECK --interval=15s --timeout=15s --start-period=45s CMD "/healthcheck.sh"
+
 ADD runner.sh ./bbcouch-runner.sh
 RUN chmod +x ./bbcouch-runner.sh /opt/clouseau/bin/clouseau
 CMD ["./bbcouch-runner.sh"]
diff --git a/hosting/couchdb/healthcheck.sh b/hosting/couchdb/healthcheck.sh
new file mode 100644
index 0000000000..758ee5111a
--- /dev/null
+++ b/hosting/couchdb/healthcheck.sh
@@ -0,0 +1,13 @@
+#!/usr/bin/env bash
+healthy=true
+
+if [[ $(curl -s -w "%{http_code}\n" http://localhost:5984/_up -o /dev/null) -ne 200 ]]; then
+    echo 'ERROR: CouchDB is not running';
+    healthy=false
+fi
+
+if [ $healthy == true ]; then
+  exit 0
+else
+  exit 1
+fi
diff --git a/hosting/couchdb/runner.sh b/hosting/couchdb/runner.sh
index 2e4d26122f..b576c886c2 100644
--- a/hosting/couchdb/runner.sh
+++ b/hosting/couchdb/runner.sh
@@ -26,27 +26,48 @@ if [[ "${TARGETBUILD}" = "aas" ]]; then
     sed -i "s#DATA_DIR#/home#g" /opt/clouseau/clouseau.ini
     sed -i "s#DATA_DIR#/home#g" /opt/couchdb/etc/local.ini
 elif [[ "${TARGETBUILD}" = "single" ]]; then
+    # In the single image build, the Dockerfile specifies /data as a volume
+    # mount, so we use that for all persistent data.
     sed -i "s#DATA_DIR#/data#g" /opt/clouseau/clouseau.ini
     sed -i "s#DATA_DIR#/data#g" /opt/couchdb/etc/local.ini
 elif [[ -n $KUBERNETES_SERVICE_HOST ]]; then
     # In Kubernetes the directory /opt/couchdb/data has a persistent volume
     # mount for storing database data.
     sed -i "s#DATA_DIR#/opt/couchdb/data#g" /opt/clouseau/clouseau.ini
-    sed -i "s#DATA_DIR#/opt/couchdb/data#g" /opt/couchdb/etc/local.ini
+
+    # We remove the database_dir and view_index_dir settings from the local.ini
+    # in Kubernetes because it will default to /opt/couchdb/data which is what
+    # our Helm chart was using prior to us switching to using our own CouchDB
+    # image.
+    sed -i "s#^database_dir.*\$##g" /opt/couchdb/etc/local.ini
+    sed -i "s#^view_index_dir.*\$##g" /opt/couchdb/etc/local.ini
+
+    # We remove the -name setting from the vm.args file in Kubernetes because
+    # it will default to the pod FQDN, which is what's required for clustering
+    # to work.
     sed -i "s/^-name .*$//g" /opt/couchdb/etc/vm.args
 else
+    # For all other builds, we use /data for persistent data.
     sed -i "s#DATA_DIR#/data#g" /opt/clouseau/clouseau.ini
     sed -i "s#DATA_DIR#/data#g" /opt/couchdb/etc/local.ini
 fi
 
+# Start Clouseau. Budibase won't function correctly without Clouseau running, it
+# powers the search API endpoints which are used to do all sorts, including
+# populating app grids.
 /opt/clouseau/bin/clouseau > /dev/stdout 2>&1 &
+
+# Start CouchDB.
 /docker-entrypoint.sh /opt/couchdb/bin/couchdb &
 
+# Wati for CouchDB to start up.
 while [[ $(curl -s -w "%{http_code}\n" http://localhost:5984/_up -o /dev/null) -ne 200 ]]; do
     echo 'Waiting for CouchDB to start...';
     sleep 5;
 done
 
+# CouchDB needs the `_users` and `_replicator` databases to exist before it will
+# function correctly, so we create them here.
 curl -X PUT http://${COUCHDB_USER}:${COUCHDB_PASSWORD}@localhost:5984/_users
 curl -X PUT http://${COUCHDB_USER}:${COUCHDB_PASSWORD}@localhost:5984/_replicator
 sleep infinity
\ No newline at end of file
diff --git a/hosting/single/Dockerfile b/hosting/single/Dockerfile
index e9ff6c6596..a1b93d7f1a 100644
--- a/hosting/single/Dockerfile
+++ b/hosting/single/Dockerfile
@@ -39,7 +39,7 @@ COPY packages/worker/pm2.config.js packages/worker/pm2.config.js
 COPY packages/string-templates packages/string-templates
 
 
-FROM budibase/couchdb as runner
+FROM samwho/test as runner
 ARG TARGETARCH
 ENV TARGETARCH $TARGETARCH
 ENV NODE_MAJOR 18