
KubeSphere Backup is a Disaster-Recovery-as-a-Service service developed by the KubeSphere team for use cases related to hybrid clouds. You can back up and recover the container resources in your Kubernetes clusters through several clicks on the console with no need to deploy the infrastructure for backup and recovery on your own.

## Features

KubeSphere Backup provides easy-to-use wizard UI to simplify backup and recovery operations, facilitates the establishment of backup plans and recovery plans, and improves the overall disaster tolerance. 

## Use cases

KubeSphere Backup is applicable to the following use cases:

- **System or hardware failure**

   Reduces the risks of business interruption due to system or hardware failure to ensure the continuity of core businesses running in your Kubernetes clusters.  

- **Development and testing environment changes**

   Recovers the data backed up in any storage repository at any time in case of development and testing environment changes or configuration modifications.

- **Malicious attacks or improper operations**

   Prevents data loss due to malicious attacks or improper operations by backing up and recovering data to ensure data integrity.

- **Protection across multiple clusters and storage repositories**

   Implements data backup and recovery across multiple clusters running by different cloud providers, in different locations, and on different infrastructures according to your needs.

- **Container data migration across clouds**

   Provides an easy-to-use method for data migration to help you avoid vendor lock-in.





Introduces the features and use cases of KubeSphere Backup.

What is KubeSphere Backup


KubeSphere Backup has the following advantages:

- **Cloud-native backup and recovery architecture**

   Built on the native Kubernetes API for fine-grained, application-centric, and containerized business scenarios.

- **Open infrastructure**

   Supports popular Kubernetes distributions and any S3-compatible object storage with no limitation on Kubernetes cluster or number of nodes.

- **Easy-to-use and scalable SaaS**

   Implements auto-scaling according to business growth with no need to deploy any local backup and recovery infrastructure with a pay-as-you-go billing mode.

- **Intuitive wizard UI**

   Adds your resources on the console with several clicks to start backup and recovery with no need to understand Kubernetes basics.

Introduces the advantages of KubeSphere Backup.

Advantages


This topic introduces the billing items, subscriptions, and renewal methods of KubeSphere Backup.

## Billing items

KubeSphere Backup charges for the protected applications (namespaces). A protected application is the number of namespaces protected by the executed backup jobs and recovery jobs. The billing cycle is every month and actual costs is calculated according to the actual number of days that you used the Service.
## Billing mode

KubeSphere Backup is charged on a monthly, quarterly, and yearly basis.
## Subscriptions

KubeSphere Backup provides a Standard subscription for free trial. When the free trial ends, you can still subscribe to the long-term free plan. Besides, the Service also provides Basic, Enterprise, and Customization for enterprises with long-term business protection needs. The following table describes the current available subscriptions.

  <table>
    <tbody>
      <tr>
      	<th width="10%">Subscription</th>
       	<th width="10%">Protected Applications</th>
       	<th width="15%">Maximum Retention (Day)</th>
        <th width="15%">Support</th>
        <th width="15%">Quota of Hosted Repository</th>
        <th width="10%">Supported Resource Template</th>
        <th width="10%">Database Consistency Protection</th>
        <th width="20%">Pricing</th>
      </tr>
      <tr>
        <td>Free</td>
        <td>2</td>
        <td>3</td>
        <td>Community support</td>
        <td>10 GB</td>
        <td>Not supported</td>
        <td>Not supported</td>
        <td>Free</td>
      </tr>
      <tr>
        <td>Basic</td>
        <td>100</td>
        <td>14</td>
        <td>8 x 5 (GMT+8, business hours)</td>
        <td>100 GB</td>
        <td>3</td>
        <td>Not supported</td>
        <td>USD 65/month, 183/quarter, and 670/year</td>
      </tr>
      <tr>
        <td>Standard</td>
        <td>500</td>
        <td>30</td>
        <td>8 x 5 (GMT+8, business hours)</td>
        <td>500 GB</td>
        <td>10</td>
        <td>Supported</td>
        <td>USD 200/month, 564/quarter, and 2,064/year</td>
      </tr>
      <tr>
        <td>Enterprise</td>
        <td>1500</td>
        <td>90</td>
        <td>8 x 5 (GMT+8, business hours)</td>
        <td>1024 GB (1 TB)</td>
        <td>Unlimited</td>
        <td>Supported</td>
        <td>USD 340/month, 958/quarter, and 3,508/year</td>
      </tr>
      <tr>
         <td>Exclusive</td>
        <td>Customizable</td>
        <td>Customizable</td>
        <td>24 x 7</td>
        <td>Customizable</td>
        <td>Unlimited</td>
        <td>Supported</td>
        <td>Contact sales</td>
      </tr>
    </tbody>
  </table>


  <Notice type='warning'>

  When the protected applications exceed the subscription quota, you can upgrade your subscription to get more quota of protected applications, or you can delete some backup jobs and recovery jobs to release some quota. Please upgrade your subscription or release some quotas to prevent the data already backed up from any potential data loss.

  </Notice>

## Change of subscription

After you subscribe to a plan, you can change it according to your needs, and the billing will be based on the new subscription. The billing formula is described as follows:

Amount paid = Amount payable of new subscription － (Amount payable of current subscription/Days of current subscription) x (Days of current subscription － Used days of current subscription)


<Notice type='note'>

Duration of the new subscription must be equal to or longer than that of the current subscription. For example, if your current subscription is charged on a quarterly basis, then the new subscription must be charged on a quarterly or yearly basis.

</Notice>

## Renewal

The Service currently supports renewal of the same subscription or upgrading to a higher-level subscription. Renewal to a lower-level subscription is not supported.
## Out of credit

The Service will send you a notice starting from 7 days before your subscription expires. You can click **Subscribe Now** to renew your subscription. If you do not renew your subscription in time, the Service will still provide services to ensure business continuity, but the quota on backup, recovery, and hosted storage repository will be changed to the quota of the free plan. 

If the current protected applications exceed the quota of the free plan, the excessive protected applications will be deleted after a certain period of time (the actual time varies according to different subscriptions).

Introduces the billing items, subscriptions, and renewal methods of KubeSphere Backup.

Billing


This topic introduces the basic concepts of KubeSphere Backup.

## Namespace

A namespace is an abstract of a set of resources and objects. You can create multiple namespaces to achieve isolation between applications in different namespaces. The Service charges for namespaces.

## Source cluster

A source cluster is the source Kubernetes cluster associated with a backup plan.
## Protected application

The number of protected applications refers to the number of applications (namespaces) protected in the executed backup jobs and recovery jobs. For example, if you back up one application every day, then 30 protected applications will be generated in 30 days. You can delete backup jobs to release the quota of protected applications.
## Retention

Retention is the period when an application is protected, which varies according to different subscriptions.

Introduces the basic concepts of KubeSphere Backup.

Concepts

Introduces the concepts of KubeSphere Backup and its advantages and billing methods.

Introduction


This topic describes how to import a Kubernetes cluster on the console.

## Prerequisites

