From f0cdb3615241dab8ed8a94cb7f9be4c6c7a66cf9 Mon Sep 17 00:00:00 2001 From: Catherine Luse Date: Mon, 5 Oct 2020 10:09:21 -0700 Subject: [PATCH] Update backup and restore docs --- content/rancher/v2.x/en/backups/_index.md | 17 +++++----- .../configuration/backup-config/_index.md | 7 ++-- .../configuration/restore-config/_index.md | 33 ++++++++++++------- .../configuration/storage-config/_index.md | 1 + .../v2.x/en/backups/docker-installs/_index.md | 10 ++++++ .../docker-backups}/_index.md | 1 + .../docker-restores}/_index.md | 4 +-- .../rancher/v2.x/en/backups/legacy/_index.md | 6 ++-- .../v2.x/en/backups/legacy/backup/_index.md | 2 +- .../{k8s-backups => }/ha-backups/_index.md | 0 .../{k8s-backups => }/k3s-backups/_index.md | 0 .../legacy/backup/k8s-backups/_index.md | 8 ----- .../v2.x/en/backups/legacy/restore/_index.md | 2 +- .../{k8s-restore => }/k3s-restore/_index.md | 0 .../legacy/restore/k8s-restore/_index.md | 6 ---- .../{k8s-restore => }/rke-restore/_index.md | 0 .../en/backups/restoring-rancher/_index.md | 2 +- 17 files changed, 53 insertions(+), 46 deletions(-) create mode 100644 content/rancher/v2.x/en/backups/docker-installs/_index.md rename content/rancher/v2.x/en/backups/{legacy/backup/single-node-backups => docker-installs/docker-backups}/_index.md (99%) rename content/rancher/v2.x/en/backups/{legacy/restore/single-node-restoration => docker-installs/docker-restores}/_index.md (92%) rename content/rancher/v2.x/en/backups/legacy/backup/{k8s-backups => }/ha-backups/_index.md (100%) rename content/rancher/v2.x/en/backups/legacy/backup/{k8s-backups => }/k3s-backups/_index.md (100%) delete mode 100644 content/rancher/v2.x/en/backups/legacy/backup/k8s-backups/_index.md rename content/rancher/v2.x/en/backups/legacy/restore/{k8s-restore => }/k3s-restore/_index.md (100%) delete mode 100644 content/rancher/v2.x/en/backups/legacy/restore/k8s-restore/_index.md rename content/rancher/v2.x/en/backups/legacy/restore/{k8s-restore => }/rke-restore/_index.md (100%) diff --git a/content/rancher/v2.x/en/backups/_index.md b/content/rancher/v2.x/en/backups/_index.md index 5399851e1f9..9ecad4552e6 100644 --- a/content/rancher/v2.x/en/backups/_index.md +++ b/content/rancher/v2.x/en/backups/_index.md @@ -3,12 +3,13 @@ title: Backups and Disaster Recovery weight: 5 --- -In this section, you'll learn how to create backups of Rancher, how to restore Rancher from backup, and how to migrate Rancher to a new server. +In this section, you'll learn how to create backups of Rancher, how to restore Rancher from backup, and how to migrate Rancher to a new Kubernetes cluster. -Rancher version must be v2.5.0 and up to use this approach of backing up and restoring Rancher. +The Rancher version must be v2.5.0 and up to use this approach of backing up and restoring Rancher. As of Rancher v2.5, the `rancher-backup` operator is used to backup and restore Rancher. The Helm chart is [here.](https://github.com/rancher/charts/tree/main/charts/rancher-backup) - [Changes in Rancher v2.5](#changes-in-rancher-v2-5) -- [Backup and Restore for Rancher Prior to v2.5](#backup-and-restore-for-rancher-prior-to-v2-5) + - [Backup and Restore for Rancher v2.5 installed with Docker](#backup-and-restore-for-rancher-v2-5-installed-with-docker) + - [Backup and Restore for Rancher installed on a Kubernetes Cluster Prior to v2.5](#backup-and-restore-for-rancher-installed-on-a-kubernetes-cluster-prior-to-v2-5) - [How Backups and Restores Work](#how-backups-and-restores-work) - [Installing the rancher-backup Operator](#installing-the-rancher-backup-operator) - [Installing rancher-backup with the Rancher UI](#installing-rancher-backup-with-the-rancher-ui) @@ -19,7 +20,7 @@ Rancher version must be v2.5.0 and up to use this approach of backing up and res - [Default Storage Location Configuration](#default-storage-location-configuration) - [Example values.yaml for the rancher-backup Helm Chart](#example-values-yaml-for-the-rancher-backup-helm-chart) -### Changes in Rancher v2.5 +# Changes in Rancher v2.5 The new `rancher-backup` operator allows Rancher to be backed up and restored on any Kubernetes cluster. This application is a Helm chart, and it can be deployed through the Rancher **Apps & Marketplace** page, or by using the Helm CLI. @@ -31,16 +32,16 @@ In Rancher v2.5, it is now supported to install Rancher hosted Kubernetes cluste ### Backup and Restore for Rancher v2.5 installed with Docker -For Rancher installed with Docker, refer to the same steps used up till 2.5 for [single node backups]({{}}/rancher/v2.x/en/backups/legacy/backup/single-node-backups/) and [restore]({{}}/rancher/v2.x/en/backups/legacy/restore/single-node-restoration/) documentation. +For Rancher installed with Docker, refer to the same steps used up till 2.5 for [backups](./docker-installs/docker-backups) and [restores.](./docker-installs/docker-backups) -### Backup and Restore for Rancher installed on Kubernetes cluster Prior to v2.5 +### Backup and Restore for Rancher installed on a Kubernetes Cluster Prior to v2.5 For Rancher prior to v2.5, the way that Rancher is backed up and restored differs based on the way that Rancher was installed. Our legacy backup and restore documentation is here: - For Rancher installed on an RKE Kubernetes cluster, refer to the legacy [backup]({{}}/rancher/v2.x/en/backups/legacy/backup/k8s-backups/ha-backups/) and [restore]({{}}/rancher/v2.x/en/backups/legacy/restore/k8s-restore/rke-restore/) documentation. - For Rancher installed on a K3s Kubernetes cluster, refer to the legacy [backup]({{}}/rancher/v2.x/en/backups/legacy/backup/k8s-backups/k3s-backups/) and [restore]({{}}/rancher/v2.x/en/backups/legacy/restore/k8s-restore/k3s-restore/) documentation. -### How Backups and Restores Work +# How Backups and Restores Work The `rancher-backup` operator introduces three custom resources: Backups, Restores, and ResourceSets. The following cluster-scoped custom resource definitions are added to the cluster: @@ -48,7 +49,7 @@ The `rancher-backup` operator introduces three custom resources: Backups, Restor - `resourcesets.resources.cattle.io` - `restores.resources.cattle.io` -The ResourceSet defines which Kubernetes resources need to be backed up. The ResourceSet is not available to be configured in the Rancher UI because the values required to back up Rancher are predefined. +The ResourceSet defines which Kubernetes resources need to be backed up. The ResourceSet is not available to be configured in the Rancher UI because the values required to back up Rancher are predefined. This ResourceSet should not be modified. When a Backup custom resource is created, the `rancher-backup` operator calls the `kube-apiserver` to get the resources in the ResourceSet (specifically, the predefined `rancher-resource-set`) that the Backup custom resource refers to. diff --git a/content/rancher/v2.x/en/backups/configuration/backup-config/_index.md b/content/rancher/v2.x/en/backups/configuration/backup-config/_index.md index ee44cb76a1d..adbb9e065f1 100644 --- a/content/rancher/v2.x/en/backups/configuration/backup-config/_index.md +++ b/content/rancher/v2.x/en/backups/configuration/backup-config/_index.md @@ -24,11 +24,10 @@ The Backup Create page lets you configure a schedule, enable encryption and spec Select the first option to perform a one-time backup, or select the second option to schedule recurring backups. Selecting **Recurring Backups** lets you configure following two fields: -1. **Schedule**: This field accepts +- **Schedule**: This field accepts - Standard [cron expressions](https://en.wikipedia.org/wiki/Cron), such as `"0 * * * *"` - Descriptors, such as `"@midnight"` or `"@every 1h30m"` - -1. **Retention Count**: This value specifies how many backup files must be retained. If files exceed the given retentionCount, the oldest files will be deleted. The default value is 10. +- **Retention Count**: This value specifies how many backup files must be retained. If files exceed the given retentionCount, the oldest files will be deleted. The default value is 10. {{< img "/img/rancher/backup_restore/backup/schedule.png" "">}} @@ -77,6 +76,8 @@ In the example command above, the name `encryptionconfig` can be changed to anyt {{< img "/img/rancher/backup_restore/backup/storageLocation.png" "">}} +If the StorageLocation is specified in the Backup, the operator will retrieve the backup location from that particular S3 bucket. If not specified, the operator will try to find this file in the default operator-level S3 store, and in the operator-level PVC store. The default storage location is configured during the deployment of the `rancher-backup` operator. + Selecting the first option stores this backup in the storage location configured while installing the rancher-backup chart. The second option lets you configure a different S3 compatible storage provider for storing the backup. ### S3 diff --git a/content/rancher/v2.x/en/backups/configuration/restore-config/_index.md b/content/rancher/v2.x/en/backups/configuration/restore-config/_index.md index 91e17a171da..fbd9b1368c2 100644 --- a/content/rancher/v2.x/en/backups/configuration/restore-config/_index.md +++ b/content/rancher/v2.x/en/backups/configuration/restore-config/_index.md @@ -9,32 +9,41 @@ The Restore Create page lets you provide details of the backup to restore from {{< img "/img/rancher/backup_restore/restore/restore.png" "">}} - [Backup Source](#backup-source) - - [Getting the Backup Filename from S3](#getting-the-backup-filename-from-s3) + - [An Existing Backup Config](#an-existing-backup-config) + - [The default storage target](#the-default-storage-target) + - [An S3-compatible object store](#an-s3-compatible-object-store) - [Encryption](#encryption) -- [StorageLocation](#storagelocation) - [Prune during restore](#prune-during-restore) +- [Getting the Backup Filename from S3](#getting-the-backup-filename-from-s3) - -### Backup Source +# Backup Source Provide details of the backup file and its storage location, which the operator will then use to perform the restore. Select from the following options to provide these details + + +### An existing backup config + +Selecting this option will populate the **Target Backup** dropdown with the Backups available in this cluster. Select the Backup from the dropdown, and that will fill out the **Backup Filename** field for you, and will also pass the backup source information from the selected Backup to the operator. + {{< img "/img/rancher/backup_restore/restore/existing.png" "">}} -* **An existing backup config**: Selecting this option will populate the **Target Backup** dropdown with the Backups available in this cluster. Select the Backup from the dropdown, and that will fill out the **Backup Filename** field for you, and will also pass the backup source information from the selected Backup to the operator. +If the Backup custom resource does not exist in the cluster, you need to get the exact filename and provide the backup source details with the default storage target or an S3-compatible object store. -If the Backup custom resource does not exist in the cluster, you need to get the exact filename and provide the backup source details with either of the following options: +### The default storage target + +Select this option if you are restoring from a backup file that exists in the default storage location configured at the operator-level. The operator-level configuration is the storage location that was configured when the `rancher-backup` operator was installed or upgraded. Provide the exact filename in the **Backup Filename** field. {{< img "/img/rancher/backup_restore/restore/default.png" "">}} -* **The default storage target**: Select this option if you are restoring from a backup file that exists in the default storage location configured at the operator-level. The operator-level configuration is the storage location that was configured when the `rancher-backup` operator was installed or upgraded. Provide the exact filename in the **Backup Filename** field. +### An S3-compatible object store + +Select this option if no default storage location is configured at the operator-level, OR if the backup file exists in a different S3 bucket than the one configured as the default storage location. Provide the exact filename in the **Backup Filename** field. Refer to [this section](#getting-the-backup-filename-from-s3) for exact steps on getting the backup filename from s3. Fill in all the details for the S3 compatible object store. Its fields are exactly same as ones for the `backup.StorageLocation` configuration in the [Backup custom resource.](../../configuration/backup-config/#storagelocation) {{< img "/img/rancher/backup_restore/restore/s3store.png" "">}} -* **An S3-compatible object store**: Select this option if no default storage location is configured at the operator-level, OR if the backup file exists in a different S3 bucket than the one configured as the default storage location. Provide the exact filename in the **Backup Filename** field. Refer [this section](#getting-the-backup-filename-from-s3) for exact steps on getting the backup filename from s3. Fill in all the details for the S3 compatible object store. Its fields are exactly same as ones for the `backup.StorageLocation` configuration in the [Backup custom resource.](../../configuration/backup-config/#storagelocation) - -### Encryption +# Encryption If the backup was created with encryption enabled, its file will have `.enc` suffix. Choosing such a Backup, or providing a backup filename with `.enc` suffix will display another dropdown named **Encryption Config Secret**. @@ -51,7 +60,7 @@ The `Encryption Config Secret` dropdown will filter out and list only those Secr > **Important** This field should only be set if the backup was created with encryption enabled. Providing the incorrect encryption config will cause the restore to fail. -### Prune during restore +# Prune During Restore * **Prune**: In order to fully restore Rancher from a backup, and to go back to the exact state it was at when the backup was performed, we need to delete any additional resources that were created by Rancher after the backup was taken. The operator does so if the **Prune** flag is enabled. Prune is enabled by default and it is recommended to keep it enabled. * **Delete Timeout**: This is the amount of time the operator will wait while deleting a resource before editing the resource to remove finalizers and attempt deletion again. @@ -61,7 +70,7 @@ This field should only be set if the backup was created with encryption enabled. | `prune` | Delete the resources managed by Rancher that are not present in the backup (Recommended). | | `deleteTimeoutSeconds` | Amount of time the operator will wait while deleting a resource before editing the resource to remove finalizers and attempt deletion again. | -### Getting the Backup Filename from S3 +# Getting the Backup Filename from S3 This is the name of the backup file that the `rancher-backup` operator will use to perform the restore. diff --git a/content/rancher/v2.x/en/backups/configuration/storage-config/_index.md b/content/rancher/v2.x/en/backups/configuration/storage-config/_index.md index 7650ce3b511..1ebb4259b85 100644 --- a/content/rancher/v2.x/en/backups/configuration/storage-config/_index.md +++ b/content/rancher/v2.x/en/backups/configuration/storage-config/_index.md @@ -32,6 +32,7 @@ You can choose to not have any operator-level storage location configured. If yo | Folder | The [folder in the S3 bucket](https://docs.aws.amazon.com/AmazonS3/latest/user-guide/using-folders.html) where the backups will be stored. | | Endpoint | The [S3 endpoint](https://docs.aws.amazon.com/general/latest/gr/s3.html) For example, `s3.us-west-2.amazonaws.com`. | | Endpoint CA | The CA cert used to for the S3 endpoint. Default: base64 encoded CA cert | +| insecureTLSSkipVerify | Set to true if you are not using TLS. | ### Existing StorageClass diff --git a/content/rancher/v2.x/en/backups/docker-installs/_index.md b/content/rancher/v2.x/en/backups/docker-installs/_index.md new file mode 100644 index 00000000000..3f818e0faf8 --- /dev/null +++ b/content/rancher/v2.x/en/backups/docker-installs/_index.md @@ -0,0 +1,10 @@ +--- +title: Backup and Restore for Rancher Installed with Docker +shortTitle: Docker Installs +weight: 10 +--- + +The steps for backing up and restoring Rancher installed with Docker did not change in Rancher v2.5. + +- [Backups](./docker-backups) +- [Restores](./docker-restores) \ No newline at end of file diff --git a/content/rancher/v2.x/en/backups/legacy/backup/single-node-backups/_index.md b/content/rancher/v2.x/en/backups/docker-installs/docker-backups/_index.md similarity index 99% rename from content/rancher/v2.x/en/backups/legacy/backup/single-node-backups/_index.md rename to content/rancher/v2.x/en/backups/docker-installs/docker-backups/_index.md index d8ff02e977c..d06c933dda6 100644 --- a/content/rancher/v2.x/en/backups/legacy/backup/single-node-backups/_index.md +++ b/content/rancher/v2.x/en/backups/docker-installs/docker-backups/_index.md @@ -7,6 +7,7 @@ aliases: - /rancher/v2.x/en/installation/after-installation/single-node-backup-and-restoration/ --- + After completing your Docker installation of Rancher, we recommend creating backups of it on a regular basis. Having a recent backup will let you recover quickly from an unexpected disaster. ## Before You Start diff --git a/content/rancher/v2.x/en/backups/legacy/restore/single-node-restoration/_index.md b/content/rancher/v2.x/en/backups/docker-installs/docker-restores/_index.md similarity index 92% rename from content/rancher/v2.x/en/backups/legacy/restore/single-node-restoration/_index.md rename to content/rancher/v2.x/en/backups/docker-installs/docker-restores/_index.md index ce66594f4fa..6f79b790e63 100644 --- a/content/rancher/v2.x/en/backups/legacy/restore/single-node-restoration/_index.md +++ b/content/rancher/v2.x/en/backups/docker-installs/docker-restores/_index.md @@ -11,7 +11,7 @@ If you encounter a disaster scenario, you can restore your Rancher Server to you ## Before You Start -During restoration of your backup, you'll enter a series of commands, filling placeholders with data from your environment. These placeholders are denoted with angled brackets and all capital letters (``). Here's an example of a command with a placeholder: +During restore of your backup, you'll enter a series of commands, filling placeholders with data from your environment. These placeholders are denoted with angled brackets and all capital letters (``). Here's an example of a command with a placeholder: ``` docker run --volumes-from -v $PWD:/backup \ @@ -69,4 +69,4 @@ Using a [backup]({{}}/rancher/v2.x/en/backups/backups/single-node-backu docker start ``` -1. Wait a few moments and then open Rancher in a web browser. Confirm that the restoration succeeded and that your data is restored. +1. Wait a few moments and then open Rancher in a web browser. Confirm that the restore succeeded and that your data is restored. diff --git a/content/rancher/v2.x/en/backups/legacy/_index.md b/content/rancher/v2.x/en/backups/legacy/_index.md index 3b35e376401..5033e89d4db 100644 --- a/content/rancher/v2.x/en/backups/legacy/_index.md +++ b/content/rancher/v2.x/en/backups/legacy/_index.md @@ -3,9 +3,6 @@ title: Legacy Backup and Restore Documentation weight: 6 --- -> This section is under construction. - - This section is devoted to protecting your data in a disaster scenario. To protect yourself from a disaster scenario, you should create backups on a regular basis. @@ -13,10 +10,11 @@ To protect yourself from a disaster scenario, you should create backups on a reg - Rancher server backups: - [Rancher installed on a K3s Kubernetes cluster](./backups/k3s-backups) - [Rancher installed on an RKE Kubernetes cluster](./backups/ha-backups) - - [Rancher installed with Docker](./backups/single-node-backups/) - [Backing up Rancher Launched Kubernetes Clusters]({{}}/rancher/v2.x/en/cluster-admin/backing-up-etcd/) In a disaster scenario, you can restore your `etcd` database by restoring a backup. - [Rancher Server Restorations]({{}}/rancher/v2.x/en/backups/restorations) - [Restoring Rancher Launched Kubernetes Clusters]({{}}/rancher/v2.x/en/cluster-admin/restoring-etcd/) + +For Rancher installed with Docker, the backup and restore procedure is the same in Rancher v2.5. The backup and restore instructions for Docker installs are [here.]({{}}/rancher/v2.x/en/backups/docker-installs) \ No newline at end of file diff --git a/content/rancher/v2.x/en/backups/legacy/backup/_index.md b/content/rancher/v2.x/en/backups/legacy/backup/_index.md index 1a776f62c29..2bad5e462b6 100644 --- a/content/rancher/v2.x/en/backups/legacy/backup/_index.md +++ b/content/rancher/v2.x/en/backups/legacy/backup/_index.md @@ -10,6 +10,6 @@ This section contains information about how to create backups of your Rancher da - [Backing up Rancher installed on a K3s Kubernetes cluster](./k3s-backups) - [Backing up Rancher installed on an RKE Kubernetes cluster](./ha-backups/) -- [Backing up Rancher installed with Docker](./single-node-backups/) +- [Backing up Rancher installed with Docker]({{}}/rancher/v2.x/en/backups/docker-installs/docker-backups) If you are looking to back up your [Rancher launched Kubernetes cluster]({{}}/rancher/v2.x/en/cluster-provisioning/rke-clusters/), please refer [here]({{}}/rancher/v2.x/en/cluster-admin/backing-up-etcd/). diff --git a/content/rancher/v2.x/en/backups/legacy/backup/k8s-backups/ha-backups/_index.md b/content/rancher/v2.x/en/backups/legacy/backup/ha-backups/_index.md similarity index 100% rename from content/rancher/v2.x/en/backups/legacy/backup/k8s-backups/ha-backups/_index.md rename to content/rancher/v2.x/en/backups/legacy/backup/ha-backups/_index.md diff --git a/content/rancher/v2.x/en/backups/legacy/backup/k8s-backups/k3s-backups/_index.md b/content/rancher/v2.x/en/backups/legacy/backup/k3s-backups/_index.md similarity index 100% rename from content/rancher/v2.x/en/backups/legacy/backup/k8s-backups/k3s-backups/_index.md rename to content/rancher/v2.x/en/backups/legacy/backup/k3s-backups/_index.md diff --git a/content/rancher/v2.x/en/backups/legacy/backup/k8s-backups/_index.md b/content/rancher/v2.x/en/backups/legacy/backup/k8s-backups/_index.md deleted file mode 100644 index 0221ac77312..00000000000 --- a/content/rancher/v2.x/en/backups/legacy/backup/k8s-backups/_index.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -title: Kubernetes Backups -weight: 1 -aliases: - - /rancher/v2.x/en/backups/backups/k8s-backups ---- - -> This section is under construction. \ No newline at end of file diff --git a/content/rancher/v2.x/en/backups/legacy/restore/_index.md b/content/rancher/v2.x/en/backups/legacy/restore/_index.md index d90a64cc4d0..9acfbf7ad73 100644 --- a/content/rancher/v2.x/en/backups/legacy/restore/_index.md +++ b/content/rancher/v2.x/en/backups/legacy/restore/_index.md @@ -6,7 +6,7 @@ aliases: --- If you lose the data on your Rancher Server, you can restore it if you have backups stored in a safe location. -- [Restoring Backups—Docker Installs]({{}}/rancher/v2.x/en/backups/restorations/single-node-restoration/) +- [Restoring Backups—Docker Installs]({{}}/rancher/v2.x/en/backups/docker-installs/docker-restores) - [Restoring Backups—Kubernetes installs]({{}}/rancher/v2.x/en/backups/restorations/ha-restoration/) If you are looking to restore your [Rancher launched Kubernetes cluster]({{}}/rancher/v2.x/en/cluster-provisioning/rke-clusters/), please refer [here]({{}}/rancher/v2.x/en/cluster-admin/restoring-etcd/). diff --git a/content/rancher/v2.x/en/backups/legacy/restore/k8s-restore/k3s-restore/_index.md b/content/rancher/v2.x/en/backups/legacy/restore/k3s-restore/_index.md similarity index 100% rename from content/rancher/v2.x/en/backups/legacy/restore/k8s-restore/k3s-restore/_index.md rename to content/rancher/v2.x/en/backups/legacy/restore/k3s-restore/_index.md diff --git a/content/rancher/v2.x/en/backups/legacy/restore/k8s-restore/_index.md b/content/rancher/v2.x/en/backups/legacy/restore/k8s-restore/_index.md deleted file mode 100644 index c0dd69de384..00000000000 --- a/content/rancher/v2.x/en/backups/legacy/restore/k8s-restore/_index.md +++ /dev/null @@ -1,6 +0,0 @@ ---- -title: Kubernetes Installs -weight: 1 -aliases: - - /rancher/v2.x/en/backups/restorations/k8s-restore ---- \ No newline at end of file diff --git a/content/rancher/v2.x/en/backups/legacy/restore/k8s-restore/rke-restore/_index.md b/content/rancher/v2.x/en/backups/legacy/restore/rke-restore/_index.md similarity index 100% rename from content/rancher/v2.x/en/backups/legacy/restore/k8s-restore/rke-restore/_index.md rename to content/rancher/v2.x/en/backups/legacy/restore/rke-restore/_index.md diff --git a/content/rancher/v2.x/en/backups/restoring-rancher/_index.md b/content/rancher/v2.x/en/backups/restoring-rancher/_index.md index 6c050fbedd9..c7c07b8a9dd 100644 --- a/content/rancher/v2.x/en/backups/restoring-rancher/_index.md +++ b/content/rancher/v2.x/en/backups/restoring-rancher/_index.md @@ -9,7 +9,7 @@ A restore is performed by creating a Restore custom resource. * Follow the instructions from this page for restoring rancher on the same cluster where it was backed up from. In order to migrate rancher to a new cluster, follow the steps to [migrate rancher.](../migrating-rancher) * While restoring rancher on the same setup, the operator will scale down the rancher deployment when restore starts, and it will scale back up the deployment once restore completes. So Rancher will be unavailable during the restore. -### 1. Create the Restore Custom Resource +### Create the Restore Custom Resource 1. In the **Cluster Explorer,** go to the dropdown menu in the upper left corner and click **Rancher Backups.** 1. Click **Restore.**