使用Terraform备份和恢复应用

创建立即备份任务

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

   resource "kubernetes_manifest" "applicationbackup-demo" {
     manifest = {
       apiVersion  	= "csdr.alibabacloud.com/v1beta1"
       kind        	= "ApplicationBackup"
       metadata = {
         name		= "<yourApplicationBackupName>"
         namespace 	= "csdr"
         annotations = {
           "csdr.alibabacloud.com/backuplocations" = "{\"name\":\"<yourBackuplocationName>\",\"region\":\"cn-beijing\",\"bucket\":\"<cnfs-oss-yourBucketName>\",\"prefix\":\"<subDir>\",\"provider\":\"alibabacloud\"}"
       }
       spec = {
         includedNamespaces 	= ["default","default1"]
         includedResources 	= ["statefulset"]
         excludedResources 	= ["excludedResources"]
         labelSelector 		= {
           matchLabels 		= {
             "app" = "mysql-sts"
           }
         }
         pvBackup = {
           defaultPvBackup 	= "false"
         } 
         storageLocation 		= "<yourBackuplocationName>"
         ttl									= "720h0m0s"
         includeClusterResources = "false"
       }
     }
     
     #备份成功完成的标志为status.phase转化为Completed阶段
     #备份时长与集群应用数量、存储卷数据量有关
     #wait {
     #  fields = {
     #    "status.phase" = "Completed"
     #  }
     #}
   
     #timeouts {
     #  create = "60m"
     #}
    }
   }

   参数	是否必选	说明
   csdr.alibabacloud.com/backuplocations	是	备份所在的备份仓库信息，需与备份仓库的配置一致。
   name	是	立即备份任务的名称。
   includedNamespaces	是	指定命名空间名称。
   includedResources	否	指定集群资源类型。 重要 为避免非预期备份结果，includedResources和excludedResources您只需配置一项。当两者均为空时，表示备份所有资源类型。
   excludedResources	否	排除集群资源类型。 重要 为避免非预期备份结果，includedResources和excludedResources您只需配置一项。当两者均为空时，表示备份所有资源类型。
   matchLabels	否	指定标签，只备份符合的资源。
   includeClusterResources	否	是否备份Cluster级别的资源，例如StorageClass、CRD、Webhook等。 true：备份所有Cluster级别资源。 false：仅备份被选择的命名空间中的Namespace级别资源引用的Cluster级别资源。例如，备份Pod时，引用的ServiceAccount授权了某ClusterRole，该ClusterRole将被自动备份；备份CR时，CRD将被自动备份。 说明 通过容器服务管理控制台创建的备份任务，默认IncludeClusterResources字段为false。
   defaultPvBackup		是否备份存储卷，开启数据备份。取值： true：备份应用和存储卷。 false：只备份应用。
   storageLocation	是	备份仓库名称。 说明 若您的集群已使用Velero，请加入钉钉用户群（钉钉群号：35532895）咨询。
   ttl	是	备份有效期，即备份任务的数据存储有效期，过期之后数据将无法恢复。格式如720h0m0s，取值范围：24h0m0s~1572864h0m0s。

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

   terraform plan

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

   展开查看返回信息

     # kubernetes_manifest.applicationbackup-demo will be created
     + resource "kubernetes_manifest" "applicationbackup-demo" {
         + manifest = {
             + apiVersion = "csdr.alibabacloud.com/v1beta1"
             + kind       = "ApplicationBackup"
             + metadata   = {
                 + annotations = {
                     + "csdr.alibabacloud.com/backuplocations" = "{name:<yourBackuplocationName>,region:cn-beijing,bucket:<cnfs-oss-yourBucketName>,prefix:<subDir>,provider:alibabacloud}"
                   }
                 + name        = "<yourApplicationBackupName>"
                 + namespace   = "csdr"
               }
             + spec       = {
                 + excludedResources  = [
                     + "excludedResources",
                   ]
                 + includedNamespaces = [
                     + "default",
                     + "default1",
                   ]
                 + includedResources  = [
                     + "statefulset",
                   ]
                 + labelSelector      = {
                     + matchLabels = {
                         + app = "mysql-sts"
                       }
                   }
                 + pvBackup           = {
                     + defaultPvBackup = "false"
                   }
                 + storageLocation    = "vault-a"
                 + ttl                = "720h0m0s"
               }
           }
         + object   = {
             + apiVersion = "csdr.alibabacloud.com/v1beta1"
             + kind       = "ApplicationBackup"
             + 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                       = "<yourApplicationBackupName>"
                 + namespace                  = "csdr"
                 + ownerReferences            = (known after apply)
                 + resourceVersion            = (known after apply)
                 + selfLink                   = (known after apply)
                 + uid                        = (known after apply)
               }
             + spec       = {
                 + backupType              = (known after apply)
                 + excludedNamespaces      = (known after apply)
                 + excludedResources       = [
                     + "excludedResources",
                   ]
                 + includeClusterResources = (known after apply)
                 + includedNamespaces      = [
                     + "default",
                     + "default1",
                   ]
                 + includedResources       = [
                     + "statefulset",
                   ]
                 + labelSelector           = {
                     + matchExpressions = (known after apply)
                     + matchLabels      = {
                         + app = "mysql-sts"
                       }
                   }
                 + orderedResources        = (known after apply)
                 + pvBackup                = {
                     + defaultPvBackup  = false
                     + pvcList          = (known after apply)
                     + pvcSelector      = {
                         + matchExpressions = (known after apply)
                         + matchLabels      = (known after apply)
                       }
                     + snapshotPostRule = (known after apply)
                     + snapshotPreRule  = (known after apply)
                   }
                 + storageLocation     = "<yourBackuplocationName>"
                 + ttl                 = "720h0m0s"
               }
           }
       }
   

