使用Terraform备份和恢复应用

前提条件

• 已创建ACK集群，且集群版本为1.18及以上版本。具体操作，请参见创建ACK托管版集群。

• 已安装备份服务组件并完成对应权限的配置。具体操作，请参见安装migrate-controller备份服务组件并配置权限。您也可以使用Terraform安装组件。

• 已创建用于存储备份的OSS Bucket，并以cnfs-oss-*格式命名。具体操作，请参见使用Terraform管理OSS、alicloud_oss_bucket。

• 若需要使用存储卷备份，还需要开通ECS快照服务和HBR云备份服务。相关信息，请参见开通OSS服务、开通快照、开通云备份。

注意事项

• 请勿通过kubectl的delete命令删除备份及恢复任务，避免相关云资源删除不彻底。备份相关的删除操作，请参见下文步骤五：删除集群备份中心的相关资源。

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

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

步骤一：关联集群

您可以通过Kubernetes Provider关联集群，关于Provider更多信息，请参见Kubernetes Provider。

本示例以使用KubeConfig文件为例介绍如何关联集群。

1. 创建Terraform工作目录。

2. 在Terraform工作目录中创建名为csdr.tf配置文件，并在该配置文件中加入以下内容，用于关联KubeConfig文件。

   provider "kubernetes" {
     config_path = "~/.kube/config"
   }

3. 执行以下命令，初始化Terraform运行环境。

   terraform init

   返回信息如下，表明Terraform初始化成功。

   展开查看返回信息

   Initializing the backend...
   
   Initializing provider plugins...
   - Reusing previous version of hashicorp/alicloud from the dependency lock file
   - Reusing previous version of hashicorp/kubernetes from the dependency lock file
   - Using previously-installed hashicorp/alicloud v1.223.1
   - Using previously-installed hashicorp/kubernetes v2.30.0
   
   ╷
   │ Warning: Additional provider information from registry
   │
   │ The remote registry returned warnings for registry.terraform.io/hashicorp/alicloud:
   │ - For users on Terraform 0.13 or greater, this provider has moved to aliyun/alicloud. Please
   │ update your source in required_providers.
   ╵
   
   Terraform has been successfully initialized!
   

步骤二：创建备份仓库

1. 在csdr.tf配置文件中加入以下内容，并根据实际需求修改。

   resource "kubernetes_manifest" "backuplocation-demo" {
     manifest = {
       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"  
       }
     }
     wait {
       fields = {
         "status.phase" = "Available"
       }
     }
   
     timeouts {
       create = "10m"
     }
   }

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

2. 执行以下命令，生成资源规划。

   terraform plan

   返回信息如下，表明资源规划生成成功。

   展开查看返回信息

     # kubernetes_manifest.backuplocation-demo will be created
     + resource "kubernetes_manifest" "backuplocation-demo" {
         + manifest = {
             + 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"
               }
           }
         + object   = {
             + apiVersion = "csdr.alibabacloud.com/v1beta1"
             + kind       = "BackupLocation"
             + metadata   = {
                 + annotations                = (known after apply)
                 + creationTimestamp          = (known after apply)
                 + deletionGracePeriodSeconds = (known after apply)
                 + deletionTimestamp          = (known after apply)
                 + finalizers                 = (known after apply)
                 + generateName               = (known after apply)
                 + generation                 = (known after apply)
                 + labels                     = (known after apply)
                 + managedFields              = (known after apply)
                 + name                       = "<yourBackuplocationName>"
                 + namespace                  = "csdr"
                 + ownerReferences            = (known after apply)
                 + resourceVersion            = (known after apply)
                 + selfLink                   = (known after apply)
                 + uid                        = (known after apply)
               }
             + spec       = {
                 + accessMode          = (known after apply)
                 + backupSyncPeriod    = "0s"
                 + config              = {
                     + network = "internal"
                     + region  = "cn-beijing"
                   }
                 + objectStorage       = {
                     + bucket = "<cnfs-oss-yourBucketName>"
                     + caCert = (known after apply)
                     + prefix = "<subDir>"
                   }
                 + provider            = "alibabacloud"
                 + validationFrequency = (known after apply)
               }
           }
   
         + timeouts {
             + create = "10m"
           }
   
         + wait {
             + fields = {
                 + "status.phase" = "Available"
               }
           }
       }

3. 执行以下命令，创建备份仓库。

   terraform apply

   返回信息如下，表明备份仓库创建成功。

   kubernetes_manifest.backuplocation-demo: Creating...
   kubernetes_manifest.backuplocation-demo: Creation complete after 1s
   
   Apply complete! Resources: 1 added, 0 changed, 0 destroyed.

步骤三：创建备份任务

步骤四：创建恢复任务

