Restoring from Backups

Full restores and admin console only restores must be done using the kots CLI because the admin console gets recreated and the admin console UI is disconnected during this process.

Partial restores (application only) can be done using the:

• kots CLI from a full backup
• admin console from either a full or partial backup

For more information about the restore process, see About Restores in About Backup and Restore.

Restore from the CLI

From a full backup, you can do any of the following types of restores using the kots CLI:

• Full restore: Restores the admin console and the application
• Partial restore: Restores the application only
• Admin console: Restores the admin console only

Use the corresponding CLI procedure for your environment:

• Existing Clusters
• Online Kubernetes Installer Clusters
• Air Gapped Kubernetes Installer Clusters

Existing Clusters

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 backup on an existing cluster:

1. (New or Unhealthy Clusters Only) Install a version of Velero compatible with the one that was used to make the snapshot backup:

   • Host Path: See Configuring a Host Path Storage Destination
   • NFS: See Configuring an NFS Storage Destination or for the configuration steps and how to set up Velero.
   • AWS, GCP, Azure, or other S3: See Configuring Other Storage Destinations.

2. Run the kubectl kots get backups command to get a list of backups.

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 restore options, including application only and admin console only, see restore in Reference.

Online Kubernetes Installer Clusters

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 backup on a Kubernetes installer-created cluster:

1. (New or Unhealthy Clusters Only) Provision a Kubernetes installer cluster and install the application. See Installing with the Kubernetes Installer.

2. (New or Unhealthy Clusters Only) Configure a storage destination that holds the backup you want to use:

   • Host Path: See Configuring a Host Path Storage Destination
   • NFS: See Configuring an NFS Storage Destination or for the configuration steps and how to set up Velero.
   • AWS, GCP, Azure, or other S3: See Configuring Other Storage Destinations.

3. Run the kubectl kots get backups command to get a list of backups.

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 restore options, including application only and admin console only, see restore in Reference.

Air Gapped Kubernetes Installer Clusters

To restore a backup on an air gapped Kubernetes installer cluster:

1. Run the following command to install a new cluster and provide the Kubernetes installer with the correct registry IP address. The Kubernetes installer 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.

   • Host Path: See Configuring a Host Path Storage Destination
   • NFS: See Configuring an NFS Storage Destination or for the configuration steps and how to set up Velero.
   • S3-Compatible: See Configure S3-Compatible Storage for Air Gapped Environments in Configuring Other Storage Destinations.

3. Run the kubectl kots get backups command to get a list of backups.

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 restore options, including application only and admin console only, see restore in Reference.

Restore the Application from the Admin Console

You can restore the application only, known as a partial restore, from either a full backup or a partial backup in the admin console.

Alternatively, you can use the kots CLI to restore any type of backup. See Restore Any Backup from the CLI.

Use a Full Backup to do a Partial Restore

To use a full backup to do a partial restore in the admin console:

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

   

   View a larger 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.

   

   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.

5. Click Confirm and restore.

Use a Partial Backup to do a Partial Restore

To use a partial backup to do a partial restore in the admin console:

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

   

   View a larger 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.

   

4. Click Confirm and restore.

Additional Resources

Troubleshooting Backup and Restore