3. 执行以下命令，创建立即备份任务。

   terraform apply

   返回信息如下，表明立即备份任务创建成功。

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

创建定时备份计划

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

   展开查看配置文件

   resource "kubernetes_manifest" "backupschedule-demo" {
     manifest = {
       apiVersion  	= "csdr.alibabacloud.com/v1beta1"
       kind        	= "BackupSchedule"
       metadata = {
         name		= "<yourBackupScheduleName>"
         namespace 	= "csdr"
         annotations = {
           "csdr.alibabacloud.com/backuplocations" = "{\"name\":\"<yourBackuplocationName>\",\"region\":\"cn-beijing\",\"bucket\":\"<cnfs-oss-yourBucketName>\",\"prefix\":\"<subDir>\",\"provider\":\"alibabacloud\"}"
         }
       }
       spec = {
         schedule = "1 4 * * *"
         template = {
           includedNamespaces 			= ["default","default1"]
           includedResources 			= ["statefulset"]
           excludedResources 			= ["excludedResources"]
           labelSelector 				= {
             matchLabels 				= {
               "app" = "mysql-sts"
             }
           }
           pvBackup = {
             defaultPvBackup 			= "false"
           } 
           storageLocation 			= "<yourBackuplocationName>"
           ttl											= "720h0m0s"
           includeClusterResources = "false"
         }
       }
     }
     wait {
       fields = {
         "status.phase" = "Enabled"
       }
     }
     timeouts {
       create = "10m"
     }
   }

   参数	是否必选	说明
   csdr.alibabacloud.com/backuplocations	是	备份所在的备份仓库信息，需与备份仓库的配置一致。
   name	是	定时备份计划的名称。
   schedule	是	备份周期，请使用Cron表达式。
   includedNamespaces	是	指定命名空间名称。
   includedResources	否	指定集群资源类型。 重要 为避免非预期备份结果，includedResources和excludedResources您只需配置一项。当两者均为空时，表示备份所有资源类型。
   excludedResources	否	排除集群资源类型。 重要 为避免非预期备份结果，includedResources和excludedResources您只需配置一项。当两者均为空时，表示备份所有资源类型。
   matchLabels	否	指定标签，只备份符合条件的资源。
   includeClusterResources	否	是否备份Cluster级别的资源，例如StorageClass、CRD、Webhook等。 true：备份所有Cluster级别资源。 false：仅备份被选择的命名空间中的Namespace级别资源引用的Cluster级别资源。例如，备份Pod时，引用的ServiceAccount授权了某ClusterRole，该ClusterRole将被自动备份；备份CR时，CRD将被自动备份。 说明 通过容器服务管理控制台创建的备份任务，默认IncludeClusterResources字段为false。
   defaultPvBackup	是	是否备份存储卷，开启数据备份。取值： true：备份应用和存储卷。 false：只备份应用。
   storageLocation	是	备份仓库名称。 说明 若您的集群已使用Velero，请加入钉钉用户群（钉钉群号：35532895）咨询。
   ttl	是	备份有效期，即备份任务的数据存储有效期，过期之后数据将无法恢复。格式如720h0m0s，取值范围：24h0m0s~1572864h0m0s。

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

   terraform plan

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

   展开查看返回信息

     # kubernetes_manifest.backupschedule-demo will be created
     + resource "kubernetes_manifest" "backupschedule-demo" {
         + manifest = {
             + apiVersion = "csdr.alibabacloud.com/v1beta1"
             + kind       = "BackupSchedule"
             + metadata   = {
                 + annotations = {
                     + "csdr.alibabacloud.com/backuplocations" = "{name:<yourBackuplocationName>,region:cn-beijing,bucket:<cnfs-oss-yourBucketName>,prefix:<subDir>,provider:alibabacloud}"
                   }
                 + name        = "<yourBackupscheduleName>"
                 + namespace   = "csdr"
               }
             + spec       = {
                 + schedule = "1 4 * * *"
                 + template = {
                     + excludedResources  = [
                         + "excludedResources",
                       ]
                     + includedNamespaces = [
                         + "default",
                         + "default1",
                       ]
                     + includedResources  = [
                         + "statefulset",
                       ]
                     + labelSelector      = {
                         + matchLabels = {
                             + app = "mysql-sts"
                           }
                       }
                     + pvBackup           = {
                         + defaultPvBackup = "false"
                       }
                     + storageLocation    = "<yourBackuplocationName>"
                     + ttl                = "720h0m0s"
                   }
               }
           }
         + object   = {
             + apiVersion = "csdr.alibabacloud.com/v1beta1"
             + kind       = "BackupSchedule"
             + 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                       = "<yourBackupscheduleName>"
                 + namespace                  = "csdr"
                 + ownerReferences            = (known after apply)
                 + resourceVersion            = (known after apply)
                 + selfLink                   = (known after apply)
                 + uid                        = (known after apply)
               }
             + spec       = {
                 + backupAll = (known after apply)
                 + paused    = (known after apply)
                 + schedule  = "1 4 * * *"
                 + template  = {
                     + backupType              = (known after apply)
                     + excludedNamespaces      = (known after apply)
                     + excludedResources       = [
                         + "excludedResources",
                       ]
                     + includeClusterResources = (known after apply)
                     + includedNamespaces      = [
                         + "default",
                         + "default1",
                       ]
                     + includedResources       = [
                         + "statefulset",
                       ]
                     + labelSelector           = {
                         + matchExpressions = (known after apply)
                         + matchLabels      = {
                             + app = "mysql-sts"
                           }
                       }
                     + orderedResources        = (known after apply)
                     + pvBackup                = {
                         + defaultPvBackup  = false
                         + pvcList          = (known after apply)
                         + pvcSelector      = {
                             + matchExpressions = (known after apply)
                             + matchLabels      = (known after apply)
                           }
                         + snapshotPostRule = (known after apply)
                         + snapshotPreRule  = (known after apply)
                       }
                     + storageLocation         = "<yourBackuplocationName>"
                     + ttl                     = "720h0m0s"
                   }
               }
           }
         + timeouts {
             + create = "10m"
           }
   
         + wait {
             + fields = {
                 + "status.phase" = "Enabled"
               }
           }
       }

