使用 tidbcloud_dedicated_network_container 资源

本文档介绍了如何使用 tidbcloud_dedicated_network_container 资源来管理 TiDB Cloud Dedicated 网络容器。

网络容器是一个逻辑网络资源，允许你为特定项目和区域定义和管理一个 CIDR 块（IP 地址范围）。该 CIDR 块用于为 TiDB Cloud Dedicated 集群创建 VPC，并且在该区域设置 VPC 对等连接之前是必需的。

在向某个区域添加 VPC 对等连接请求之前，你必须先为该区域设置 CIDR 块并创建首个 TiDB Cloud Dedicated 集群。创建第一个集群后，TiDB Cloud 会自动创建关联的 VPC，从而使你能够与你应用的 VPC 建立对等连接。

tidbcloud_dedicated_network_container 资源的功能包括：

• 创建 TiDB Cloud Dedicated 网络容器。
• 导入 TiDB Cloud Dedicated 网络容器。
• 删除 TiDB Cloud Dedicated 网络容器。

前置条件

• 获取 TiDB Cloud Terraform Provider v0.4.0 或更高版本。

创建 TiDB Cloud Dedicated 网络容器

你可以使用 tidbcloud_dedicated_network_container 资源来创建 TiDB Cloud Dedicated 网络容器。

以下示例展示了如何创建一个 TiDB Cloud Dedicated 网络容器。

1. 为 TiDB Cloud Dedicated 网络容器创建一个目录并进入该目录。

2. 创建一个 network_container.tf 文件：

   terraform {
     required_providers {
       tidbcloud = {
         source = "tidbcloud/tidbcloud"
       }
     }
   }
   
   provider "tidbcloud" {
     public_key = "your_public_key"
     private_key = "your_private_key"
   }
   
   resource "tidbcloud_dedicated_network_container" "example" {
     project_id = "1372813089454000000"
     region_id = "aws-ap-northeast-2"
     cidr_notation = "172.16.16.0/21"
   }
   

   使用 resource 块来定义 TiDB Cloud 的资源，包括资源类型、资源名称和资源详情。

   • 要使用 tidbcloud_dedicated_network_container 资源，需要将资源类型设置为 tidbcloud_dedicated_network_container。
   • 资源名称可以根据需要自定义，例如 example。
   • 如果你不知道如何获取必需参数的值，请参见 为区域设置 CIDR。
   • 有关 TiDB Cloud Dedicated 网络容器规范的更多信息，请参见 tidbcloud_dedicated_network_container (Resource)。

