通過Terraform管理事件總線
Terraform是一種開源工具,用于安全高效地預(yù)覽、配置和管理云基礎(chǔ)架構(gòu)和資源。本文將為您介紹如何通過Terraform管理事件總線,包括創(chuàng)建事件總線、事件源、連接配置、API 端點(diǎn)與事件規(guī)則等操作。
本教程所含示例代碼支持一鍵運(yùn)行,您可以直接運(yùn)行代碼。一鍵運(yùn)行
前提條件
完成此教程,您需要開通以下服務(wù):
事件總線:開通請(qǐng)參見開通事件總線EventBridge并授權(quán)。
輕量消息隊(duì)列(原 MNS):開通請(qǐng)參見開通輕量消息隊(duì)列(原 MNS)并授權(quán)。
為了降低信息安全風(fēng)險(xiǎn),建議使用最小權(quán)限的RAM用戶完成此教程的操作。請(qǐng)參見創(chuàng)建RAM用戶與為RAM用戶授權(quán),完成此教程所需權(quán)限的權(quán)限策略如下:
{ "Version": "1", "Statement": [ { "Effect": "Allow", "Action": "mns:*", "Resource": "*" }, { "Effect": "Allow", "Action": [ "eventbridge:GetEventBus", "eventbridge:ListEventBuses", "eventbridge:CreateEventBus", "eventbridge:DeleteEventBus", "eventbridge:UpdateEventBus", "eventbridge:ListApiDestinations", "eventbridge:ListUserDefinedEventSources", "eventbridge:CreateEventSource", "eventbridge:DeleteEventSource", "eventbridge:UpdateEventSource", "eventbridge:ListPartnerEventSources", "eventbridge:GetRule", "eventbridge:ListRules", "eventbridge:CreateRule", "eventbridge:DeleteRule", "eventbridge:EnableRule", "eventbridge:UpdateRule", "eventbridge:ListConnections", "eventbridge:CreateConnection", "eventbridge:DeleteConnection", "eventbridge:UpdateConnection", "eventbridge:GetConnection", "eventbridge:GetApiDestination", "eventbridge:CreateApiDestination", "eventbridge:DeleteApiDestination", "eventbridge:UpdateApiDestination" ], "Resource": "*" } ] }
準(zhǔn)備Terraform運(yùn)行環(huán)境,您可以選擇以下任一方式來使用Terraform。
在Terraform Explorer中使用Terraform:阿里云提供了Terraform的在線運(yùn)行環(huán)境,您無需安裝Terraform,登錄后即可在線使用和體驗(yàn)Terraform。適用于零成本、快速、便捷地體驗(yàn)和調(diào)試Terraform的場景。
Cloud Shell:阿里云Cloud Shell中預(yù)裝了Terraform的組件,并已配置好身份憑證,您可直接在Cloud Shell中運(yùn)行Terraform的命令。適用于低成本、快速、便捷地訪問和使用Terraform的場景。
在本地安裝和配置Terraform:適用于網(wǎng)絡(luò)連接較差或需要自定義開發(fā)環(huán)境的場景。
使用的資源
本教程示例包含的部分資源會(huì)產(chǎn)生一定費(fèi)用,請(qǐng)?jiān)诓恍枰獣r(shí)及時(shí)進(jìn)行釋放或退訂。
alicloud_mns_queue:輕量消息隊(duì)列。
alicloud_event_bridge_api_destination:API 端點(diǎn)。
alicloud_event_bridge_rule:事件規(guī)則。
步驟一:創(chuàng)建事件總線與事件源
創(chuàng)建一個(gè)工作目錄,并在該工作目錄中創(chuàng)建名為main.tf的配置文件。以下代碼將創(chuàng)建事件總線、消息隊(duì)列以及將消息隊(duì)列設(shè)置為事件源,請(qǐng)將以下代碼復(fù)制到main.tf中。
variable "region" { default = "cn-shanghai" } provider "alicloud" { region = var.region } variable "api_key_name"{ default = "<使用API_KEY_AUTH鑒權(quán)方式的用戶名>" } variable "api_key_value"{ default = "<使用API_KEY_AUTH鑒權(quán)方式的Value>" } # API端點(diǎn)的URL variable "endpoint"{ default = "http://xxxx:8080/putEventsByAPiKey" } data "alicloud_account" "default" { } resource "random_integer" "default" { min = 10000 max = 99999 } # 自定義事件總線 resource "alicloud_event_bridge_event_bus" "example" { event_bus_name = "event_bus_name_${random_integer.default.result}" } # 消息隊(duì)列,用于作為事件源 resource "alicloud_mns_queue" "source" { name = "queue-name-source-${random_integer.default.result}" } # 自定義事件源 resource "alicloud_event_bridge_event_source" "default" { event_bus_name = alicloud_event_bridge_event_bus.example.event_bus_name event_source_name = "event_source_name_${random_integer.default.result}" description = "description_${random_integer.default.result}" linked_external_source = true external_source_type = "MNS" external_source_config = { QueueName = alicloud_mns_queue.source.name } }
執(zhí)行如下命令,初始化Terraform運(yùn)行環(huán)境。
terraform init
返回信息如下,則Terraform初始化成功。
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.
執(zhí)行如下命令,開始執(zhí)行代碼。
terraform apply
在執(zhí)行過程中,根據(jù)提示輸入
yes
并按下Enter鍵,等待命令執(zhí)行完成,若出現(xiàn)以下信息,則表示代碼執(zhí)行成功。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: 4 added, 0 changed, 0 destroyed.
驗(yàn)證結(jié)果。
執(zhí)行terraform show命令
您可以在工作目錄中,使用以下命令查詢Terraform已創(chuàng)建資源的詳細(xì)信息:
terraform show
登錄控制臺(tái)查看
登錄事件總線 EventBridge控制臺(tái),進(jìn)入 頁簽,左上角選擇地區(qū),此例中選擇華東2 (上海),查看已創(chuàng)建的事件總線。
單擊事件總線名稱,進(jìn)入事件總線詳情界面,單擊,查看已創(chuàng)建的事件源。
步驟二:創(chuàng)建連接配置與API 端點(diǎn)
在
main.tf
文件中增加如下代碼。# 連接配置 resource "alicloud_event_bridge_connection" "defaultConnection" { connection_name = "connection_name_${random_integer.default.result}" description = "description_alicloud_event_bridge_connection_${random_integer.default.result}" network_parameters { network_type = "PublicNetwork" } auth_parameters { authorization_type = "API_KEY_AUTH" api_key_auth_parameters { api_key_name = var.api_key_name api_key_value = var.api_key_value } } } # API端點(diǎn) resource "alicloud_event_bridge_api_destination" "default" { description = "description_alicloud_event_bridge_api_destinationn_${random_integer.default.result}" http_api_parameters { endpoint = var.endpoint method = "POST" } api_destination_name = "api_destination_name_${random_integer.default.result}" connection_name = alicloud_event_bridge_connection.defaultConnection.connection_name }
創(chuàng)建執(zhí)行計(jì)劃,并預(yù)覽變更。
terraform plan
執(zhí)行如下命令,開始執(zhí)行代碼。
terraform apply
在執(zhí)行過程中,根據(jù)提示輸入
yes
并按下Enter鍵,等待命令執(zhí)行完成,若出現(xiàn)以下信息,則表示代碼執(zhí)行成功。Apply complete! Resources: 2 added, 0 changed, 0 destroyed.
驗(yàn)證結(jié)果。
執(zhí)行terraform show命令
您可以在工作目錄中,使用以下命令查詢Terraform已創(chuàng)建資源的詳細(xì)信息:
terraform show
登錄控制臺(tái)查看
登錄事件總線 EventBridge控制臺(tái),進(jìn)入 頁面,左上角選擇地區(qū),此例中選擇華東2 (上海),進(jìn)入連接配置頁簽,查看已創(chuàng)建的連接配置。
進(jìn)入API 端點(diǎn)頁簽,查看已創(chuàng)建的API 端點(diǎn)。
步驟三:創(chuàng)建事件規(guī)則
在
main.tf
文件中增加如下代碼。# 事件規(guī)則 resource "alicloud_event_bridge_rule" "default" { event_bus_name = alicloud_event_bridge_event_bus.example.event_bus_name rule_name = "rule_name_${random_integer.default.result}" description = "description_${random_integer.default.result}" filter_pattern = "{\n \"source\": [\n \"tf-test-api-key\"\n ]\n}" targets { target_id = "tf_example_${random_integer.default.result}" endpoint = "acs:api-destination:${var.region}:${data.alicloud_account.default.id}:name/${alicloud_event_bridge_api_destination.default.api_destination_name}" type = "acs.api.destination" param_list { resource_key = "Name" form = "CONSTANT" value = "terraform-api_destination-name-api-key" } param_list { resource_key = "QueryStringParameters" form = "TEMPLATE" value = "{\"queryKey1\":\"id\",\"queryValue1\":\"$.data.name\"}" # ${}用于聲明EventBridge中的變量,$${}用于在Terraform文件中聲明變量。 template = "{\"$${queryKey1}\":\"$${queryValue1}\"}" } } }
創(chuàng)建執(zhí)行計(jì)劃,并預(yù)覽變更。
terraform plan
執(zhí)行如下命令,開始執(zhí)行代碼。
terraform apply
在執(zhí)行過程中,根據(jù)提示輸入
yes
并按下Enter鍵,等待命令執(zhí)行完成,若出現(xiàn)以下信息,則表示代碼執(zhí)行成功。Apply complete! Resources: 1 added, 0 changed, 0 destroyed.
驗(yàn)證結(jié)果。
執(zhí)行terraform show命令
您可以在工作目錄中,使用以下命令查詢Terraform已創(chuàng)建資源的詳細(xì)信息:
terraform show
登錄控制臺(tái)查看
登錄事件總線 EventBridge控制臺(tái),進(jìn)入 頁簽,左上角選擇地區(qū),此例中選擇華東2 (上海),單擊已創(chuàng)建事件總線操作列的事件規(guī)則,查看已創(chuàng)建的事件規(guī)則。
清理資源
當(dāng)您不再需要上述通過Terraform創(chuàng)建或管理的資源時(shí),請(qǐng)運(yùn)行以下命令以釋放資源。關(guān)于terraform destroy
的更多信息,請(qǐng)參見Terraform常用命令。
terraform destroy
完整示例
本教程所含示例代碼支持一鍵運(yùn)行,您可以直接運(yùn)行代碼。一鍵運(yùn)行
示例代碼
variable "region" {
default = "cn-shanghai"
}
provider "alicloud" {
region = var.region
}
variable "api_key_name"{
default = "<使用API_KEY_AUTH鑒權(quán)方式的用戶名>"
}
variable "api_key_value"{
default = "<使用API_KEY_AUTH鑒權(quán)方式的Value>"
}
# API端點(diǎn)的URL
variable "endpoint"{
default = "http://xxxx:8080/putEventsByAPiKey"
}
data "alicloud_account" "default" {
}
resource "random_integer" "default" {
min = 10000
max = 99999
}
# 自定義事件總線
resource "alicloud_event_bridge_event_bus" "example" {
event_bus_name = "event_bus_name_${random_integer.default.result}"
}
# 消息隊(duì)列,用于作為事件源
resource "alicloud_mns_queue" "source" {
name = "queue-name-source-${random_integer.default.result}"
}
# 自定義事件源
resource "alicloud_event_bridge_event_source" "default" {
event_bus_name = alicloud_event_bridge_event_bus.example.event_bus_name
event_source_name = "event_source_name_${random_integer.default.result}"
description = "description_${random_integer.default.result}"
linked_external_source = true
external_source_type = "MNS"
external_source_config = {
QueueName = alicloud_mns_queue.source.name
}
}
# 連接配置
resource "alicloud_event_bridge_connection" "defaultConnection" {
connection_name = "connection_name_${random_integer.default.result}"
description = "description_alicloud_event_bridge_connection_${random_integer.default.result}"
network_parameters {
network_type = "PublicNetwork"
}
auth_parameters {
authorization_type = "API_KEY_AUTH"
api_key_auth_parameters {
api_key_name = var.api_key_name
api_key_value = var.api_key_value
}
}
}
# API端點(diǎn)
resource "alicloud_event_bridge_api_destination" "default" {
description = "description_alicloud_event_bridge_api_destinationn_${random_integer.default.result}"
http_api_parameters {
endpoint = var.endpoint
method = "POST"
}
api_destination_name = "api_destination_name_${random_integer.default.result}"
connection_name = alicloud_event_bridge_connection.defaultConnection.connection_name
}
# 事件規(guī)則
resource "alicloud_event_bridge_rule" "default" {
event_bus_name = alicloud_event_bridge_event_bus.example.event_bus_name
rule_name = "rule_name_${random_integer.default.result}"
description = "description_${random_integer.default.result}"
filter_pattern = "{\n \"source\": [\n \"tf-test-api-key\"\n ]\n}"
targets {
target_id = "tf_example_${random_integer.default.result}"
endpoint = "acs:api-destination:${var.region}:${data.alicloud_account.default.id}:name/${alicloud_event_bridge_api_destination.default.api_destination_name}"
type = "acs.api.destination"
param_list {
resource_key = "Name"
form = "CONSTANT"
value = "terraform-api_destination-name-api-key"
}
param_list {
resource_key = "QueryStringParameters"
form = "TEMPLATE"
value = "{\"queryKey1\":\"id\",\"queryValue1\":\"$.data.name\"}"
# ${}用于聲明EventBridge中的變量,$${}用于在Terraform文件中聲明變量。
template = "{\"$${queryKey1}\":\"$${queryValue1}\"}"
}
}
}
如果您想體驗(yàn)更多完整示例,請(qǐng)前往更多完整示例中對(duì)應(yīng)產(chǎn)品的文件夾查看。
相關(guān)文檔
Terrafrom介紹,請(qǐng)參見Terraform產(chǎn)品介紹。
當(dāng)您遇到由于網(wǎng)絡(luò)延遲等原因造成的
terraform init
超時(shí),導(dǎo)致無法正常下載Provider等情況時(shí),請(qǐng)參見Terraform Init 加速方案配置。