From bf1d13b78c6407507aea366539c2eae054b8ca7b Mon Sep 17 00:00:00 2001 From: Frederik Ring Date: Sat, 27 Jan 2024 13:50:56 +0100 Subject: [PATCH] Document script behavior on label collision --- docs/how-tos/stop-containers-during-backup.md | 3 +++ docs/how-tos/use-with-docker-swarm.md | 4 ++++ 2 files changed, 7 insertions(+) diff --git a/docs/how-tos/stop-containers-during-backup.md b/docs/how-tos/stop-containers-during-backup.md index 941ebda..f87f754 100644 --- a/docs/how-tos/stop-containers-during-backup.md +++ b/docs/how-tos/stop-containers-during-backup.md @@ -7,6 +7,9 @@ nav_order: 1 # Stop containers during backup +{: .note } +In case you are running Docker in Swarm mode, [dedicated documentation](./use-with-docker-swarm.html) on service and container restart applies. + In many cases, it will be desirable to stop the services that are consuming the volume you want to backup in order to ensure data integrity. This image can automatically stop and restart containers and services. By default, any container that is labeled `docker-volume-backup.stop-during-backup=true` will be stopped before the backup is being taken and restarted once it has finished. diff --git a/docs/how-tos/use-with-docker-swarm.md b/docs/how-tos/use-with-docker-swarm.md index 507b8b2..2917855 100644 --- a/docs/how-tos/use-with-docker-swarm.md +++ b/docs/how-tos/use-with-docker-swarm.md @@ -16,6 +16,10 @@ The mechanisms described in this page __do only apply when Docker is running in Stopping and restarting containers during backup creation when running Docker in Swarm mode is supported in two ways. +{: .important } +Make sure you label your services and containers using only one of the describe approaches. +In case the script encounters a container that is labeled and has a parent service that is also labeled, it will exit early. + ### Scaling services down to zero before scaling back up When labeling a service in the `deploy` section, the following strategy for stopping and restarting will be used: