udhos/gateboard-discovery

gateboard Docker镜像文档

镜像概述和主要用途

gateboard 是一个用于解析 AWS Private API Gateway ID 的工具。其核心功能是帮助用户识别、验证或获取 AWS Private API Gateway 的唯一标识符（ID），以便于在应用部署、服务配置或自动化流程中准确引用目标 API 网关资源。

核心功能和特性

• AWS Private API Gateway ID 解析：支持从 AWS 环境中查询并返回 Private API Gateway 的 ID。
• AWS 服务集成：与 AWS 官方 API 无缝对接，确保解析结果的准确性和实时性。
• 轻量级设计：镜像体积小，运行依赖少，可快速部署于容器化环境。
• 环境适配：支持通过环境变量或 IAM 角色配置 AWS 凭证，适配不同部署场景（如 ECS、EKS、本地容器）。

使用场景和适用范围

• 应用部署配置：在应用启动前动态获取 Private API Gateway ID，避免硬编码配置。
• 自动化运维脚本：在 CI/CD 流程中集成，验证 API 网关资源是否存在或更新。
• 服务发现辅助：作为微服务架构中的辅助工具，帮助服务实例定位目标 Private API Gateway。

使用方法和配置说明

前提条件

• 已安装 Docker 环境（Docker Engine 20.10+ 或 Docker Desktop 4.0+）。
• 具备 AWS 访问权限（需配置 AWS_ACCESS_KEY_ID 和 AWS_SECRET_ACCESS_KEY，或通过 IAM 角色绑定）。
• 目标 AWS 账户中存在 Private API Gateway 资源。

环境变量配置

gateboard 通过环境变量接收配置参数，常用参数如下：

Docker 运行命令示例

1. 使用访问密钥直接运行

bash
docker run --rm \
  -e AWS_REGION=us-east-1 \
  -e AWS_ACCESS_KEY_ID=AKIAEXAMPLE \
  -e AWS_SECRET_ACCESS_KEY=secret_example \
  -e API_GATEWAY_NAME=my-private-api \
  docker.xuanyuan.run/udhos/gateboard

2. 通过 IAM 角色运行（适用于 ECS/EKS 环境）

若容器运行在 AWS ECS、EKS 或 EC2 实例（已绑定 IAM 角色），可省略 AWS_ACCESS_KEY_ID 和 AWS_SECRET_ACCESS_KEY，直接通过 IAM 角色获取权限：

bash
docker run --rm \
  -e AWS_REGION=ap-southeast-1 \
  -e API_GATEWAY_NAME=prod-api-gateway \
  docker.xuanyuan.run/udhos/gateboard

Docker Compose 配置示例

创建 docker-compose.yml 文件，配置如下：

yaml
version: '3.8'
services:
  gateboard:
    image: docker.xuanyuan.run/udhos/gateboard
    environment:
      - AWS_REGION=us-west-2
      - AWS_ACCESS_KEY_ID=AKIAEXAMPLE
      - AWS_SECRET_ACCESS_KEY=secret_example
      - API_GATEWAY_NAME=staging-private-api
    restart: "no"  # 一次性任务，执行后退出

启动命令：

bash
docker-compose up

输出说明

容器运行后，将在标准输出（stdout）中返回解析到的 Private API Gateway ID，格式示例：

Private API Gateway ID: abc123def456ghi789jkl012mno345pqr678stu901vwx

若未找到目标 API Gateway，将输出错误信息（如 Error: Private API Gateway not found）。

注意事项

• 权限最小化：建议为 AWS 凭证或 IAM 角色仅授予 apigateway:GET 权限，遵循最小权限原则。
• 区域一致性：确保 AWS_REGION 与目标 Private API Gateway 所在区域一致，否则可能导致解析失败。
• 网络访问：若在本地运行，需确保 Docker 容器可访问 AWS API 端点（apigateway.<region>.amazonaws.com）。