Skip to main content

Restore from Backups

This topic describes how to restore from full or partial backups using Replicated snapshots.

Overview​

Snapshots supports the following types of restores:

  • Restore both the application and the KOTS Admin Console (also referred to as a full restore)
  • Restore the KOTS Admin Console only
  • Restore the application only (also referred to as a partial restore)

You can do any type of restore from a full backup using the KOTS CLI. You can also restore an application from a full or partial backup using the Admin Console.

Limitations​

The following limitations apply to restoring from backups using snapshots:

  • Only full backups that include both the application and the Admin Console can be restored to a new cluster in disaster recovery scenarios. Partial backups that include the application only cannot be restored to a new cluster, and are therefore not useable for disaster recovery.

  • Snapshots must be restored on the same operating system that the snapshot was taken on. For example, snapshots taken on a CentOS cluster must be restored on a CentOS cluster.

  • Snapshots can be restored only to clusters that use the same installation method as the cluster the snapshot was taken from. For example, snapshots taken in an online (internet-connected) cluster must be restored to an online cluster.

  • Only full backups can be restored using the KOTS CLI. To restore an application from a partial backup, use the Admin Console. See Restore the Application Only Using the Admin Console.

For a full list of limitations and considerations related to the snapshots feature, see Limitations and Considerations in About Backup and Restore.

Restore From a Full Backup Using the CLI​

You can use the KOTS CLI to restore both the Admin Console and the application, the Admin Console only, or the application only. If you need to restore the Admin Console, you must use the KOTS CLI because the Admin Console gets recreated and is disconnected during the restore process.

note

Only full backups can be restored using the KOTS CLI. To restore an application from a partial backup, use the Admin Console. See Restore the Application Only Using the Admin Console.

To restore using the CLI, see the corresponding procedure for your environment:

Existing Clusters​

note

If you are restoring to a healthy cluster, you can skip reinstalling Velero and continue to running the get backups and restore commands in the last two steps.

To restore a full backup in an existing cluster:

  1. (New or Unhealthy Clusters Only) In the cluster where you will do the restore, install a version of Velero that is compatible with the version that was used to make the snapshot backup.

    The Velero installation command varies depending on the storage destination for the backup. For the Velero installation command, see one of the following:

  2. Run the kubectl kots get backups command to get the list of full backups for the instance.

  3. Run the following command to restore a full backup:

    kubectl kots restore --from-backup BACKUP

    Replace BACKUP with the the name of the backup to restore from.

    For more information about the available options for the kots restore command, including application-only and Admin Console-only options, see restore.

Online Embedded kURL Clusters​

note

If you are restoring to a healthy cluster, you can skip the installation and configuration steps and continue to running the get backups and restore commands in the last two steps.

To restore a full backup in a kURL cluster:

  1. (New or Unhealthy Clusters Only) Provision a cluster with kURL and install the target application in the cluster. See Online Installation with kURL.

  2. (New or Unhealthy Clusters Only) In the new kURL cluster, configure a storage destination that holds the backup you want to use:

  3. Run the kubectl kots get backups command to get the list of full backups for the instance.

  4. Run the following command to restore a full backup:

    kubectl kots restore --from-backup BACKUP

    Replace BACKUP with the the name of the backup to restore from.

    For more information about the available options for the kots restore command, including application-only and Admin Console-only options, see restore.

Air Gap kURL Clusters​

To restore a full backup in an air gap kURL cluster:

  1. Run the following command to install a new cluster and provide kURL with the correct registry IP address. kURL must be able to assign the same IP address to the embedded private image registry in the new cluster.

    cat install.sh | sudo bash -s airgap kurl-registry-ip=IP

    Replace IP with the registry IP address.

  2. Use the KOTS CLI to configure Velero to use a storage destination. The storage backend used for backups must be accessible from the new cluster.

  3. Run the kubectl kots get backups command to get the list of full backups for the instance.

  4. Run the following command to restore a full backup:

    kubectl kots restore --from-backup BACKUP

    Replace BACKUP with the the name of the backup to restore from.

    For more information about the available options for the kots restore command, including application-only and Admin Console-only options, see restore.

Restore the Application Only Using the Admin Console​

You can restore an application from a full or partial backup using the Admin Console.

Restore an Application From a Full Backup​

To restore an application from a full backup:

  1. Select Full Snapshots (Instance) from the Snapshots tab.

    Full Snapshot tab

    View a larger version of this image

  2. Click the Restore from this backup icon (the circular blue arrows) for the backup that you want to restore.

  3. In the Restore from backup dialog, select Partial restore.

    Restore Full Snapshot dialog

    View a larger version of this image

    note

    You can also get the CLI commands for full restores or Admin Console only restores from this dialog.

  4. At the bottom of the dialog, enter the application slug provided by your software vendor. For more information, see Get the Application Slug in Managing Applications.

  5. Click Confirm and restore.

Restore an Application From a Partial Backup​

To restore an application from a partial backup:

  1. Select Partial Snapshots (Application) from the Snapshots tab.

    Partial Snapshot tab

    View a larger version of this image

  2. Click the Restore from this backup icon (the circular blue arrows) for the backup that you want to restore.

    The Restore from Partial backup (Application) dialog opens.

  3. Under Type your application slug to continue, enter the application slug provided by your software vendor. For more information, see Get the Application Slug in Managing Applications.

    Restore Partial Snapshot dialog

    View a larger version of this image

  4. Click Confirm and restore.

Additional Resources​

Troubleshooting Snapshots