Container Service for Kubernetes:Back up and restore applications with Terraform

Criar uma tarefa de backup instantâneo

1. Adicione o seguinte conteúdo ao arquivo csdr.tf, substituindo os espaços reservados:

   Se o seu cluster ACK usar o Velero, participe do grupo 35532895 no DingTalk para obter suporte técnico.

   Parâmetro	Obrigatório	Descrição
   csdr.alibabacloud.com/backuplocations	Sim	Anotação do cofre de backup. Deve corresponder exatamente à configuração do BackupLocation.
   name	Sim	Nome da tarefa de backup instantâneo.
   includedNamespaces	Sim	Namespaces para backup.
   includedResources	Não	Tipos de recursos a incluir. Especifique apenas um entre includedResources ou excludedResources. Se ambos estiverem vazios, o sistema fará backup de todos os tipos de recursos.
   excludedResources	Não	Tipos de recursos a excluir. Consulte includedResources.
   matchLabels	Não	Rótulos dos recursos para backup.
   includeClusterResources	Não	Controla recursos com escopo de cluster. true: todos os recursos com escopo de cluster. false ou não definido: apenas aqueles referenciados pelos namespaces especificados. Padrão no console do ACK: false.
   defaultPvBackup	Não	true: faz backup de aplicações e volumes. false: faz backup apenas das aplicações.
   storageLocation	Sim	Nome do cofre de backup (BackupLocation).
   ttl	Sim	Período de validade do backup. Formato: 720h0m0s. Intervalo válido: 24h0m0s a 1572864h0m0s. Backups expirados não podem ser restaurados.

   resource "kubernetes_manifest" "applicationbackup-demo" {
     manifest = {
       apiVersion = "csdr.alibabacloud.com/v1beta1"
       kind       = "ApplicationBackup"
       metadata = {
         name      = "<your-backup-task-name>"
         namespace = "csdr"
         annotations = {
           # Must match the backup vault configuration exactly
           "csdr.alibabacloud.com/backuplocations" = "{\"name\":\"<your-backup-vault-name>\",\"region\":\"cn-beijing\",\"bucket\":\"<cnfs-oss-your-bucket-name>\",\"prefix\":\"<sub-directory>\",\"provider\":\"alibabacloud\"}"
         }
       }
       spec = {
         includedNamespaces = ["default", "default1"]  # Namespaces to back up
   
         # Specify only one of includedResources or excludedResources.
         # If both are empty, all resource types are backed up.
         includedResources = ["statefulset"]
         excludedResources = ["excludedResources"]
   
         labelSelector = {
           matchLabels = {
             "app" = "mysql-sts"  # Optional: back up only resources with these labels
           }
         }
   
         pvBackup = {
           defaultPvBackup = "false"  # "true": back up apps and volumes; "false": apps only
         }
   
         storageLocation = "<your-backup-vault-name>"  # Must match the BackupLocation name
   
         ttl = "720h0m0s"  # Backup validity period. Format: 720h0m0s
                           # Valid range: 24h0m0s to 1572864h0m0s
                           # Expired backups cannot be restored
   
         # includeClusterResources controls whether cluster-scoped resources are included:
         # "true"  — include all cluster-scoped resources (StorageClasses, CRDs, webhooks, etc.)
         # "false" — include only cluster-scoped resources referenced by the specified namespaces
         #           (for example, if a pod uses a service account with a cluster role,
         #            that cluster role is automatically included)
         # Unset  — same behavior as "false" when namespace filtering is used
         includeClusterResources = "false"
       }
     }
   
     # Uncomment to wait for backup completion (recommended for scripted workflows).
     # Backup duration depends on the number of applications and volume data size.
     #wait {
     #  fields = {
     #    "status.phase" = "Completed"
     #  }
     #}
     #timeouts {
     #  create = "60m"
     #}
   }

2. Visualize as alterações:

   terraform plan

