docker/ucp backupEstimated reading time: 1 minute
Create a backup of a UCP manager node.
docker container run --log-driver none --rm -i \ --name ucp \ -v /var/run/docker.sock:/var/run/docker.sock \ docker/ucp \ backup [command options] > backup.tar
This command creates a tar file with the contents of the volumes used by
this UCP manager node, and prints it. You can then use the
restore command to
restore the data from an existing backup.
To create backups of a multi-node cluster, you only need to back up a single manager node. The restore operation will reconstitute a new UCP installation from the backup of any previous manager.
The backup contains private keys and other sensitive information. Use the
--passphraseflag to encrypt the backup with PGP-compatible encryption or
--no-passphraseto opt out (not recommended).
If using the
--fileoption, the path to the file must be bind mounted onto the container that is performing the backup, and the filepath must be relative to the container’s file tree. For example:
docker run <other options> --mount type=bind,src=/home/user/backup:/backup docker/ucp --file /backup/backup.tar
||Enable debug mode|
|--file value||Name of the file to write the backup contents to. Ignored in interactive mode|
||Produce json formatted output for easier parsing|
||Run in interactive mode and prompt for configuration values|
||Opt out to encrypt the tar file with a passphrase (not recommended)|
||Encrypt the tar file with a passphrase|