1. 在csdr.tf配置文件中加入以下内容，并根据实际需求修改。

   resource "kubernetes_manifest" "applicationrestore-demo" {
     manifest = {
       apiVersion  = "csdr.alibabacloud.com/v1beta1"
       kind        = "ApplicationRestore"
       metadata = {
         name        = "<yourApplicationRestoreName>"
         namespace   = "csdr"
         annotations = {
           "csdr.alibabacloud.com/backuplocations" = "{\"name\":\"<yourBackuplocationName>\",\"region\":\"cn-beijing\",\"bucket\":\"<cnfs-oss-yourBucketName>\",\"prefix\":\"<subDir>\",\"provider\":\"alibabacloud\"}"
         }
       }
       spec = {
         appRestoreOnly 		= "false"
         preserveNodePorts		= "true"
         includedNamespaces 	= ["default","default1"]
         includedResources 	= ["statefulset"]
         excludedResources 	= ["excludedResources"]
         convertedarg = [
         {
           convertToStorageClassType	= "alicloud-disk-topology-alltype"
           namespace									= "default"
           persistentVolumeClaim		= "pvc-nas"
         },
         {
           convertToStorageClassType	= "alicloud-disk-topology-alltype"
           namespace									= "default1"
           persistentVolumeClaim		= "pvc-oss"
         }
         ]
         backupName			= "<yourApplicationBackupName>"
         namespaceMapping			= {
           "<backupNamespace>" = "<restoreNamespace>"
         }
       }
     }
     
     # 恢复成功完成的标志为status.phase转化为Completed阶段。
     # 恢复时长与集群应用数量、存储卷数据量有关。
     #wait {
     #  fields = {
     #    "status.phase" = "Completed"
     #  }
     #}
   
     #timeouts {
     #  create = "60m"
     #}
   }

   参数	是否必选	说明
   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>不存在，将创建新的命名空间。
   convertedarg	否	转换存储类列表。备份中的FileSystem数据类型的存储卷（OSS、NAS、CPFS、本地存储等）的存储声明，在当前集群中恢复为目标存储类，实现例如NAS存储至云盘存储的转换。 convertToStorageClassType：目标存储类，需要在当前集群已存在。当前版本仅支持选择云盘或NAS类型的存储类。 namespace：存储声明所在的命名空间。 persistentVolumeClaim：存储声明名称。 您可以通过kubectl -ncsdr describe <backup-name>查询备份的存储声明信息，在输出的status.resourceList.dataResource.pvcBackupInfo列表中dataType字段为数据类型，分为FileSystem与Snapshot，nameSpace与pvcName分别为存储声明所在的命名空间与存储声明名称。

2. 执行以下命令，生成资源规划。

   terraform plan

   返回信息如下，表明资源规划生成成功。

   展开查看返回信息

     # kubernetes_manifest.applicationrestore-demo will be created
     + resource "kubernetes_manifest" "applicationrestore-demo" {
         + manifest = {
             + apiVersion = "csdr.alibabacloud.com/v1beta1"
             + kind       = "ApplicationRestore"
             + metadata   = {
                 + annotations = {
                     + "csdr.alibabacloud.com/backuplocations" = "{name:<yourBackuplocationName>,region:cn-beijing,bucket:<cnfs-oss-yourBucketName>,prefix:subpath,provider:alibabacloud}"
                   }
                 + name        = "<yourApplicationRestoreName>"
                 + namespace   = "csdr"
               }
             + spec       = {
                 + appRestoreOnly     = "false"
                 + backupName         = "<yourApplicationbackupName>"
                 + convertedarg       = [
                     + {
                         + convertToStorageClassType = "alicloud-disk-topology-alltype"
                         + namespace                 = "default"
                         + persistentVolumeClaim     = "pvc-nas"
                       },
                     + {
                         + convertToStorageClassType = "alicloud-disk-topology-alltype"
                         + namespace                 = "default1"
                         + persistentVolumeClaim     = "pvc-oss"
                       },
                   ]
                 + excludedResources  = [
                     + "excludedResources",
                   ]
                 + includedNamespaces = [
                     + "default",
                     + "default1",
                   ]
                 + includedResources  = [
                     + "statefulset",
                   ]
                 + namespaceMapping   = {
                     + default = "default1"
                   }
                 + preserveNodePorts  = "true"
               }
           }
         + object   = {
             + apiVersion = "csdr.alibabacloud.com/v1beta1"
             + kind       = "ApplicationRestore"
             + metadata   = {
                 + annotations                = (known after apply)
                 + creationTimestamp          = (known after apply)
                 + deletionGracePeriodSeconds = (known after apply)
                 + deletionTimestamp          = (known after apply)
                 + finalizers                 = (known after apply)
                 + generateName               = (known after apply)
                 + generation                 = (known after apply)
                 + labels                     = (known after apply)
                 + managedFields              = (known after apply)
                 + name                       = "<yourApplicationRestoreName>"
                 + namespace                  = "csdr"
                 + ownerReferences            = (known after apply)
                 + resourceVersion            = (known after apply)
                 + selfLink                   = (known after apply)
                 + uid                        = (known after apply)
               }
             + spec       = {
                 + appRestoreOnly          = false
                 + backupName              = "<yourApplicationbackupName>"
                 + convertedarg            = [
                     + {
                         + convertToStorageClassType = "alicloud-disk-topology-alltype"
                         + namespace                 = "default"
                         + persistentVolumeClaim     = "pvc-nas"
                       },
                     + {
                         + convertToStorageClassType = "alicloud-disk-topology-alltype"
                         + namespace                 = "default1"
                         + persistentVolumeClaim     = "pvc-oss"
                       },
                   ]
                 + excludedNamespaces      = (known after apply)
                 + excludedResources       = [
                     + "excludedResources",
                   ]
                 + existingResourcePolicy  = (known after apply)
                 + includeClusterResources = (known after apply)
                 + includedNamespaces      = [
                     + "default",
                     + "default1",
                   ]
                 + includedResources       = [
                     + "statefulset",
                   ]
                 + labelSelector           = {
                     + matchExpressions = (known after apply)
                     + matchLabels      = (known after apply)
                   }
                 + namespaceMapping        = {
                     + default = "default1"
                   }
                 + preserveNodePorts       = true
                 + pvRestore               = {
                     + pvcPrefix = (known after apply)
                     + pvcSuffix = (known after apply)
                   }
                 + pvRestoreOnly           = (known after apply)
               }
           }
       }