3. Crie a tarefa de backup instantâneo:

   terraform apply

   Expandir para visualizar a saída

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

Criar uma tarefa de backup agendado

1. Adicione o seguinte conteúdo ao arquivo csdr.tf, substituindo os espaços reservados:

   Expandir para visualizar o arquivo de configuração

   resource "kubernetes_manifest" "backupschedule-demo" {
     manifest = {
       apiVersion = "csdr.alibabacloud.com/v1beta1"
       kind       = "BackupSchedule"
       metadata = {
         name      = "<your-schedule-name>"
         namespace = "csdr"
         annotations = {
           "csdr.alibabacloud.com/backuplocations" = "{\"name\":\"<your-backup-vault-name>\",\"region\":\"cn-beijing\",\"bucket\":\"<cnfs-oss-your-bucket-name>\",\"prefix\":\"<sub-directory>\",\"provider\":\"alibabacloud\"}"
         }
       }
       spec = {
         # Cron expression for the backup schedule (server time zone).
         # Format:  minute  hour  day-of-month  month  day-of-week
         # Example: "1 4 * * *" runs at 04:01 every day.
         schedule = "1 4 * * *"
   
         template = {
           includedNamespaces = ["default", "default1"]
           includedResources  = ["statefulset"]
           excludedResources  = ["excludedResources"]
           labelSelector = {
             matchLabels = {
               "app" = "mysql-sts"
             }
           }
           pvBackup = {
             defaultPvBackup = "false"  # Required for BackupSchedule
           }
           storageLocation         = "<your-backup-vault-name>"
           ttl                     = "720h0m0s"
           includeClusterResources = "false"
         }
       }
     }
   
     wait {
       fields = {
         "status.phase" = "Enabled"
       }
     }
   
     timeouts {
       create = "10m"
     }
   }

   Parâmetro	Obrigatório	Descrição
   csdr.alibabacloud.com/backuplocations	Sim	Anotação do cofre de backup. Deve corresponder exatamente à configuração do BackupLocation.
   name	Sim	Nome da tarefa de backup agendado.
   schedule	Sim	Frequência de backup como uma expressão cron. Formato: minute hour day-of-month month day-of-week. Exemplo: "1 4 * * *" executa às 04:01 todos os dias.
   includedNamespaces	Sim	Namespaces para backup.
   includedResources	Não	Tipos de recursos a incluir. Especifique apenas um entre includedResources ou excludedResources. Se ambos estiverem vazios, o sistema fará backup de todos os tipos de recursos.
   excludedResources	Não	Tipos de recursos a excluir. Consulte a observação sobre includedResources.
   matchLabels	Não	Rótulos dos recursos para backup.
   includeClusterResources	Não	Controla recursos com escopo de cluster. true: todos os recursos com escopo de cluster. false ou não definido: apenas aqueles referenciados pelos namespaces especificados.
   defaultPvBackup	Sim	true: faz backup de aplicações e volumes. false: faz backup apenas das aplicações.
   storageLocation	Sim	Nome do cofre de backup (BackupLocation).
   ttl	Sim	Período de validade do backup. Formato: 720h0m0s. Intervalo válido: 24h0m0s a 1572864h0m0s.

2. Visualize as alterações:

   terraform plan

3. Crie a tarefa de backup agendado:

   terraform apply

   Expandir para visualizar a saída

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

Gerencie tarefas de backup agendado

Localizar backups criados por um agendamento

Liste os backups de um agendamento específico:

data "kubernetes_resources" "list-applicationbackup" {
  api_version    = "csdr.alibabacloud.com/v1beta1"
  kind           = "ApplicationBackup"
  namespace      = "csdr"
  label_selector = "csdr/schedule-name=<your-schedule-name>"
}

output "applicationbackup-name" {
  value = data.kubernetes_resources.list-applicationbackup.objects
}

Modifique uma tarefa de backup agendado

Para alterar parâmetros como a frequência do agendamento:

