如何通过Terraform CLI为Terraform Cloud指定运行名称？

CLI操作方式 #

Terraform CLI本身没有专门的命令行参数直接设置运行名称（即界面中的启动原因），但可以通过环境变量实现这个需求：

• 执行terraform apply或terraform plan时，设置TF_CLOUD_RUN_COMMENT环境变量，变量值就是你想要的运行启动原因。示例命令：

TF_CLOUD_RUN_COMMENT="生产环境v2.1版本基础设施更新" terraform apply

这个环境变量会将自定义注释传递给Terraform Cloud，对应界面中显示的运行启动原因。

API驱动执行方式 #

如果偏好API驱动的执行，可以调用Terraform Cloud的创建运行API，在请求的JSON体中指定comment字段来设置运行名称/启动原因。示例请求体：

{
  "data": {
    "type": "runs",
    "attributes": {
      "comment": "API触发的季度安全合规扫描运行",
      "is-destroy": false
    },
    "relationships": {
      "workspace": {
        "data": {
          "type": "workspaces",
          "id": "你的工作空间ID"
        }
      }
    }
  }
}

向Terraform Cloud的API端点发送POST请求即可创建带有自定义注释的运行。

你也可以结合CLI和API的优势：先用CLI生成执行计划，再通过API提交运行并附加自定义注释，兼顾操作便捷性和配置灵活性。

内容的提问来源于stack exchange，提问作者Abhijeet Kamble