hashicorp/consul-ecs

Consul on ECS 镜像文档

1. 镜像概述

本镜像由HashiCorp提供，用于简化在Amazon ECS（Elastic Container Service）环境中安装和运行Consul的流程。Consul是一款开源的服务网格解决方案，提供服务发现、配置管理和分布式一致性等核心能力。该镜像针对ECS环境进行了优化，可直接集成ECS任务定义与集群管理，降低Consul在容器编排平台上的部署复杂度。

更多详细信息请参考官方文档：[***]

2. 核心功能与特性

2.1 核心功能

• 服务发现：自动发现ECS集群中的服务实例，支持健康检查与动态更新
• 配置管理：集中存储和分发服务配置，支持动态配置更新
• 服务网格集成：与Consul Connect集成，提供服务间加密通信与流量控制
• 分布式一致性：基于Raft协议实现集群数据一致性，确保配置与服务信息可靠同步

2.2 ECS环境优化特性

• 原生支持ECS任务定义集成，无需额外编写服务注册脚本
• 自动关联ECS集群元数据（如集群名称、任务ARN、容器网络信息）
• 简化Consul agent部署流程，支持以sidecar容器模式运行
• 兼容ECS Fargate与EC2启动类型

3. 使用场景与适用范围

3.1 典型使用场景

• 微服务架构下的服务发现：在ECS集群中部署的微服务通过Consul实现跨服务通信与实例发现
• 分布式配置中心：集中管理ECS任务的动态配置，避免硬编码配置文件
• 服务网格构建：通过Consul Connect实现ECS服务间的流量加密、熔断与重试
• 跨集群服务治理：管理多ECS集群间的服务注册与通信策略

3.2 适用范围

• 环境：Amazon ECS（支持Fargate/EC2启动类型）
• 用户：ECS集群管理员、微服务架构设计者、DevOps工程师
• 前置条件：已部署ECS集群，具备AWS IAM权限（用于Consul与ECS API交互）

4. 使用方法与配置说明

4.1 基础部署（docker run）

通过docker run命令直接启动Consul on ECS镜像（需替换<占位符>为实际配置）：

bash
docker run -d \
  --name consul-ecs-agent \
  -e CONSUL_ECS_CLUSTER=<your-ecs-cluster-name> \
  -e CONSUL_ECS_REGION=<aws-region> \
  -e CONSUL_ECS_SERVICE_NAME=<your-service-name> \
  -e CONSUL_HTTP_ADDR=<consul-server-addr> \
  -v /var/run/docker.sock:/var/run/docker.sock \
  hashicorp/consul-ecs:latest

参数说明：

• -v /var/run/docker.sock:/var/run/docker.sock：挂载Docker套接字，用于监听ECS任务生命周期事件
• 环境变量详见4.3节

4.2 ECS任务定义集成（推荐）

在ECS任务定义中以sidecar容器模式部署（示例片段）：

json
{
  "containerDefinitions": [
    {
      "name": "consul-ecs-agent",
      "image": "hashicorp/consul-ecs:latest",
      "essential": true,
      "environment": [
        { "name": "CONSUL_ECS_CLUSTER", "value": "my-ecs-cluster" },
        { "name": "CONSUL_ECS_REGION", "value": "us-west-2" },
        { "name": "CONSUL_HTTP_ADDR", "value": "consul-server:8500" },
        { "name": "CONSUL_ECS_LOG_LEVEL", "value": "info" }
      ],
      "mountPoints": [
        {
          "sourceVolume": "docker-sock",
          "containerPath": "/var/run/docker.sock",
          "readOnly": true
        }
      ]
    },
    {
      "name": "your-application",
      "image": "your-app-image:latest",
      // 应用容器配置...
    }
  ],
  "volumes": [
    {
      "name": "docker-sock",
      "host": { "sourcePath": "/var/run/docker.sock" }
    }
  ]
}

4.3 环境变量配置

4.4 配置参数说明

通过挂载Consul配置文件（如consul-ecs.hcl）自定义高级配置，示例：

hcl
// 服务注册配置
service_registration {
  enabled = true
  port_label = "http"  // 从ECS任务端口标签中提取服务端口
  health_check {
    type = "http"
    path = "/health"
    interval = "10s"
  }
}

// Consul Connect配置（服务网格）
connect {
  enabled = true
  proxy {
    sidecar_service {
      port = 20000  // 代理监听端口
    }
  }
}

挂载方式：在docker run或ECS任务定义中添加 -v /path/to/consul-ecs.hcl:/etc/consul-ecs/consul-ecs.hcl

5. 注意事项

• 确保ECS任务执行角色具备以下权限：ecs:DescribeTasks、ecs:ListTasks（用于服务发现）
• Consul服务器需提前部署（可部署在ECS或独立集群中），并确保网络互通（默认端口：8500/http，8301/serf-lan）
• 生产环境建议通过AWS Secrets Manager管理Consul ACL令牌，避免明文传递敏感信息

详细配置与最佳实践请参考官方文档：[***]