3. 执行以下命令，创建定时备份计划。

   terraform apply

   返回信息如下，表明定时备份计划创建成功。

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

相关操作

• 通过定时备份计划，查找备份。

  通过labelSelector可以查找由备份计划创建的备份。

  data "kubernetes_resources" "list-applicationbackup" {
    api_version 			= "csdr.alibabacloud.com/v1beta1"
    kind       				= "ApplicationBackup"
    namespace         = "csdr"
    label_selector    = "csdr/schedule-name=terraform-schedule-test"
  }
  
  # 通过Output进行输出。
  output "applicationbackup-name" {
    value = data.kubernetes_resources.list-applicationbackup.objects
  }

• 修改定时备份计划。

  1. 将spec.paused设置为true，以暂停定时备份计划，然后根据需求修改spec中用于设置备份计划中定义备份行为的其他字段（spec.schedule）等，示例如下。

     resource "kubernetes_manifest" "backupschedule-demo" {
       manifest = {
         apiVersion          = "csdr.alibabacloud.com/v1beta1"
         kind                = "BackupSchedule"
         metadata = {
           name                              = "<yourBackcupscheduleName>"
           namespace         = "csdr"
           annotations = {
             "csdr.alibabacloud.com/backuplocations" = "{\"name\":\"<yourBackuplocationName>\",\"region\":\"cn-beijing\",\"bucket\":\"<cnfs-oss-yourBucketName>\",\"prefix\":\"<subDir>\",\"provider\":\"alibabacloud\"}"
           }
         }
         spec = {
           # 暂停备份计划。
           paused = "true" 
           # 修改备份计划的备份周期。
           schedule = "0 5 * * *"
           template = {
             includedNamespaces      = ["default","default1"]
             includedResources       = ["statefulset"]
             excludedResources       = ["excludedResources"]
             labelSelector                   = {
               matchLabels                   = {
                 "app" = "mysql-sts"
               }
             }
             pvBackup = {
               defaultPvBackup       = "false"
             }
             storageLocation                 = "vault-a"
             ttl                                                                     = "720h0m0s"
             includeClusterResources = "false"
           }
         }
       }
       wait {
         fields = {
           # 暂停备份计划后，预期的状态应为Paused。
           "status.phase" = "Paused"
         }
       }
       timeouts {
         create = "10m"
       }
     }

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

     terraform plan

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

     kubernetes_manifest.backupschedule-demo: Refreshing state...
     
     Terraform used the selected providers to generate the following execution plan. Resource actions
     are indicated with the following symbols:
       ~ update in-place
     
     Terraform will perform the following actions:
     
       # kubernetes_manifest.backupschedule-demo will be updated in-place
       ~ resource "kubernetes_manifest" "backupschedule-demo" {
           ~ manifest = {
               ~ spec       = {
                   ~ paused   = "false" -> "true"
                   ~ schedule = "1 4 * * *" -> "0 5 * * *"
                     # (1 unchanged attribute hidden)
                 }
                 # (3 unchanged attributes hidden)
             }
           ~ object   = {
               ~ spec       = {
                   ~ paused    = false -> true
                   ~ schedule  = "1 4 * * *" -> "0 5 * * *"
                     # (2 unchanged attributes hidden)
                 }
                 # (3 unchanged attributes hidden)
             }
     
           ~ wait {
               ~ fields = {
                   ~ "status.phase" = "Enabled" -> "Paused"
                 }
             }
     
             # (1 unchanged block hidden)
         }
     
     Plan: 0 to add, 1 to change, 0 to destroy.

  3. 执行以下命令，使定时备份计划修改生效。

     terraform apply

     返回信息如下，表明定时备份计划修改成功。

     kubernetes_manifest.backupschedule-demo: Modifying...
     kubernetes_manifest.backupschedule-demo: Modifications complete after 1s
     
     Apply complete! Resources: 0 added, 1 changed, 0 destroyed.