全部產品
Search

搜尋本產品

    ApsaraMQ for Kafka：通過 Terraform 管理 Kafka 執行個體

    文件中心

    ApsaraMQ for Kafka：通過 Terraform 管理 Kafka 執行個體

    更新時間：Mar 06, 2025

    Terraform的alicloud_alikafka_instance資源提供一系列參數來管理Kafka執行個體，使用Terraform自動建立、部署執行個體可以縮短部署時間，保證多個環境的配置一致性，減少人為操作，降低引入錯誤的機率。

    說明

    本教程所含範例程式碼支援一鍵運行，您可以直接運行代碼。一鍵運行

    前提條件

    • 由於阿里雲帳號（主帳號）具有資源的所有許可權，一旦發生泄露將面臨重大風險。建議您使用RAM使用者，並為該RAM使用者建立AccessKey，具體操作方式請參見建立RAM使用者和建立AccessKey。

    • 通過RAM授權，阿里雲使用者可以有效地管理其雲資源存取權限，適應多使用者協同工作的需求，並且能夠按需為使用者指派最小許可權，避免許可權過大導致的安全性漏洞‌。具體操作方式請參見為RAM使用者授權。

      {
    "Version": "1",
    "Statement": [
        {
            "Effect": "Allow",
            "Action": [
                "vpc:DescribeVpcAttribute",
                "vpc:DescribeRouteTableList",
                "vpc:DescribeVSwitchAttributes",
                "vpc:DeleteVpc",
                "vpc:DeleteVSwitch",
                "vpc:CreateVpc",
                "vpc:CreateVSwitch"
            ],
            "Resource": "*"
        },
        {
            "Effect": "Allow",
            "Action": "bss:ModifyAgreementRecord",
            "Resource": "*"
        },
        {
            "Effect": "Allow",
            "Action": [
                "bss:DescribeOrderList",
                "bss:DescribeOrderDetail",
                "bss:PayOrder",
                "bss:CancelOrder"
            ],
            "Resource": "*"
        },
        {
            "Effect": "Allow",
            "Action": [
                "ecs:CreateSecurityGroup",
                "ecs:ModifySecurityGroupPolicy",
                "ecs:DescribeSecurityGroups",
                "ecs:ListTagResources",
                "ecs:DeleteSecurityGroup",
                "ecs:DescribeSecurityGroupAttribute",
                "ecs:AuthorizeSecurityGroup",
                "ecs:RevokeSecurityGroup"
            ],
            "Resource": "*"
        },
        {
            "Action": "alikafka:*",
            "Resource": "*",
            "Effect": "Allow"
        },
        {
            "Action": "ram:CreateServiceLinkedRole",
            "Resource": "*",
            "Effect": "Allow",
            "Condition": {
                "StringEquals": {
                    "ram:ServiceName": [
                        "connector.alikafka.aliyuncs.com",
                        "instanceencryption.alikafka.aliyuncs.com",
                        "alikafka.aliyuncs.com",
                        "etl.alikafka.aliyuncs.com"
                    ]
                }
            }
        }
    ]
}

    • 準備Terraform運行環境，您可以選擇以下任一方式來使用Terraform。

      • 在Terraform Explorer中使用Terraform：阿里雲提供了Terraform的線上運行環境，您無需安裝Terraform，登入後即可線上使用和體驗Terraform。適用於零成本、快速、便捷地體驗和調試Terraform的情境。

      • Cloud Shell：阿里雲Cloud Shell中預裝了Terraform的組件，並已配置好身份憑證，您可直接在Cloud Shell中運行Terraform的命令。適用於低成本、快速、便捷地訪問和使用Terraform的情境。

      • 在本地安裝和配置Terraform：適用於網路連接較差或需要自訂開發環境的情境。

    使用的資源

    說明

    本教程樣本包含的部分資源會產生一定費用，請在不需要時及時進行釋放或退訂。

    建立並部署執行個體

    說明

    目前不支援通過Terraform刪除預付費執行個體。

    本樣本以在華南1（深圳）地區下建立流量規格為alikafka.hw.2xlarge的VPC Kafka執行個體為例，執行個體名稱為alikafkaInstanceName。

    1. 建立一個工作目錄，並在該工作目錄中建立名為main.tf的設定檔，然後將以下代碼複製到main.tf中。

      variable "region" {
  default = "cn-shenzhen"
}

variable "instance_name" {
  default = "alikafkaInstanceName"
}

variable "zone_id" {
  default = "cn-shenzhen-f"
}

provider "alicloud" {
  region = var.region
}

# 建立VPC
resource "alicloud_vpc" "default" {
  vpc_name   = "alicloud"
  cidr_block = "172.16.0.0/16"
}

# 建立交換器
resource "alicloud_vswitch" "default" {
  vpc_id     = alicloud_vpc.default.id
  cidr_block = "172.16.192.0/20"
  zone_id    = var.zone_id
}

# 建立安全性群組。
resource "alicloud_security_group" "default" {
  vpc_id = alicloud_vpc.default.id
}

