feat: Add optional healthcheck scripts to images

wmde · Nov 7, 2024 · 9004bdb · 9004bdb
1 parent a7122ca
commit 9004bdb
Show file tree

Hide file tree

Showing 22 changed files with 234 additions and 139 deletions.
diff --git a/build/elasticsearch/Dockerfile b/build/elasticsearch/Dockerfile
@@ -12,6 +12,7 @@ RUN \
     org.wikimedia.search:extra:${ELASTICSEARCH_PLUGIN_WIKIMEDIA_EXTRA} && \
   ./bin/elasticsearch-plugin install \
     org.wikimedia.search.highlighter:experimental-highlighter-elasticsearch-plugin:${ELASTICSEARCH_PLUGIN_WIKIMEDIA_HIGHLIGHTER}
+COPY healthcheck.sh /healthcheck.sh
 COPY default.jvm.options /default.jvm.options
 RUN cat /default.jvm.options >> /usr/share/elasticsearch/config/jvm.options && \
     rm /default.jvm.options
diff --git a/build/elasticsearch/README.md b/build/elasticsearch/README.md
@@ -46,24 +46,25 @@ services:
       DB_USER: "mariadb-user"
       DB_PASS: "change-this-password"
       ELASTICSEARCH_HOST: elasticsearch
-    healthcheck:
-      test: curl --silent --fail localhost/wiki/Main_Page
-      interval: 10s
-      start_period: 5m
     depends_on:
       mysql:
         condition: service_healthy
     restart: unless-stopped
+    healthcheck:
+      test: /healthcheck.sh
+      interval: 10s
+      start_period: 5m
 
   wikibase-jobrunner:
     image: wikibase/wikibase
     volumes_from:
       - wikibase
-    command: /jobrunner-entrypoint.sh
     depends_on:
       wikibase:
         condition: service_healthy
     restart: always
+    environment:
+      IS_JOBRUNNER: true
 
   mysql:
     image: mariadb:10.11
@@ -90,7 +91,7 @@ services:
       discovery.type: single-node
       ES_JAVA_OPTS: -Xms512m -Xmx512m -Dlog4j2.formatMsgNoLookups=true
     healthcheck:
-      test: curl --silent --fail localhost:9200
+      test: /healthcheck.sh
       interval: 10s
       start_period: 2m
 

diff --git a/build/elasticsearch/healthcheck.sh b/build/elasticsearch/healthcheck.sh
@@ -0,0 +1,17 @@
+#!/bin/bash
+
+# Ref. https://github.com/docker-library/healthcheck/blob/master/elasticsearch/docker-healthcheck
+
+set -eo pipefail
+
+host="$(hostname --ip-address || echo '127.0.0.1')"
+
+if health="$(curl -fsSL "http://$host:9200/_cat/health?h=status")"; then
+	health="$(echo "$health" | sed -r 's/^[[:space:]]+|[[:space:]]+$//g')" # trim whitespace (otherwise we'll have "green ")
+	if [ "$health" = 'green' ]; then
+		exit 0
+	fi
+	echo >&2 "unexpected health status: $health"
+fi
+
+exit 1
diff --git a/build/quickstatements/Dockerfile b/build/quickstatements/Dockerfile
@@ -34,6 +34,7 @@ COPY --from=composer /tmp/quickstatements /var/www/html/quickstatements
 COPY --from=composer /tmp/magnustools /var/www/html/magnustools
 
 COPY entrypoint.sh /entrypoint.sh
+COPY healthcheck.sh /healthcheck.sh
 
 COPY config.json /templates/config.json
 COPY oauth.ini /templates/oauth.ini

diff --git a/build/quickstatements/README.md b/build/quickstatements/README.md
@@ -95,19 +95,20 @@ services:
       DB_PASS: "change-this-password"
       QUICKSTATEMENTS_PUBLIC_URL: https://quickstatements.example
     healthcheck:
-      test: curl --silent --fail localhost/wiki/Main_Page
+      test: /healthcheck.sh
       interval: 10s
       start_period: 5m
 
   wikibase-jobrunner:
     image: wikibase/wikibase
