本文將介紹如何使用terraform創建和執行OOS模板。
本教程所含示例代碼支持一鍵運行,您可以直接運行代碼。一鍵運行
前提條件
為了降低信息安全風險,建議使用最小權限的RAM用戶完成此教程的操作。請參見創建RAM用戶與為RAM用戶授權,完成此教程所需最小權限的權限策略如下:
{ "Version": "1", "Statement": [ { "Effect": "Allow", "Action": [ "oos:CreateTemplate", "oos:GetTemplate", "oos:DeleteTemplate", "oos:StartExecution", "oos:ListExecutions", "oos:DeleteExecutions", "oos:ListTemplates" ], "Resource": "*" }, { "Effect": "Allow", "Action": "ecs:DescribeInstances", "Resource": "*" } ] }
準備Terraform運行環境,您可以選擇以下任一方式來使用Terraform。
Explorer:阿里云提供了Terraform的在線運行環境,您無需安裝Terraform,登錄后即可在線使用和體驗Terraform。適用于零成本、快速、便捷地體驗和調試Terraform的場景。
Cloud Shell:阿里云Cloud Shell中預裝了Terraform的組件,并已配置好身份憑證,您可直接在Cloud Shell中運行Terraform的命令。適用于低成本、快速、便捷地訪問和使用Terraform的場景。
在本地安裝和配置Terraform:適用于網絡連接較差或需要自定義開發環境的場景。
使用的資源
alicloud_oos_template:創建OOS模板。
alicloud_oos_execution:執行OOS模板。
步驟一:創建OOS模板
創建一個工作目錄,并在該工作目錄中創建名為main.tf的配置文件,然后將以下代碼復制到main.tf中。
variable "region" { default = "cn-beijing" } provider "alicloud" { region = var.region } resource "random_integer" "default" { min = 10000 max = 99999 } resource "alicloud_oos_template" "example" { tags = { "Created" = "TF", "For" = "template Test" } content = <<EOF { "FormatVersion": "OOS-2019-06-01", "Description": "Update Describe instances of given status", "Parameters":{ "Status":{ "Type": "String", "Description": "(Required) The status of the Ecs instance." } }, "Tasks": [ { "Properties" :{ "Parameters":{ "Status": "{{ Status }}" }, "API": "DescribeInstances", "Service": "Ecs" }, "Name": "foo", "Action": "ACS::ExecuteApi" }] } EOF template_name = "terraform-test-${random_integer.default.result}" }
執行如下命令,初始化Terraform運行環境。
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.
執行如下命令,開始創建OOS模板。
terraform apply
在執行過程中,根據提示輸入
yes
并按下Enter鍵,等待命令執行完成,若出現以下信息,則表示創建OOS成功。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: 2 added, 0 changed, 0 destroyed.
驗證結果。
說明如果您需要更新terraform創建的資源,可以通過系統運維管理 OOS控制臺修改,也可以修改配置文件,然后執行terraform apply進行更新。詳細了解terraform apply命令請參見Terraform常用命令。
執行terraform show命令
您可以在工作目錄中,使用以下命令查詢Terraform已創建資源的詳細信息:
terraform show
登錄系統運維管理 OOS控制臺
登錄系統運維管理 OOS,進入 頁簽,左上角選擇地區,此例中選擇華北2 (北京),查看已創建的OOS模板。
步驟二:更新OOS模板
以修改此例所創建OOS模板的模板描述為例,演示如何更新OOS模板。
修改
main.tf
文件中的資源alicloud_oos_template的模板描述,將"Description": "Update Describe instances of given status"修改為:"Description": "Update Describe instances of given status,test update oos",如以下代碼所示。resource "alicloud_oos_template" "example" { tags = { "Created" = "TF", "For" = "template Test" } content = <<EOF { "FormatVersion": "OOS-2019-06-01", "Description": "Update Describe instances of given status,test update oos", "Parameters":{ "Status":{ "Type": "String", "Description": "(Required) The status of the Ecs instance." } }, "Tasks": [ { "Properties" :{ "Parameters":{ "Status": "{{ Status }}" }, "API": "DescribeInstances", "Service": "Ecs" }, "Name": "foo", "Action": "ACS::ExecuteApi" }] } EOF template_name = "terraform-test-${random_integer.default.result}" }
創建執行計劃,并預覽變更。
terraform plan
執行如下命令,開始執行代碼。
terraform apply
在執行過程中,根據提示輸入
yes
并按下Enter鍵,等待命令執行完成,若出現以下信息,則表示代碼執行成功。Apply complete! Resources: 0 added, 1 changed, 0 destroyed.
驗證結果。
執行terraform show命令
您可以在工作目錄中,使用以下命令查詢Terraform已管理資源的詳細信息:
terraform show
登錄控制臺查看
登錄系統運維管理 OOS,進入 頁簽,左上角選擇地區,此例中選擇華北2 (北京),單擊此例創建模板操作列的詳情,查看模板詳情。
步驟三:執行OOS模板
在
main.tf
文件中增加如下代碼。resource "alicloud_oos_execution" "exampleExecution" { template_name = alicloud_oos_template.example.template_name description = "From TF Test" parameters = <<EOF {"Status":"Running"} EOF }
創建執行計劃,并預覽變更。
terraform plan
執行如下命令,開始執行OOS模板。
terraform apply
在執行過程中,根據提示輸入
yes
并按下Enter鍵,等待命令執行完成,若出現以下信息,則表示OOS模板執行成功。Apply complete! Resources: 1 added, 0 changed, 0 destroyed.
驗證結果。
執行terraform show命令
您可以在工作目錄中,使用以下命令查詢Terraform已創建資源的詳細信息:
terraform show
登錄系統運維管理 OOS控制臺
登錄系統運維管理 OOS,進入 頁簽,左上角選擇地區,此例中選擇華北2 (北京),查看任務執行詳情。
清理資源
當您不再需要上述通過Terraform創建或管理的資源時,請運行以下命令以釋放資源。關于terraform destroy
的更多信息,請參見Terraform常用命令。
terraform destroy
完整示例
本教程所含示例代碼支持一鍵運行,您可以直接運行代碼。一鍵運行
示例代碼
variable "region" {
default = "cn-beijing"
}
provider "alicloud" {
region = var.region
}
resource "random_integer" "default" {
min = 10000
max = 99999
}
resource "alicloud_oos_template" "example" {
tags = {
"Created" = "TF",
"For" = "template Test"
}
content = <<EOF
{
"FormatVersion": "OOS-2019-06-01",
"Description": "Update Describe instances of given status",
"Parameters":{
"Status":{
"Type": "String",
"Description": "(Required) The status of the Ecs instance."
}
},
"Tasks": [
{
"Properties" :{
"Parameters":{
"Status": "{{ Status }}"
},
"API": "DescribeInstances",
"Service": "Ecs"
},
"Name": "foo",
"Action": "ACS::ExecuteApi"
}]
}
EOF
template_name = "terraform-test-${random_integer.default.result}"
}
resource "alicloud_oos_execution" "exampleExecution" {
template_name = alicloud_oos_template.example.template_name
description = "From TF Test"
parameters = <<EOF
{"Status":"Running"}
EOF
}
如果您想體驗更多完整示例,請前往更多完整示例中對應產品的文件夾查看。
相關文檔
Terrafrom介紹,請參見Terraform產品介紹。
當您遇到由于網絡延遲等原因造成的 terraform init 超時,導致無法正常下載 Provider 等情況時,請參見Terraform Init 加速方案配置。