offen/docker-volume-backup
2
0
Fork 0
mirror of https://github.com/offen/docker-volume-backup.git synced 2024-11-22 21:30:28 +01:00
Code Issues Packages Projects Releases Wiki Activity

Document script behavior on label collision

Browse Source
This commit is contained in:
Frederik Ring 2024-01-27 13:50:56 +01:00
parent 538a069a70
commit bf1d13b78c
2 changed files with 7 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
docs/how-tos/stop-containers-during-backup.md
View File

@ -7,6 +7,9 @@ nav_order: 1
# Stop containers during backup # 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. 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. 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. 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.

4
docs/how-tos/use-with-docker-swarm.md
View File

@ -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. 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 ### 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: When labeling a service in the `deploy` section, the following strategy for stopping and restarting will be used: