uqlibrary/docker-ecs-deployment

uqlibrary/docker-ecs-deployment镜像说明

镜像概述

本镜像包含ecs-deployment脚本，用于在Amazon ECS中自动化部署新任务定义到服务。它通过读取SQS消息队列中的任务定义JSON和目标服务名称，实现ECS服务的蓝绿部署，可作为ECS任务响应SQS消息触发部署流程。

核心功能

• 从指定SQS队列接收消息，提取新任务定义和目标服务名称
• 注册新的ECS任务定义
• 更新ECS服务以使用新任务定义
• 支持通过Slack发送部署状态通知
• 实现蓝绿部署策略，确保服务平滑更新

使用场景

• 自动化更新ECS生产环境中的服务
• 代码提交触发部署时，通过SQS消息启动该镜像任务执行部署
• 需要低 downtime 部署策略的ECS服务更新场景

配置说明

1. AWS凭证挂载

需将包含AWS CLI配置的.aws目录挂载到容器的/root/.aws路径，确保容器拥有操作ECS和SQS的权限。

2. 环境变量配置

• 必填变量：SQS_URL（SQS队列的完整URL）
• 可选变量：
  • ECS_CLUSTER：目标ECS集群名称（默认值："default"）
  • ECS_TIMEOUT：部署超时时间（默认值：300秒）
  • SLACK_WEBHOOK：Slack通知Webhook URL（需配合SLACK_CHANNEL使用）
  • SLACK_CHANNEL：Slack通知频道（需配合SLACK_WEBHOOK使用）
  • SLACK_BOTNAME：Slack通知机器人名称（默认值："ecs-deployment"）
  • SLACK_COLOR：Slack消息颜色（默认值："#335EFF"）

3. SQS消息要求

• 消息体：完整的ECS任务定义JSON（SQS会自动转义JSON payload）
• 消息属性：
  • service：目标ECS服务名称（值为"false"时仅注册任务定义，不更新服务）
  • commit_url（可选）：触发部署的GitHub提交URL

部署示例

Docker Run命令

bash
docker run \
  -v /local/path/to/.aws:/root/.aws \
  -e SQS_URL=https://sqs.us-east-1.amazonaws.com/123456789012/my-queue \
  -e ECS_CLUSTER=my-production-cluster \
  uqlibrary/docker-ecs-deployment

SQS消息发送示例（AWS CLI）

bash
aws sqs send-message \
  --queue-url "[***]" \
  --message-body '{"family":"my-service","containerDefinitions":[{"name":"my-container","image":"my-image:latest","portMappings":[{"containerPort":80}]}]}' \
  --message-attributes '{"service":{"DataType":"String","StringValue":"my-service"},"commit_url":{"DataType":"String","StringValue":"https://github.com/my-repo/commit/abc123"}}'