通过kubectl实现集群应用的备份和恢复

使用场景

• 因权限问题，无法通过容器服务控制台操作备份中心。

• 容灾备份流程需要自动化实现。

注意事项

• 备份及恢复任务不能通过kubectl的delete命令简单删除。请参见下文步骤四：删除集群备份中心的相关资源。

• 关注备份中心组件migrate-controller版本发布情况，并及时升级。请参见管理组件。

• 请勿删除下文示例代码中出现的配置参数，以免备份恢复失败。

步骤一：创建备份仓库

1. 使用以下内容，在备份集群和恢复集群中创建backuplocation.yaml文件。

   apiVersion: csdr.alibabacloud.com/v1beta1
   kind: BackupLocation
   metadata:
     name: <yourBackuplocationName>
     namespace: csdr
   spec:
     backupSyncPeriod: 0s
     config:
       network: internal
       region: cn-beijing
     objectStorage:
       bucket: <cnfs-oss-yourBucketName>
       prefix: <subDir>
     provider: alibabacloud

   其余参数无需设置，保持默认配置即可。

   参数	是否必选	说明

   参数	是否必选	说明
   name	是	备份仓库的名称，须符合K8s命名规则。
   network	是	OSS Bucket的网络访问方式。取值： internal：内网访问模式，所有关联集群与OSS Bucket需处于同一地域。 public：公网访问模式，无地域限制。
   region	是	OSS Bucket所在地域。
   bucket	是	OSS Bucket名称，需提前创建，且名称需符合以cnfs-oss-****开头的命名规则。
   prefix	否	OSS Bucket子目录。设定该参数后，实际备份内容存储在此子目录下。

2. 分别在备份集群和恢复集群中执行以下命令，部署backuplocation对象。

   kubectl apply -f backuplocation.yaml

3. 分别在备份集群和恢复集群中执行以下命令，查看backuplocation的状态。

   kubectl describe backuplocation <yourBackuplocationName> -n csdr

   预期输出：

   ...
   Status:
     Last Validation Time:  2022-12-08T04:00:22Z
     Message:               success by csdr-controller
     Phase:                 Available

   由预期输出可看到，已创建的备份仓库状态为Available，说明当前集群具有访问OSS的权限可以直接访问。

步骤二：创建备份任务

步骤三：创建恢复任务

