Chapter 1. Backing up and restoring MicroShift data

Procedure

1. Enter the following command to stop the MicroShift service:

   $ sudo systemctl stop microshift

2. Workloads deployed on MicroShift might continue running even after the MicroShift service has been stopped. Enter the following command to display running workloads:

   $ sudo crictl ps -a

3. Enter the following commands to stop the deployed workloads:

   $ sudo systemctl stop kubepods.slice

Procedure

1. Manually create a backup by using the parent directory and specifying a name, such as /var/lib/microshift-backups/<manual_backup>, by running the following command:

   $ sudo microshift backup /var/lib/microshift-backups/<manual_backup>

   • For <manual_backup>, specify the backup name that you want to use.

     Example output

     ??? I1017 07:38:16.770506    5900 data_manager.go:92] "Copying data to backup directory" storage="/var/lib/microshift-backups" name="test" data="/var/lib/microshift"
     ??? I1017 07:38:16.770713    5900 data_manager.go:227] "Starting copy" cmd="/bin/cp --verbose --recursive --preserve --reflink=auto /var/lib/microshift /var/lib/microshift-backups/test"
     ??? I1017 07:38:16.776162    5900 data_manager.go:241] "Finished copy" cmd="/bin/cp --verbose --recursive --preserve --reflink=auto /var/lib/microshift /var/lib/microshift-backups/test"
     ??? I1017 07:38:16.776256    5900 data_manager.go:125] "Copied data to backup directory" backup="/var/lib/microshift-backups/test" data="/var/lib/microshift"

2. Optional: Manually create a backup in a specific parent directory with a custom name by running the following command:

   $ sudo microshift backup /mnt/<other_backups_location>/<another_manual_backup>

   • For <other_backups_location>, specify the directory that you want to use.
   • For <another_manual_backup>, specify the backup name that you want to use.

Procedure

1. Manually restore MicroShift data by using the full file path of the backup you want to restore by running the following command:

   $ sudo microshift restore /var/lib/microshift-backups/<manual_backup>

   • For <manual_backup>, specify the backup name that you want to use. Optionally, you can also restore automatic ostree backups using the full file path.

     Example output

     ??? I1017 07:39:52.055165    6007 data_manager.go:131] "Copying backup to data directory" storage="/var/lib/microshift-backups" name="test" data="/var/lib/microshift"
     ??? I1017 07:39:52.055243    6007 data_manager.go:154] "Renaming existing data dir" data="/var/lib/microshift" renamedTo="/var/lib/microshift.saved"
     ??? I1017 07:39:52.055326    6007 data_manager.go:227] "Starting copy" cmd="/bin/cp --verbose --recursive --preserve --reflink=auto /var/lib/microshift-backups/test /var/lib/microshift"
     ??? I1017 07:39:52.061363    6007 data_manager.go:241] "Finished copy" cmd="/bin/cp --verbose --recursive --preserve --reflink=auto /var/lib/microshift-backups/test /var/lib/microshift"
     ??? I1017 07:39:52.061404    6007 data_manager.go:175] "Removing temporary data directory" path="/var/lib/microshift.saved"
     ??? I1017 07:39:52.063745    6007 data_manager.go:180] "Copied backup to data directory" name="test" data="/var/lib/microshift"

2. Optional. Manually restore data from a customized directory by using the full file path of the backup. Run the following command:

   $ sudo microshift restore /mnt/<other_backups_location>/<another_manual_backup>

   • For <other_backups_location>, specify the directory that you used.
   • For <another_manual_backup>, specify the backup name that you used when creating the backup you are restoring.
3. Restart the host. Restarting the host enables all workloads and pods to restart.