-    command: /jobrunner-entrypoint.sh
+    volumes_from:
+      - wikibase
     depends_on:
       wikibase:
         condition: service_healthy
     restart: always
-    volumes_from:
-      - wikibase
+    environment:
+      IS_JOBRUNNER: true
 
   mysql:
     image: mariadb:10.11
@@ -148,7 +149,7 @@ services:
       QUICKSTATEMENTS_PUBLIC_URL: https://quickstatements.example
       WIKIBASE_PUBLIC_URL: https://wikibase.example
     healthcheck:
-      test: curl --silent --fail localhost
+      test: /healthcheck.sh
       interval: 10s
       start_period: 2m
 
@@ -215,6 +216,7 @@ Hooking into the internal filesystem can extend the functionality of this image.
 
 | Directory                                   | Description                    |
 | ------------------------------------------- | ------------------------------ |
+| `/healthcheck.sh`                           | Optional healthcheck script    |
 | `/var/www/html/quickstatements`             | Base QuickStatements directory |
 | `/var/www/html/quickstatements/public_html` | The Apache root folder         |
 | `/var/www/html/magnustools`                 | Base magnustools directory     |

diff --git a/build/quickstatements/healthcheck.sh b/build/quickstatements/healthcheck.sh
@@ -0,0 +1,10 @@
+#!/usr/bin/env bash
+
+# Perform the health check using curl
+if curl --silent --fail "http://localhost" > /dev/null; then
+  echo "Health check passed."
+  exit 0
+else
+  echo "Health check failed."
+  exit 1
+fi
diff --git a/build/wdqs-frontend/Dockerfile b/build/wdqs-frontend/Dockerfile
@@ -31,6 +31,7 @@ WORKDIR /usr/share/nginx/html
 COPY --from=builder /tmp/wikidata-query-gui/build /usr/share/nginx/html
 RUN echo "" > style.css
 COPY entrypoint.sh /entrypoint.sh
+COPY healthcheck.sh /healthcheck.sh
 COPY custom-config.json /templates/custom-config.json
 COPY default.conf /templates/default.conf
 

diff --git a/build/wdqs-frontend/README.md b/build/wdqs-frontend/README.md
@@ -82,19 +82,20 @@ services:
       DB_USER: "mariadb-user"
       DB_PASS: "change-this-password"
     healthcheck:
-      test: curl --silent --fail localhost/wiki/Main_Page
+      test: /healthcheck.sh
       interval: 10s
       start_period: 5m
 
   wikibase-jobrunner:
     image: wikibase/wikibase
-    command: /jobrunner-entrypoint.sh
     depends_on:
       wikibase:
         condition: service_healthy
     restart: always
     volumes_from:
       - wikibase
+    environment:
+      IS_JOBRUNNER: true
 
   mysql:
     image: mariadb:10.11
@@ -126,7 +127,7 @@ services:
     volumes:
       - wdqs-data:/wdqs/data
     healthcheck:
-      test: curl --silent --fail localhost:9999/bigdata/namespace/wdq/sparql
+      test: /healthcheck.sh
       interval: 10s
       start_period: 2m
 
@@ -157,7 +158,7 @@ services:
     environment:
       WDQS_HOST: wdqs-proxy
     healthcheck:
-      test: curl --silent --fail localhost
+      test: /healthcheck.sh
       interval: 10s
       start_period: 2m
 

diff --git a/build/wdqs-frontend/healthcheck.sh b/build/wdqs-frontend/healthcheck.sh
@@ -0,0 +1,10 @@
+#!/bin/bash
+
+# Perform the health check using curl
+if curl --silent --fail "http://localhost" > /dev/null; then
+  echo "Health check passed."
+  exit 0
+else
+  echo "Health check failed."
+  exit 1
+fi
diff --git a/build/wdqs-proxy/README.md b/build/wdqs-proxy/README.md
@@ -65,19 +65,20 @@ services:
       DB_USER: "mariadb-user"
       DB_PASS: "change-this-password"
     healthcheck:
-      test: curl --silent --fail localhost/wiki/Main_Page
+      test: /healthcheck.sh
       interval: 10s
       start_period: 5m
 
   wikibase-jobrunner:
     image: wikibase/wikibase