1. 使用以下内容，在恢复集群中创建applicationrestore.yaml文件。

   apiVersion: csdr.alibabacloud.com/v1beta1
   kind: ApplicationRestore
   metadata:
     annotations:    
       csdr.alibabacloud.com/backuplocations: >-
         {"name":"<yourBackuplocationName>","region":"cn-beijing","bucket":"<cnfs-oss-yourBucketName>","prefix":"<subDir>","provider":"alibabacloud"}
     name: <yourApplicationRestoreName>
     namespace: csdr
   spec:
     appRestoreOnly: false
     preserveNodePorts: true
     includedNamespaces:
       - default
     includedResources:
       - statefulset
     excludedResources:
       - secret
     convertedarg:
     - convertToStorageClassType: alicloud-disk-topology-alltype
       convertToAccessModes:
       - ReadWriteOnce
       namespace: nas
       persistentVolumeClaim: pvc-nas
     - convertToStorageClassType: alicloud-disk-topology-alltype
       namespace: oss
       persistentVolumeClaim: pvc-oss
     backupName: <yourApplicationBackupName>
     namespaceMapping:
       <backupNamespace>: <restoreNamespace>
     imageRegistryMapping:
       <oldImageRegistry>: <newImageRegistry>

   其余参数无需设置，保持默认配置即可。

   说明

   appRestoreOnly、preserveNodePorts、includedResources、excludedResources 这几个参数只支持应用备份，在数据保护场景配置不生效。

   参数	是否必选	说明

   参数	是否必选	说明
   csdr.alibabacloud.com/backuplocations	是	备份所在的备份仓库信息，需与备份仓库的配置一致。
   name	是	恢复任务的名称。
   appRestoreOnly	否	该参数仅对应用备份类型的任务生效，数据保护类型任务下不生效。 对于备份了存储卷的备份，是否仅恢复应用，不恢复存储声明、存储卷及其对应的数据，取值： true：仅恢复应用。如果您需要更改备份应用的数据源，可以先手动创建存储声明、存储卷，然后再创建恢复任务并将该参数设置为true。 false：恢复应用以及相关的存储数据，默认为false。
   preserveNodePorts	否	该参数仅对应用备份类型的任务生效，数据保护类型任务下不生效。 是否保持应用的NodePort端口。当备份集群与恢复集群相同时，默认为false，将随机修改端口值，避免与已有的同类应用冲突。否则设置为true。
   includedNamespaces	是	指定恢复的命名空间名称。设置为空时，表示恢复所有已备份的命名空间。
   includedResources	否	该参数仅对应用备份类型的任务生效，数据保护类型任务下不生效。 指定待恢复的集群资源类型。 重要 为避免非预期备份结果，includedResources和excludedResources您只需配置一项。均为空时，表示恢复所有已备份的资源类型。
   excludedResources	否	该参数仅对应用备份类型的任务生效，数据保护类型任务下不生效。 排除待恢复的集群资源类型。 重要 为避免非预期备份结果，includedResources和excludedResources您只需配置一项。均为空时，表示恢复所有已备份的资源类型。
   backupName	是	待恢复的备份名称。使用定期备份功能时，需要指定为某个时间点创建的备份名称，例如<yourBackupScheduleName>-20221205225845。
   namespaceMapping	否	重定义命名空间。取值： <backupNamespace>：创建备份任务时指定的备份集群命名空间。 <restoreNamespace>：根据备份创建的资源在恢复集群所在的命名空间。若不设置，则默认在同名命名空间中恢复。 说明 若<restoreNamespace>不存在，将创建新的命名空间。
   imageRegistryMapping	否	重定义镜像仓库地址，作用范围为所有应用符合规则的镜像配置。取值： <oldImageRegistry>：备份中应用的原镜像仓库地址。 <newImageRegistry>：恢复时的目标镜像仓库地址。若不设置，则不变更应用中的镜像的配置。 示例： 原集群应用使用的镜像为registry.cn-beijing.aliyuncs.com/my-registry/nginx:v1，需要调整至registry.cn-hangzhou.aliyuncs.com/my-registry/nginx:v1。在该字段配置： namespaceMapping: "registry.cn-beijing.aliyuncs.com/my-registry/": "registry.cn-beijing.aliyuncs.com/my-registry/"
   convertedarg	否	存储类转换列表。备份中的FileSystem数据类型的存储卷（OSS、NAS、CPFS、本地存储等）的存储声明，在当前集群中恢复为目标存储类，实现例如NAS存储至云盘存储的转换。 convertToStorageClassType：目标存储类，需要在当前集群已存在。当前版本仅支持选择云盘或NAS类型的存储类。 namespace：存储声明所在的命名空间。 persistentVolumeClaim：存储声明名称。 以上为存储类转换功能中的必选参数。 存储类转换时，同时支持通过以下可选参数修改存储卷的AccessModes配置。 convertToAccessModes：目标AccessModes列表。 说明 AccessModes为ReadWriteMany或ReadOnlyMany的存储卷需要恢复至云盘存储类时，需要同时将AccessModes转换为ReadWriteOnce，避免强制拔盘风险。 您可以通过kubectl -ncsdr describe <backup-name>查询备份的存储声明信息，在输出的status.resourceList.dataResource.pvcBackupInfo列表中dataType字段为数据类型，分为FileSystem与Snapshot，nameSpace与pvcName分别为存储声明所在的命名空间与存储声明名称。

