Use this command to restore a MKE cluster from a backup.
This command installs a new MKE cluster that is populated with the
state of a previous MKE manager node using a tar file generated by
the backup command. All MKE settings, users, teams and permissions
will be restored from the backup file.
The Restore operation does not alter or recover any containers, networks, volumes or services of an underlying cluster.
The restore command can be performed on any manager node of an
existing cluster. If the current node does not belong in a
cluster, one will be initialized using the value of the --host-address
flag. When restoring on an existing swarm-mode cluster, no previous
MKE components must be running on any node of the cluster. This cleanup
can be performed with the uninstall-ucp command.
If restore is performed on a different cluster than the one where the backup file was taken on, the Cluster Root CA of the old MKE installation will not be restored. This will invalidate any previously issued Admin Client Bundles and all administrator will be required to download new client bundles after the operation is completed. Any existing Client Bundles for non-admin users will still be fully operational.
By default, the backup tar file is read from stdin. You can also
bind-mount the backup file under /config/backup.tar, and run the
restore command with the --interactive flag.
Note
uninstall-ucp before attempting the restore operation on
an existing MKE cluster.docker swarm init --force-new-cluster command.| Option | Description |
|---|---|
--debug, -D |
Enable debug mode |
--jsonlog |
Produce json formatted output for easier parsing. |
--interactive, i |
Run in interactive mode and prompt for configuration values. |
--data-path-addr value |
Address or interface to use for data path traffic. |
--force-minimums |
Force the install/upgrade even if the system does not meet the minimum requirements. |
--host-address value |
The network address to advertise to other nodes. Format: IP address or network interface name. |
--passphrase value |
Decrypt the backup tar file with the provided passphrase. |
--san value |
Add subject alternative names to certificates (e.g. –san www1.acme.com –san www2.acme.com). |
--swarm-grpc-port value |
Port for communication between nodes (default: 2377). |
--unlock-key value |
The unlock key for this swarm-mode cluster, if one exists. |