AI 助理
备案控制台
官方文档
输入文档关键字查找
首页 云数据库 ClickHouse 开发参考 Terraform 通过Terraform新建集群并为其创建数据库账号

通过Terraform新建集群并为其创建数据库账号

更新时间：
产品详情
我的收藏

本文为您介绍RAM用户如何使用Terraform调用云数据库服务ClickHouse社区版的OpenAPI创建一个集群，并为其创建一个数据库账号。

说明

当前示例代码支持一键运行，您可以直接运行代码。一键运行

前提条件

  • 由于阿里云账号（主账号）具有资源的所有权限，一旦发生泄露将面临重大风险。建议您使用RAM用户，并为该RAM用户创建AccessKey，具体操作方式，请参见创建RAM用户和创建AccessKey。

  • 为RAM用户授予AliyunClickHouseFullAccess管理云数据库服务（ClickHouse）社区版）和AliyunVPCFullAccess（管理专有网络（VPC））权限。授权示例如下，如何授权，请参见为RAM用户授权。

    {
    "Version": "1",
    "Statement": [
        {
            "Action": "clickhouse:*",
            "Resource": "*",
            "Effect": "Allow"
        },
        {
            "Action": "ram:CreateServiceLinkedRole",
            "Resource": "*",
            "Effect": "Allow",
            "Condition": {
                "StringEquals": {
                    "ram:ServiceName": "clickhouse.aliyuncs.com"
                }
            }
        },
        {
            "Action": [
                "vpc:CreateVpc",
                "vpc:DescribeVpc",
                "vpc:ModifyVpcAttribute",
                "vpc:DeleteVpc",
                "vpc:CreateVSwitch",
                "vpc:DescribeVSwitch",
                "vpc:ModifyVSwitchAttribute",
                "vpc:DeleteVSwitch"
            ],
            "Resource": "*",
            "Effect": "Allow"
        }
    ]
}

  • 准备Terraform运行环境，您可以选择以下任一方式来使用Terraform。

    • 在Terraform Explorer中使用Terraform：阿里云提供了Terraform的在线运行环境，您无需安装Terraform，登录后即可在线使用和体验Terraform。适用于零成本、快速、便捷地体验和调试Terraform的场景。

    • Cloud Shell：阿里云Cloud Shell中预装了Terraform的组件，并已配置好身份凭证，您可直接在Cloud Shell中运行Terraform的命令。适用于低成本、快速、便捷地访问和使用Terraform的场景。

    • 在本地安装和配置Terraform：适用于网络连接较差或需要自定义开发环境的场景。

      重要

      请确保Terraform版本不低于v0.12.28。如需检查现有版本，请运行terraform --version命令。

重要

本教程示例包含的部分资源会产生一定费用，请在不需要时及时进行退订。

使用的资源

使用Terraform为指定集群创建一个数据库账号

  1. 创建一个工作目录，并且在工作目录中创建以下名为main.tf的配置文件。main.tf是Terraform主文件，定义了将要部署的资源。

    variable "region" {
  default = "cn-qingdao"
}
provider "alicloud" {
  region = var.region
}
variable "name" {
  default = "tf-example-ClickHouse"
}
variable "type" {
  default = "Normal"
}
variable "account_password" {
  default = "testPassword123%"
}
variable "account_name" {
  default = "test_account"
}
variable "account_description" {
  default = "createdByTerraform"
}
variable "storage_type" {
  default = "cloud_essd"
}
data "alicloud_click_house_regions" "default" {
  region_id = var.region
  # current = true
}
# 创建 alicloud_vpc 资源
resource "alicloud_vpc" "vpc1" {
  vpc_name   = var.name
  cidr_block = "172.16.0.0/12"
}
# 在 local.zone_id 地区创建 alicloud_vpc 资源下的 alicloud_vswitch 资源
resource "alicloud_vswitch" "default" {
  vswitch_name = var.name
  cidr_block   = "172.16.20.0/24"
  vpc_id       = alicloud_vpc.vpc1.id
  zone_id      = data.alicloud_click_house_regions.default.regions.0.zone_ids.1.zone_id
}
# 创建ClickHouse社区版集群实例
resource "alicloud_click_house_db_cluster" "default" {
  timeouts {
    create = "60m" # 给创建加上超时时间
  }
  # （必需，强制新建）DBCluster 版本。有效值：20.3.10.75, 20.8.7.15, 21.8.10.19, 22.8.5.29, 23.8。
  db_cluster_version      = "23.8"
  # （必需，强制新建）DBCluster 的类别。有效值：Basic, HighAvailability。
  category                = "Basic"
  # （必需，强制新建）DBCluster 类别。根据类别，db_cluster_class 有两个值范围：
  #  如果类别是 Basic，有效值：LS20, LS40, LS80, S8, S16, S32, S64, S80, S104。
  # 如果类别是 HighAvailability，有效值：LC20, LC40, LC80, C8, C16, C32, C64, C80, C104。
  db_cluster_class        = "S8"
  # （必需，强制新建）DBCluster 网络类型。有效值：vpc。
  db_cluster_network_type = "vpc"
  # （必需，强制新建）数据库节点组数量。数字范围为 1 到 48。
  db_node_group_count     = "1"
  # （必需，强制新建）资源的支付类型。有效值：PayAsYouGo, Subscription。
  payment_type            = "PayAsYouGo"
  # （必需）数据库节点存储。
  db_node_storage         = "100"
  # （必需，强制新建）DBCluster 的存储类型。有效值：cloud_essd, cloud_efficiency, cloud_essd_pl2, cloud_essd_pl3。
  storage_type            = var.storage_type
  # （可选，强制新建）DBCluster 的 vswitch ID。
  vswitch_id              = alicloud_vswitch.default.id
  vpc_id                  = alicloud_vpc.vpc1.id
  # （可选）资源状态。有效值：Running, Creating, Deleting, Restarting, Preparing。
  status                  = "Running"
}
# 创建账号。
resource "alicloud_click_house_account" "default" {
  # （必需，强制新建）数据库集群 ID。
  db_cluster_id       = alicloud_click_house_db_cluster.default.id
  # （可选）可使用中文、英文字符。可以包含中文和英文字符、小写字母、数字和下划线（_）、短横线（-）。
  account_description = var.account_description
  # （必需，强制新建）账户名称：小写字母、数字、下划线，必须是小写字母；长度不超过 16 个字符。
  account_name        = var.account_name
  # （必需）账户密码：包含大写字母、小写字母、数字和特殊字符（特殊字符包括 !#$%^&*()_+-=），长度为 8-32 位。
  account_password    = var.account_password
  # （可选，强制新建）数据库账户类型。有效值：Normal 或 Super。
  type                = var.type
}

  2. 执行以下命令，初始化Terraform运行环境。

    terraform init

    返回如下信息，表示Terraform初始化成功。

    Initializing the backend...

