使用 Backup 资源

你可以在本文档中学习如何使用 tidbcloud_backup 资源为 TiDB Cloud 集群创建备份。

tidbcloud_backup 资源的功能包括：

• 为 TiDB Cloud 专属集群创建备份。
• 删除 TiDB Cloud 专属集群的备份。

前置条件

• 获取 TiDB Cloud Terraform Provider。
• 备份与恢复功能不支持 TiDB Cloud Serverless 集群。要使用备份资源，请确保你已创建 TiDB Cloud 专属集群。

使用 backup 资源创建备份

1. 创建一个用于备份的目录并进入该目录。

2. 创建一个 backup.tf 文件。

   例如：

   terraform {
    required_providers {
      tidbcloud = {
        source = "tidbcloud/tidbcloud"
      }
    }
   }
   
   provider "tidbcloud" {
    public_key = "your_public_key"
    private_key = "your_private_key"
   }
   resource "tidbcloud_backup" "example_backup" {
     project_id  = "1372813089189561287"
     cluster_id  = "1379661944630234067"
     name        = "firstBackup"
     description = "create by terraform"
   }
   

   你需要将文件中的资源值（如 project ID 和 cluster ID）替换为你自己的。

   如果你已经通过 Terraform 管理了一个集群资源（例如 example_cluster），也可以如下配置备份资源，无需指定实际的 project ID 和 cluster ID。

   resource "tidbcloud_backup" "example_backup" {
     project_id  = tidbcloud_cluster.example_cluster.project_id
     cluster_id  = tidbcloud_cluster.example_cluster.id
     name        = "firstBackup"
     description = "create by terraform"
   }
   

3. 运行 terraform apply 命令：

   $ terraform apply
   
   tidbcloud_cluster.example_cluster: Refreshing state... [id=1379661944630234067]
   
   Terraform used the selected providers to generate the following execution plan. Resource actions are indicated with the following symbols:
     + create
   
   Terraform will perform the following actions:
   
     # tidbcloud_backup.example_backup will be created
     + resource "tidbcloud_backup" "example_backup" {
         + cluster_id       = "1379661944630234067"
         + create_timestamp = (known after apply)
         + description      = "create by terraform"
         + id               = (known after apply)
         + name             = "firstBackup"
         + project_id       = "1372813089189561287"
         + size             = (known after apply)
         + status           = (known after apply)
         + type             = (known after apply)
       }
   
   Plan: 1 to add, 0 to change, 0 to destroy.
   
   Do you want to perform these actions?
     Terraform will perform the actions described above.
     Only 'yes' will be accepted to approve.
   
     Enter a value:
   

4. 输入 yes 以创建备份：

     Enter a value: yes
   
   tidbcloud_backup.example_backup: Creating...
   tidbcloud_backup.example_backup: Creation complete after 2s [id=1350048]
   
   Apply complete! Resources: 1 added, 0 changed, 0 destroyed.
   
   

5. 使用 terraform state show tidbcloud_backup.${resource-name} 查看备份状态：

   $ terraform state show tidbcloud_backup.example_backup
   
   # tidbcloud_backup.example_backup:
   resource "tidbcloud_backup" "example_backup" {
       cluster_id       = "1379661944630234067"
       create_timestamp = "2022-08-26T07:56:10Z"
       description      = "create by terraform"
       id               = "1350048"
       name             = "firstBackup"
       project_id       = "1372813089189561287"
       size             = "0"
       status           = "PENDING"
       type             = "MANUAL"
   }
   

6. 等待几分钟，然后使用 terraform refresh 更新状态：

   $ terraform refresh
   tidbcloud_cluster.example_cluster: Refreshing state... [id=1379661944630234067]
   tidbcloud_backup.example_backup: Refreshing state... [id=1350048]
   $ terraform state show tidbcloud_backup.example_backup
   # tidbcloud_backup.example_backup:
   resource "tidbcloud_backup" "example_backup" {
       cluster_id       = "1379661944630234067"
       create_timestamp = "2022-08-26T07:56:10Z"
       description      = "create by terraform"
       id               = "1350048"
       name             = "firstBackup"
       project_id       = "1372813089189561287"
       size             = "198775"
       status           = "SUCCESS"
       type             = "MANUAL"
   }
   

当 status 变为 SUCCESS 时，表示你已为集群创建了备份。请注意，备份在创建后无法更新。

现在，你已经为集群创建了备份。如果你想使用该备份恢复集群，可以使用 restore 资源。

更新备份

备份无法被更新。

删除备份

要删除备份，请进入包含对应 backup.tf 文件的备份目录，然后运行 terraform destroy 命令销毁备份资源。

$ terraform destroy

Plan: 0 to add, 0 to change, 1 to destroy.

Do you really want to destroy all resources?
Terraform will destroy all your managed infrastructure, as shown above.
There is no undo. Only 'yes' will be accepted to confirm.

Enter a value: yes

此时，如果你运行 terraform show 命令，将不会有任何输出，因为资源已被清除：

$ terraform show