Merge pull request #2355 from replicatedhq/105074

Clarifying the limitations of restoring from full versus partial snapshots

docs/enterprise/snapshots-restoring-full.md → docs/enterprise/snapshots-restoring-full.mdx

@@ -1,82 +1,90 @@
 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
 
-Full restores and Replicated admin console only restores must be done using the Replicated kots CLI because the admin console gets recreated and the admin console UI is disconnected during this process.
+This topic describes how to restore from full or partial backups using Replicated snapshots.
 
-Partial restores (application only) can be done using the:
+## Overview
 
-- kots CLI from a full backup
-- Admin console from either a full or partial backup
+<RestoreTypes/>
 
-For more information about the restore process, see [About Restores](snapshots-understanding#restores) in _About Backup and 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.
 
-## Restore from the CLI {#full-cli}
+## Limitations
 
-From a full backup, you can do any of the following types of restores using the kots CLI:
+The following limitations apply to restoring from backups using snapshots:
 
-- **Full restore:** Restores the admin console and the application
-- **Partial restore:** Restores the application only
-- **Admin console:** Restores the admin console only
+* <Dr/>
+* <Os/>
+* <InstallMethod/>
+* <CliRestores/>
 
-Use the corresponding CLI procedure for your environment:
+For a full list of limitations and considerations related to the snapshots feature, see  [Limitations and Considerations](snapshots-understanding#limitations-and-considerations) in _About Backup and Restore_. 
 
-- [Existing Clusters](#existing)
-- [Online Embedded kURL Clusters](#online)
-- [Air Gapped Embedded kURL Clusters](#air-gapped)
+## 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
+<CliRestores/>
+:::
 
+To restore using the CLI, see the corresponding procedure for your environment:
+
+- [Existing Clusters](#existing)
+- [Online kURL Clusters](#online)
+- [Air Gap kURL Clusters](#air-gapped)
 
 ### 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 backup on an existing cluster:
+To restore a full backup in 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:
+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](snapshots-configuring-hostpath)
     * **NFS:** See [Configuring an NFS Storage Destination](snapshots-configuring-nfs) or  for the configuration steps and how to set up Velero.
     * **AWS, GCP, Azure, or other S3:** See [Configuring Other Storage Destinations](snapshots-storage-destinations). 
 
-1. Run the `kubectl kots get backups` command to get a list of backups.
-
-1. Run the following command to restore a full backup: 
+1. <GetBackups/>
 
-    ```bash
-    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](/reference/kots-cli-restore-index/) in _Reference_.
+1. <Restore/>
 
 ### 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 backup in an embedded kURL cluster:
+To restore a full backup in a kURL cluster:
 
-1. (New or Unhealthy Clusters Only) Provision an embedded cluster with Replicated kURL and install the application. See [Online Installation with kURL](installing-embedded-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](installing-embedded-cluster).
 
-1. (New or Unhealthy Clusters Only) Configure a storage destination that holds the backup you want to use:
+1. (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](snapshots-configuring-hostpath)
     * **NFS:** See [Configuring an NFS Storage Destination](snapshots-configuring-nfs) or  for the configuration steps and how to set up Velero.
     * **AWS, GCP, Azure, or other S3:** See [Configuring Other Storage Destinations](snapshots-storage-destinations).
 
-1. Run the `kubectl kots get backups` command to get a list of backups.
+1. <GetBackups/>
 
-1. Run the following command to restore a full backup: 
+1. <Restore/>
 
-    ```bash
-    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](/reference/kots-cli-restore-index/) in _Reference_.
-
-### Air Gapped Embedded kURL Clusters {#air-gapped}
+### Air Gap kURL Clusters {#air-gapped}
 
-To restore a backup in an air gapped embedded kURL cluster:
+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.
 
@@ -92,39 +100,32 @@ To restore a backup in an air gapped embedded kURL cluster:
     * **NFS:** See [Configuring an NFS Storage Destination](snapshots-configuring-nfs) or  for the configuration steps and how to set up Velero.
     * **S3-Compatible:** See [Configure S3-Compatible Storage for Air Gapped Environments](snapshots-storage-destinations#configure-s3-compatible-storage-for-air-gapped-environments) in _Configuring Other Storage Destinations_.
 
-1. Run the `kubectl kots get backups` command to get a list of backups.
+1. <GetBackups/>
 
-1. Run the following command to restore a full backup: 
+1. <Restore/>
 
-    ```bash
-    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](/reference/kots-cli-restore-index/) in _Reference_.
+## Restore the Application Only Using the Admin Console {#admin-console}
 
-## Restore the Application from the Admin Console {#admin-console}
+You can restore an application from a full or partial backup using 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.
+### Restore an Application From a Full Backup
 
-Alternatively, you can use the kots CLI to restore any type of backup. See [Restore Any Backup from the CLI](#full-cli).
-
-### Use a Full Backup to do a Partial Restore
-
-To use a full backup to do a partial restore in the admin console:
+To restore an application from a full backup:
 
 1. Select **Full Snapshots (Instance)** from the Snapshots tab.
 
     ![Full Snapshot tab](/images/full-snapshot-tab.png)
 
-    [View a larger image](/images/full-snapshot-tab.png)
+    [View a larger version of this image](/images/full-snapshot-tab.png)
 
 1. Click the **Restore from this backup** icon (the circular blue arrows) for the backup that you want to restore.
 
 1. In the **Restore from backup** dialog, select **Partial restore**.
 
     ![Restore Full Snapshot dialog](/images/restore-backup-dialog.png)
 
+    [View a larger version of this image](/images/restore-backup-dialog.png)
+
     :::note
     You can also get the CLI commands for full restores or admin console only restores from this dialog.
     :::     
@@ -133,15 +134,15 @@ To use a full backup to do a partial restore in the admin console:
 
 1. Click **Confirm and restore**.
 
-### Use a Partial Backup to do a Partial Restore
+### Restore an Application From a Partial Backup 
 
-To use a partial backup to do a partial restore in the admin console:
+To restore an application from a partial backup:
 
 1. Select **Partial Snapshots (Application)** from the Snapshots tab.
 
     ![Partial Snapshot tab](/images/partial-snapshot-tab.png)
 
-    [View a larger image](/images/partial-snapshot-tab.png)
+    [View a larger version of this image](/images/partial-snapshot-tab.png)
 
 1. Click the **Restore from this backup** icon (the circular blue arrows) for the backup that you want to restore.
 
@@ -151,8 +152,10 @@ To use a partial backup to do a partial restore in the admin console:
 
     ![Restore Partial Snapshot dialog](/images/restore-partial-dialog.png)
 
+    [View a larger version of this image](/images/restore-partial-dialog.png)
+
 1. Click **Confirm and restore**.
 
 ## Additional Resources
 
-[Troubleshooting Backup and Restore](snapshots-troubleshooting-backup-restore)
+[Troubleshooting Backup and Restore](snapshots-troubleshooting-backup-restore)