Initializing provider plugins...
- Finding latest version of hashicorp/alicloud...
- Installing hashicorp/alicloud v1.234.0...
- Installed hashicorp/alicloud v1.234.0 (signed by HashiCorp)

Terraform has created a lock file .terraform.lock.hcl to record the provider
selections it made above. Include this file in your version control repository
so that Terraform can guarantee to make the same selections by default when
you run "terraform init" in the future.

Terraform has been successfully initialized!

You may now begin working with Terraform. Try running "terraform plan" to see
any changes that are required for your infrastructure. All Terraform commands
should now work.

If you ever set or change modules or backend configuration for Terraform,
rerun this command to reinitialize your working directory. If you forget, other
commands will detect it and remind you to do so if necessary.

  3. 创建执行计划，并预览变更。

    terraform plan

  4. 执行以下命令，使用Terraform调用云数据库服务ClickHouse社区版的OpenAPI创建一个集群，并为其创建一个数据库账号。

    terraform apply

    在执行过程中，根据提示输入yes并按下Enter键，等待命令执行完成，若出现以下信息，则表示使用Terraform调用云数据库服务ClickHouse社区版的OpenAPI创建一个集群，并为其创建一个数据库账号成功。

    Plan: 4 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

alicloud_vpc.vpc1: Creating...
alicloud_vpc.vpc1: Creation complete after 6s [id=vpc-m5eg98idembac44wqa***]
alicloud_vswitch.default: Creating...
alicloud_vswitch.default: Creation complete after 3s [id=vsw-m5e95h2x73sjh0jz3m***]
alicloud_click_house_db_cluster.default: Creating...
alicloud_click_house_db_cluster.default: Still creating... [10s elapsed]
alicloud_click_house_db_cluster.default: Still creating... [20s elapsed]
alicloud_click_house_db_cluster.default: Still creating... [30s elapsed]
alicloud_click_house_db_cluster.default: Still creating... [40s elapsed]
alicloud_click_house_db_cluster.default: Still creating... [50s elapsed]
alicloud_click_house_db_cluster.default: Still creating... [1m0s elapsed]
alicloud_click_house_db_cluster.default: Still creating... [1m10s elapsed]
alicloud_click_house_db_cluster.default: Still creating... [1m20s elapsed]
alicloud_click_house_db_cluster.default: Still creating... [1m30s elapsed]
alicloud_click_house_db_cluster.default: Still creating... [1m40s elapsed]
alicloud_click_house_db_cluster.default: Still creating... [1m50s elapsed]
alicloud_click_house_db_cluster.default: Still creating... [2m0s elapsed]
alicloud_click_house_db_cluster.default: Still creating... [2m10s elapsed]
alicloud_click_house_db_cluster.default: Still creating... [2m20s elapsed]
alicloud_click_house_db_cluster.default: Still creating... [2m30s elapsed]
alicloud_click_house_db_cluster.default: Still creating... [2m40s elapsed]
alicloud_click_house_db_cluster.default: Still creating... [2m50s elapsed]
alicloud_click_house_db_cluster.default: Still creating... [3m0s elapsed]
alicloud_click_house_db_cluster.default: Still creating... [3m10s elapsed]
alicloud_click_house_db_cluster.default: Still creating... [3m20s elapsed]
alicloud_click_house_db_cluster.default: Still creating... [3m30s elapsed]
...
alicloud_click_house_db_cluster.default: Still creating... [6m20s elapsed]
alicloud_click_house_db_cluster.default: Still creating... [6m30s elapsed]
alicloud_click_house_db_cluster.default: Creation complete after 6m37s [id=cc-m5e0608gia0t0***]
alicloud_click_house_account.default: Creating...
alicloud_click_house_account.default: Creation complete after 0s [id=cc-m5e0608gia0t***:test_acco***]

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

  5. 验证结果 。

    执行terraform show命令

    您可以使用以下命令查询Terraform已创建的资源详细信息：

    terraform show

    image

    登录ClickHouse管理控制台

    创建完成后，您可以登录云数据库ClickHouse控制台，检查操作是否正确完成。

    新建集群：

    image

    为新建集群创建的数据库账号：

    image