3. 运行 terraform apply 命令。应用资源时，不建议使用 terraform apply --auto-approve。

   $ terraform apply
   
   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_dedicated_network_container.example will be created
       + resource "tidbcloud_dedicated_network_container" "example" {
           + cidr_notation        = "172.16.16.0/21"
           + cloud_provider       = (known after apply)
           + labels               = (known after apply)
           + network_container_id = (known after apply)
           + project_id           = "1372813089454543324"
           + region_display_name  = (known after apply)
           + region_id            = "aws-ap-northeast-2"
           + state                = (known after apply)
           + vpc_id               = (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:
   

   在上述结果中，Terraform 为你生成了一个执行计划，描述了 Terraform 将要执行的操作：

   • 你可以检查配置与当前状态之间的差异。
   • 你还可以看到本次 apply 的结果。它将新增一个资源，不会有资源被更改或销毁。
   • known after apply 表示你会在 apply 后获得对应的值。

4. 如果你的计划内容无误，输入 yes 继续：

   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
   
   tidbcloud_dedicated_network_container.example: Creating...
   tidbcloud_dedicated_network_container.example: Creation complete after 4s
   

   该资源的状态会保持为 INACTIVE，直到你在该 TiDB Cloud Dedicated 网络容器所在区域创建 TiDB Cloud Dedicated 集群。之后，状态会变为 ACTIVE。

5. 使用 terraform show 或 terraform state show tidbcloud_dedicated_network_container.${resource-name} 命令来检查资源的状态。前者会显示所有资源和数据源的状态。

   $ terraform state show tidbcloud_dedicated_network_container.example          
   # tidbcloud_dedicated_network_container.example:
   resource "tidbcloud_dedicated_network_container" "example" {
       cidr_notation        = "172.16.16.0/21"
       cloud_provider       = "aws"
       labels               = {
           "tidb.cloud/project" = "1372813089454000000"
       }
       network_container_id = "1934235512696000000"
       project_id           = "1372813089454000000"
       region_display_name  = "Seoul (ap-northeast-2)"
       region_id            = "aws-ap-northeast-2"
       state                = "INACTIVE"
       vpc_id               = null
   }
   

导入 TiDB Cloud Dedicated 网络容器

对于未被 Terraform 管理的 TiDB Cloud Dedicated 网络容器，你可以通过导入的方式让 Terraform 管理它。

例如，你可以导入一个不是通过 Terraform 创建的网络容器。

1. 为新的 tidbcloud_dedicated_network_container 资源添加一个 import 块。

   在你的 .tf 文件中添加如下 import 块，将 example 替换为你想要的资源名称，将 ${id} 替换为 cluster_id,network_container_id 格式：

   import {
     to = tidbcloud_dedicated_network_container.example
     id = "${id}"
   }
   

2. 生成新的配置文件。

   根据 import 块为新的 tidbcloud_dedicated_network_container 资源生成新的配置文件：

   terraform plan -generate-config-out=generated.tf
   

   上述命令中不要指定已存在的 .tf 文件名，否则 Terraform 会返回错误。

   然后，generated.tf 文件会在当前目录下生成，包含了被导入资源的配置信息。

3. 审查并应用生成的配置。

   审查生成的配置文件，确保其符合你的需求。你也可以选择将该文件内容移动到你喜欢的位置。

   然后，运行 terraform apply 来导入你的基础设施。应用后，示例输出如下：

   tidbcloud_dedicated_network_container.example: Importing... [id=10423692645683000000,example]
   tidbcloud_dedicated_network_container.example: Import complete [id=10423692645683000000,example]
   
   Apply complete! Resources: 1 imported, 0 added, 0 changed, 0 destroyed.
   

现在你可以使用 Terraform 管理被导入的 TiDB Cloud Dedicated 网络容器了。

删除 TiDB Cloud Dedicated 网络容器

要删除 TiDB Cloud Dedicated 集群，你可以删除 tidbcloud_dedicated_cluster 资源的配置，然后使用 terraform apply 命令销毁该资源。但你必须确保 TiDB Cloud Dedicated 网络容器的状态不是 ACTIVE。如果状态为 ACTIVE，则无法删除。

如果状态为 INACTIVE，你可以通过以下命令删除：

  $ terraform apply
  tidbcloud_dedicated_network_container.example: Refreshing state...

  Terraform used the selected providers to generate the following execution plan. Resource actions are indicated with the following symbols:
    - destroy

  Terraform will perform the following actions:

    # tidbcloud_dedicated_network_container.example will be destroyed
    # (because tidbcloud_dedicated_network_container.example is not in configuration)
    - resource "tidbcloud_dedicated_network_container" "example" {
        - cidr_notation        = "172.16.16.0/21" -> null
        - cloud_provider       = "aws" -> null
        - labels               = {
            - "tidb.cloud/project" = "1372813089454000000"
          } -> null
        - network_container_id = "1934235512696000000" -> null
        - project_id           = "1372813089454000000" -> null
        - region_display_name  = "Seoul (ap-northeast-2)" -> null
        - region_id            = "aws-ap-northeast-2" -> null
        - state                = "INACTIVE" -> null
          # (1 unchanged attribute hidden)
      }

  Plan: 0 to add, 0 to change, 1 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

  tidbcloud_dedicated_network_container.example: Destroying...
  tidbcloud_dedicated_network_container.example: Destruction complete after 2s

  Apply complete! Resources: 0 added, 0 changed, 1 destroyed.

现在，如果你运行 terraform show 命令，将不会显示任何被管理的资源，因为该资源已被清除：

$ terraform show