fix: return 503 when ocis and office are down

We need to use file configuration in order to setup an empty service
where the requests will be routed if the containters are down.
Maintenance configuration will be also setup in there for convenience.
Router configuration for the "unavailable" service is in the docker's
labels because we want to skip the routing for traefik in case the
dashboard is enabled, although it might not be needed.

Author: jvillafanez

deployments/examples/ocis_full/collabora.yml

@@ -76,7 +76,7 @@ services:
       - "traefik.http.routers.collabora.rule=Host(`${COLLABORA_DOMAIN:-collabora.owncloud.test}`)"
       - "traefik.http.routers.collabora.tls.certresolver=http"
       - "traefik.http.routers.collabora.service=collabora"
-      - "traefik.http.routers.collabora.middlewares=maintenance"
+      - "traefik.http.routers.collabora.middlewares=maintenance@file"
       - "traefik.http.services.collabora.loadbalancer.server.port=9980"
     logging:
       driver: ${LOG_DRIVER:-local}

deployments/examples/ocis_full/config/traefik/maintenance.yml

@@ -0,0 +1,15 @@
+---
+http:
+  services:
+    unavailable:
+      loadBalancer:
+        servers: {}
+  middlewares:
+    maintenance:
+      plugin:
+        traefik-maintenance:
+          enabled: true
+          filename: '/maintenance/content.txt'
+          triggerFilename: '/maintenance/content.txt.trigger'
+          httpResponseCode: 503
+          httpContentType: 'text/plain; charset=utf-8'

deployments/examples/ocis_full/docker-compose.yml

@@ -25,8 +25,10 @@ services:
       - "--entryPoints.https.transport.respondingTimeouts.writeTimeout=12h"
       - "--entryPoints.https.transport.respondingTimeouts.idleTimeout=3m"
       # docker provider (get configuration from container labels)
+      - "--providers.docker=true"
       - "--providers.docker.endpoint=unix:///var/run/docker.sock"
       - "--providers.docker.exposedByDefault=false"
+      - "--providers.file.directory=/etc/traefik/dynamic"
       # access log
       - "--accessLog=true"
       - "--accessLog.format=json"
@@ -40,6 +42,7 @@ services:
     volumes:
       - "${DOCKER_SOCKET_PATH:-/var/run/docker.sock}:/var/run/docker.sock:ro"
       - "certs:/certs"
+      - "./config/traefik/:/etc/traefik/dynamic/"
     labels:
       - "traefik.enable=true"
        # defaults to admin:admin
@@ -49,12 +52,13 @@ services:
       - "traefik.http.routers.traefik.middlewares=traefik-auth"
       - "traefik.http.routers.traefik.tls.certresolver=http"
       - "traefik.http.routers.traefik.service=api@internal"
-      # maintenance configuration
-      - "traefik.http.middlewares.maintenance.plugin.traefik-maintenance.enabled=true"
-      - "traefik.http.middlewares.maintenance.plugin.traefik-maintenance.httpResponseCode=503"
-      - "traefik.http.middlewares.maintenance.plugin.traefik-maintenance.filename=/maintenance/content.txt"
-      - "traefik.http.middlewares.maintenance.plugin.traefik-maintenance.triggerFilename=/maintenance/content.txt.trigger"
-      - "traefik.http.middlewares.maintenance.plugin.traefik-maintenance.httpContentType=text/plain; charset=utf-8"
+      # catchall configuration to return 503 for all requests if container is not available (except for traefik)
+      - "traefik.http.routers.catchall.entrypoints=https"
+      - "traefik.http.routers.catchall.rule=PathPrefix(`/`) && !Host(`${TRAEFIK_DOMAIN:-traefik.owncloud.test}`)"
+      - "traefik.http.routers.catchall.priority=1"
+      - "traefik.http.routers.catchall.middlewares=maintenance@file"
+      - "traefik.http.routers.catchall.tls.certresolver=http"
+      - "traefik.http.routers.catchall.service=unavailable@file"
     logging:
       driver: ${LOG_DRIVER:-local}
     restart: always

deployments/examples/ocis_full/ocis.yml

@@ -66,7 +66,7 @@ services:
       - "traefik.http.routers.ocis.rule=Host(`${OCIS_DOMAIN:-ocis.owncloud.test}`)"
       - "traefik.http.routers.ocis.tls.certresolver=http"
       - "traefik.http.routers.ocis.service=ocis"
-      - "traefik.http.routers.ocis.middlewares=maintenance"
+      - "traefik.http.routers.ocis.middlewares=maintenance@file"
       - "traefik.http.services.ocis.loadbalancer.server.port=9200"
     logging:
       driver: ${LOG_DRIVER:-local}

deployments/examples/ocis_full/onlyoffice.yml

@@ -78,7 +78,7 @@ services:
       - "traefik.http.services.onlyoffice.loadbalancer.server.port=80"
       # websockets can't be opened when this is omitted
       - "traefik.http.middlewares.onlyoffice.headers.customrequestheaders.X-Forwarded-Proto=https"
-      - "traefik.http.routers.onlyoffice.middlewares=onlyoffice,maintenance"
+      - "traefik.http.routers.onlyoffice.middlewares=onlyoffice,maintenance@file"
     logging:
       driver: ${LOG_DRIVER:-local}
     restart: always