Backup and recovery

This topic describes how to use the Backup and Recovery page on the console.

View the Backup Plans tab and the Details page

Prerequisites

• You have registered an account.

• You have created a backup plan.

View the Backup Plans tab

1. Log in to the KubeSphere Cloud platform with your account.

2. In the upper-right corner, hover your cursor over the username area and click Console from the drop-down list.

3. In the navigation pane on the left, click Backup and Recovery.

4. On the Backup Plans tab, you can view the following information:

   Parameter	Description
   Name	User-defined name of the backup plan. Click the name to view its details page.
   Backup Type	Backup type of the backup plan. The value can be Instant or Scheduled.
   Source Cluster	Source cluster associated with the backup plan.
   Backup Resources	Source namespace associated with the backup plan.
   Jobs	Number of backup jobs executed under the backup plan.
   Status	Current status of the backup plan, indicating the status of the latest backup job, including: Successful: The backup job is successful. In progress: The backup job is in progress. Error: The backup job fails.
   Backup Time	Time when the latest backup job was executed.
   Operations	Select one of the operations on the backup plan, including: Back Up: Execute a backup job immediately. Details: Click to view the backup plan details page. More: Click to select Delete from the drop-down list and confirm whether to delete the backup plan in the displayed dialog box. If the backup plan is deleted, the backup jobs under the backup plan cannot be restored. Please ensure that you understand the risks of this operation.

5. (Optional) Click the search box on the top of the backup plan list, enter the name of a backup plan or the name of a source namespace, and then press Enter to search for it.

6. (Optional) Click in the upper-right corner to refresh the backup plan list.

7. To create a backup plan, click Create Backup Plan in the upper-right corner. For more information, see Create a Backup Plan.

View the Backup Plan Details page

Click the name of a backup plan on the list page to enter its details page.

1. Click to enter the Edit Backup Plan page and modify its information. Name, Source Cluster, and Source Namespace cannot be modified.

2. After modifying the information, click Update or Update and Back Up, or click Cancel to exit editing.

3. The following table describes the information shown on the Backup Plan Details page.

   Parameter	Description
   Source Cluster	Source Kubernetes cluster associated with the backup plan.
   Source Namespace	Source namespace associated with the backup plan. If you selected Resource Template when you created the backup plan, Resource Template is displayed here.
   Object Storage Repository	Object storage repository (Bucket) used by the backup plan.
   Backup Type	Backup type of the backup plan.
   Volume Backup Method	Volume backup method of the backup plan, including: Copy Volumes and Use CSI Snapshot.
   Retained Snapshots	Number of retained snapshots.
   Snapshots Exported	Whether you select to export snapshots while you are creating a backup plan.
   Description	User-defined description of the backup plan.

4. The following table describes the information shown in the backup job list.

   Parameter	Description
   Job Name	Backup job name generated by the system.
   Creation Time	Time when the backup job was created.
   Retention (Days)	Retention duration specified by the backup plan.
   Resources	Number of resources backed up by the backup job.
   Volumes	Number of volumes backed up by the backup job.
   Status	Status of the backup job, including: In progress: The backup job is being executed. Successful: The backup job was successfully executed. Error: The backup job is not correctly configured. Job not found: The backup job is not found. Backup failed: The backup job fails. Not ready: The backup job is not ready. Job submitted: The backup job has been submitted. To be executed: The backup job is waiting for execution. Canceling: The backup job is being canceled. Canceled: The backup job has been canceled.

5. (Optional) Click the Select a time range box on the top of the backup job list, and select a date to filter the backup jobs.

6. To recover, cancel, or delete a backup job, click the radio button on the left of the backup job, and then click Recover, Cancel, or Delete on the top of the list.

View the Recovery Plans tab and the Details page

Prerequisites

• You have registered an account.

• You have created and successfully executed a backup plan.

• You have created a recovery plan.

View the Recovery Plans tab

1. On the Backup and Recovery page, click the Recovery Plans tab to view the recovery plan list page. The following table describes the information shown on the list page.

   Parameter	Description
   Name	User-defined name of the recovery plan. Click the name of a recovery plan to enter its details page.
   Target Cluster	Name of the target cluster associated with the recovery plan.
   Associated Backup Plan	Name of the backup plan associated with the recovery plan.
   Status	Status of the recovery plan, including: Successful: the recovery plan was successfully executed. In progress: the recovery job is being executed. Error: the recovery job failed.
   Recovery Time	Time when the recovery job was started.
   Operations	Select an operation on the recovery plan, which includes the following: Details: click to enter the recovery plan details page. More: click to select Delete from the drop-down list and confirm whether to delete the recovery plan in the displayed dialog box. If the recovery plan is deleted, the application recovery details will be unavailable. Please ensure you understand the risks of this operation.

2. (Optional) Click the search box on the top of the recovery plan list, enter the name of a recovery plan or the name of the associated backup plan, and then press Enter to search for it.

3. (Optional) Click in the upper-right corner to refresh the recovery plan list.

4. To create a recovery plan, click Create Recovery Plan in the upper-right corner. For more information, see Create a recovery plan.

View the Recovery Plan Details page

On the recovery plan list page, click the name of a recovery plan to enter its details page.

1. Click to enter the Edit Recovery Plan page and modify its information. Name, Target Cluster, and Target Namespace cannot be modified.

2. After modifying the information, click Update, or click Cancel to exit editing.

3. The following table describes the information shown on the Recovery Plan Details page.

   Parameter	Description
   Target Cluster	Name of the target cluster associated with the recovery plan.
   Source Cluster	Name of the source cluster associated with the recovery plan.
   Object Storage Repository	Name of the object storage repository used by the recovery plan.
   Associated Backup Plan	Name of the backup plan associated with the recovery plan.
   Namespace Mapping	Mapping relationship between the source and target namespaces.
   Snapshots Imported	If you selected Export snapshots when creating a backup plan, Yes is displayed here. If you have not selected Export snapshots, No is displayed.
   Description	User-defined description of the recovery plan.

4. The following table describes the information shown on the recovery job list.

   Parameter	Description
   Job Name	Recovery job name generated by the system.
   Creation Time	Time when the recovery job was created.
   Recovery Duration	Duration of executing the recovery job.
   Resources	Number of resources recovered by the recovery job.
   Status	Status of the recovery plan, which includes the following: Waiting for recovery: The recovery job is waiting for execution. In progress: The recovery job is being executed. Successful: The recovery job was successfully executed. Error: The recovery job is not correctly configured. Job not found: The recovery job is not found. Recovery failed: The recovery job fails. Not ready: The recovery job is not ready. Job submitted: The recovery job has been submitted. To be executed: The recovery job is waiting for execution. Canceling: The recovery job is being canceled. Canceled: The recovery job has been canceled.

5. To cancel a recovery job, click the radio button on the left of the recovery job, and then click Cancel on the top of the list.