# 建立執行個體，磁碟類型為高效雲端硬碟，磁碟容量為500 GB，流量規格為alikafka.hw.2xlarge。
# 部署執行個體。
resource "alicloud_alikafka_instance" "default" {
  name           = var.instance_name
  partition_num  = 50
  disk_type      = 0
  disk_size      = 500
  deploy_type    = 5
  io_max_spec    = "alikafka.hw.2xlarge"
  vswitch_id     = alicloud_vswitch.default.id
  security_group = alicloud_security_group.default.id
}

    2. 執行以下命令，初始化Terraform運行環境。

      terraform init

      返回如下資訊，表示Terraform初始化成功。

      Initializing the backend...

Initializing provider plugins...
- Checking for available provider plugins...
- Downloading plugin for provider "alicloud" (hashicorp/alicloud) 1.90.1...
...

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

    3. 建立執行計畫，並預覽變更。

      terraform plan

    4. 執行以下命令，建立資源。

      terraform apply

      在執行過程中，根據提示輸入yes並按下Enter鍵，等待命令執行完成，若出現以下資訊，則表示運行成功。

      ...

alicloud_alikafka_instance.default: Destroying... [id=alikafka_post-cn-****]
alicloud_alikafka_instance.default: Still destroying... [id=alikafka_post-cn-****, 10s elapsed]
alicloud_alikafka_instance.default: Destruction complete after 11s
alicloud_security_group.default: Destroying... [id=sg-****]
alicloud_vswitch.vsw: Destroying... [id=vsw-****]
alicloud_security_group.default: Destruction complete after 1s
alicloud_vpc.default: Creating...
alicloud_vswitch.vsw: Destruction complete after 4s
alicloud_vpc.vpc: Destroying... [id=vpc-****]
alicloud_vpc.vpc: Destruction complete after 1s
alicloud_vpc.default: Creation complete after 4s [id=vpc-****]
alicloud_security_group.default: Creating...
alicloud_vswitch.default: Creating...
alicloud_security_group.default: Creation complete after 1s [id=sg-****]
alicloud_vswitch.default: Creation complete after 4s [id=vsw-****]
alicloud_alikafka_instance.default: Creating...
alicloud_alikafka_instance.default: Still creating... [10s elapsed]
...
alicloud_alikafka_instance.default: Creation complete after 3m42s [id=alikafka_post-cn-****]

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

    5. 驗證結果。

      執行terraform show命令

      執行terraform show查看Kafka執行個體資訊。

      terraform show
      # alicloud_alikafka_instance.default:
resource "alicloud_alikafka_instance" "default" {
    config            = jsonencode(
        {
            "cloud.maxTieredStoreSpace"       = "0"
            "enable.acl"                      = "false"
            "enable.compact"                  = "true"
            "enable.tiered"                   = "false"
            "enable.vpc_sasl_ssl"             = "false"
            "kafka.log.retention.hours"       = "72"
            "kafka.message.max.bytes"         = "1048576"
            "kafka.offsets.retention.minutes" = "10080"
            "kafka.ssl.bit"                   = "1024"
        }
    )
    deploy_type       = 5
    disk_size         = 500
    disk_type         = 0
    eip_max           = 0
    end_point         = "172.16.201.166:9092,172.16.201.167:9092,172.16.201.165:9092"
    group_left        = 2100
    group_used        = 0
    id                = "alikafka_post-cn-jfj40boei007"
    io_max            = 20
    io_max_spec       = "alikafka.hw.2xlarge"
    is_partition_buy  = 1
    kms_key_id        = null
    name              = "alikafkaInstanceName"
    paid_type         = "PostPaid"
    partition_left    = 1050
    partition_num     = 50
    partition_used    = 0
    resource_group_id = "rg-acfmykd63gtpfpa"
    security_group    = "sg-wz95ccy5lzy46acczhsm"
    service_version   = "2.2.0"
    spec_type         = "normal"
    status            = 5
    topic_left        = 1050
    topic_num_of_buy  = 1050
    topic_quota       = 1050
    topic_used        = 0
    vpc_id            = "vpc-wz9gv3xgeoyxte8t4zab0"
    vswitch_id        = "vsw-wz9u6icvx3k1hy2d44emk"
    zone_id           = "zonef"
}

      登入雲訊息佇列 Kafka 版控制台

      登入雲訊息佇列 Kafka 版控制台，查看Kafka執行個體資訊。image

    查詢執行個體

    以查詢雲帳號下的第一個Kafka執行個體為例。

    1. 在上述main.tf檔案中，增加data "alicloud_alikafka_instances" "instances_ds"配置項，具體配置如下。

      data "alicloud_alikafka_instances" "instances_ds" {
  output_file = "instances.txt"
}