清理资源

当您不再需要上述通过Terraform创建或管理的资源时，请运行以下命令以释放资源。关于terraform destroy的更多信息，请参见Terraform常用命令。

terraform destroy

完整示例

说明

当前示例代码支持一键运行，您可以直接运行代码。一键运行

示例代码

variable "region" {
  default = "cn-qingdao"
}
provider "alicloud" {
  region = var.region
}
variable "name" {
  default = "tf-example-ClickHouse"
}
variable "type" {
  default = "Normal"
}
variable "account_password" {
  default = "testPassword123%"
}
variable "account_name" {
  default = "test_account"
}
variable "account_description" {
  default = "createdByTerraform"
}
variable "storage_type" {
  default = "cloud_essd"
}
data "alicloud_click_house_regions" "default" {
  region_id = var.region
  # current = true
}
# 创建 alicloud_vpc 资源
resource "alicloud_vpc" "vpc1" {
  vpc_name   = var.name
  cidr_block = "172.16.0.0/12"
}
# 在 local.zone_id 地区创建 alicloud_vpc 资源下的 alicloud_vswitch 资源
resource "alicloud_vswitch" "default" {
  vswitch_name = var.name
  cidr_block   = "172.16.20.0/24"
  vpc_id       = alicloud_vpc.vpc1.id
  zone_id      = data.alicloud_click_house_regions.default.regions.0.zone_ids.1.zone_id
}
# 创建ClickHouse集群实例
resource "alicloud_click_house_db_cluster" "default" {
  timeouts {
    create = "60m" # 给创建加上超时时间
  }
  # （必需，强制新建）DBCluster 版本。有效值：20.3.10.75, 20.8.7.15, 21.8.10.19, 22.8.5.29, 23.8。
  db_cluster_version      = "23.8"
  # （必需，强制新建）DBCluster 的类别。有效值：Basic, HighAvailability。
  category                = "Basic"
  # （必需，强制新建）DBCluster 类别。根据类别，db_cluster_class 有两个值范围：
  #  如果类别是 Basic，有效值：LS20, LS40, LS80, S8, S16, S32, S64, S80, S104。
  # 如果类别是 HighAvailability，有效值：LC20, LC40, LC80, C8, C16, C32, C64, C80, C104。
  db_cluster_class        = "S8"
  # （必需，强制新建）DBCluster 网络类型。有效值：vpc。
  db_cluster_network_type = "vpc"
  # （必需，强制新建）数据库节点组数量。数字范围为 1 到 48。
  db_node_group_count     = "1"
  # （必需，强制新建）资源的支付类型。有效值：PayAsYouGo, Subscription。
  payment_type            = "PayAsYouGo"
  # （必需）数据库节点存储。
  db_node_storage         = "100"
  # （必需，强制新建）DBCluster 的存储类型。有效值：cloud_essd, cloud_efficiency, cloud_essd_pl2, cloud_essd_pl3。
  storage_type            = var.storage_type
  # （可选，强制新建）DBCluster 的 vswitch ID。
  vswitch_id              = alicloud_vswitch.default.id
  vpc_id                  = alicloud_vpc.vpc1.id
  # （可选）资源状态。有效值：Running, Creating, Deleting, Restarting, Preparing。
  status                  = "Running"
}
# 创建账号。
resource "alicloud_click_house_account" "default" {
  # （必需，强制新建）数据库集群 ID。
  db_cluster_id       = alicloud_click_house_db_cluster.default.id
  # （可选）可使用中文、英文字符。可以包含中文和英文字符、小写字母、数字和下划线（_）、短横线（-）。
  account_description = var.account_description
  # （必需，强制新建）账户名称：小写字母、数字、下划线，必须是小写字母；长度不超过 16 个字符。
  account_name        = var.account_name
  # （必需）账户密码：包含大写字母、小写字母、数字和特殊字符（特殊字符包括 !#$%^&*()_+-=），长度为 8-32 位。
  account_password    = var.account_password
  # （可选，强制新建）数据库账户类型。有效值：Normal 或 Super。
  type                = var.type
}

如果您想体验更多完整示例，请前往更多完整示例中对应产品的文件夹查看。

上一篇：Terraform资源列表下一篇：SQL手册