signiant/ecs-cluster-scaledown

ecs-cluster-scaledown 镜像文档

镜像概述和主要用途

ecs-cluster-scaledown 是一款用于自动缩减ECS集群的工具，旨在解决单向扩容（仅允许扩容）场景下集群过度配置的问题。当ECS集群因长期运行任务（持续时间不确定，难以常规缩容）仅启用扩容时，易导致资源浪费。该工具通过自动化流程缩减集群规模，包括检查实例状态、按负载排序实例、将指定数量实例置为DRAINING状态并在满足条件时终止，从而优化资源利用率。

核心功能和特性

• 实例状态检查：自动检测集群中处于DRAINING状态的实例，并尝试移除（需满足无运行任务或仅含忽略列表任务）。
• 负载排序：获取集群中ACTIVE状态实例，按任务数量（负载）排序。
• 实例缩减：将指定数量（或指定ID）的实例置为DRAINING状态，并在条件满足时终止实例，同时调整自动扩缩组期望容量。
• 灵活控制：支持通过任务忽略列表（仅忽略列表任务运行时允许移除）、告警状态检查（仅告警激活时执行缩容）、 dryrun模式（模拟操作不实际变更）等参数控制缩容行为。
• 指定实例移除：支持直接指定实例ID移除（需已处于DRAINING状态）。

使用场景和适用范围

适用于以下场景：

• 需单向扩容（仅扩容）的ECS集群，长期运行任务难以通过常规方式缩容。
• 集群因单向扩容导致过度配置，需定期自动缩减以节省资源。
• 需要灵活控制缩容条件（如基于告警、忽略特定任务）的场景。

使用方法和配置说明

前提条件

• 已安装Docker。
• 具备AWS访问凭证：通过EC2实例IAM角色（推荐，无需显式密钥）或AWS访问密钥/密钥对。

命令行参数说明

部署示例

1. 拉取镜像

bash
docker pull docker.xuanyuan.run/signiant/ecs-cluster-scaledown

2. 基础缩容示例（dryrun模式）

模拟缩减集群test-cluster中2个实例，不实际执行变更：

bash
docker run \
  docker.xuanyuan.run/signiant/ecs-cluster-scaledown \
    --cluster-name test-cluster \
    --count 2 \
    --region us-east-1 \
    --dryrun

3. 使用AWS访问密钥缩容

通过访问密钥认证，基于告警状态缩减1个实例（默认count=1）：

bash
docker run \
  -e AWS_ACCESS_KEY_ID=your_access_key \
  -e AWS_SECRET_ACCESS_KEY=your_secret_key \
  docker.xuanyuan.run/signiant/ecs-cluster-scaledown \
    --cluster-name test-cluster \
    --region us-east-1 \
    --alarm-name "Cluster scale down alarm"

4. 指定忽略任务列表

缩减时忽略LogspoutTask任务，仅当实例无其他运行任务时移除：

bash
docker run \
  docker.xuanyuan.run/signiant/ecs-cluster-scaledown \
    --cluster-name test-cluster \
    --region us-east-1 \
    --ignore-list LogspoutTask

5. 移除指定实例ID

移除指定ID的实例（需已处于DRAINING状态）：

bash
docker run \
  docker.xuanyuan.run/signiant/ecs-cluster-scaledown \
    --cluster-name test-cluster \
    --region us-east-1 \
    --instance-ids i-0x1x2x3x4x5x6x7x8 i-0x2x3x4x5x6x7x8x9

6. 清除DRAINING状态实例（不缩容集群）

指定count=0仅清除DRAINING状态实例，不额外缩减集群：

bash
docker run \
  docker.xuanyuan.run/signiant/ecs-cluster-scaledown \
    --cluster-name test-cluster \
    --region us-east-1 \
    --ignore-list LogspoutTask \
    --count 0

注意事项

• 当前仅支持包含最多2个可用区实例的ECS集群。
• 指定--instance-ids时，实例必须已处于DRAINING状态，否则无法移除。
• 使用--alarm-name时，工具会先检查告警状态是否为“ALARM”，非ALARM状态将直接退出。