AI 助理
备案控制台
文档
输入文档关键字查找
首页 系统运维管理 实践教程 开源集成 使用Terraform操作OOS

使用Terraform操作OOS

更新时间：
产品详情
相关技术圈
我的收藏

本文将介绍如何使用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：适用于网络连接较差或需要自定义开发环境的场景。

使用的资源

步骤一：创建OOS模板

  1. 创建一个工作目录，并在该工作目录中创建名为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}"
}

  2. 执行如下命令，初始化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.

  3. 执行如下命令，开始创建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.

  4. 验证结果。

    说明

    如果您需要更新terraform创建的资源，可以通过系统运维管理 OOS控制台修改，也可以修改配置文件，然后执行terraform apply进行更新。详细了解terraform apply命令请参见Terraform常用命令。

    执行terraform show命令

    您可以在工作目录中，使用以下命令查询Terraform已创建资源的详细信息：

    terraform show

    image

    登录系统运维管理 OOS控制台

    登录系统运维管理 OOS，进入自动化任务 > 自定义任务模板页签，左上角选择地区，此例中选择华北2 （北京），查看已创建的OOS模板。

    image

步骤二：更新OOS模板

以修改此例所创建OOS模板的模板描述为例，演示如何更新OOS模板。

  1. 修改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}"
}

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

    terraform plan

  3. 执行如下命令，开始执行代码。

    terraform apply

    在执行过程中，根据提示输入yes并按下Enter键，等待命令执行完成，若出现以下信息，则表示代码执行成功。

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

  4. 验证结果。

    执行terraform show命令

    您可以在工作目录中，使用以下命令查询Terraform已管理资源的详细信息：

    terraform show

    image

    登录控制台查看

    登录系统运维管理 OOS，进入自动化任务 > 自定义任务模板页签，左上角选择地区，此例中选择华北2 （北京），单击此例创建模板操作列的详情，查看模板详情。image

步骤三：执行OOS模板

  1. 在main.tf文件中增加如下代码。

    resource "alicloud_oos_execution" "exampleExecution" {
  template_name = alicloud_oos_template.example.template_name
  description   = "From TF Test"
  parameters    = <<EOF
          {"Status":"Running"}
        EOF
}

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

    terraform plan

  3. 执行如下命令，开始执行OOS模板。

    terraform apply

    在执行过程中，根据提示输入yes并按下Enter键，等待命令执行完成，若出现以下信息，则表示OOS模板执行成功。

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

  4. 验证结果。

    执行terraform show命令

    您可以在工作目录中，使用以下命令查询Terraform已创建资源的详细信息：

    terraform show

    image

    登录系统运维管理 OOS控制台

    登录系统运维管理 OOS，进入自动化任务 > 任务执行管理页签，左上角选择地区，此例中选择华北2 （北京），查看任务执行详情。image

清理资源

当您不再需要上述通过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
}

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

相关文档

上一篇：开源集成下一篇：使用Ansible创建OOS模板与执行
文档推荐