⚓ Unified healthcheck timing: hoisted shared anchor for cleaner sails

Author: scottgigawatt

docker-compose.yml

@@ -72,6 +72,15 @@ x-arr-stack-container: &arr-stack-container  # YAML anchor for arr-stack contain
   environment:                               # Define common arr-stack container variables
     <<: *arr-stack-environment               # Pull in the arr-stack environment information
 
+#
+# Standard healthcheck timing settings
+#
+x-default-healthcheck-settings: &default-healthcheck-settings  # YAML anchor for healthcheck settings
+  interval: ${DEFAULT_HEALTHCHECK_INTERVAL}                    # Run the check at this interval
+  timeout: ${DEFAULT_HEALTHCHECK_TIMEOUT}                      # Fail if it exceeds this duration
+  start_period: ${DEFAULT_HEALTHCHECK_START_PERIOD}            # Grace period before checks start
+  retries: 5                                                   # Mark as unhealthy after 5 failures
+
 #
 # Define the services section
 #
@@ -155,10 +164,7 @@ services:
     # Define container healthcheck to verify VPN connectivity
     healthcheck:
       test: ["CMD-SHELL", "wget -qO- https://ipinfo.io | grep -q 'ip'"]  # Check if public IP is reachable
-      interval: ${GLUETUN_HEALTHCHECK_INTERVAL}                          # Run the check at this interval
-      timeout: ${GLUETUN_HEALTHCHECK_TIMEOUT}                            # Fail if it exceeds this duration
-      start_period: ${GLUETUN_HEALTHCHECK_START_PERIOD}                  # Grace period before checks start
-      retries: 5                                                         # Mark as unhealthy after 5 failures
+      <<: *default-healthcheck-settings                                  # Pull in default healthcheck settings
 
     # Specify container service dependencies
     depends_on:
@@ -189,10 +195,7 @@ services:
     # Define container healthcheck to verify FlareSolverr connectivity
     healthcheck:
       test: ["CMD-SHELL", "curl -s http://localhost:8191 | grep -q 'FlareSolverr'"]  # Check if FlareSolverr UI is reachable
-      interval: ${FLARESOLVERR_HEALTHCHECK_INTERVAL}                                 # Run the check at this interval
-      timeout: ${FLARESOLVERR_HEALTHCHECK_TIMEOUT}                                   # Fail if it exceeds this duration
-      start_period: ${FLARESOLVERR_HEALTHCHECK_START_PERIOD}                         # Grace period before checks start
-      retries: 5                                                                     # Mark as unhealthy after 5 failures
+      <<: *default-healthcheck-settings                                              # Pull in default healthcheck settings
 
   #
   # Define the 'prowlarr' service for managing indexers
@@ -210,11 +213,8 @@ services:
 
     # Define container healthcheck to verify Prowlarr connectivity
     healthcheck:
-      test: ["CMD-SHELL", "wget -qO- http://localhost:9696 | grep -q '<title>Login - Prowlarr</title>'"]  # Check if Prowlarr web UI is up
-      interval: ${PROWLARR_HEALTHCHECK_INTERVAL}                                                          # Run the check at this interval
-      timeout: ${PROWLARR_HEALTHCHECK_TIMEOUT}                                                            # Fail if it exceeds this duration
-      start_period: ${PROWLARR_HEALTHCHECK_START_PERIOD}                                                  # Grace period before checks start
-      retries: 5                                                                                          # Mark as unhealthy after 5 failures
+      test: ["CMD-SHELL", "wget -qO- http://localhost:${PROWLARR_WEBUI_PORT} | grep -q 'Prowlarr'"]  # Check if Prowlarr web UI is up
+      <<: *default-healthcheck-settings                                                              # Pull in default healthcheck settings
 
     # Specify container service dependencies
     depends_on:
@@ -240,11 +240,8 @@ services:
 
     # Define container healthcheck to verify qBittorrent connectivity
     healthcheck:
