バックアップリソースを使用する

このドキュメントでは、 tidbcloud_backupリソースを使用してTiDB Cloudクラスターのバックアップを作成する方法を学習できます。

tidbcloud_backupリソースの機能は次のとおりです。

TiDB Cloud Dedicated クラスターのバックアップを作成します。
TiDB Cloud Dedicated クラスターのバックアップを削除します。

前提条件

TiDB Cloud Terraform プロバイダーを入手。
バックアップと復元機能は、 TiDB Cloud Serverless クラスターでは使用できません。バックアップリソースを使用するには、 TiDB Cloud Dedicated クラスターを作成していることを確認してください。

バックアップリソースを使用してバックアップを作成する

バックアップ用のディレクトリを作成してそこに入ります。

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"
}

ファイル内のリソース値 (プロジェクト ID やクラスター ID など) を独自のものに置き換える必要があります。

Terraform を使用してクラスターリソース (たとえば、 example_cluster ) を管理している場合は、実際のプロジェクト ID とクラスター 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"
}

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:

バックアップを作成するには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.

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"
}

数分間お待ちください。その後、 terraform refersh使用してステータスを更新します。

$ 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"
}

ステータスがSUCCESSに変わると、クラスターのバックアップが作成されたことを示します。作成後はバックアップを更新できないことに注意してください。

これで、クラスターのバックアップが作成されました。バックアップを使用してクラスターを復元する場合は、復元リソースを使用する実行します。

バックアップを更新する

バックアップを更新できません。

バックアップを削除する

バックアップを削除するには、対応する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

バックアップリソースを使用する

前提条件

バックアップリソースを使用してバックアップを作成する

バックアップを更新する

バックアップを削除する

このページは役に立ちましたか？