docker/dtr backup

Estimated reading time: 2 minutes

These are the docs for DTR version 2.4.1

To select a different version, use the selector below.

Create a backup of DTR

Usage

docker run -i --rm docker/dtr \
    backup [command options] > backup.tar

Description

This command creates a tar file with the contents of the volumes used by DTR, and prints it. You can then use the ‘restore’ command to restore the data from an existing backup.

Note:

  • This command only creates backups of configurations, and image metadata. It doesn’t backup users and organizations. Users and organizations can be backed up when performing a UCP backup.

    It also doesn’t backup the Docker images stored in your registry. You should implement a separate backup policy for the Docker images stored in your registry, taking in consideration whether your DTR installation is configured to store images on the filesystem or using a cloud provider.

  • This backup contains sensitive information and should be stored securely.

Options

OptionEnvironment VariableDescription
--debug$DEBUGEnable debug mode for additional logs.
--existing-replica-id$DTR_REPLICA_IDThe ID of an existing DTR replica.To add, remove or modify DTR, you must connect to an existing healthy replica’s database..
--help-extended$DTR_EXTENDED_HELPDisplay extended help text for a given command.
--ucp-ca$UCP_CAUse a PEM-encoded TLS CA certificate for UCP.Download the UCP TLS CA certificate from https:// /ca, and use --ucp-ca "$(cat ca.pem)".
--ucp-insecure-tls$UCP_INSECURE_TLSDisable TLS verification for UCP.The installation uses TLS but always trusts the TLS certificate used by UCP, which can lead to man-in-the-middle attacks. For production deployments, use –ucp-ca “$(cat ca.pem)” instead.
--ucp-password$UCP_PASSWORDThe UCP administrator password.
--ucp-url$UCP_URLThe UCP URL including domain and port.
--ucp-username$UCP_USERNAMEThe UCP administrator username.
dtr, cli, backup