-      test: ["CMD-SHELL", "wget -qO- http://localhost:8080 | grep -q '<title>qBittorrent WebUI</title>'"]  # Check if qBittorrent web UI is reachable
-      interval: ${QBITTORRENT_HEALTHCHECK_INTERVAL}                                                        # Run the check at this interval
-      timeout: ${QBITTORRENT_HEALTHCHECK_TIMEOUT}                                                          # Fail if it exceeds this duration
-      start_period: ${QBITTORRENT_HEALTHCHECK_START_PERIOD}                                                # Grace period before checks start
-      retries: 5                                                                                           # Mark as unhealthy after 5 failures
+      test: ["CMD-SHELL", "wget -qO- http://localhost:${QBITTORRENT_WEBUI_PORT} | grep -q 'qBittorrent'"]  # Check if qBittorrent web UI is reachable
+      <<: *default-healthcheck-settings                                                                    # Pull in default healthcheck settings
 
     # Specify container service dependencies
     depends_on:
@@ -269,11 +266,8 @@ services:
 
     # Define container healthcheck to verify Radarr connectivity
     healthcheck:
-      test: ["CMD-SHELL", "wget -qO- http://localhost:7878 | grep -q '<title>Radarr</title>'"]  # Check if Radarr web UI is reachable
-      interval: ${RADARR_HEALTHCHECK_INTERVAL}                                                  # Run the check at this interval
-      timeout: ${RADARR_HEALTHCHECK_TIMEOUT}                                                    # Fail if it exceeds this duration
-      start_period: ${RADARR_HEALTHCHECK_START_PERIOD}                                          # Grace period before checks start
-      retries: 5                                                                                # Mark as unhealthy after 5 failures
+      test: ["CMD-SHELL", "wget -qO- http://localhost:7878 | grep -q 'Radarr'"]  # Check if Radarr web UI is reachable
+      <<: *default-healthcheck-settings                                          # Pull in default healthcheck settings
 
     # Specify container service dependencies
     depends_on:
@@ -302,11 +296,8 @@ services:
 
     # Define container healthcheck to verify Sonarr connectivity
     healthcheck:
-      test: ["CMD-SHELL", "wget -qO- http://localhost:8989 | grep -q '<title>Sonarr</title>'"]  # Check if Sonarr web UI is reachable
-      interval: ${SONARR_HEALTHCHECK_INTERVAL}                                                  # Run the check at this interval
-      timeout: ${SONARR_HEALTHCHECK_TIMEOUT}                                                    # Fail if it exceeds this duration
-      start_period: ${SONARR_HEALTHCHECK_START_PERIOD}                                          # Grace period before checks start
-      retries: 5                                                                                # Mark as unhealthy after 5 failures
+      test: ["CMD-SHELL", "wget -qO- http://localhost:${SONARR_WEBUI_PORT} | grep -q 'Sonarr'"]  # Check if Sonarr web UI is reachable
+      <<: *default-healthcheck-settings                                                          # Pull in default healthcheck settings
 
     # Specify container service dependencies
     depends_on:
@@ -335,11 +326,8 @@ services:
 
     # Define container healthcheck to verify Bazarr connectivity
     healthcheck:
-      test: ["CMD-SHELL", "wget -qO- http://localhost:6767 | grep -q '<title>Bazarr</title>'"]  # Check if Bazarr web UI is reachable
-      interval: ${BAZARR_HEALTHCHECK_INTERVAL}                                                  # Run the check at this interval
-      timeout: ${BAZARR_HEALTHCHECK_TIMEOUT}                                                    # Fail if it exceeds this duration
-      start_period: ${BAZARR_HEALTHCHECK_START_PERIOD}                                          # Grace period before checks start
-      retries: 5                                                                                # Mark as unhealthy after 5 failures
+      test: ["CMD-SHELL", "wget -qO- http://localhost:6767 | grep -q 'Bazarr'"]  # Check if Bazarr web UI is reachable
+      <<: *default-healthcheck-settings                                          # Pull in default healthcheck settings
 
     # Specify container service dependencies
     depends_on:
@@ -368,11 +356,8 @@ services:
 
     # Define container healthcheck to verify Readarr connectivity
     healthcheck:
