Container Service for Kubernetes:Terraform を使用してアプリケーションをバックアップおよび復元する

インスタントバックアップタスクを作成する

1. 次の内容を csdr.tf 構成ファイルに追加し、ビジネス要件に基づいて内容を変更します。

   resource "kubernetes_manifest" "applicationbackup-demo" {
     manifest = {
       apiVersion  	= "csdr.alibabacloud.com/v1beta1"
       kind        	= "ApplicationBackup"
       metadata = {
         name		= "<アプリケーションバックアップ名>"
         namespace 	= "csdr"
         annotations = {
           "csdr.alibabacloud.com/backuplocations" = "{\"name\":\"<バックアップボールト名>\",\"region\":\"cn-beijing\",\"bucket\":\"<cnfs-oss-バケット名>\",\"prefix\":\"<サブディレクトリ>\",\"provider\":\"alibabacloud\"}"
       }
       spec = {
         includedNamespaces 	= ["default","default1"]
         includedResources 	= ["statefulset"]
         excludedResources 	= ["excludedResources"]
         labelSelector 		= {
           matchLabels 		= {
             "app" = "mysql-sts"
           }
         }
         pvBackup = {
           defaultPvBackup 	= "false"
         } 
         storageLocation 		= "<バックアップボールト名>"
         ttl									= "720h0m0s"
         includeClusterResources = "false"
       }
     }
     
     # status.phase パラメーターの値が Completed に変わると、バックアップは成功です。
     # バックアップの所要時間は、クラスター内のアプリケーションの数とボリュームに保存されているデータ量によって異なります。
     #wait {
     #  fields = {
     #    "status.phase" = "Completed"
     #  }
     #}
   
     #timeouts {
     #  create = "60m"
     #}
    }
   }

   パラメーター	必須	説明
   csdr.alibabacloud.com/backuplocations	はい	バックアップを保存するバックアップボールト。情報がバックアップボールトの構成と同じであることを確認してください。
   name	はい	リアルタイムバックアップタスクの名前。
   includedNamespaces	はい	名前空間の名前。
   includedResources	いいえ	バックアップリストに含めるクラスターリソースのタイプ。 重要 予期しないバックアップ結果を避けるために、includedResources パラメーターと excludedResources パラメーターのいずれか 1 つのみを構成する必要があります。両方のパラメーターを空のままにすると、すべてのリソースタイプがバックアップされます。
   excludedResources	いいえ	バックアップリストから除外するクラスターリソースのタイプ。 重要 予期しないバックアップ結果を避けるために、includedResources パラメーターと excludedResources パラメーターのいずれか 1 つのみを構成する必要があります。両方のパラメーターを空のままにすると、すべてのリソースタイプがバックアップされます。
   matchLabels	いいえ	バックアップするリソースのラベル。
   includeClusterResources	いいえ	StorageClass、CustomResourceDefinitions (CRD)、Webhook など、すべてのクラスターレベルリソースをバックアップするかどうかを指定します。 true: すべてのクラスターレベルリソースをバックアップします。 false: 指定された名前空間内の名前空間レベルリソースで使用されるクラスターレベルリソースのみをバックアップします。たとえば、システムがポッドをバックアップすると、ポッドで使用されるサービスアカウントにクラスターロールが割り当てられます。この場合、クラスターロールは自動的にバックアップされます。システムがカスタムリソース (CR) をバックアップすると、対応する CRD がバックアップされます。 説明 デフォルトでは、IncludeClusterResourcesfalseACK コンソールで作成されたバックアップタスクでは、IncludeClusterResources は false に設定されています。
   defaultPvBackup		ボリュームをバックアップするかどうかを指定します。有効な値： true: アプリケーションとボリュームをバックアップします。 false: アプリケーションのみをバックアップします。
   storageLocation	はい	バックアップボールトの名前。 説明 ACK クラスターで Velero を使用している場合は、DingTalk グループ 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:<バックアップボールト名>,region:cn-beijing,bucket:<cnfs-oss-バケット名>,prefix:<サブディレクトリ>,provider:alibabacloud}"
                   }
                 + name        = "<アプリケーションバックアップ名>"
                 + 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                       = "<アプリケーションバックアップ名>"
                 + 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     = "<バックアップボールト名>"
                 + 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		= "<スケジュールバックアップタスク名>"
         namespace 	= "csdr"
         annotations = {
           "csdr.alibabacloud.com/backuplocations" = "{\"name\":\"<バックアップボールト名>\",\"region\":\"cn-beijing\",\"bucket\":\"<cnfs-oss-バケット名>\",\"prefix\":\"<サブディレクトリ>\",\"provider\":\"alibabacloud\"}"
         }
       }
       spec = {
         schedule = "1 4 * * *"
         template = {
           includedNamespaces 			= ["default","default1"]
           includedResources 			= ["statefulset"]
           excludedResources 			= ["excludedResources"]
           labelSelector 				= {
             matchLabels 				= {
               "app" = "mysql-sts"
             }
           }
           pvBackup = {
             defaultPvBackup 			= "false"
           } 
           storageLocation 			= "<バックアップボールト名>"
           ttl											= "720h0m0s"
           includeClusterResources = "false"
         }
       }
     }
     wait {
       fields = {
         "status.phase" = "Enabled"
       }
     }
     timeouts {
       create = "10m"
     }
   }

   パラメーター	必須	説明
   csdr.alibabacloud.com/backuplocations	はい	バックアップを保存するバックアップボールト。情報がバックアップボールトの構成と同じであることを確認してください。
   name	はい	スケジュールバックアップタスクの名前。
   schedule	はい	バックアップサイクルを指定する Cron 式。 Cron 式の指定方法の詳細については、「バックアッププランを作成するときにバックアップサイクルを指定するにはどうすればよいですか。」をご参照ください。
   includedNamespaces	はい	名前空間の名前。
   includedResources	いいえ	バックアップリストに含めるクラスターリソースのタイプ。 重要 予期しないバックアップ結果を避けるために、includedResources パラメーターと excludedResources パラメーターのいずれか 1 つのみを構成する必要があります。両方のパラメーターを空のままにすると、すべてのリソースタイプがバックアップされます。
   excludedResources	いいえ	バックアップリストから除外するクラスターリソースのタイプ。 重要 予期しないバックアップ結果を避けるために、includedResources パラメーターと excludedResources パラメーターのいずれか 1 つのみを構成する必要があります。両方のパラメーターを空のままにすると、すべてのリソースタイプがバックアップされます。
   matchLabels	いいえ	バックアップするリソースのラベル。
   includeClusterResources	いいえ	StorageClass、CustomResourceDefinitions (CRD)、Webhook など、すべてのクラスターレベルリソースをバックアップするかどうかを指定します。 true: すべてのクラスターレベルリソースをバックアップします。 false: 指定された名前空間内の名前空間レベルリソースで使用されるクラスターレベルリソースのみをバックアップします。たとえば、システムがポッドをバックアップすると、ポッドで使用されるサービスアカウントにクラスターロールが割り当てられます。この場合、クラスターロールは自動的にバックアップされます。システムがカスタムリソース (CR) をバックアップすると、対応する CRD がバックアップされます。 説明 デフォルトでは、IncludeClusterResourcesfalseACK コンソールで作成されたバックアップタスクでは、IncludeClusterResources は false に設定されています。
   defaultPvBackup	はい	ボリュームをバックアップするかどうかを指定します。有効な値： true: アプリケーションとボリュームをバックアップします。 false: アプリケーションのみをバックアップします。
   storageLocation	はい	バックアップボールトの名前。 説明 ACK クラスターで Velero を使用している場合は、DingTalk グループ 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:<バックアップボールト名>,region:cn-beijing,bucket:<cnfs-oss-バケット名>,prefix:<サブディレクトリ>,provider:alibabacloud}"
                   }
                 + name        = "<スケジュールバックアップタスク名>"
                 + namespace   = "csdr"
               }
             + spec       = {
                 + schedule = "1 4 * * *"
                 + template = {
                     + excludedResources  = [
                         + "excludedResources",
                       ]
                     + includedNamespaces = [
                         + "default",
                         + "default1",
                       ]
                     + includedResources  = [
                         + "statefulset",
                       ]
                     + labelSelector      = {
                         + matchLabels = {
                             + app = "mysql-sts"
                           }
                       }
                     + pvBackup           = {
                         + defaultPvBackup = "false"
                       }
                     + storageLocation    = "<バックアップボールト名>"
                     + 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                       = "<スケジュールバックアップタスク名>"
                 + 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         = "<バックアップボールト名>"
                     + 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 "applicationbackup-name" {
    value = data.kubernetes_resources.list-applicationbackup.objects
  }

• スケジュールバックアップタスクを変更します。

  1. spec.paused パラメーターを true に設定してスケジュールバックアップタスクを一時停止し、ビジネス要件に基づいてバックアップタスクのバックアップ動作を定義する spec.schedule などの spec パラメーターの他のパラメーターを変更します。サンプルコード:

     resource "kubernetes_manifest" "backupschedule-demo" {
       manifest = {
         apiVersion          = "csdr.alibabacloud.com/v1beta1"
         kind                = "BackupSchedule"
         metadata = {
           name                              = "<スケジュールバックアップタスク名>"
           namespace         = "csdr"
           annotations = {
             "csdr.alibabacloud.com/backuplocations" = "{\"name\":\"<バックアップボールト名>\",\"region\":\"cn-beijing\",\"bucket\":\"<cnfs-oss-バケット名>\",\"prefix\":\"<サブディレクトリ>\",\"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.

インスタントバックアップタスクを作成する

1. 次の内容を csdr.tf 構成ファイルに追加し、ビジネス要件に基づいて内容を変更します。

   resource "kubernetes_manifest" "applicationbackup-demo" {
     manifest = {
       apiVersion  	= "csdr.alibabacloud.com/v1beta1"
       kind        	= "ApplicationBackup"
       metadata = {
         name		= "<アプリケーションバックアップ名>"
         namespace 	= "csdr"
         annotations = {
           "csdr.alibabacloud.com/backuplocations" = "{\"name\":\"<バックアップボールト名>\",\"region\":\"cn-beijing\",\"bucket\":\"<cnfs-oss-バケット名>\",\"prefix\":\"<サブディレクトリ>\",\"provider\":\"alibabacloud\"}"
       }
       spec = {
         backupType = "PvBackup"
         includedNamespaces 	= ["default","default1"]
         pvBackup = {
           pvcList           = [
           {
             namespace								= "default"
             name                  	= "pvc-nas"
           },
           {
             namespace								= "default1"
             name                		= "pvc-oss"
           }
           ]
           storageClassList 	= ["disk-essd","disk-ssd"]
         } 
         storageLocation 		= "<バックアップボールト名>"
         ttl									= "720h0m0s"
       }
     }
     
     # status.phase フィールドの値が Completed に変わると、バックアッププロセスは正常に完了します。
     # バックアッププロセスに必要な時間は、クラスター内のアプリケーションの数とボリューム内のデータ量によって異なります。
     #wait {
     #  fields = {
     #    "status.phase" = "Completed"
     #  }
     #}
   
     #timeouts {
     #  create = "60m"
     #}
    }
   }

2. 次のコマンドを実行して、リソースプランを作成します。

   terraform plan

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		= "<スケジュールバックアップタスク名>"
         namespace 	= "csdr"
         annotations = {
           "csdr.alibabacloud.com/backuplocations" = "{\"name\":\"<バックアップボールト名>\",\"region\":\"cn-beijing\",\"bucket\":\"<cnfs-oss-バケット名>\",\"prefix\":\"<サブディレクトリ>\",\"provider\":\"alibabacloud\"}"
         }
       }
       spec = {
         schedule = "1 4 * * *"
         template = {
           includedNamespaces 			= ["default","default1"]
           pvBackup = {
             pvcList           = [
             {
               namespace								= "default"
               name                  	= "pvc-nas"
             },
             {
               namespace								= "default1"
               name                		= "pvc-oss"
             }
             ]
             storageClassList 	= ["disk-essd","disk-ssd"]
           } 
           storageLocation 			= "<バックアップボールト名>"
           ttl											= "720h0m0s"
         }
       }
     }
     wait {
       fields = {
         "status.phase" = "Enabled"
       }
     }
     timeouts {
       create = "10m"
     }
   }

   パラメーター	必須	説明
   csdr.alibabacloud.com/backuplocations	はい	バックアップを保存するバックアップボールト。情報がバックアップボールトの構成と同じであることを確認してください。
   name	はい	リアルタイムバックアップタスクの名前。
   schedule	はい	バックアップサイクルを指定する Cron 式。 Cron 式の指定方法の詳細については、「バックアッププランを作成するときにバックアップサイクルを指定するにはどうすればよいですか。」をご参照ください。
   includedNamespaces	はい	名前空間の名前。
   pvcList	いいえ	バックアップするボリュームに対応する PVC。name パラメーターは、PVC の名前を指定します。 重要 pvcList と storageClassList の両方が指定されている場合、storageClassList の構成は無効になります。 pvcList も storageClassList も指定されていない場合、指定された名前空間内のすべてのボリュームがバックアップされます。
   storageClassList	いいえ	バックアップするボリュームのタイプ。StorageClass の名前です。
   storageLocation	はい	バックアップボールトの名前。 説明 ACK クラスターで Velero を使用している場合は、DingTalk グループ 35532895 に参加してテクニカルサポートをリクエストしてください。
   ttl	はい	バックアップの有効期間。期限切れのバックアップからデータを復元することはできません。期間は 720h0m0s 形式で指定します。有効な値: 24h0m0s から 1572864h0m0s。

2. 次のコマンドを実行して、リソースプランを作成します。

   terraform plan

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.