- You have [registered an account](https://kubesphere.cloud/en/sign-up/).
- You have prepared at least one Kubernetes cluster.

## Import a Kubernetes cluster

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 **Resource Management**. On the **Kubernetes Clusters** page, click **Import Self-build Cluster**.

   <Notice type='note'>

   On the **Overview** page, you can also click **Add Cluster > Import** under **Resource Management**.

   </Notice>

4. On the **Import Kubernetes Cluster** page, set the following parameters:

   <table border="1">
     <tbody>
     	<tr>
       	<th width="100">Parameter</th>
         <th width="100">Required</th>
         <th>Description</th>
       </tr>
       <tr>
       	<td>Cluster Name</td>
         <td>Yes</td>
         <td>User-defined name of the cluster. The name can contain only lowercase letters, numbers, and hyphens (-), and must start and end with a lowercase letter or number. The maximum length is 63 characters.</td>
       </tr>
       <tr>
       	<td>Tag</td>
         <td>No</td>
         <td>
         	User-defined tag of the cluster. Select a tag from the drop-down list to tag the cluster: 
           <ul>
             <li><b>Production</b></li>
             <li><b>Development</b></li>
             <li><b>Testing</b></li>
             <li><b>Demo</b></li>
           </ul>
         </td>
       </tr>
       <tr>
       	<td>Connection Method</td>
         <td>Yes</td>
         <td>Select a connection method for importing the cluster, including:
           <ul>
             <li><b>Direct Connection</b>: To use this method, enter the kubeconfig of the Kubernetes cluster, and you have to ensure that the address of <code>cluster.server</code> is exposed to the public network.</li>
             <li><b>Agent Connection</b>: To use this method, you have to install the agent connection component in the Kubernetes cluster. For more information, see <a href="#use-agent-connection">Use Agent Connection</a>.</li>
           </ul>
         </td>
       </tr>
       <tr>
       <td>Skip TLS verification</td>
       <td>No</td>
       <td>Skip TLS verification or not. If selected, the verification of the Kubernetes server certificate will be skipped. <b>Note</b>: This option is displayed only after you select <b>Direct Connection</b>. The HTTPS connection to the Kubernetes cluster will become insecure if you select this item.<br/>If the service fails to connect to the Kubernetes cluster while you are certain that the address of <code>cluster.server</code> is exposed to the public network, please select this item and try clicking <b>Connect</b> again.</td>
       </tr>
     </tbody>
   </table>

5. After setting the parameters, click **Connect**. After the service successfully connects to the cluster, click **Import**. The imported cluster is displayed in the cluster list.

   <Notice type='note'>

   - You may need to configure port forwarding rules and open the port in the firewall depending on the environment where the cluster is deployed. If the service cannot connect to the cluster after you click **Connect**, refer to [Obtain Kubeconfig](#obtain-kubeconfig).
   
   - After the cluster is imported, a namespace `qiming-backend` will be automatically created to install backup and recovery components.

   </Notice>

## (Recommended) Use Agent Connection

To use **Agent Connection** to import your Kubernetes cluster, perform the following steps:

1. On the **Import Kubernetes Cluster** page, set the required parameters, and select **Agent Connection** for **Connection Method**.

2. On the control plane of the cluster, run the command that is displayed at the bottom of the page to install agent connection component.

   <Notice type='note'>

   If you have limited network access, enable domain names **kubesphere.cloud** and **tower.kubesphere.cloud** and ports **80** and **443**.

   </Notice>

3. Click **Agent Component Installed** and wait until the connection is established.

4. If the connection is successfully established, the page will be redirected to the cluster details page.

5. (Optional) If the agent connection fails, the page will be redirected to the cluster details page. Please click **Note** and refer to the instructions to do troubleshooting through the following steps.

   - Step 1:

     1. On the node where the agent connection component is installed, run the following command to check the status of the components. The `READY` and `AVAILABLE` column should be `1/1` and `1` respectively.
   
        ```bash
        kubectl get deploy cluster-agent -n kubesphere-cloud-system
        ```
   
        ![](/images/docs/disaster-recovery-and-backup/import-cluster/agent-info.png)
   
     2. If the agent connection component is not running properly, run the following command to check the logs for further troubleshooting.
   
        ```bash
        kubectl logs -l app=agent -n kubesphere-cloud-system
        ```
   
        ![](/images/docs/disaster-recovery-and-backup/import-cluster/agent-logs.png)
   
   - Step 2:
   
     1. If the component cannot run properly, run the command shown on the page to uninstall the component.
   
     2. Run the command shown on the page to install the agent connection component again.
   
     3. After the component is successfully installed, click **Connect** to establish the agent connection.

## Obtain kubeconfig

### Managed Kubernetes clusters

If you use managed Kubernetes cluster service from cloud providers, use the kubeconfig exposed to the public network to import your cluster. For example:

- If you use Alibaba Cloud Container Service for Kubernetes (ACK):
  - Make sure you select the **Expose API Server with EIP** for **Access to API Server**. For more information, see [Alibaba Cloud documentation](https://www.alibabacloud.com/help/en/container-service-for-kubernetes/latest/getting-started-with-ack-using-the-ack-console#section-ll1-v66-lz8).
  - On the **Cluster Information** page, click the **Connection Information** tab and you can find the kubeconfig under **Public Access**. For more information, see [Alibaba Cloud documentation](https://www.alibabacloud.com/help/en/container-service-for-kubernetes/latest/use-the-kubernetes-api).
- If you use Cloud Container Engine (CCE) of Huawei Cloud:
  - Make sure you have bound EIP for **Public API Server Address** on the **Cluster Details** page, and download the kubeconfig from the **Kubectl** tab. For more information, see [Huawei Cloud documentation](https://support.huaweicloud.com/intl/en-us/usermanual-cce/cce_01_0107.html#section2).
- If you use Tencent Kubernetes Engine (TKE):
  - Make sure you have enabled **Internet access** on the **Cluster APIServer information** page, and copy or download the kubeconfig. For more information, see [Tencent Cloud documentation](https://intl.cloud.tencent.com/document/product/457/30639#configuring-kubeconfig).

### Self-managed Kubernetes clusters

If you use self-managed Kubernetes clusters, run the command `cat $HOME/.kube/config` to obtain the kubeconfig for importing the cluster. Make sure the address of <code>cluster.server</code> is exposed to the public network, or select **Skip TLS verification** at the same time to import the cluster.

If you cannot import the cluster, please take the following steps to obtain the kubeconfig again:

1. On every control plane of the Kubernetes cluster, go to the directory `/etc/kubernetes/pki/` and use the [sample file](https://github.com/stoneshi-yunify/scripts/blob/master/update-apiserver-with-external-ip.sh) to create a script file. 

2. Run the following command to make the script file executable:

   ```bash
   chmod +x <script file name>
   ```

3. Run the following command to run the script on every control plane of the cluster:

   ```bash
   ./<script file name> <public IP address>
   ```

4. Forward the private IP address and port of the control plane to a public IP address and port. 

5. Run the following command on the control plane to obtain the kubeconfig:

   ```bash
   cat $HOME/.kube/config
   ```

6. Replace the address of <code>cluster.server</code> with the public IP address and port, and use the modified kubeconfig to import the cluster.

### No Kubernetes cluster deployed

1. Run the following command to download the latest version of KubeKey:

   ```
   curl -sfL https://get-kk.kubesphere.io | VERSION=v2.2.2 sh -
   ```

   <Notice type='note'>

   - It is recommended that you [use KubeKey to deploy a Kubernetes cluster](https://github.com/kubesphere/kubekey#advanced).

   - If your network connection to GitHub is slow, run the command `export KKZONE=cn` first before downloading KubeKey.

   </Notice>

2. Run the following command to create a sample configuration file, and refer to [Edit the configuration file](https://kubesphere.com.cn/en/docs/installing-on-linux/introduction/multioverview/#2-edit-the-configuration-file-of-a-kubernetes-multi-node-cluster) to edit the configuration file for your cluster.

   ```bash
   ./kk create config [--with-kubernetes version] [(-f | --file) path]
   ```

3. In the configuration file of the cluster (for example, `config-sample.yaml`), add the following content under `spec.kubernetes`:

   ```yaml
   apiserverCertExtraSans: <[public IP address]>
   ```

   <Notice type='note'>

   Make sure you indent 2 spaces at the beginning of the line.

   </Notice>

4. Run the following command to create the cluster:

   ```bash
   ./kk create cluster -f config-sample.yaml
   ```

   <Notice type='note'>

   Make sure you replace `config-sample.yaml` with your configuration file name.

   </Notice>

5. Forward the private IP address and port of the control plane to a public IP address and port.

6. Run the following command on the control plane to obtain the kubeconfig:

   ```bash
   cat $HOME/.kube/config
   ```

7. Replace the address of <code>cluster.server</code> with the public IP address and port, and use the modified kubeconfig to import the cluster.


Describes how to import a Kubernetes cluster on the console.

Import a Kubernetes cluster


This section describes how to enable the KubeSphere Backup component.

## Prerequisites

- You have [registered an account](https://kubesphere.cloud/en/sign-up/).

- You have created a lite cluster or imported a Kubernetes cluster. For more information, refer to [Create a lite cluster](../../../ks-lite/quickstart/create-lite-cluster) or [Import a Kubernetes cluster](../../quickstart/import-k8s-cluster/).


## Procedure

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 **Resource Management**.

4. On the **Kubernetes Clusters** tab page, click the target cluster to go to the cluster details page.

5. On the **Components** tab page, click **On** next to **Backup and Recovery**.

6. On the **Install KubeSphere Backup Component** dialog box, click **Confirm**.

<Notice type="note">

It takes several minutes to install the KubeSphere Backup component. After the component is installed, you can back up and recover data of clusters.

</Notice>






Describes how to enable the KubeSphere Backup component.

Enable the KubeSphere Backup component


This topic describes how to create an object storage repository on the console.

You can choose to create a hosted repository or a S3-compatible repository.

## Prerequisites

You have [registered an account](https://kubesphere.cloud/en/sign-up/).

## Create a hosted repository

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 **Resource Management > Object Storage Repositories**, and then click **Create Repository**.

   <Notice type='note'>

   You can also click **Create Repository** under **Object Storage Repositories** on the **Overview** page.

   </Notice>

4. On the **Create Repository** page, click **Hosted Repository**.

5. Set the name in **Repository Name** and click **Create**. You can view the created repository in the object storage repository list.

   <Notice type='note'>

   Each account can create only one hosted repository.

   </Notice>

## Add an S3-compatible repository

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 **Resource Management > Object Storage Repositories**, and then click **Create Repository**.

   <Notice type='note'>

   You can also click **Create Repository** under **Object Storage Repositories** on the **Overview** page.

   </Notice>

4. On the **Create Repository** page, click **AWS S3 Standard Repository**, specify **Private Cloud Repo** or **Public Cloud Repo**, and set the following parameters. 

   <table border="1">
     <tbody>
     	<tr>
       	<th>Parameter</th>
         <th width="100">Required</th>
         <th>Description</th>
       </tr>
       <tr>
       	<td>Storage Type</td>
         <td>Yes</td>
         <td>Type of the object storage. The default value is <code>S3 Standard</code>.</td>
       </tr>
       <tr>
       	<td>Repository Name</td>
         <td>Yes</td>
         <td>User-defined name of the repository. The name can contain only lowercase letters, numbers, and hyphens (-), and must start and end with a lowercase letter or number. The maximum length is 253 characters.</td>
       </tr>
       <tr>
       	<td>Bucket</td>
         <td>Yes</td>
         <td>Name of the S3 bucket.</td>
       </tr>
       <tr>
       	<td>Region</td>
         <td>Yes</td>
         <td>Name of the region of the S3 bucket. For more information, refer to the object storage documentation provided by the cloud provider.</td>
       </tr>
       <tr>
       	<td>Endpoint</td>
         <td>Yes</td>
         <td>
         	Endpoint of the storage repository. It must be compatible with the AWS S3 Standard. For more information, refer to the object storage documentation provided by the cloud provider on AWS S3 compatibility.
         </td>
       </tr>
       <tr>
       	<td>Access Key ID</td>
         <td>Yes</td>
         <td>
         	Access key ID of the object storage repository. For more information, refer to the object storage documentation provided by the cloud provider.
         </td>
       </tr>
       <tr>
       	<td>Access Key Secret</td>
         <td>Yes</td>
         <td>
         	Access key secret of the object storage repository. For more information, refer to the object storage documentation provided by the cloud provider.
         </td>
       </tr>
       <tr>
       	<td>Disable SSL</td>
         <td>No</td>
         <td>Whether to disable SSL. Security risks may arise if you select it.</td>
       </tr>
     </tbody>
   </table>

5. After setting the parameters, click **Add**.

   <Notice type='note'>

   If you select **Public Cloud Repo** before, you need to click **Connect** first. After the connection is successful, click **Add**.

   </Notice>



Describes how to create an object storage repository on the console.

Create a repository


This topic describes how to create a backup plan on the console.

## Prerequisites

- You have [imported a Kubernetes cluster](../import-k8s-cluster/).
- You have [created an object storage repository](../create-oss-repo/).
- You have [enabled the KubeSphere Backup component](../enable-backup-com/).

## Create a backup plan

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 > Backup Plans**, and then click **Create Backup Plan**.

   <Notice type='note'>

   You can also click **Create** under **Backup Plans** on the **Overview** page.

   </Notice>

4. On the **Create Backup Plan** page, set the following parameters.

   <table border="1">
     <tbody>
     	<tr>
       	<th width="110">Parameter</th>
         <th width="100">Required</th>
         <th>Description</th>
       </tr>
       <tr>
       	<td>Name</td>
         <td>Yes</td>
         <td>User-defined name of the backup plan. The name can contain only lowercase letters, numbers, and hyphens (-), and must start and end with a lowercase letter or number. The maximum length is 63 characters.</td>
       </tr>
       <tr>
       	<td>Object Storage Repository</td>
         <td>Yes</td>
         <td>Select an existing object storage repository from the drop-down list.<br/>If you have not created any repository, click <b>Create Repository</b> to create one. After creation, click <img src="/images/docs/disaster-recovery-and-backup/ui/refresh.png" width="16" /> and select the repository created.</td>
       </tr>
       <tr>
       	<td>Source Cluster</td>
         <td>Yes</td>
         <td>Select an existing Kubernetes cluster from the drop-down list.<br/>If a cluster in the list is dimmed with a notice of <b>Cluster not ready.</b>, please check whether the pods in the <code>qiming-backend</code> namespace of that cluster are up and running.<br/>If you have not imported any cluster, click <b>Import</b> to import a Kubernetes cluster. After importing, click <img src="/images/docs/disaster-recovery-and-backup/ui/refresh.png" width="16" /> and select the cluster imported.</td>
       </tr>
       <tr>
       	<td>Backup Resources</td>
         <td>Yes</td>
         <td>
         It includes the following options:
         <ul>
             <li><b>Source Namespace</b>: Select an existing namespace of the source cluster from the drop-down list.</li>
             <li><b>Resource Template</b>: Create a resource template so that you can reuse settings of the backup plan. For more information, please refer to <a href="#create-and-manage-resource-templates">Create and manage resource templates</a>.</li>
           </ul>
         </td>
       </tr>
       <tr>
       	<td>Description</td>
         <td>No</td>
         <td>User-defined description of the backup plan.</td>
       </tr>
       <tr>
       	<td>Backup Type</td>
         <td>Yes</td>
         <td>
           Select a backup type for the backup plan:
           <ul>
             <li><b>Instant</b>: Execute a backup job immediately when the backup plan is created.</li>
             <li><b>Scheduled</b>: Execute backup jobs according to the specified frequency. Available system time zones include: <b>UTC</b> and <b>Current Time Zone</b>. Available frequencies include: <b>Hour</b>, <b>Day</b>, <b>Week</b>, and <b>Month</b>.</li>
           </ul>
           <b>Retention (Days)</b>: Retention period of the backup plan. The backup plan and the data uploaded to the storage repository will be deleted after the specified retention period.
         </td>
       </tr>
       <tr>
       	<td>Volumes</td>
         <td>No</td>
         <td>
           Select <b>Back up volumes</b> to specify whether to back up the data in the volumes. Available backup methods include:
           <ul>
             <li><b>Copy Volumes</b>: Copy the data in volumes for backup.</li>
             <li><b>Use CSI Snapshot</b>: Use the CSI snapshot to back up volumes. To use this method, ensure the associated volume snapshot class exists in your Kubernetes cluster. For more information about how to create a volume snapshot class, see <a href="#create-a-volume-snapshot-class">Create a volume snapshot class</a>.</li>
             <li><b>Retained Snapshots</b>: Set the number of snapshots to retain. The default value is <b>All</b>. To save the storage space, you can set this parameter based on the volumes used during backup. Please note that if the value is too small, it is possible that some snapshots may be deleted and cannot be restored.</li>
             <li><b>Export snapshot</b>: To prevent data loss and ensure rapid service recovery, you are advised to select this option to export the CSI snapshot while backing up volumes. The retention period of the snapshot equals to that of the backup plan.</li>
           </ul>
         </td>
       </tr>
     </tbody>
   </table>

   The following table describes differences among the three volume backup methods. Please choose the one that best fits your needs.
   <table>
     <thead>
       <tr>
         <th width='150'>Backup Method</th><th>Application Scenarios</th><th>Backup Speed for Large Volumes of Data</th><th>Data Consistency</th>
       </tr>
     </thead>
     <tbody>
       <tr>
         <td>Copy Volumes</td><td>CSI snapshot not supported by the storage system</td><td>Slow</td><td>Partially inconsistent</td>
       </tr>
       <tr>
         <td>Use CSI Snapshot</td><td>Same cloud environment, cluster, and storage system</td><td>Fast</td><td>Consistent</td>
       </tr>
       <tr>
         <td>Use CSI Snapshot + Export snapshot</td><td>Across cloud environments, clusters, or storage systems</td><td>Slow</td><td>Consistent</td>
       </tr>
     </tbody>
   </table>

5. After setting the parameters, click **OK**. The successfully created backup plan will appear in the list.

   <Notice type='note'>

   * According to the specified backup type and frequency, the number of generated protected applications differs. For example, if you select **Scheduled** and set the backup job to be executed at 00:00 and 12:00 every day, then 2 protected applications will be generated every day.

   * To view the usage records of the protected applications of the backup plan, go to the **Overview** page and click **Usage Records** in **Subscription**.

   </Notice>

## View and create a volume snapshot class

If you select **Use CSI Snapshot** when creating a backup plan, you have to ensure the associated volume snapshot class exists in your Kubernetes cluster. To view or create a volume snapshot class, refer to the following steps.

### View a volume snapshot class

If you already have a volume snapshot class, refer to the following steps:

1. Run the following command to view the PVCs in the namespace to be backed up. In the output, you can see the storage class associated with each PVC.

   ```bash
   $ kubectl get pvc -n <namespace>
   NAME             STATUS   VOLUME                                     CAPACITY   ACCESS MODES   STORAGECLASS     AGE
   busybox-test-a   Bound    pvc-5f0e74b8-d8d0-4c68-a3f8-5cd125a4d45a   10Gi       RWO            csi-hostpath-a   24h
   ```

2. Run the following command to view the information about a specified storage class. In the output, you can see the `PROVISIONER` associated with the storage class. 

   ```bash
   $ kubectl get sc csi-hostpath-a
   NAME                        PROVISIONER             RECLAIMPOLICY   VOLUMEBINDINGMODE   ALLOWVOLUMEEXPANSION   AGE
   csi-hostpath-a              hostpath.csi.k8s.io-a   Delete          Immediate           true                   24h
   ```

   <Notice type='note'>

   Make sure you replace the `csi-hostpath-a` with the actual name of the storage class in your cluster.

   </Notice>

3. Run the following command to view the volume snapshot class. If any volume snapshot class exists in your cluster, you have to ensure that the `PROVISIONER` obtained in previous steps supports the existing volume snapshot class before making any snapshot of the PVCs. If no volume snapshot class exists in your cluster, perform the following steps to create one.

   ```bash
   $ kubectl get volumesnapshotclass --show-labels
   No resources found in tt namespace.
   ```

### Create a volume snapshot class

If you want to create a volume snapshot class, refer to the following steps:

1. Use the following content to create a YAML file, for example, `volumesnapshotclass.yaml`.

   ```yaml
   apiVersion: snapshot.storage.k8s.io/v1 # Set this field according to the snapshot CRD version of your cluster. The service currently supports v1 and v1beta1.
   deletionPolicy: Retain # Must set to Retain.
   driver: hostpath.csi.k8s.io-a # Consistent with the PROVISIONER of the storage class in your cluster.
   kind: VolumeSnapshotClass
   metadata:
     name: csi-hostpath-sc # Set to any value accepted by Kubernetes.
     labels:
       velero.io/csi-volumesnapshot-class: 'true' # Must set this label.
   parameters: # (Optional) set this field according to your actual storage system.
     ...
   ```

2. Run the following command to create the volume snapshot class.

   ```bash
   kubectl apply -f volumesnapshotclass.yaml
   ```

3. Run the following command to view the volume snapshot class. Make sure the value of `DRIVER` in the output is consistent with the value of `PROVISIONER` associated with the storage class.

   ```bash
   $ kubectl get volumesnapshotclass --show-labels
   NAME                     DRIVER                  DELETIONPOLICY   AGE   LABELS
   csi-hostpath-sc          hostpath.csi.k8s.io-a   Retain           9s    velero.io/csi-volumesnapshot-class=true
   ```

### Notes

When using a volume snapshot class, you have to note that:

- If PVCs created by CSI and other PVCs not created by CSI both exist in the namespace to be backed up, select **Copy Volumes** to back up your PVCs.

- If PVCs created by multiple CSI drivers exist in the namespace to be backed up, perform the above steps to create a corresponding volume snapshot class for each CSI driver.

- If multiple volume snapshot classes exist for the same CSI driver, the service will randomly select a volume snapshot class for backup. 

- When creating a recovery plan, make sure the target cluster can access the volume snapshot backup.

## Create and manage resource templates
### Create a resource template

When creating a backup plan, you can create a resource template so that you can reuse it. To create a template, refer to the following steps.

1. In the **Backup Resources** area on the **Create Backup Plan** page, click **Resource Template** > **Create Resource Template**.

2. In the **Create Resource Template** dialog box that is displayed, set the template name.

   <Notice type='note'>

   **App Resources** and **Cluster Resources** are supported. By default, **App Resources** is enabled. If you need to back up cluster-level resources or both namespace-level and cluster-level resources, enable **Cluster Resources**. Here, **App Resources** is used as an example.

   </Notice>

3. In the **Select App** area, specify one or more source namespaces to back up by name or label.

4. In the **Filter Resources** area, filter application resources by **Group** and **Resource**, and click **OK**.

   <Notice type='note'>

   - If you do not filter application resources, all resources in the namespace will be selected.
   - If you have enabled **Cluster Resources**, but do not filter cluster resources, no cluster-level resources will be selected.

   </Notice>

5. In the **Create Resource Template** area, select the created template from the drop-down list.

6. To edit the template, click <img src="/images/console/icon-edit.svg" width="15" /> next to the template from the drop-down list. On the **Edit Resource Template** page, change the resource template information as needed, and click **OK**.

### View and manage resource templates

To view and manage all backup resource templates, please refer to the following steps.

1. On the **Backup Plans** tab, click **Resource Templates**.

2. In the **My Templates** dialog box that is displayed, you can view all templates.

3. Click a template. On the upper-right corner of the page, you can apply, edit, and delete the template.

   <Notice type='note'>

   You can also click **Create Template** on the left side of the page to create a template.

   </Notice>

Describes how to create a backup plan on the console.

Create a backup plan


This topic describes how to create a recovery plan on the console.

## Prerequisites

- You have [created a backup plan](../create-backup-plan/) and the backup job is successfully executed.
- You have [enabled the KubeSphere Backup component](../enable-backup-com/).

## Create a recovery plan

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 > Recovery Plans**, and then click **Create Recovery Plan**.

   <Notice type='note'>

   You can also click **Create** under **Recovery Plans** on the **Overview** page.

   </Notice>

4. On the **Create Recovery Plan** page, set the following parameters.

   <table border="1">
     <tbody>
     	<tr>
       	<th width="100">Parameter</th>
         <th width="100">Required</th>
         <th>Description</th>
       </tr>
       <tr>
       	<td>Name</td>
         <td>Yes</td>
         <td>User-defined name of the recovery plan. The name can contain only lowercase letters, numbers, and hyphens (-), and must start and end with a lowercase letter or number. The maximum length is 63 characters.</td>
       </tr>
       <tr>
       	<td>Backup Jobs</td>
         <td>Yes</td>
         <td>
           Select the backup job to be used for the recovery plan. You can specify the backup job from the existing executed ones or by filtering them:
           <ul>
             <li>Click the <code>Specify backup time</code> box and select one day or a period in the pop-up menu to specify the time when the backup job was executed.</li>
             <li>Click the search box, select <code>Name</code> or <code>Namespace</code>, enter the name of the backup plan or the name of the source namespace, and press <b>Enter</b> to search for the backup job.</li>
           </ul>
         </td>
       </tr>
       <tr>
       	<td>Description</td>
         <td>No</td>
         <td>User-defined description of the recovery plan.</td>
       </tr>
       <tr>
       	<td>Recovered To</td>
         <td>Yes</td>
         <td>
           <ul>
             <li><b>Target Cluster</b>: Select an imported Kubernetes cluster from the drop-down list as the target cluster for the recovery plan.<br/>If you have not imported the target cluster, click <b>Import</b> to import it. After the target cluster is imported, click <img src="/images/docs/disaster-recovery-and-backup/ui/refresh.png" width="16" /> and then select it from the drop-down list.</li>
             <li><b>Namespace Mapping</b>: Set the mapping relationship between the source and target namespaces.</li>
           </ul>
         </td>
       </tr>
       <tr>
       	<td>Volumes</td>
         <td>No</td>
         <td>
           If you select <b>Copy Volumes</b> or select <b>Export snapshot</b> when choosing <b>Use CSI Snapshot</b>, the following parameters are displayed.
           <ul>
             <li><b>Source Storage Class</b>: Name of the source storage class.</li>
             <li><b>Target Storage Class</b>: When there is a storage class on the target cluster, the system automatically matches the source and the storage class, and you can also change the mapping relationship. When there is no storage class on the target cluster, the value of <b>Target Storage Class</b> is <b>Unmatched</b>. Then, you need to click "<b>No storage class available for recovery in the target cluster?</b>" and create a storage class as prompted. For more information, please refer to <a href="#Create a storage class">Create a storage class</a>.</li>
           </ul>
         </td>
       </tr>
     </tbody>
   </table>

5. After setting the parameters, click **OK**. The created recovery plan is displayed in the list.

   <Notice type='note'>

   Each recovery plan uses 1 protected application. On the **Overview** page, click **Usage Records** in **Subscription** to view the protected applications used by recovery plans.

   </Notice>

## Create a storage class

When there is no storage class on the target cluster, perform the following steps to create one.

1. Create a YAML file, for example, `sc.yaml`.

   ```yaml
   apiVersion: storage.k8s.io/v1
   kind: StorageClass
   metadata:
     name: standard
   provisioner: kubernetes.io/aws-ebs
   parameters:
     type: gp3
   reclaimPolicy: Retain
   allowVolumeExpansion: true
   mountOptions:
     - debug
   volumeBindingMode: Immediate
   ```
   <Notice type='note'>

   Content in the YAML file is for reference only, and you need to customize it based on your actual situation. For more information, please refer to [Kubernetes Documentation](https://kubernetes.io/docs/concepts/storage/storage-classes/).

   </Notice>

2. Run the following command to create a storage class:
   
   ```bash
   kubectl apply -f sc.yaml
   ```
3. Run the following command to check whether the storage class has been successfully created:
   
   ```bash
   $ kubectl get storageclass

   NAME              PROVISIONER             RECLAIMPOLICY   VOLUMEBINDINGMODE      ALLOWVOLUMEEXPANSION   AGE
   local (default)   openebs.io/local        Delete          WaitForFirstConsumer   false                  24h
   standard          kubernetes.io/aws-ebs   Retain          Immediate              true                   21s
   ```

Describes how to create a recovery plan on the console.

Create a recovery plan

Quickstarts


This topic describes how to use the **Overview** page on the console.

## Use the Overview Page

### Prerequisites

You have [registered an account](https://kubesphere.cloud/en/sign-up/).

### Procedure

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. The page is redirected to the **Overview** page by default.

The following table describes the functional areas on the **Overview** page.

<table border="1">
  <tbody>
  	<tr>
    	<th>Title</th>
      <th>Functional Area</th>
      <th>Description</th>
    </tr>
    <tr>
    	<td rowspan="2">Resource Management</td>
      <td>Kubernetes Clusters</td>
      <td>
      	<ul>
        	<li>
          	Show the number and status of the imported self-build and lite Kubernetes clusters:
            <ul>
              <li><b>Connected</b>: Indicate the number of connected Kubernetes clusters.</li>
              <li><b>Disconnected</b>: Indicate the number of disconnected Kubernetes clusters. If a cluster is disconnected, please ensure that the cluster is up and running and you have entered the correct <a href="../../quickstart/import-k8s-cluster/#obtain-kubeconfig">kubeconfig</a>.</li>
            </ul>
          </li>
          <li><b>Add Cluster</b>: Click to import a Kubernetes cluster or create a managed cluster. For more information, see <a href="../../quickstart/import-k8s-cluster/">Import a Kubernetes Cluster</a>.</li>
        </ul>
      </td>
    </tr>
    <tr>
    	<td>Object Storage Repositories</td>
      <td>
      	<ul>
          <li>
          	Show the number of created object storage repositories:
            <ul>
              <li><b>Hosted Repository</b>: Show the capacity of the created hosted repository.</li>
              <li><b>S3-compatible Repository</b>: Show the number of added S3-compatible repositories.</li>
            </ul>
          </li>
          <li><b>Create Repository</b>: Click to create an object storage repository. For more information, see <a href="../../quickstart/create-oss-repo/">Create an Object Storage Repository</a>.</li>
        </ul>
      </td>
    </tr>
    <tr>
    	<td rowspan="2">Backup and Recovery</td>
      <td>Backup Plans</td>
      <td>
      	<ul>
          <li><b>Backup Plans</b>: Show the number of created backup plans.</li>
          <li><b>Create</b>: Click to create a backup plan. For more information, see <a href="../../quickstart/create-backup-plan/">Create a Backup Plan</a>.</li>
        </ul>
      </td>
    </tr>
    <tr>
    	<td>Recovery Plans</td>
      <td>
      	<ul>
          <li><b>Recovery Plans</b>: Show the number of created recovery plans.</li>
          <li><b>Create</b>: Click to create a recovery plan. For more information, see <a href="../../quickstart/create-recovery-plan/">Create a Recovery Plan</a>.</li>
        </ul>
      </td>
    </tr>
    <tr>
    	<td>Cluster Inspection</td>
      <td>Cluster Inspection</td>
        <td>
      	<ul>
          <li><b>Inspected Clusters</b>: Show the number of inspected clusters.</li>
          <li><b>Inspect Clusters</b>: Click to go to the inspection list, where you can view the inspected and suspended clusters and clusters to inspect.</li>
        </ul>
      </td>
    </tr>
  </tbody>
</table>



Describes how to use the Overview page on the console.

Overview


This topic describes how to use the **Resource Management** page on the console.

## View the Kubernetes Clusters tab

### Prerequisites

- You have [registered an account](https://kubesphere.cloud/en/sign-up/).

- You have [imported a Kubernetes cluster](../../quickstart/import-k8s-cluster/).

### Procedure

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 **Resource Management**.

4. On the **Resource Management** page, you can view the list of imported Kubernetes clusters under the **Kubernetes Clusters** tab. The following table describes the information shown on the list page:

   <table border="1">
     <tbody>
     	<tr>
       	<th>Parameter</th>
         <th>Description</th>
       </tr>
       <tr>
       	<td>Name</td>
         <td>User-defined name of the cluster. The tag of the cluster is shown on the left of the cluster name.</td>
       </tr>
       <tr>
       	<td>Status</td>
         <td>
         	Status of the cluster, which includes the following:
           <ul>
             <li><b>Connected</b>: The cluster has been imported or created.</li>
             <li><b>Disconnected</b>: Importing or creating a cluster fails, and you need to import or create the cluster again.</li>
             <li><b>Creating</b>: The cluster is being imported or created.</li>
           </ul>
         </td>
       </tr>
       <tr>
       	<td>Type</td>
         <td>
         	Connection method used for importing the cluster, including:
           <ul>
             <li>Direct connection</li>
             <li>Agent connection</li>
             <li>Managed</li>
           </ul>
         </td>
       </tr>
       <tr>
       	<td>Version</td>
         <td>Version of the Kubernetes cluster.</td>
       </tr>
       <tr>
       	<td>Nodes</td>
         <td>Number of nodes in the Kubernetes cluster.</td>
       </tr>
       <tr>
       	<td>Creation Time</td>
         <td>Time when the Kubernetes cluster was imported or created. If the cluster is a managed cluster, the expiry time is displayed because of trial use.</td>
       </tr>
       <tr>
       	<td>Operations</td>
         <td>
         	Select one of the operations on the cluster, including:
           <ul>
             <li><b>Edit</b>: Click to enter the cluster edit page. You can change the tag of the cluster.</li>
             <li><b>Details</b>: Click to enter the cluster details page. You can view the details about cluster status and backup and recovery components status.</li>
             <li><b>More</b>: Click to select <b>Delete</b> from the drop-down list and confirm whether to delete the cluster in the displayed dialog box.</li>
           </ul>
         </td>
       </tr>
     </tbody>
   </table>

5. (Optional) Click the search box on the top of the cluster list, enter the name of a cluster, and then press **Enter** to search for the cluster.

6. (Optional) Click <img src="/images/docs/disaster-recovery-and-backup/ui/refresh.png" width="15" /> in the upper-right corner to refresh the cluster list.

7. To import a Kubernetes cluster, click **Import Self-build Cluster** on the upper-right corner of the page. For more information, see [Import a Kubernetes Cluster](../../quickstart/import-k8s-cluster/).

8. To create a managed cluster, click **Create Lite Cluster** on the upper-right corner of the page. For more information, see [Create and use a lite cluster](../../../ks-lite/quickstart/create-lite-cluster/).

## View the Object Storage Repositories tab

### Prerequisites

- You have [registered an account](https://kubesphere.cloud/en/sign-up/).

- You have [created an object storage repository](../../quickstart/create-oss-repo/).

### Procedure

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 **Resource Management**.

4. On the **Resource Management** page, you can view the list of existing object storage repositories under the **Object Storage Repositories** tab. The following table describes the information shown on the list page:

   <table border="1">
     <tbody>
     	<tr>
       	<th width="100">Parameter</th>
         <th>Description</th>
       </tr>
       <tr>
       	<td>Name</td>
         <td>User-defined name of the storage repository.</td>
       </tr>
       <tr>
       	<td>Repository Type</td>
         <td>
         	Repository type specified when creating it, including:
           <ul>
             <li>Hosted Repository</li>
             <li>S3-compatible Repository</li>
           </ul>
         </td>
       </tr>
       <tr>
       	<td>URL</td>
         <td>URL of the storage repository (compatible with AWS S3 Standard).</td>
       </tr>
       <tr>
       	<td>Creation Time</td>
         <td>Time when the repository was created.</td>
       </tr>
       <tr>
       	<td>Operations</td>
         <td>
         	Select one of the operations on the repository, which includes the following:
           <ul>
             <li><b>Edit</b>: Click to enter the <b>Edit Repository</b> page to modify the repository information. The repository name cannot be changed, and the hosted repository cannot be edited.</li>
             <li><b>Details</b>: Click to view the repository details. You can also click the repository name to view the repository details page.</li>
             <li><b>More</b>: Click to select <b>Delete</b> from the drop-down list and confirm whether to delete the repository in the displayed dialog box.</li>
           </ul>
         </td>
       </tr>
     </tbody>
   </table>

5. (Optional) Click the search box on the top of the repository list, enter the name of a repository, and then press **Enter** to search for it.

6. (Optional) Click <img src="/images/docs/disaster-recovery-and-backup/ui/refresh.png" width="15" /> in the upper-right corner to refresh the repository list.

7. To create a repository, click **Create Repository** in the upper-right corner. For more information, see [Create an Object Storage Repository](../../quickstart/create-oss-repo/).


Describes how to use the Resource Management page on the console.

Resource management


This section describes how to manage the KubeSphere Backup component.

## Prerequisites

- You have [registered an account](https://kubesphere.cloud/en/sign-up/).

- You have [created a lite cluster](../../../ks-lite/quickstart/create-lite-cluster) and [imported a Kubernetes cluster](../../quickstart/import-k8s-cluster/).

## Enable the backup component

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 **Resource Management**.

4. On the **Kubernetes Clusters** tab page, click the target cluster to go to the cluster details page.

5. On the **Components** tab page, click **On** next to **Backup and Recovery**.

6. On the **Install KubeSphere Backup Component** dialog box, click **Confirm**.

   <Notice type="note">

   It takes several minutes to install the KubeSphere Backup component. After the component is installed, you can back up and recover data of clusters.

    </Notice>

## Suspend the backup component

If you want to suspend the backup component, perform the following steps.

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 **Resource Management**.

4. On the **Kubernetes Clusters** tab page, click the target cluster to go to the cluster details page.

5. On the **Components** tab page, click **More > Suspend**.

6. On the **Suspend KubeSphere Backup Component** dialog box, click **Confirm and suspend > Suspend**.

    <Notice type="note">

    After suspending the KubeSphere Backup component, you cannot use the backup and recovery features, but can still view your operation history.

    </Notice>


## Uninstall the backup component

If you want to uninstall the backup component, perform the following steps.

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 **Resource Management**.

4. On the **Kubernetes Clusters** tab page, click the target cluster to go to the cluster details page.

5. On the **Components** tab page, click **More > Uninstall**.

6. On the **Suspend KubeSphere Backup Component** dialog box, click **Forcibly uninstall the component > Uninstall**.

    <Notice type="note">

    Exercise caution when you uninstall the component, because you will not be able to use the backup and recovery features.

    </Notice>

### Manually clear backup resources

In some cases, for example, cluster disconnection, uninstallation may fail. To manually clear the backup resources, refer to the following steps.

<Notice type="note">

As some CRDs rely on controllers' workloads, you need to delete workloads after deleting CRDs.

</Notice>


1. Run the following command to delete all CRDs.

   ```bash
   kubectl delete crd backups.velero.io backupstoragelocations.velero.io deletebackuprequests.velero.io downloadrequests.velero.io podvolumebackups.velero.io podvolumerestores.velero.io resticrepositories.velero.io restores.velero.io schedules.velero.io serverstatusrequests.velero.io volumesnapshotlocations.velero.io apphooks.ys.jibudata.com veleroexports.ys.jibudata.com veleroimports.ys.jibudata.com
   ```

2. Run the following command to delete all workloads.

   ```bash
   kubectl -n kubesphere-cloud-system delete deployment/agent-operator deployment/amberapp-controller-manager deployment/data-mover-controller-manager deployment/stub deployment/velero daemonset/restic
   ```

Describes how to manage the KubeSphere Backup component.

KubeSphere Backup component

Manage the KubeSphere Backup component


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](https://kubesphere.cloud/en/sign-up/).

- You have [created a backup plan](../../quickstart/create-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: 

   <table border="1">
     <tbody>
     	<tr>
       	<th width="100">Parameter</th>
         <th>Description</th>
       </tr>
       <tr>
       	<td>Name</td>
         <td>User-defined name of the backup plan. Click the name to view its details page.</td>
       </tr>
       <tr>
       	<td>Backup Type</td>
         <td>
           Backup type of the backup plan. The value can be <b>Instant</b> or <b>Scheduled</b>.
         </td>
       </tr>
       <tr>
       	<td>Source Cluster</td>
         <td>Source cluster associated with the backup plan.</td>
       </tr>
       <tr>
       	<td>Backup Resources</td>
         <td>Source namespace associated with the backup plan.</td>
       </tr>
       <tr>
       	<td>Jobs</td>
         <td>Number of backup jobs executed under the backup plan.</td>
       </tr>
       <tr>
       	<td>Status</td>
         <td>
         	Current status of the backup plan, indicating the status of the latest backup job, including:
           <ul>
             <li><b>Successful</b>: The backup job is successful.</li>
             <li><b>In progress</b>: The backup job is in progress.</li>
             <li><b>Error</b>: The backup job fails.</li>
           </ul>
         </td>
       </tr>
       <tr>
       	<td>Backup Time</td>
         <td>Time when the latest backup job was executed.</td>
       </tr>
       <tr>
       	<td>Operations</td>
         <td>
         	Select one of the operations on the backup plan, including:
           <ul>
             <li><b>Back Up</b>: Execute a backup job immediately.</li>
             <li><b>Details</b>: Click to view the backup plan details page.</li>
             <li><b>More</b>: Click to select <b>Delete</b> 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.</li>
           </ul>
         </td>
       </tr>
     </tbody>
   </table>

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 <img src="/images/docs/disaster-recovery-and-backup/ui/refresh.png" width="15" /> 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](../../quickstart/create-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 <img src="/images/docs/disaster-recovery-and-backup/ui/edit.png" width="15" /> 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.

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

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

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


   <Notice type='note'>

   A backup job is the actual backup executed according to the settings of the backup plan. You need to ensure that at least one backup job is successfully executed before creating a recovery plan.

   </Notice>

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](https://kubesphere.cloud/en/sign-up/).

- You have [created and successfully executed a backup plan](../../quickstart/create-backup-plan/).

- You have [created a recovery plan](../../quickstart/create-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. 

   <table border="1">
     <tbody>
     	<tr>
       	<th width="100">Parameter</th>
         <th>Description</th>
       </tr>
       <tr>
       	<td>Name</td>
         <td>User-defined name of the recovery plan. Click the name of a recovery plan to enter its details page.</td>
       </tr>
       <tr>
       	<td>Target Cluster</td>
         <td>Name of the target cluster associated with the recovery plan.</td>
       </tr>
       <tr>
       	<td>Associated Backup Plan</td>
         <td>Name of the backup plan associated with the recovery plan.</td>
       </tr>
       <tr>
       	<td>Status</td>
         <td>
         	Status of the recovery plan, including:
           <ul>
             <li><b>Successful</b>: the recovery plan was successfully executed.</li>
             <li><b>In progress</b>: the recovery job is being executed.</li>
             <li><b>Error</b>: the recovery job failed.</li>
           </ul>
         </td>
       </tr>
       <tr>
       	<td>Recovery Time</td>
         <td>Time when the recovery job was started.</td>
       </tr>
       <tr>
       	<td>Operations</td>
         <td>
         	Select an operation on the recovery plan, which includes the following:
           <ul>
             <li><b>Details</b>: click to enter the recovery plan details page.</li>
             <li><b>More</b>: click to select <b>Delete</b> 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.</li>
           </ul>
         </td>
       </tr>
     </tbody>
   </table>

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 <img src="/images/docs/disaster-recovery-and-backup/ui/refresh.png" width="15" /> 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](../../quickstart/create-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 <img src="/images/docs/disaster-recovery-and-backup/ui/edit.png" width="15" /> 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.

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

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

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

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.

Describes how to use the Backup and Recovery page on the console.

Backup and recovery

Introduces different pages on the console.

User Guide


This topic lists frequently asked questions about KubeSphere Backup.

Cluster-related questions:

- [Why my cluster is not ready when creating a backup/recovery plan?](#why-my-cluster-is-not-ready-when-creating-a-backup/recovery-plan?)
- [Do I need to buy a S3-compatible storage repository from QingCloud?](#do-i-need-to-buy-a-s3-compatible-storage-repository-from-qingcloud?)
- [What resources will be covered in a backup?](#what-resources-will-be-covered-in-a-backup?)
- [Can I execute multiple backup/recovery jobs associated with the same cluster at the same time?](#can-i-execute-multiple-backup/recovery-jobs-associated-with-the-same-cluster-at-the-same-time?)
- [Why certain resources have recovery errors when source Kubernetes cluster version is different from target cluster version?](#why-certain-resources-have-recovery-errors-when-source-kubernetes-cluster-version-is-different-from-target-cluster-version?)
- [Why the status of recovery job remains in progress during execution?](#why-the-status-of-recovery-job-remains-in-progress-during-execution?)
- [Can I back up multiple namespaces at once?](#can-i-back-up-multiple-namespaces-at-once?)
- [Can I back up cluster-level resources?](#can-i-back-up-cluster-level-resources?)
- [Can I create CSI volume snapshots?](#can-i-create-csi-volume-snapshots?)
- [Can I back up/recover KubeSphere multi-cluster projects and applications?](#can-i-back-up/recover-kubesphere-multi-cluster-projects-and-applications?)
- [Where are the resources and data in the cluster stored after backup?](#where-are-the-resources-and-data-in-the-cluster-stored-after-backup?)
- [Can I select multiple source namespaces when creating a backup plan?](#can-i-select-multiple-source-namespaces-when-creating-a-backup-plan?)
- [Can I delete multiple backup jobs at once?](#can-i-delete-multiple-backup-jobs-at-once?)
- [Can I delete a backup/recovery job in progress?](#can-i-delete-a-backup/recovery-job-in-progress?)

Object storage repository-related questions:

- [Do I need to buy a S3-compatible storage repository from QingCloud?](#do-i-need-to-buy-a-s3-compatible-storage-repository-from-qingcloud?)

Backup/recovery-related questions:

- [Why my cluster is not ready when creating a backup/recovery plan?](#why-my-cluster-is-not-ready-when-creating-a-backup/recovery-plan?)
- [Do I need to buy a S3-compatible storage repository from QingCloud?](#do-i-need-to-buy-a-s3-compatible-storage-repository-from-qingcloud?)
- [What resources will be covered in a backup?](#what-resources-will-be-covered-in-a-backup?)
- [Can I execute multiple backup/recovery jobs associated with the same cluster at the same time?](#can-i-execute-multiple-backup/recovery-jobs-associated-with-the-same-cluster-at-the-same-time?)
- [Why certain resources have recovery errors when source Kubernetes cluster version is different from target cluster version?](#why-certain-resources-have-recovery-errors-when-source-kubernetes-cluster-version-is-different-from-target-cluster-version?)
- [Why the status of recovery job remains in progress during execution?](#why-the-status-of-recovery-job-remains-in-progress-during-execution?)
- [Can I back up multiple namespaces at once?](#can-i-back-up-multiple-namespaces-at-once?)
- [Can I back up cluster-level resources?](#can-i-back-up-cluster-level-resources?)
- [Can I create CSI volume snapshots?](#can-i-create-csi-volume-snapshots?)
- [Can I back up/recover KubeSphere multi-cluster projects and applications?](#can-i-back-up/recover-kubesphere-multi-cluster-projects-and-applications?)
- [Where are the resources and data in the cluster stored after backup?](#where-are-the-resources-and-data-in-the-cluster-stored-after-backup?)
- [Can I select multiple source namespaces when creating a backup plan?](#can-i-select-multiple-source-namespaces-when-creating-a-backup-plan?)
- [Can I delete multiple backup jobs at once?](#can-i-delete-multiple-backup-jobs-at-once?)
- [Can I delete a backup/recovery job in progress?](#can-i-delete-a-backup/recovery-job-in-progress?)

## Why my cluster is not ready when creating a backup/recovery plan?

- After you import a cluster, it will take about 5 minutes to install backup and recovery components on the cluster. The actual installation speed is dependent on the network speed. The cluster remains as not ready until the components are up and running.
- If the kubeconfig used for connecting the cluster is invalid, the cluster is not ready.

## Do I need to buy a S3-compatible storage repository from QingCloud?

No. You just need to ensure the object storage repository to be added is compatible with AWS S3 Standard and accessible to the internet.

## What resources will be covered in a backup?

A backup covers all the resources and other data selected by you for backup in the source namespace, including workloads, projects, user permissions, and persistent data.

## Can I execute multiple backup/recovery jobs associated with the same cluster at the same time?

No. You can execute multiple backup/recovery jobs associated with the same cluster, but they can only be executed once at a time in sequence.

## Why certain resources have recovery errors when source Kubernetes cluster version is different from target cluster version?

Errors may occur when the resource (Kubernetes built-in objects or CRDs) versions in the source cluster is different from the target cluster. Please ensure that the resource versions in the source cluster are compatible with the target cluster.

## Why the status of recovery job remains in progress during execution?

The Service does not support storage class detection for now. If the target cluster does not have the storage class backed up by the backup job associated with the recovery job, the persistent volume created through the storage class in the source cluster in the target cluster will remain in `pending` status, which causes the recovery job remains in progress. Please check the storage class in the target cluster when creating a recovery plan.

## Can I back up multiple namespaces at once?

Not supported for now and will be available in the future.

## Can I back up cluster-level resources?

Not supported for now and will be available in the future.

## Can I create CSI volume snapshots?

Yes. You have to ensure that your Kubernetes cluster has the appropriate volume snapshot class. For more information, see [Create volume snapshot class](../quickstart/create-backup-plan/#create-volume-snapshot-class).

## Can I back up/recover KubeSphere multi-cluster projects and applications?

Not supported for now and will be available in the future.

## Where are the resources and data in the cluster stored after backup?

If you use a hosted repository, resources and data will be stored in the cloud storage repository in QingCloud. If you use a S3-compatible repository, resources and data will be stored in the storage repository you added.

## Can I select multiple source namespaces when creating a backup plan?

Not supported for now and will be available in the future.

## Can I delete multiple backup jobs at once?

Not supported for now and will be available in the future. If you need to delete multiple backup jobs, you can delete the backup plan to delete all the backup jobs under the backup plan.

## Can I delete a backup/recovery job in progress?

Not supported.


Lists frequently asked questions about KubeSphere Backup.

FAQs


After you import a Kubernetes cluster, a namespace `qiming-backend` will be created on the cluster for installing backup and recovery components, including Velero installer and Velero itself.

This document describes how to troubleshoot issues related to KubeSphere Backup.

## Kubernetes cluster resource request

To let backup and recovery components run smoothly, make sure your Kubernetes cluster has enough resource requests. The default resource settings are described as follows:

1. The Velero installer is a DaemonSet named `restic` that controls the transmission of local files to an S3 storage repository. Its resource request is as follows:

   ```yaml
   name: restic
   resources:
     limits:
       cpu: "1"
       memory: 1Gi
     requests:
       cpu: 500m
       memory: 512Mi
   ```

   <Notice type='note'>

   The default settings are recommended. To change the resource settings, run `kubectl edit daemonset restic -n qiming-backend`,  modify the settings under `spec.template.spec.containers.resources`, and save your changes.

   </Notice>

2. Velero is a 1-replica Deployment that handles the control logic of Velero, including backup and recovery. Its resource request is as follows:

   ```yaml
   name: velero
   resources:
     limits:
       cpu: "1"
       memory: 1000Mi
     requests:
       cpu: 500m
       memory: 256Mi
   ```

   <Notice type='note'>

   The default settings are recommended. To change the resource settings, run `kubectl edit deploy velero -n qiming-backend`, modify the settings under `spec.template.spec.containers.resources`, and save your changes.

   </Notice>

## Obtain the component logs

If the backup and recovery components do not run properly, please try to obtain the logs of relevant pods for troubleshooting.

1. On the control plane of your cluster, run the following command to obtain the information of pods running in the `qiming-backend` namespace.

   ```bash
   $ kubectl get pods -n qiming-backend
   NAME                                READY   STATUS    RESTARTS   AGE
   restic-98lc4                        1/1     Running   0          80m
   velero-564c9df5c6-mn2s7             1/1     Running   0          80m
   velero-installer-66d65557c4-dz86t   1/1     Running   0          83m
   ```

2. Run the following command to obtain the logs of Velero pods.

   ```bash
   kubectl logs <Velero pod ID> -n qiming-backend > /tmp/velero.log
   ```

3. Run the following command to obtain the logs of the `restic` pods.

   ```bash
   kubectl logs <restic pod ID> -n qiming-backend > /tmp/restic.log
   ```

## Obtain backup and recovery information and logs

If any backup job or recovery job is not running properly, please obtain the information and logs of the abnormal job for troubleshooting.

### Prerequisites

1. Make sure your machine can access the cluster with an error reported.

2. Download the installation package for Velero v1.7.0 according to your environment from [this page](https://github.com/vmware-tanzu/velero/releases/tag/v1.7.0).

3. Run the following command to unzip the installation package and view the version information.

   ```bash
   tar -xvf <installation package filename>
   cd <installation package directory>
   chmod +x velero
   ./velero version
   ```

4. Run the following command to create a configuration file and edit it.

   ```bash
   mkdir -p $HOME/.config/velero
   vi $HOME/.config/velero/config.json
   ```

5. Enter the following content in the configuration file to link the configuration file to the `qiming-backend` namespace. Save the changes when you finish.

   ```json
   {
     "namespace": "qiming-backend"
   }
   ```
   
6. Save the kubeconfig of the cluster for troubleshooting to `~/.kube/config`. By default, Velero uses this kubeconfig to connect to the cluster. You can also use `velero --kubeconfig=<your-kubeconfig-file>` to specify the path of the kubeconfig.

### Obtain information and logs of a backup job

1. Run the following command to view the information of backup jobs.

   ```bash
   ./velero get backups
   ```

2. Run the following command to view the details of backup jobs.

   ```bash
   ./velero describe backup <backup job name>
   ```

3. Run the following command to view the logs of backup jobs.

   ```bash
   ./velero backup logs <backup job name>
   ```

### Obtain information and logs of a recovery job

1. Run the following command to view the information of recovery jobs.

   ```bash
   ./velero get restores
   ```

2. Run the following command to view the details of recovery jobs.

   ```bash
   ./velero describe restore <recovery job name>
   ```

3. Run the following command to view the logs of recovery jobs.

   ```bash
   ./velero restore logs <recovery job name>
   ```

## Troubleshooting for components installation

-  A pod cannot start running in the `qiming-backend` namespace.

  1. Run the following command to view the causes of start failure.

     ```bash
     kubectl -n qiming-backend describe pod <pod name>
     ```

  2. If the output shows error in pulling images, run the following command to check whether the current node or cluster can pull images.

     ```bash
     docker pull registry.cn-shanghai.aliyuncs.com/jibudata/velero-installer:xxx
     ```

  3. If the output shows insufficient resources in the cluster, please ensure [your cluster has sufficient resources](#kubernetes-cluster-resource-request). 

- `restic` DaemonSet errors.

  1. Run the following command to view the causes of errors.

     ```bash
     kubectl -n qiming-backend describe pod <restic pod name>
     ```

  2. The `restic` DaemonSet accesses the PVC data for backup by mounting the kubelet directory `/var/lib/kubelet/pods`. If the kubelet path of your Kubernetes cluster is different from that path, run the following command to change the value of `spec.template.spec.volumes.hostPath.path` to the correct path and save the changes.

     ```bash
     kubectl edit daemonset restic -n qiming-backend
     ```


## Backup troubleshooting

### Backup job remains in progress

1. Run the following command to view the information about backup jobs.

   ```bash
   ./velero get backups
   ```

2. Run the following command to view the details of the backup jobs remaining in progress and do troubleshooting according to the details.

   ```bash
   ./velero describe backup <backup job name> --details
   ```

### Backup job failure

1. Run the following command to view the information about backup jobs.

   ```bash
   ./velero get backups
   ```

2. Run the following command to view the details of the failed backup jobs and do troubleshooting according to the output in `Errors`.

   ```bash
   ./velero describe backup <backup job name> --details
   ```

## View backup/recovery CR information

### View CRs of a backup job

1. Run the following command to view all the CRs of the backup jobs.

   ```bash
   $ kubectl get backups.velero.io -n qiming-backend
   NAME                      AGE
   test-backup-4lx3w-vfg5q   2d19h
   ```

   <Notice type='note'>

   The prefix of the backup CR name is the backup job name created by the system. For example, if you create a backup plan named `test-backup1`, then the corresponding backup job CR name is `test-backup1-xxxxx-xxxxx`.

   </Notice>

2. Run the following command to view the status of the backup job CR.

   ```bash
   kubectl get backups.velero.io -n qiming-backend <backup job CR name> -o yaml
   ```

   <Notice type='note'>

   Pay attention to the `status.phase` in the output to look for any error or warning information.

   </Notice>

### View CRs of a recovery job

1. Run the following command to view all the CRs of the recovery jobs.

   ```bash
   kubectl get restores.velero.io -n qiming-backend
   ```

2. Run the following command to view the status of the CR of a recovery job.

   ```bash
   kubectl get restores.velero.io -n qiming-backend <restore cr name> -o yaml
   ```



Describes how to troubleshoot issues related to KubeSphere Backup.

Troubleshooting

KubeSphere Backup is a SaaS service that helps you back up your Kubernetes cluster resources to your object storage repositories.