orstensemantics/concourse-tfe-resource

concourse-tfe-resource

Concourse资源，用于与Terraform Cloud和Terraform Enterprise集成，基于https://github.com/hashicorp/go-tfe%E5%AE%9E%E7%8E%B0%E3%80%82

镜像概述和主要用途

该镜像提供Concourse资源，用于与Terraform Cloud和Terraform Enterprise进行交互，支持变量推送、运行创建、运行状态检索及相关元数据获取等功能，适用于CI/CD流程中Terraform环境的自动化管理。

核心功能和特性

• 支持向Terraform工作区推送变量（包括Terraform变量和环境变量）
• 可创建和管理Terraform运行（Run）
• 检索运行状态及相关元数据（变量、环境变量、状态输出等）
• 支持等待运行进入最终状态，并可配置是否自动确认需要确认的运行
• 提供灵活的消息变量插值，支持Concourse环境信息注入

使用场景和适用范围

• Concourse CI/CD流水线中集成Terraform Cloud/Enterprise操作
• 自动化Terraform变量管理和部署流程
• 实现Terraform运行状态的监控和反馈
• 适用于需要通过Concourse管理Terraform基础设施即代码（IaC）的场景

使用方法和配置说明

资源类型定义

yaml
resource_types:
  - name: tfe
    type: docker-image
    source:
      repository: orstensemantics/concourse-tfe-resource

源配置（Source Configuration）

行为（Behaviour）

in - 检索运行及相关信息

• 等待运行进入最终状态（policy_soft_failed、planned_and_finished、applied、discarded、errored、canceled、force_canceled）
• 不会根据运行的最终状态失败。如需根据最终状态响应，可使用以下命令（当运行未以成功应用或无变更计划结束时，将返回非零状态）：

  shell
  $ cat your_run/metadata.json | jq -e '.final_status | IN(["applied","planned_and_finished"], .)'
  

• 若运行需要确认且confirm为true，则会确认运行（由运行的actions.is-confirmable属性决定，与工作区的自动应用设置无关）
• 将检索工作区变量、环境变量和状态输出：
  • 重要 - 返回的值为当前值，即使提供的运行ID不是最新的
  • ./vars：包含每个工作区变量的文件，存储变量的当前值。HCL变量位于.vars/hcl。敏感变量为空
  • ./env_vars：包含每个环境变量的文件，存储变量的当前值。敏感值为空
  • ./outputs.json：包含工作区当前状态所有根级输出的JSON文件。敏感值为空字符串，除非sensitive参数为true，适用于load_var/set_pipeline步骤
  • ./outputs：包含每个根级输出的文件，内容为JSON格式。敏感值为空文件，除非sensitive参数为true
  • ./metadata.json：包含资源版本中可见的相同元数据值

参数

out - 推送变量并创建运行

• 推送所有提供的变量到工作区
• 排队创建一个运行

参数

变量参数

每个变量条目至少需设置value或file之一，其他为可选参数。

示例

yaml
    - ...
    - put: my-workspace
      params:
        vars:
          my_workspace_var:
            # 若同时指定value和file，value优先
            value: a value # 直接指定值
            file: someoutput/filename # 或引用包含值的文件
            description: a description # 可选
            sensitive: true # 可选，默认为false
            hcl: true # 可选，默认为false
          MY_ENV_VAR:
            value: a value
            file: someoutput/filename
            category: env
        message: Terraform Cloud中的构建名称 # 可选

消息变量

message和apply_message支持通过https://github.com/drone/envsubst%E8%BF%9B%E8%A1%8C%E6%8F%92%E5%80%BC%EF%BC%8C%E6%94%AF%E6%8C%81%E5%A4%A7%E5%A4%9A%E6%95%B0bash%E5%AD%97%E7%AC%A6%E4%B8%B2%E6%9B%BF%E6%8D%A2%E5%87%BD%E6%95%B0%E3%80%82%E4%BB%A5%E4%B8%8B%E6%98%AF%E5%8F%AF%E7%94%A8%E5%8F%98%E9%87%8F%EF%BC%9A