-      test: ["CMD-SHELL", "wget -qO- http://localhost:8787 | grep -q '<title>Readarr</title>'"]  # Check if Readarr web UI is reachable
-      interval: ${READARR_HEALTHCHECK_INTERVAL}                                                  # Run the check at this interval
-      timeout: ${READARR_HEALTHCHECK_TIMEOUT}                                                    # Fail if it exceeds this duration
-      start_period: ${READARR_HEALTHCHECK_START_PERIOD}                                          # Grace period before checks start
-      retries: 5                                                                                 # Mark as unhealthy after 5 failures
+      test: ["CMD-SHELL", "wget -qO- http://localhost:${READARR_WEBUI_PORT} | grep -q 'Readarr'"]  # Check if Readarr web UI is reachable
+      <<: *default-healthcheck-settings                                                            # Pull in default healthcheck settings
 
     # Specify container service dependencies
     depends_on:

example.env

@@ -29,6 +29,13 @@ DEFAULT_PUID="${DEFAULT_PUID:-1000}"
 DEFAULT_PGID="${DEFAULT_PGID:-1000}"
 DEFAULT_GROUP="${DEFAULT_GROUP:-109}"
 
+#
+# Standard healthcheck timing settings
+#
+DEFAULT_HEALTHCHECK_INTERVAL="${DEFAULT_HEALTHCHECK_INTERVAL:-10s}"
+DEFAULT_HEALTHCHECK_TIMEOUT="${DEFAULT_HEALTHCHECK_TIMEOUT:-10s}"
+DEFAULT_HEALTHCHECK_START_PERIOD="${DEFAULT_HEALTHCHECK_START_PERIOD:-10s}"
+
 #
 # Container logging settings
 #
@@ -71,9 +78,6 @@ GLUETUN_TAG="${GLUETUN_TAG:-latest}"
 GLUETUN_VPN_SERVICE_PROVIDER="${GLUETUN_VPN_SERVICE_PROVIDER:-custom}"
 GLUETUN_VPN_TYPE="${GLUETUN_VPN_TYPE:-wireguard}"
 GLUETUN_CONFIG_PATH="${GLUETUN_CONFIG_PATH:-./config/gluetun}"
-GLUETUN_HEALTHCHECK_INTERVAL="${GLUETUN_HEALTHCHECK_INTERVAL:-10s}"
-GLUETUN_HEALTHCHECK_TIMEOUT="${GLUETUN_HEALTHCHECK_TIMEOUT:-10s}"
-GLUETUN_HEALTHCHECK_START_PERIOD="${GLUETUN_HEALTHCHECK_START_PERIOD:-10s}"
 
 #
 # Flaresolverr environment variables
@@ -83,19 +87,13 @@ FLARESOLVERR_LOG_LEVEL="${FLARESOLVERR_LOG_LEVEL:-info}"
 FLARESOLVERR_LOG_HTML="${FLARESOLVERR_LOG_HTML:-false}"
 FLARESOLVERR_CAPTCHA_SOLVER="${FLARESOLVERR_CAPTCHA_SOLVER:-none}"
 FLARESOLVERR_PORT="${FLARESOLVERR_PORT:-8191}"
-FLARESOLVERR_HEALTHCHECK_INTERVAL="${FLARESOLVERR_HEALTHCHECK_INTERVAL:-10s}"
-FLARESOLVERR_HEALTHCHECK_TIMEOUT="${FLARESOLVERR_HEALTHCHECK_TIMEOUT:-10s}"
-FLARESOLVERR_HEALTHCHECK_START_PERIOD="${FLARESOLVERR_HEALTHCHECK_START_PERIOD:-10s}"
 
 #
 # Prowlarr environment variables
 #
 PROWLARR_TAG="${PROWLARR_TAG:-latest}"
 PROWLARR_WEBUI_PORT="${PROWLARR_WEBUI_PORT:-9696}"
 PROWLARR_CONFIG_PATH="${PROWLARR_CONFIG_PATH:-./config/prowlarr}"
-PROWLARR_HEALTHCHECK_INTERVAL="${PROWLARR_HEALTHCHECK_INTERVAL:-10s}"
-PROWLARR_HEALTHCHECK_TIMEOUT="${PROWLARR_HEALTHCHECK_TIMEOUT:-10s}"
-PROWLARR_HEALTHCHECK_START_PERIOD="${PROWLARR_HEALTHCHECK_START_PERIOD:-10s}"
 
 #
 # qBittorrent environment variables
