Skip to content

Backup and restore#

Mirantis strongly recommends that you regularly back up your MKE 4k clusters. In paraticular, you should backup your clusters anytime you make a configuration change.

Info

The MKE 4k backup operation does not impact normal cluster function.

Limitations#

  • You can only restore an MKE 4k cluster from a backup that was derived from the exact same version of the software.

  • You cannot run two backups of an MKE 4k cluster at the same time.

  • Initiating an upgrade while a backup operation is in progress can lead to unpredictable results.

  • MKE 4k may not be able to back up a cluster that has crashed.

  • MKE 4k does not support scheduled backups.

Create a backup#

Info

MKE 4k backups are saved as local tarballs.

To create an MKE 4k backup and save it to a local path, run:

mkectl etcd backup -f <config_file_path>

You can provide a name for the backup using the --name flag. If this flag is not specified, the system will apply backup.tar as the tarball file name. If a backup with the same name already exists, the backup process will immediately fail. To use the same name, please rename the earlier backup tarball or move it to a different location.

Restore from a backup#

To restore an MKE 4k backup, run:

mkectl etcd restore --name <backup_name> -f <config_file_path>

This command will restore the indicated MKE 4k backup to the target cluster. Be aware that this operation will result in cluster disruption, as the cluster will be restored to the state it was in at the point the backup was created.

Important

Verify that the parameters of the MKE 4k configuration file hosts section are correct, as the restore operation requires the information herein to connect to the relevant hosts.