output "first_instance_name" {
  # 索引[0]在這裡表示列表中的第一項。
  value = data.alicloud_alikafka_instances.instances_ds.instances.0.name
}

    2. 建立執行計畫，並預覽變更。

      terraform plan

    3. 執行以下命令，建立資源。

      terraform apply

      在執行過程中，根據提示輸入yes並按下Enter鍵，等待命令執行完成，若出現以下資訊，則表示運行成功。

      alicloud_vpc.default: Refreshing state... [id=vpc-****]
alicloud_security_group.default: Refreshing state... [id=sg-****]
alicloud_vswitch.default: Refreshing state... [id=vsw-****]
alicloud_alikafka_instance.default: Refreshing state... [id=alikafka_post-cn-****]
data.alicloud_alikafka_instances.instances_ds: Reading...
data.alicloud_alikafka_instances.instances_ds: Read complete after 0s [id=****]

Changes to Outputs:
  + first_instance_name = "alikafkaInstanceName"

You can apply this plan to save these new output values to the Terraform state, without changing any real
infrastructure.

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


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

Outputs:

first_instance_name = "alikafkaInstanceName"

    4. 驗證結果。

      在instances.txt檔案中查看執行個體的其他更多資訊。

      [
	{
		"config": "{\"enable.vpc_sasl_ssl\":\"false\",\"kafka.log.retention.hours\":\"72\",\"kafka.offsets.retention.minutes\":\"10080\",\"enable.tiered\":\"false\",\"cloud.maxTieredStoreSpace\":\"0\",\"enable.acl\":\"true\",\"kafka.ssl.bit\":\"1024\",\"enable.compact\":\"true\",\"kafka.message.max.bytes\":\"1048576\"}",
		"create_time": 1698908400000,
		"deploy_type": 5,
		"disk_size": 900,
		"disk_type": 0,
		"domain_endpoint": "alikafka-post-cn-uax3go6z****-1-vpc.alikafka.aliyuncs.com:9092,alikafka-post-cn-****-2-vpc.alikafka.aliyuncs.com:9092,alikafka-post-cn-****-3-vpc.alikafka.aliyuncs.com:9092",
		"eip_max": 0,
		"end_point": "192.168.XX.XX:9092,192.168.XX.XX:9092,192.168.XX.XX:9092",
		"expired_time": 2014527600000,
		"id": "alikafka_post-cn-****",
		"io_max": 20,
		"msg_retain": 72,
		"name": "alikafka_post-cn-****",
		"paid_type": "PostPaid",
		"sasl_domain_endpoint": "alikafka-post-cn-****-1-vpc.alikafka.aliyuncs.com:9094,alikafka-post-cn-****-2-vpc.alikafka.aliyuncs.com:9094,alikafka-post-cn-****-3-vpc.alikafka.aliyuncs.com:9094",
		"security_group": "sg-****",
		"service_status": 5,
		"service_version": "2.2.0",
		"spec_type": "professional",
		"ssl_domain_endpoint": null,
		"ssl_end_point": "",
		"tags": {},
		"upgrade_service_detail_info": [
			{
				"current2_open_source_version": "2.2.0"
			}
		],
		"vpc_id": "vpc-****",
		"vswitch_id": "vsw-****",
		"zone_id": "zonek"
	},
]

    清理資源

    當您不再需要上述通過Terraform建立或管理的資源時，請運行以下命令以釋放資源。關於terraform destroy的更多資訊，請參見常用命令。

    terraform destroy

    完整樣本

    說明

    當前範例程式碼支援一鍵運行，您可以直接運行代碼。一鍵運行

    範例程式碼

    variable "region" {
  default = "cn-shenzhen"
}

variable "instance_name" {
  default = "alikafkaInstanceName"
}

variable "zone_id" {
  default = "cn-shenzhen-f"
}

provider "alicloud" {
  region = var.region
}

# 建立VPC
resource "alicloud_vpc" "default" {
  vpc_name   = "alicloud"
  cidr_block = "172.16.0.0/16"
}

# 建立交換器
resource "alicloud_vswitch" "default" {
  vpc_id     = alicloud_vpc.default.id
  cidr_block = "172.16.192.0/20"
  zone_id    = var.zone_id
}

# 建立安全性群組。
resource "alicloud_security_group" "default" {
  vpc_id = alicloud_vpc.default.id
}

# 建立執行個體，磁碟類型為高效雲端硬碟，磁碟容量為500 GB，流量規格為alikafka.hw.2xlarge。
# 部署執行個體。
resource "alicloud_alikafka_instance" "default" {
  name           = var.instance_name
  partition_num  = 50
  disk_type      = 0
  disk_size      = 500
  deploy_type    = 5
  io_max_spec    = "alikafka.hw.2xlarge"
  vswitch_id     = alicloud_vswitch.default.id
  security_group = alicloud_security_group.default.id
}

# 查詢執行個體
data "alicloud_alikafka_instances" "instances_ds" {
  depends_on = [alicloud_alikafka_instance.default]
  output_file = "instances.txt"
}

output "first_instance_name" {
  # 索引[0]在這裡表示列表中的第一項。
  value = data.alicloud_alikafka_instances.instances_ds.instances.0.name
}

    相關文檔