-    command: /jobrunner-entrypoint.sh
+    volumes_from:
+      - wikibase
     depends_on:
       wikibase:
         condition: service_healthy
     restart: always
-    volumes_from:
-      - wikibase
+    environment:
+      IS_JOBRUNNER: true
 
   mysql:
     image: mariadb:10.11
@@ -109,7 +110,7 @@ services:
     volumes:
       - wdqs-data:/wdqs/data
     healthcheck:
-      test: curl --silent --fail localhost:9999/bigdata/namespace/wdq/sparql
+      test: /healthcheck.sh
       interval: 10s
       start_period: 2m
 

diff --git a/build/wdqs/Dockerfile b/build/wdqs/Dockerfile
@@ -71,7 +71,7 @@ ENV MEMORY=""\
 
 WORKDIR /wdqs
 
-COPY --chown=blazegraph:blazegraph wait-for-it.sh entrypoint.sh runBlazegraph.sh runUpdate.sh /
+COPY --chown=blazegraph:blazegraph wait-for-it.sh healthcheck.sh entrypoint.sh runBlazegraph.sh runUpdate.sh /
 COPY --chown=blazegraph:blazegraph mwservices.json /templates/mwservices.json
 COPY --chown=blazegraph:blazegraph RWStore.properties allowlist.txt logback.xml /wdqs/
 

diff --git a/build/wdqs/README.md b/build/wdqs/README.md
@@ -85,19 +85,20 @@ services:
       DB_USER: "mariadb-user"
       DB_PASS: "change-this-password"
     healthcheck:
-      test: curl --silent --fail localhost/wiki/Main_Page
+      test: /healthcheck.sh
       interval: 10s
       start_period: 5m
 
   wikibase-jobrunner:
     image: wikibase/wikibase
-    command: /jobrunner-entrypoint.sh
     depends_on:
       wikibase:
         condition: service_healthy
     restart: always
     volumes_from:
       - wikibase
+    environment:
+      IS_JOBRUNNER: true
 
   mysql:
     image: mariadb:10.11
@@ -129,7 +130,7 @@ services:
     volumes:
       - wdqs-data:/wdqs/data
     healthcheck:
-      test: curl --silent --fail localhost:9999/bigdata/namespace/wdq/sparql
+      test: /healthcheck.sh
       interval: 10s
       start_period: 2m
 
@@ -197,6 +198,7 @@ Hooking into the internal filesystem can extend the functionality of this image.
 
 | File                         | Description                                                                                    |
 | ---------------------------- | ---------------------------------------------------------------------------------------------- |
+| `/healthcheck.sh`            | Optional healthcheck script                                                                    |
 | `/wdqs/allowlist.txt`        | SPARQL endpoints allowed for federation                                                        |
 | `/wdqs/RWStore.properties`   | Properties for the service                                                                     |
 | `/templates/mwservices.json` | Template for MediaWiki services (populated and placed into `/wdqs/mwservices.json` at runtime) |

diff --git a/build/wdqs/healthcheck.sh b/build/wdqs/healthcheck.sh
@@ -0,0 +1,10 @@
+#!/usr/bin/env bash
+
+# Perform the health check using curl
+if curl --silent --fail "http://localhost:9999/bigdata/namespace/wdq/sparql" > /dev/null; then
+  echo "Health check passed."
+  exit 0
+else
+  echo "Health check failed."
+  exit 1
+fi
diff --git a/build/wikibase/Dockerfile b/build/wikibase/Dockerfile
@@ -170,6 +170,7 @@ RUN set -x; \
     ls -la && pwd && \
     composer install --no-dev -vv -n
 
+
 # ###########################################################################
 # hadolint ignore=DL3006
 FROM mediawiki AS wikibase
@@ -194,9 +195,11 @@ RUN chmod o-w /var/www/html && \
     ln -s /var/www/html/ /var/www/html/w && \
     chown www-data /var/www/html/images -R
 
-COPY wikibase-php.ini /usr/local/etc/php/conf.d/wikibase-php.ini
 COPY entrypoint.sh /entrypoint.sh
