hashicorppreview/consul-ecs

Consul on ECS 镜像文档

1. 镜像概述和主要用途

该镜像用于简化 Consul 在 Amazon ECS (Elastic Container Service) 环境中的安装与运行流程。其核心目标是提供开箱即用的工具链，辅助用户在 ECS 集群中部署、配置和管理 Consul 服务。

重要说明：本仓库中的镜像为 开发环境专用镜像（dev 标签），仅适用于开发和测试场景。生产环境部署需使用 HashiCorp 官方稳定镜像：https://hub.docker.com/r/hashicorp/consul-ecs%E3%80%82

2. 核心功能和特性

• 简化安装流程：内置 ECS 环境适配逻辑，减少手动配置步骤，快速完成 Consul 在 ECS 上的部署。
• 运行时管理支持：提供 Consul 服务注册、健康检查、配置同步等基础操作的辅助工具。
• ECS 环境集成：原生支持 ECS 任务定义、服务发现、IAM 权限对接等 ECS 特有环境需求。

3. 使用场景和适用范围

适用场景

• 开发/测试环境中，在 ECS 集群（含 EC2 启动类型和 Fargate 启动类型）上部署 Consul 服务网格。
• 验证 Consul 与 ECS 集成的功能兼容性（如服务注册、配置中心、ACL 策略等）。

适用范围

• ECS 集群版本需兼容 Consul 官方支持的环境（参考 Consul ECS 文档）。
• 仅支持 Linux 架构容器实例（AMD64/ARM64）。

4. 使用方法和配置说明

4.1 前提条件

• 本地或服务器已安装 Docker Engine（20.10+）。
• 已配置 ECS 集群访问权限（通过 AWS CLI 或 ECS 任务执行角色授予必要权限）。
• 参考官方文档获取完整环境依赖：Consul ECS 官方文档。

4.2 镜像拉取

从官方仓库拉取开发镜像（具体仓库路径需参考 Consul ECS 文档 确认）：

bash
docker pull <官方仓库路径>/consul-ecs:dev

4.3 基本使用命令（docker run）

通过 docker run 启动容器，需根据 ECS 集群配置传入必要参数。以下为基础示例：

bash
docker run -d \
  --name consul-ecs-dev \
  -e ECS_CLUSTER="my-ecs-cluster" \  # ECS 集群名称（必填）
  -e CONSUL_AGENT_MODE="client" \     # Consul 代理模式（client/server，默认 client）
  -e CONSUL_HTTP_ADDR="http://consul-server:8500" \  # Consul 服务器地址（若为 client 模式必填）
  -v /var/run/docker.sock:/var/run/docker.sock \  # 挂载 Docker 套接字（用于容器网络通信）
  <官方仓库路径>/consul-ecs:dev

4.4 docker-compose 配置示例

以下为 docker-compose.yml 示例，适用于本地开发环境模拟 ECS 场景：

yaml
version: '3.8'
services:
  consul-ecs:
    image: <官方仓库路径>/consul-ecs:dev
    container_name: consul-ecs-dev
    environment:
      - ECS_CLUSTER=local-dev-cluster  # 本地模拟 ECS 集群名称
      - CONSUL_AGENT_MODE=server       # 以 server 模式启动（开发环境单节点测试）
      - CONSUL_BOOTSTRAP_EXpect=1      # 单节点启动（仅开发用）
      - CONSUL_DATA_DIR=/consul/data   # 数据持久化路径
    volumes:
      - consul-data:/consul/data       # 挂载数据卷
    ports:
      - "8500:8500"  # Consul HTTP 端口
      - "8600:8600/udp"  # Consul DNS 端口
    restart: unless-stopped

volumes:
  consul-data:  # 持久化 Consul 数据

启动命令：

bash
docker-compose up -d

4.5 核心配置参数和环境变量

5. 注意事项

• 环境限制：开发镜像未经过生产级稳定性测试，不支持高可用性配置，请勿用于生产环境。
• 权限要求：运行容器时需确保对 ECS 集群有足够操作权限（如通过 IAM 角色绑定 AmazonECS_FullAccess 策略，开发环境仅建议）。
• 详细配置：完整参数说明、高级功能（如 ACL、TLS 加密）请参考 Consul ECS 官方文档。