1. Defina spec.paused como "true" para pausar o agendamento e, em seguida, atualize os parâmetros. Exemplo:

   Expandir para visualizar o arquivo de configuração

   resource "kubernetes_manifest" "backupschedule-demo" {
     manifest = {
       apiVersion = "csdr.alibabacloud.com/v1beta1"
       kind       = "BackupSchedule"
       metadata = {
         name      = "<your-schedule-name>"
         namespace = "csdr"
         annotations = {
           "csdr.alibabacloud.com/backuplocations" = "{\"name\":\"<your-backup-vault-name>\",\"region\":\"cn-beijing\",\"bucket\":\"<cnfs-oss-your-bucket-name>\",\"prefix\":\"<sub-directory>\",\"provider\":\"alibabacloud\"}"
         }
       }
       spec = {
         paused   = "true"        # Pause the schedule before modifying
         schedule = "0 5 * * *"   # Updated backup frequency
         template = {
           includedNamespaces      = ["default", "default1"]
           includedResources       = ["statefulset"]
           excludedResources       = ["excludedResources"]
           labelSelector = {
             matchLabels = {
               "app" = "mysql-sts"
             }
           }
           pvBackup = {
             defaultPvBackup = "false"
           }
           storageLocation         = "<your-backup-vault-name>"
           ttl                     = "720h0m0s"
           includeClusterResources = "false"
         }
       }
     }
     wait {
       fields = {
         "status.phase" = "Paused"  # Confirm the schedule is paused before applying further changes
       }
     }
     timeouts {
       create = "10m"
     }
   }

2. Visualize as alterações:

   terraform plan

3. Aplique a configuração atualizada:

   terraform apply

   Saída esperada:

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

Proteção de dados (PvBackup)

Defina backupType como PvBackup para fazer backup apenas dos dados de volume. Especifique pvcList para fazer backup de PVCs específicos, ou storageClassList para fazer backup de volumes de StorageClasses específicas. Se você definir ambos, storageClassList será ignorado. Se você não definir nenhum, o sistema fará backup de todos os volumes nos namespaces incluídos.

Exclua uma tarefa de backup agendado

Execute terraform destroy para remover o BackupSchedule e interromper o agendamento.

Exclua uma tarefa de backup ou restauração

Use um CR DeleteRequest para remover com segurança tarefas de backup ou restauração e os recursos associados da cloud.

Excluir uma tarefa de backup não afeta os backups existentes. Excluir uma tarefa de restauração não afeta os dados restaurados.

1. Adicione o seguinte conteúdo ao arquivo csdr.tf:

   Parâmetro	Obrigatório	Descrição
   name	Sim	Nome da solicitação de exclusão. Formato: <ApplicationBackup-name>-dbr para excluir uma tarefa de backup, ou <ApplicationRestore-name>-dbr para excluir uma tarefa de restauração.
   deleteObjectName	Sim	Nome do recurso a ser excluído.
   deleteObjectType	Sim	"Backup": exclui o CR ApplicationBackup e recursos relacionados. "Restore": exclui o CR ApplicationRestore e recursos relacionados.

   resource "kubernetes_manifest" "deleterequest-demo" {
     manifest = {
       apiVersion = "csdr.alibabacloud.com/v1beta1"
       kind       = "DeleteRequest"
       metadata = {
         name      = "<object-name>-dbr"  # Format: <ApplicationBackup-or-ApplicationRestore-name>-dbr
         namespace = "csdr"
       }
       spec = {
         deleteObjectName = "<object-name>"   # Name of the backup or restoration task to delete
         deleteObjectType = "Backup"          # "Backup": deletes ApplicationBackup and related resources
                                              # "Restore": deletes ApplicationRestore and related resources
       }
     }
   }

2. Visualize as alterações:

   terraform plan

3. Aplique a exclusão:

   terraform apply

   Expandir para visualizar a saída

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

   Após excluir o recurso de destino, o sistema também exclui o CR DeleteRequest.