+COPY mediawiki-entrypoint.sh /mediawiki-entrypoint.sh
 COPY jobrunner-entrypoint.sh /jobrunner-entrypoint.sh
+COPY healthcheck.sh /healthcheck.sh
+COPY wikibase-php.ini /usr/local/etc/php/conf.d/wikibase-php.ini
 COPY htaccess /var/www/html/.htaccess
 COPY LocalSettings.d LocalSettings.d
 COPY default-extra-install.sh /default-extra-install.sh
@@ -206,7 +209,8 @@ COPY LocalSettings.wbs.php /templates/LocalSettings.wbs.php
 ENV DB_NAME=my_wiki \
     MW_WG_SITENAME=wikibase \
     MW_WG_LANGUAGE_CODE=en \
-    ELASTICSEARCH_PORT=9200
+    ELASTICSEARCH_PORT=9200 \
+    IS_JOBRUNNER=false
 
 ENTRYPOINT ["/bin/bash"]
 CMD ["/entrypoint.sh"]
diff --git a/build/wikibase/README.md b/build/wikibase/README.md
@@ -43,6 +43,7 @@ Variables in **bold** are required on first launch without `LocalSettings.php` i
 
 | Variable                     | Default    | Description                                                                                                                                                                                                  |
 | ---------------------------- | ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| **`IS_JOBRUNNER`**              | false  | If set to true the container will only run `maintenance/runJobs.php` instead of MediaWiki                                                                                                                                       |
 | **`DB_SERVER`**              | undefined  | Hostname and port for the MySQL server to use for MediaWiki & Wikibase                                                                                                                                       |
 | **`DB_USER`**                | undefined  | Username to use for the MySQL server                                                                                                                                                                         |
 | **`DB_PASS`**                | undefined  | Password to use for the MySQL server                                                                                                                                                                         |
@@ -61,7 +62,7 @@ Variables in **bold** are required on first launch without `LocalSettings.php` i
 
 MediaWiki/Wikibase depends on [jobs being run in the background](https://www.mediawiki.org/wiki/Manual:Job_queue). This can be either done on HTTP request or by a dedicated job runner. The default configuration of this image requires an external job runner like this.
 
-To set up an external job runner, use this image for a second container, overwrite the command to `/jobrunner-entrypoint.sh` and share the same configuration volume with it.
+To set up an external job runner, use this image for a second container, set the environment variable `IS_JOBRUNNER` to "true" and share the same configuration volume with it.
 
 ## Example
 
@@ -85,24 +86,25 @@ services:
       DB_NAME: "my_wiki"
       DB_USER: "mariadb-user"
       DB_PASS: "change-this-password"
-    healthcheck:
-      test: curl --silent --fail localhost/wiki/Main_Page
-      interval: 10s
-      start_period: 5m
     depends_on:
       mysql:
         condition: service_healthy
     restart: unless-stopped
+    healthcheck:
+      test: /healthcheck.sh
+      interval: 10s
+      start_period: 5m
 
   wikibase-jobrunner:
     image: wikibase/wikibase
     volumes_from:
       - wikibase
-    command: /jobrunner-entrypoint.sh
     depends_on:
       wikibase:
         condition: service_healthy
     restart: always
+    environment:
+      IS_JOBRUNNER: true
 
   mysql:
     image: mariadb:10.11
@@ -158,6 +160,7 @@ Hooking into the internal filesystem can extend the functionality of this image.
 
 | File                               | Description                                                                                                                                                                                    |
 | ---------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `/healthcheck.sh`                  | Optional healthcheck script                                                                                                                                                                    |
 | `/default-extra-install.sh`        | Script for automatically creating Elasticsearch indices and creating OAuth consumer for QuickStatements                                                                                        |
 | `/extra-install.sh`                | Optional script for custom functionality to be ran with MediaWiki install (when generating LocalSettings.php)                                                                                  |
 | `/templates/LocalSettings.wbs.php` | Wikibase-specific settings appended to the MediaWiki install generated `LocalSettings.php`. Specifically, this loads the Wikibase repo and client as well as all the other bundled extensions. |