ugwuanyi/aqe Docker 镜像 - 轩辕镜像

aws_quota_exporter (aqe)

访问 Git 仓库

如何使用镜像

简单运行

bash
docker run --name my-aqe -v /path/to/config.yml:/aqe/config.yml -d -p ***:*** -e CONFIG_FILE=/aqe/config.yml -e AWS_ACCESS_KEY=*** -e AWS_SECRET_KEY=secret ugwuanyi/aqe:latest

config.yml 示例

yaml
jobs:
  - serviceCode: lambda
    regions:
      - us-west-1
      - us-east-1
  - serviceCode: cloudformation
    regions:
      - us-west-1
      - us-east-1

Docker Compose 配置

yaml
version: '3.8'

services:
  aws_quota_exporter:
    image: ugwuanyi/aqe:latest
    ports:
      - ***:***
    volumes:
      - ./aws_quota_exporter/config.yml:/etc/aws_quota_exporter/config.yml
      - ${AWS_FOLDER}:/root/.aws/
    environment:
      - CONFIG_FILE=/etc/aws_quota_exporter/config.yml
      - AWS_PROFILE=${AWS_PROFILE}

镜像概述和主要用途

aws_quota_exporter (aqe) 是一款用于导出AWS服务配额指标的工具，可将AWS各服务（如Lambda、CloudFormation等）的配额数据转换为Prometheus兼容格式，便于用户通过Prometheus监控AWS资源配额使用情况，及时发现配额不足风险。

核心功能和特性

• 配额指标导出：支持将AWS各类服务的配额数据（如资源上限、已使用量等）导出至Prometheus。
• 灵活配置：通过配置文件指定需监控的AWS服务（serviceCode）和区域（regions）。
• 多环境支持：兼容AWS访问密钥直接配置或通过AWS CLI配置文件（AWS_PROFILE）授权。
• Prometheus集成：暴露HTTP端口（默认***）提供Prometheus可抓取的指标端点。

使用场景和适用范围

• AWS资源监控：适用于需要实时监控AWS服务配额使用情况的团队或个人。
• 配额预警：结合Prometheus Alertmanager，可设置配额使用率阈值告警，避免因配额不足影响业务。
• 多区域管理：支持同时监控多个AWS区域的服务配额，满足跨区域部署的监控需求。
• DevOps与云运维：融入云原生监控体系，辅助云资源规划和成本优化。

详细配置说明

必要参数

• CONFIG_FILE：配置文件路径，需通过环境变量指定，容器内配置文件需通过卷挂载。
• AWS认证：支持两种方式：
  • 通过AWS_ACCESS_KEY和AWS_SECRET_KEY环境变量直接传入访问密钥。
  • 通过挂载AWS CLI配置目录（/root/.aws/）并设置AWS_PROFILE环境变量使用配置文件认证。

配置文件（config.yml）格式

yaml
jobs:
  - serviceCode: <AWS服务代码>  # 如lambda、cloudformation、ec2等
    regions:                     # 需监控的AWS区域列表
      - <区域代码1>               # 如us-west-1、us-east-1
      - <区域代码2>
  # 可配置多个jobs监控不同服务

注：AWS服务代码可参考AWS服务配额API文档。

端口说明

默认暴露***端口，用于Prometheus抓取指标，可通过-p <主机端口>:***映射至主机。