Velero

Prerequisites

A CCE standard or Turbo cluster v1.29 or later is available.

Notes and Constraints

• If you have deployed the community version of Velero in your cluster, uninstall it before installing the CCE Velero add-on. Otherwise, installation may fail.
• After Velero is uninstalled, related CRDs and custom resources (such as ConstraintTemplates and Constraints) are retained, along with your cluster backup data.

Installing the Add-on

1. Log in to the CCE console and click the cluster name to access the cluster console.
2. In the navigation pane, choose Add-ons. Locate Velero on the right and click Install.
3. On the Install Add-on page, configure the specifications as needed.
   

   Velero runs on a single pod. Running multiple pods concurrently may lead to split-brain and data write conflicts, leading to corrupted backups or failed restorations. The single-pod deployment ensures state consistency and data security.

   • If you select Preset, choose an option based on your cluster size. CCE automatically configures the number of add-on pods and resource quotas according to the selected specification. You can view these configurations on the console.
   • If you selected Custom, you can adjust the number of pods and resource quotas as needed.

     If your cluster is large and the preset specifications do not meet your needs, you can customize resource specifications. Estimate the number of pods in the cluster to determine the add-on's memory requirements before customizing resource specifications. The recommended memory request and limit for typical large clusters can be calculated as follows:

     • Memory request = Number of pods × Pod YAML size (KB)/10000 × 0.05 GiB
     • Memory limit = Memory request + 2 GiB

       For example, consider a cluster with 20,000 pods where each pod YAML is approximately 15 KB. The memory request is calculated as 1.5 GiB (2 × 15 × 0.05 GiB), and the memory limit is 3.5 GiB (1.5 GiB + 2 GiB).

     Table 1 Recommended add-on memory sizes in large-scale scenarios

     Pods (10 KB for Each Pod YAML)	Recommended Memory Request (GiB)	Recommended Memory Limit (GiB)
     10000	1	3
     20000	2	4
     50000	4	6
     100000	8	10
     200000	16	18

4. Configure Agency Settings.
   Add-ons require access to other cloud services during runtime. You must configure an add-on agency to authorize these operations. For details, see Custom Agencies for Add-ons.

   • Create automatically: CCE automatically creates a default agency and assigns it to the add-on. If a default agency already exists, CCE will not create another one.
   • Use existing: Choose an agency from the drop-down list. Ensure that the selected agency has the required permissions. Otherwise, the add-on may not function properly.

5. Configure the add-on parameters.

   Table 2 Extended parameter settings

   Parameter	Description
   annotations	Add annotations to Velero workloads. By default, this parameter is left blank.
   tenant_id	The parameter value is automatically populated with the project ID. Do not change this value when running the add-on.
   cluster_id	The parameter value is automatically populated with the project ID. Do not change this value when running the add-on.

6. Configure deployment policies for the add-on pods.
   

   When configuring multi-AZ deployment or node affinity, ensure that there are nodes meeting the scheduling policy and that resources are sufficient in the cluster. Otherwise, the add-on pods cannot run.

   Table 3 Configurations for add-on scheduling

   Parameter	Description
   Node Affinity	Not configured: Node affinity is disabled for the add-on pods. Specify node: Specify the nodes where the add-on pods are deployed. If you do not specify the nodes, the add-on pods will be randomly scheduled based on the default cluster scheduling policy. Specify node pool: Specify the node pool where the add-on pods are deployed. If you do not specify the node pools, the add-on pods will be randomly scheduled based on the default cluster scheduling policy. Customize affinity: Enter the labels of the nodes where the add-on pods are to be deployed for more flexible scheduling policies. If you do not specify node labels, the add-on pods will be randomly scheduled based on the default cluster scheduling policy. If multiple custom affinity policies are configured, ensure that there are nodes that meet all the affinity policies in the cluster. Otherwise, the add-on pods cannot run.
   Toleration	Using both taints and tolerations enables (but does not require) the add-on's Deployment pods to be scheduled on nodes with matching taints, and allows control over pod eviction policies when host nodes are tainted. The add-on applies default toleration policies for the node.kubernetes.io/not-ready and node.kubernetes.io/unreachable taints on pods. The tolerance time window is 60s. For details, see Configuring Tolerance Policies.

7. Click Install.

Components

How to Use

After installing Velero, you can back up and restore cluster applications in Cluster Backup. For details about features and operations, see Cluster Backup.

Release History