jantman/awslimitchecker

awslimitchecker

镜像概述和主要用途

awslimitchecker是一个用于检查AWS服务限制和资源使用情况的工具，提供命令行脚本和可重用的Python模块。它能够查询当前AWS资源使用量，并与服务限制（包括AWS默认限制、API获取的限制、Service Quotas数据或Trusted Advisor数据）进行比较，在使用量接近或达到限制时发出警告。对于在AWS中构建可扩展服务的用户，该工具可有效避免因资源限制在部署或自动扩展过程中出现故障。

核心功能和特性

• 资源使用检查：对比当前AWS资源使用量与服务限制
• 使用量展示：显示和检查当前资源使用情况
• 限制覆盖：支持覆盖默认服务限制（适用于已提升限制的账户）
• 阈值告警：可定义自定义阈值，当使用量超过阈值时返回信息，CLI模式下非0退出
• 多源限制获取：从Trusted Advisor API、各服务API及Service Quotas服务获取当前限制（如可用）
• 区域支持：可显式指定AWS区域
• 跨账户访问：支持通过STS（Security Token Service）扮演其他账户角色，包括使用external_id
• Trusted Advisor集成：可选刷新Trusted Advisor"服务限制"检查并等待完成（可设置超时）
• 指标导出：可将使用量和限制指标发送至Datadog等指标存储
• 告警通知：可将警告/严重告警发送至PagerDuty等通知服务

使用场景和适用范围

• DevOps团队：在部署前检查资源限制，避免因配额不足导致部署失败
• 云架构师：监控资源使用趋势，规划容量扩展
• 系统管理员：实时跟踪多账户、多区域AWS资源限制状态
• 自动扩展环境：防止自动扩展因资源限制而失败
• AWS服务管理：集中监控数百项服务限制，弥补Trusted Advisor和Service Quotas的不足

使用方法和配置说明

前提条件

运行该工具需满足以下条件之一：

• Docker环境（推荐使用官方Docker镜像）
• Python 3.5+及依赖：boto3 >= 1.4.6、botocore >= 1.6.0

Docker部署示例

基本运行命令

bash
docker run --rm \
  -e AWS_ACCESS_KEY_ID=your_access_key \
  -e AWS_SECRET_ACCESS_KEY=your_secret_key \
  -e AWS_REGION=us-east-1 \
  jantman/awslimitchecker:latest

检查特定服务（如EC2）

bash
docker run --rm \
  -e AWS_ACCESS_KEY_ID=your_access_key \
  -e AWS_SECRET_ACCESS_KEY=your_secret_key \
  -e AWS_REGION=us-east-1 \
  jantman/awslimitchecker:latest --services ec2

设置自定义阈值（警告80%，严重90%）

bash
docker run --rm \
  -e AWS_ACCESS_KEY_ID=your_access_key \
  -e AWS_SECRET_ACCESS_KEY=your_secret_key \
  -e AWS_REGION=us-east-1 \
  jantman/awslimitchecker:latest --warning 80 --critical 90

docker-compose配置示例

yaml
version: '3'
services:
  awslimitchecker:
    image: jantman/awslimitchecker:latest
    environment:
      - AWS_ACCESS_KEY_ID=your_access_key
      - AWS_SECRET_ACCESS_KEY=your_secret_key
      - AWS_REGION=us-east-1
    command: --warning 80 --critical 90 --services ec2 s3

凭证配置

AWS凭证可通过以下方式提供：

1. 环境变量：

   • AWS_ACCESS_KEY_ID：AWS访问密钥ID
   • AWS_SECRET_ACCESS_KEY：AWS密钥
   • AWS_REGION：AWS区域（如us-east-1）

2. AWS配置文件： 挂载本地AWS配置文件到容器：

   bash
   docker run --rm \
     -v ~/.aws:/root/.aws \
     -e AWS_REGION=us-east-1 \
     jantman/awslimitchecker:latest
   

3. IAM角色： 若容器运行在EC2实例上，可通过实例IAM角色自动获取凭证，无需显式配置

自定义限制和阈值

覆盖默认限制

创建限制覆盖文件（如limits_override.json）：

json
{
  "ec2": {
    "Running On-Demand EC2 instances": 50
  }
}

通过Docker挂载并使用：

bash
docker run --rm \
  -v $(pwd)/limits_override.json:/app/limits_override.json \
  -e AWS_ACCESS_KEY_ID=your_access_key \
  -e AWS_SECRET_ACCESS_KEY=your_secret_key \
  -e AWS_REGION=us-east-1 \
  jantman/awslimitchecker:latest --limit-file /app/limits_override.json

自定义阈值

通过命令行参数设置全局阈值：

• --warning：警告阈值百分比（默认75）
• --critical：严重阈值百分比（默认90）

也可在限制覆盖文件中为特定限制设置阈值：

json
{
  "ec2": {
    "Running On-Demand EC2 instances": {
      "limit": 50,
      "warning": 80,
      "critical": 90
    }
  }
}

参考链接

• 完整文档：[***]
• 项目源码：https://github.com/jantman/awslimitchecker
• Gitter交流：[***]