Updated on 2024-06-17 GMT+08:00

e-backup

Introduction

e-backup is a subsystem in Everest 2.0 (cloud native storage system) for protecting cloud native application data. With e-backup, you can back up application data (Kubernetes resources) and service data (data in PVs) to OBS and restore backup data to a specified cluster.

The backup and restoration functions of e-backup are available for:

  • Single cluster DR

    The data of applications in a cluster is periodically backed up. When the cluster or an application is damaged, you can redeploy the application to the cluster to take over services in disaster scenarios.

  • Intra-cluster/Cross-cluster clone

    If multiple applications need to be cloned across clusters, especially the applications that have been working in a cluster for a period of time, their data is backed up and then restored to different namespaces in the same cluster or other clusters.

  • Cross-cluster/Cross-cloud migration

    If applications need to be migrated from a cluster to another cluster across regions or from another cloud to CCE due to network, cost, or service location changes, their data is backed up and then restored to the destination cluster.

Constraints

  • The cluster version must be 1.15 or later and have at least one available node.
  • When e-backup is installed in a cluster, the cluster image can be pulled from SWR.
  • To prevent failures or incomplete data, you cannot add, delete, or modify the cluster during the backup or restoration. If there are any changes to a cluster, you are advised to wait for 15 minutes until the cluster is stable and then perform the backup operation.
  • e-backup integrates the PV data backup capability of restic. e-backup can create a snapshot for the data at the backup time point and upload the data, which does not affect subsequent data read and write. However, restic does not verify the file content and service consistency.
  • The memory occupied by restic depends on the size of the PV data backed up for the first time. If there is more than 300 GB of data, use the data migration method provided by the cloud storage. If you use application data management to migrate a large amount of PV data, you can modify the resource levels of the restic instance. For details, see Modifying Add-on Settings.
  • e-backup complies with velero and restic constraints. For example, during the restoration, the Service will clear the ClusterIP to better adapt to the differences between the source and target clusters.
  • When restoring an application in a CCE cluster that uses a secret (cfe/secure-opaque) for data encryption to another cluster, you need to manually create a secret with the same name and type as the original cluster. This ensures that the restored application runs normally.

Installing e-backup

e-backup depends on the custom resource BackupStorageLocation and its secret to execute backup and restore tasks. However, the resource will change if it is uninstalled and reinstalled. As a result, if you uninstall e-backup, existing backups may not be restored.

  1. Access the cluster details page.
  2. In the navigation pane, choose Add-ons. In the Add-ons Available area, click Install of e-backup.
  3. Configure the parameters as described in Table 1.

    Table 1 e-backup parameters

    Parameter

    Description

    Add-on Specifications

    Select Standalone.

    Containers

    Configure resource levels for the add-on instance.

    • velero: backup and restoration of Kubernetes metadata.
    • restic: backup and restoration of application data storage volumes.
    NOTE:
    • To ensure the add-on instance can be scheduled, reserve sufficient resources in the cluster.
    • To create an add-on instance, ensure the request is no more than the limit.
    • To avoid add-on faults, adjust the resource limit based on the amount of data to be backed up or restored.

  4. Configure volumeWorkerNum.

    volumeWorkerNum indicates the number of concurrent data volume backup tasks, which defaults to 3.
    {
        "volumeWorkerNum": 3
    }

  5. Click Install and check the add-on status on the Add-ons page.

    Running indicates the add-on has been installed in the cluster.

Modifying Add-on Settings

  1. Access the cluster details page.
  2. In the navigation pane, choose Add-ons. In the Add-ons Installed area, click Edit of e-backup.
  3. Modify the add-on settings. For details about related parameters, see Table 1.
  4. Click OK. The add-on is in the Upgrading state. After the upgrade is complete, new settings will be used.