snapshots-restoring-full.mdx

import RestoreTable from "../partials/snapshots/_restoreTable.mdx" import RestoreTypes from "../partials/snapshots/_restore-types.mdx" import GetBackups from "../partials/snapshots/_step-get-backups.mdx" import Restore from "../partials/snapshots/_step-restore.mdx" import Dr from "../partials/snapshots/_limitation-dr.mdx" import Os from "../partials/snapshots/_limitation-os.mdx" import InstallMethod from "../partials/snapshots/_limitation-install-method.mdx" import CliRestores from "../partials/snapshots/_limitation-cli-restores.mdx"

Restoring from Backups

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

Overview

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:

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 {#full-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 :::

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

• Existing Clusters
• Online kURL Clusters
• Air Gap kURL Clusters

Existing Clusters {#existing}

:::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:

   • 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.

Online Embedded kURL Clusters {#online}

:::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:

   • 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.

Air Gap kURL Clusters {#air-gapped}

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.

   • 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.

Restore the Application Only Using the Admin Console {#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.

   

   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.

   

   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.

   

   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.

   

   View a larger version of this image

4. Click Confirm and restore.

Additional Resources

Troubleshooting Snapshots