@@ -105,49 +103,34 @@ QBITTORRENT_TCP_PORT="${QBITTORRENT_TCP_PORT:-6881}"
 QBITTORRENT_UDP_PORT="${QBITTORRENT_UDP_PORT:-6881}"
 QBITTORRENT_WEBUI_PORT="${QBITTORRENT_WEBUI_PORT:-8080}"
 QBITTORRENT_CONFIG_PATH="${QBITTORRENT_CONFIG_PATH:-./config/qbittorrent}"
-QBITTORRENT_HEALTHCHECK_INTERVAL="${QBITTORRENT_HEALTHCHECK_INTERVAL:-10s}"
-QBITTORRENT_HEALTHCHECK_TIMEOUT="${QBITTORRENT_HEALTHCHECK_TIMEOUT:-10s}"
-QBITTORRENT_HEALTHCHECK_START_PERIOD="${QBITTORRENT_HEALTHCHECK_START_PERIOD:-10s}"
 
 #
 # Radarr environment variables
 #
 RADARR_TAG="${RADARR_TAG:-latest}"
 RADARR_WEBUI_PORT="${RADARR_WEBUI_PORT:-7878}"
 RADARR_CONFIG_PATH="${RADARR_CONFIG_PATH:-./config/radarr}"
-RADARR_HEALTHCHECK_INTERVAL="${RADARR_HEALTHCHECK_INTERVAL:-10s}"
-RADARR_HEALTHCHECK_TIMEOUT="${RADARR_HEALTHCHECK_TIMEOUT:-10s}"
-RADARR_HEALTHCHECK_START_PERIOD="${RADARR_HEALTHCHECK_START_PERIOD:-10s}"
 
 #
 # Sonarr environment variables
 #
 SONARR_TAG="${SONARR_TAG:-latest}"
 SONARR_WEBUI_PORT="${SONARR_WEBUI_PORT:-8989}"
 SONARR_CONFIG_PATH="${SONARR_CONFIG_PATH:-./config/sonarr}"
-SONARR_HEALTHCHECK_INTERVAL="${SONARR_HEALTHCHECK_INTERVAL:-10s}"
-SONARR_HEALTHCHECK_TIMEOUT="${SONARR_HEALTHCHECK_TIMEOUT:-10s}"
-SONARR_HEALTHCHECK_START_PERIOD="${SONARR_HEALTHCHECK_START_PERIOD:-10s}"
 
 #
 # Bazarr environment variables
 #
 BAZARR_TAG="${BAZARR_TAG:-latest}"
 BAZARR_WEBUI_PORT="${BAZARR_WEBUI_PORT:-6767}"
 BAZARR_CONFIG_PATH="${BAZARR_CONFIG_PATH:-./config/bazarr}"
-BAZARR_HEALTHCHECK_INTERVAL="${BAZARR_HEALTHCHECK_INTERVAL:-10s}"
-BAZARR_HEALTHCHECK_TIMEOUT="${BAZARR_HEALTHCHECK_TIMEOUT:-10s}"
-BAZARR_HEALTHCHECK_START_PERIOD="${BAZARR_HEALTHCHECK_START_PERIOD:-10s}"
 
 #
 # Readarr environment variables
 #
 READARR_TAG="${READARR_TAG:-develop}"
 READARR_WEBUI_PORT="${READARR_WEBUI_PORT:-8787}"
 READARR_CONFIG_PATH="${READARR_CONFIG_PATH:-./config/readarr}"
-READARR_HEALTHCHECK_INTERVAL="${READARR_HEALTHCHECK_INTERVAL:-10s}"
-READARR_HEALTHCHECK_TIMEOUT="${READARR_HEALTHCHECK_TIMEOUT:-10s}"
-READARR_HEALTHCHECK_START_PERIOD="${READARR_HEALTHCHECK_START_PERIOD:-10s}"
 
 #
 # Overseerr environment variables