base2/cfn-manage

cfn-manage Docker镜像文档

镜像概述

cfn-manage是Base2Services提供的Docker镜像，用于管理AWS CloudFormation堆栈及相关资源的启动和停止操作。通过该镜像，用户无需关注运行时环境配置，可直接对AWS资源执行启停管理，包括自动扩展组、RDS实例、EC2实例、CloudWatch告警等多种资源类型，并能保存和恢复资源原始配置。

核心功能与特性

堆栈遍历

支持遍历主堆栈及其所有子堆栈，实现对整个环境资源的统一管理。

环境启停功能

停止环境操作

• 将所有自动扩展组（ASG）的期望容量设置为0
• 停止RDS实例（若为多可用区实例，先转换为单可用区）
• 禁用CloudWatch告警动作
• 保存资源元数据（如ASG容量配置、RDS多可用区属性）至指定S3存储桶

启动环境操作

• 恢复自动扩展组的原始容量配置
• 启动RDS实例（若之前为多可用区，恢复多可用区配置）
• 启用CloudWatch告警动作
• 从S3存储桶读取资源元数据进行恢复

操作特性

• 幂等性：重复执行停止/启动操作不会覆盖原始配置（如停止操作不会将S3中保存的ASG配置更新为0）
• 容错性：部分配置数据丢失时，仍可基于现有数据继续操作
• 资源优先级：按资源类型预设操作顺序，支持通过标签自定义优先级

支持的资源类型

AWS::AutoScaling::AutoScalingGroup

• 停止：将期望容量设置为0
• 启动：恢复停止前的容量配置

AWS::EC2::Instance

• 停止：调用StopInstances API停止实例
• 启动：调用StartInstances API启动实例

AWS::RDS::DBInstance

• 停止：停止RDS实例（最多可停止2周；多可用区实例先转为单可用区）
• 启动：启动RDS实例（恢复多可用区配置）

AWS::DocDB::DBCluster

• 停止：停止集群（最多可停止7天，之后自动启动）
• 启动：启动集群

AWS::CloudWatch::Alarm

• 停止：禁用告警动作
• 启动：启用告警动作

AWS::EC2::SpotFleet

• 停止：将目标容量设置为0
• 启动：恢复停止前的目标容量

AWS::ECS::Cluster

• 停止：将集群中所有服务的期望容量设置为0
• 启动：恢复集群中所有服务的原始容量配置

使用方法

前提条件

• 本地需有AWS凭证文件（通常位于~/.aws/credentials）
• 已安装Docker环境

基本运行命令

bash
docker run -ti --rm -v $HOME/.aws/credentials:/root/.aws/credentials base2/cfn-manage

带环境变量的运行命令

bash
docker run -ti --rm -v $HOME/.aws/credentials:/root/.aws/credentials -e AWS_REGION=us-east-1 base2/cfn-manage

CLI命令参考

基本命令格式

cfn_manage [command] [options]

主要命令

• cfn_manage help：查看帮助信息
• cfn_manage version：查看版本信息
• cfn_manage stop-environment --stack-name [STACK_NAME]：停止环境
• cfn_manage start-environment --stack-name [STACK_NAME]：启动环境
• cfn_manage stop-asg --asg-name [ASG]：停止自动扩展组
• cfn_manage start-asg --asg-name [ASG]：启动自动扩展组
• cfn_manage stop-rds --rds-instance-id [RDS_INSTANCE_ID]：停止RDS实例
• cfn_manage start-rds --rds-instance-id [RDS_INSTANCE_ID]：启动RDS实例
• cfn_manage stop-ec2 --ec2-instance-id [EC2_INSTANCE_ID]：停止EC2实例
• cfn_manage start-ec2 --ec2-instance-id [EC2_INSTANCE_ID]：启动EC2实例

通用选项

• --source-bucket [BUCKET]：指定用于存储/读取元数据的S3存储桶
• --aws-role [ROLE_ARN]：指定执行操作时要承担的AWS角色
• -r, --region [AWS_REGION]：指定AWS区域
• -p, --profile [AWS_PROFILE]：指定AWS共享凭证配置文件
• --dry-run：仅输出操作信息，不实际执行
• --debug：显示调试日志
• --continue-on-error：遇到资源操作失败时继续执行
• --skip-wait：跳过资源状态等待（不等待资源达到启停状态）

环境变量配置

AWS资源标签配置

可通过资源标签自定义资源行为，支持的标签及配置如下：

自动扩展组（AWS::AutoScaling::AutoScalingGroup）

yaml
cfn_manage:wait_state: 'HealthyInASG'       # 等待状态：'HealthyInASG'|'Running'|'HealthyInTargetGroup'
cfn_manage:skip_wait: true                   # 是否跳过等待
cfn_manage:priority: 200                     # 操作优先级
cfn_manage:suspend_termination: true         # 是否暂停终止实例（而非默认终止）

ECS集群（AWS::ECS::Cluster）

yaml
cfn_manage:wait_state: 'Running'             # 等待状态：'Running'|'HealthyInTargetGroup'
cfn_manage:skip_wait: true                   # 是否跳过等待
cfn_manage:priority: 200                     # 操作优先级
cfn_manage:wait_container_instances: true    # 是否等待容器实例激活
cfn_manage:ignore_missing_ecs_config: true   # 是否忽略缺失的ECS配置

使用场景

• 开发/测试环境的日常启停，节省AWS资源成本
• 临时环境的快速部署与清理
• 灾备场景下的环境恢复
• 资源维护前的统一停机准备