Terraform Cloud Agent 镜像文档

镜像概述和主要用途

Terraform Cloud Agent 是用于处理 Terraform Cloud 辅助工作负载的代理服务。该代理通过连接 Terraform Cloud API 接收并处理工作项，允许将 Terraform 计划（plan）、应用（apply）等核心组件的执行从 HashiCorp 托管服务器转移至用户指定的外部基础设施，从而实现将 Terraform Cloud 工作负载部署在任意所需网络环境中的能力。

核心功能和特性

• Terraform Cloud API 集成：与 Terraform Cloud 服务建立安全连接，实时接收和处理工作任务。
• 工作流执行：负责执行 Terraform 计划生成、配置应用等关键工作流程。
• 外部基础设施支持：支持将工作负载从 HashiCorp 托管服务器迁移至用户自有或指定的外部基础设施运行。
• 网络灵活性：可部署在任意网络环境（如私有网络、防火墙隔离区域），满足特定网络访问控制或数据本地化需求。

使用场景和适用范围

• 私有网络部署：需在企业内部私有网络、防火墙后或受限网络环境中运行 Terraform 工作负载的场景。
• 数据本地化合规：对数据处理位置有严格监管要求（如***、***行业），需将工作负载部署在自有数据中心的组织。
• 基础设施控制权：希望通过自有服务器管理 Terraform 工作负载，以增强资源调度、成本控制或安全性的用户。

使用方法和配置说明

拉取镜像

从 Docker Hub 拉取最新版本镜像：

bash
docker pull hashicorp/tfc-agent:latest

基本使用

通过 help 子命令获取详细使用信息：

bash
docker run hashicorp/tfc-agent:latest help

配置参数说明

容器运行需通过环境变量或命令行参数配置，关键参数（具体以 help 输出或***文档为准）包括：

• AGENT_TOKEN：用于认证 Terraform Cloud 的代理令牌（必填，从 Terraform Cloud 控制台获取）。
• AGENT_NAME：代理实例名称（可选，用于在 Terraform Cloud 控制台标识不同代理）。
• LOG_LEVEL：日志级别（可选，如 info、debug，默认 info）。

Docker 部署示例

1. 基本运行命令（后台模式）

bash
docker run -d \
  --name tfc-agent \
  -e AGENT_TOKEN="your-terraform-cloud-agent-token" \
  -e AGENT_NAME="my-onprem-agent" \
  --restart unless-stopped \
  hashicorp/tfc-agent:latest

2. Docker Compose 配置示例

创建 docker-compose.yml 文件：

yaml
version: '3.8'

services:
  tfc-agent:
    image: hashicorp/tfc-agent:latest
    container_name: tfc-agent
    environment:
      - AGENT_TOKEN=your-terraform-cloud-agent-token  # 替换为实际代理令牌
      - AGENT_NAME=my-onprem-agent                     # 可选，自定义代理名称
      - LOG_LEVEL=info                                 # 可选，日志级别
    restart: unless-stopped  # 容器退出时自动重启（除非手动停止）

启动服务：

bash
docker-compose up -d

参考文档

• 完整使用说明：运行容器并执行 help 子命令（docker run hashicorp/tfc-agent:latest help）。
• ***文档：Terraform Cloud Agents。