dnxsolutions/ecs-deploy

docker-ecs-deploy

镜像概述和主要用途

docker-ecs-deploy是一个用于辅助通过CodeDeploy将应用部署到ECS（Elastic Container Service）的容器工具。它简化了ECS服务的部署流程，支持通过环境变量配置部署参数、处理任务定义模板，并集成CodeDeploy进行部署管理。

核心功能和特性

• 环境变量配置：支持通过环境变量设置部署相关参数
• 任务定义模板处理：支持使用模板文件定义ECS任务，并通过环境变量动态替换模板中的变量
• 部署超时控制：可配置部署超时时间，默认900秒
• 实时输出支持：支持实时重载输出状态，通过回车符实现单行显示

参数说明

以下环境变量需在系统级别设置：

使用场景和适用范围

适用于需要通过CodeDeploy部署ECS服务的场景，尤其适合集成到CI/CD流程中，实现自动化部署。需配合DNXLabs的Terraform模块使用：

• https://github.com/DNXLabs/terraform-aws-ecs
• https://github.com/DNXLabs/terraform-aws-ecs-app

使用方法和配置说明

准备文件

在应用仓库中创建以下文件：

1. docker-compose.yml

yaml
  deploy:
    image: dnxsolutions/ecs-deploy:latest
    env_file:
      - .env
    volumes:
      - ./task-definition.tpl.json:/work/task-definition.tpl.json

2. .env 文件

包含必要的环境变量：

# 必填变量
APP_NAME=<ecs服务名称>
CLUSTER_NAME=<ecs集群名称>
IMAGE_NAME=<ecr镜像ARN>
CONTAINER_PORT=80
AWS_DEFAULT_REGION=

# 应用特定变量（如任务定义中使用）
DB_HOST=
DB_USER=
DB_PASSWORD=
DB_NAME=

3. task-definition.tpl.json（示例）

ECS任务定义模板，支持通过环境变量替换变量：

json
{
  "containerDefinitions": [
    {
      "essential": true,
      "image": "${IMAGE_NAME}",
      "memoryReservation": 512,
      "name": "${APP_NAME}",
      "portMappings": [
        {
          "containerPort": ${CONTAINER_PORT}
        }
      ],
      "logConfiguration": {
        "logDriver": "awslogs",
        "options": {
          "awslogs-group": "ecs-${CLUSTER_NAME}-${APP_NAME}",
          "awslogs-region": "ap-southeast-2",
          "awslogs-stream-prefix": "web"
        }
      },
      "environment" : [
        { "name" : "DB_HOST", "value" : "${DB_HOST}" },
        { "name" : "DB_USER", "value" : "${DB_USER}" },
        { "name" : "DB_PASSWORD", "value" : "${DB_PASSWORD}" },
        { "name" : "DB_NAME", "value" : "${DB_NAME}" }
      ]
    }
  ],
  "family": "${APP_NAME}"
}

运行部署命令

bash
docker-compose run --rm deploy

注意事项

• 确保任务定义中指定的日志组已在CloudWatch Logs中存在
• CodeDeploy应用和部署组必须存在，且名称格式为$CLUSTER_NAME-$APP_NAME

旧版本说明

1.x.x

1.x.x分支对应旧版本，如需更新或修复该版本的bug，请使用此分支。创建新版本时，若修改1.x.x分支的内容，需确保发布版本在同一版本体系下。

仓库地址：https://github.com/DNXLabs/docker-ecs-deploy