hashicorp/consul-terraform-sync-enterprise

Consul-Terraform-Sync Enterprise

镜像概述和主要用途

Consul-Terraform-Sync (CTS) 是 HashiCorp 推出的企业级工具，用于扩展 Consul 功能，通过 Terraform 实现网络基础设施自动化。该工具监控 L7 网络层的变化，并利用 Terraform 动态更新基础设施配置。用户可通过定义 Terraform 模块自定义资源变更逻辑，满足团队特定的基础设施自动化需求。

核心功能和特性

• L7 网络层监控：实时追踪应用层网络变化，触发自动化响应
• Terraform 驱动的动态更新：基于监控事件，通过 Terraform 执行基础设施配置变更
• 自定义模块支持：允许通过 Terraform 模块定义资源变更规则，适配多样化场景
• Consul 原生集成：与 Consul 代理无缝协作，获取服务发现和配置数据
• 企业级可靠性：提供持续运行模式，支持生产环境的高可用性需求

使用场景和适用范围

• 企业网络自动化：适用于需要动态调整网络策略、负载均衡配置的大型网络环境
• 服务驱动的基础设施变更：响应 Consul 服务注册/注销事件，自动更新关联网络资源
• 多团队协作管理：通过标准化 Terraform 模块，实现跨团队的基础设施自动化协作
• 动态微服务网络：为基于微服务架构的应用提供实时网络配置适配能力

许可信息

镜像变体注意事项（x.y.z-ent 版本）

本 HashiCorp 企业软件仅允许与 HashiCorp 或其授权经销商签订有效许可协议的客户使用。若无有效许可，不得下载或使用本软件。所有使用行为均受许可协议条款约束，未明确授予的权利均被保留。

使用协议

除非贵组织已签署单独协议规范本软件的使用，否则以下条款适用：
本软件受许可条款或社区许可（如 Mozilla Public License 2.0 或 Business Source License，视情况而定）约束，相关许可文件位于软件下载包中，或遵循 IBM International Program License Agreement、IBM International License Agreement for Evaluation of Programs（评估用途）、IBM International License Agreement for Early Release of Programs（alpha/beta 版本）及相关许可信息（可通过 IBM 条款页面 获取）。若下载包中的许可文件与上述 IBM 许可条款冲突，以 IBM 条款为准。使用前请查阅许可条款，安装或使用软件即表示接受条款；若不接受，请勿使用。

使用方法和配置说明

运行要求

• 与 HashiCorp 或其授权经销商签订的有效许可协议
• 运行中的 Consul 代理（供 CTS 连接）
• CTS 配置文件（需提前准备）

以守护进程模式运行 CTS

通过以下命令启动 Consul-Terraform-Sync 实例：

bash
$ docker run --name cts -d --rm \
  -v $(pwd):/consul-terraform-sync/config \
  -e CONSUL_LICENSE \
  hashicorp/consul-terraform-sync-enterprise

必需配置

配置文件挂载：
通过 -v 标志将主机目录挂载至容器内预期的配置文件路径 /consul-terraform-sync/config。示例中使用当前工作目录（$(pwd)），若配置文件位于其他位置，需替换为绝对路径。

许可证配置

CTS 企业版需通过以下方式之一加载有效许可证：

环境变量方式：
将许可证内容通过环境变量 CONSUL_LICENSE 传递：

bash
$ export CONSUL_LICENSE=<your-license-key>
$ docker run --name cts -d --rm \
  -v $(pwd):/consul-terraform-sync/config \
  -e CONSUL_LICENSE \
  hashicorp/consul-terraform-sync-enterprise

文件挂载方式：
将许可证文件挂载至容器，并通过环境变量 CONSUL_LICENSE_PATH 或配置文件中的 license_path 指定路径。示例：

bash
# 主机当前目录包含配置文件(config.hcl)和许可证文件(license.hclic)
$ ls $(pwd)
config.hcl    license.hclic

$ docker run --name cts -d --rm \
  -v $(pwd):/consul-terraform-sync/config \
  -e CONSUL_LICENSE_PATH=config/license.hclic \
  hashicorp/consul-terraform-sync-enterprise

Terraform 状态文件

CTS 任务快照依赖 Terraform 状态文件，其存储位置由网络驱动和 Terraform 后端配置 决定（如 Consul KV、Terraform Cloud）。生产环境禁止使用本地后端，否则容器停止后状态文件将丢失，导致任务状态无法恢复。

执行 Consul-Terraform-Sync CLI

通过 docker exec 命令在运行中的容器内执行 CTS 命令行操作。示例：启用名为 task_a 的任务：

bash
$ docker exec -t cts consul-terraform-sync task enable task_a
==> 检查启用 'task_a' 后的资源变更...

    生成 Consul Terraform Sync 将通过 Terraform 执行的计划

无变更。基础设施与配置一致。

Terraform 已将实际基础设施与配置进行比较，未发现差异，无需执行变更。

==> 'task_a' 启用完成!

环境变量

该镜像支持 CTS 配置文档 中定义的所有环境变量，可通过 -e 标志传递。示例：指定 Consul 地址：

bash
$ docker run --name cts -d --rm \
  -v $(pwd):/consul-terraform-sync/config \
  -e "CONSUL_HTTP_ADDR=consul.example.com:8500" \
  hashicorp/consul-terraform-sync-enterprise

参考链接

• 官方文档：consul.io/docs/nia
• 代码仓库：https://github.com/hashicorp/consul-terraform-sync
• 社区论坛：discuss.hashicorp.com