f5e0a593e3 | ||
---|---|---|
Dockerfile | ||
LICENSE | ||
README.md | ||
volume-backup.sh |
README.md
volume-backup
An utility to backup and restore docker volumes.
Note: Make sure no container is using the volume before backup or restore, otherwise your data might be damaged. See Miscellaneous for instructions.
Backup
To standard output
This avoids mounting a second backup volume and allows to redirect it to a file, network, etc.
Syntax:
docker run -v [volume-name]:/volume --rm loomchild/volume-backup backup - > [archive-name]
For example:
docker run -v some_volume:/volume --rm loomchild/volume-backup backup - > some_archive.tar.bz2
will archive volume named some_volume
to some_archive.tar.bz2
archive file.
WARNING: This method should not be used with a Docker for Windows installation; no usable backup will be generated.
To a file
Syntax:
docker run -v [volume-name]:/volume -v [output-dir]:/backup --rm loomchild/volume-backup backup [archive-name]
For example:
docker run -v some_volume:/volume -v /tmp:/backup --rm loomchild/volume-backup backup some_archive
will archive volume named some_volume
to /tmp/some_archive.tar.bz2
archive file.
Restore
WARNING: This operation will delete all contents of the volume
Restore from standard input
This avoids mounting a second backup volume.
NOTE: Don't forget the -i
switch for interactive operation.
Syntax:
cat [archive-name] | docker run -i -v [volume-name]:/volume --rm loomchild/volume-backup restore -
For example:
cat some_archive.tar.bz2 | docker run -i -v some_volume:/volume --rm loomchild/volume-backup restore -
will clean and restore volume named some_volume
from some_archive.tar.bz2
archive file.
WARNING: This method should not be used with a Docker for Windows installation; no usable backup will be generated.
From a file
Syntax:
docker run -v [volume-name]:/volume -v [output-dir]:/backup --rm loomchild/volume-backup restore [archive-name]
For example:
docker run -v some_volume:/volume -v /tmp:/backup --rm loomchild/volume-backup restore some_archive
will clean and restore volume named some_volume
from /tmp/some_archive.tar.bz2
archive file.
Miscellaneous
-
Upgrade / update volume-backup
docker pull loomchild/volume-backup
-
Find all containers using a volume (to stop them before backing-up)
docker ps -a --filter volume=[volume-name]
-
Exclude some files from the backup and send the archive to stdout
docker run -v [volume-name]:/volume --rm loomchild/volume-backup backup -e [excluded-glob] - > [archive-name]