2. 在恢复集群中执行以下命令，部署applicationrestore对象。

   kubectl apply -f applicationrestore.yaml

3. 在恢复集群中执行以下命令，查看恢复任务的状态。

   kubectl describe applicationrestore <yourApplicationRestoreName> -n csdr

   预期输出：

   ...
   Status:
     Completion Timestamp:  2022-12-05T15:52:19Z
     Phase:                 Completed
     Start Timestamp:       2022-12-05T15:52:09Z

   当恢复任务由Inprogress转为Completed状态，说明恢复任务创建成功。

步骤四：删除集群备份中心的相关资源

删除定时备份计划

执行以下命令，删除定时备份计划BackupSchedule资源，停止定时备份。

kubectl delete backupschedule <yourBackupSchedule> - ncsdr

删除备份任务或恢复任务

1. 使用以下内容，在待删除任务的集群中创建deleterequest.yaml文件。

   apiVersion: csdr.alibabacloud.com/v1beta1
   kind: DeleteRequest
   metadata:
     name: <objectName-dbr>
     namespace: csdr
   spec:
     deleteObjectName: <objectName>
     deleteObjectType: "Backup"

   其余参数无需设置，保持默认配置即可。

   参数	是否必选	说明

   参数	是否必选	说明
   name	是	删除请求的名称。 删除备份任务时：待删除的备份任务ApplicationBackup的名称+“-dbr”。 删除恢复任务时：待删除的恢复任务ApplicationRestore的名称+“-dbr”。
   deleteObjectName	是	待删除的资源名称。
   deleteObjectType	是	待删除的资源类型。取值： "Backup"：删除备份任务ApplicationBackup及配套资源。 "Restore"：删除恢复任务ApplicationRestore及配套资源。 说明 删除备份任务不会影响已同步到集群中的副本。 删除恢复任务不会影响已恢复的内容。

2. 在待删除任务的集群中执行以下命令，部署deleterequest删除请求。

   kubectl apply -f deleterequest.yaml

3. 使用以下命令，查看资源状态。

   • 查看删除的备份任务

     • 执行以下命令，查看删除备份任务的状态。

       kubectl get applicationbackup <yourApplicationBackupName> -n csdr

       预期输出：

       Error from server (NotFound): applicationbackups.csdr.alibabacloud.com "yourApplicationBackupName" not found

       由预期输出可看到，备份任务资源已被删除。

     • 执行以下命令，查看删除请求资源的状态。

       kubectl get deleterequest <yourApplicationBackupName-dbr> -n csdr

       预期输出：

       Error from server (NotFound): deleterequests.csdr.alibabacloud.com "yourApplicationBackupName-dbr" not found

       由预期输出可看到，除备份任务资源被删除外，删除请求的相关资源也自动被删除。

   • 查看删除的恢复任务

     • 执行以下命令，查看删除备份任务的状态。

       kubectl get applicationrestore <yourApplicationRestoreName> -n csdr

       预期输出：

       Error from server (NotFound): applicationrestores.csdr.alibabacloud.com "yourApplicationRestoreName" not found

       由预期输出可看到，恢复任务资源已被删除。

     • 执行以下命令，查看删除请求资源的状态。

       kubectl get deleterequest <yourApplicationRestoreName-dbr> -n csdr

       预期输出：

       Error from server (NotFound): deleterequests.csdr.alibabacloud.com "yourApplicationRestoreName-dbr" not found

       由预期输出可看到，除恢复任务资源被删除外，删除请求的相关资源也自动被删除。

相关文档

• 如果需要通过控制台实现集群应用的备份迁移，请根据实际需求参见如下文档：

  • 集群内备份和恢复应用

  • 同地域跨集群迁移应用

  • 跨地域跨集群迁移应用

• 如果需要实现跨存储插件、跨版本集群间的应用迁移，请参见通过备份中心实现低版本Kubernetes集群应用迁移。

• 使用Terraform备份和恢复应用