3. 执行以下命令，创建恢复任务。

   terraform apply

   返回信息如下，表明恢复任务创建完成。

   kubernetes_manifest.applicationbackup-demo: Creating...
   kubernetes_manifest.applicationrestore-demo: Creation complete after 1s
   
   Apply complete! Resources: 1 added, 0 changed, 0 destroyed.

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

删除定时备份计划

您可以直接通过terraform destroy删除定时备份计划BackupSchedule资源，停止定时备份。

删除备份任务或恢复任务

1. 在csdr.tf配置文件中加入以下内容，并根据实际需求修改。

   resource "kubernetes_manifest" "deleterequest-demo" {
     manifest = {
       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. 执行以下命令，生成资源规划。

   terraform plan

   返回信息如下，表明资源规划生成成功。

   展开查看返回信息

     # kubernetes_manifest.deleterequest-demo will be created
     + resource "kubernetes_manifest" "deleterequest-demo" {
         + manifest = {
             + apiVersion = "csdr.alibabacloud.com/v1beta1"
             + kind       = "DeleteRequest"
             + metadata   = {
                 + name      = "<objectName-dbr>"
                 + namespace = "csdr"
               }
             + spec       = {
                 + deleteObjectName = "<objectName>"
                 + deleteObjectType = "Backup"
               }
           }
         + object   = {
             + apiVersion = "csdr.alibabacloud.com/v1beta1"
             + kind       = "DeleteRequest"
             + metadata   = {
                 + annotations                = (known after apply)
                 + creationTimestamp          = (known after apply)
                 + deletionGracePeriodSeconds = (known after apply)
                 + deletionTimestamp          = (known after apply)
                 + finalizers                 = (known after apply)
                 + generateName               = (known after apply)
                 + generation                 = (known after apply)
                 + labels                     = (known after apply)
                 + managedFields              = (known after apply)
                 + name                       = "<objectName-dbr>"
                 + namespace                  = "csdr"
                 + ownerReferences            = (known after apply)
                 + resourceVersion            = (known after apply)
                 + selfLink                   = (known after apply)
                 + uid                        = (known after apply)
               }
             + spec       = {
                 + backupName       = (known after apply)
                 + deleteObjectName = "<objectName>"
                 + deleteObjectType = "Backup"
               }
           }
       }

3. 执行以下命令，删除资源。

   terraform apply

   返回信息如下，表明deleterequest资源删除请求生效。

   kubernetes_manifest.deleterequest-demo: Creating...
   kubernetes_manifest.deleterequest-demo: Creation complete after 0s
   
   Apply complete! Resources: 1 added, 0 changed, 0 destroyed.

   说明

   系统根据deleterequest资源删除请求，对应的备份或恢复任务删除后，deleterequest资源也会被删除。

相关文档

• 如需通过kubectl备份和恢复应用，请参见通过kubectl实现集群应用的备份和恢复。

• 如需通过容器服务控制台备份和恢复应用，请参见如下文档：

  • 集群内备份和恢复应用

  • 同地域跨集群迁移应用

  • 跨地域跨集群迁移应用

  • 通过注册集群实现跨账号ACK集群的备份与恢复