supergateway ***Docker镜像文档

1. 镜像概述

本镜像为supercorp-ai开源项目supergateway的***Docker封装，用于简化高性能API网关的部署与运行流程。supergateway是一款轻量级企业级API网关，具备请求路由、流量控制、安全防护等核心能力，广泛适用于微服务架构及API管理场景。***镜像由项目团队维护，确保与上游代码版本同步，并提供标准化的容器化配置方案。

2. 核心功能与特性

• 智能请求路由：支持基于路径、域名、请求头的多维度路由策略，灵活匹配后端服务
• 动态负载均衡：内置轮询、加权轮询、IP哈希等算法，优化服务资源利用率
• API安全防护：集成JWT/OAuth2.0认证、API密钥管理及请求签名验证机制
• 流量控制能力：支持限流、熔断、降级等流量治理功能，保障系统稳定性
• 可观测性集成：原生支持Prometheus指标暴露与ELK日志收集，便于监控分析
• 高可用部署：支持集群模式部署，通过健康检查与自动恢复实现服务高可用
• 配置灵活性：提供环境变量注入、配置文件挂载及动态配置更新三种配置方式

3. 使用场景与适用范围

• 企业级API管理平台：统一管理内外部API接口，实现访问控制与版本管理
• 微服务流量入口：作为微服务架构的统一流量入口，处理跨服务通信与协议转换
• 多环境一致性部署：在开发、测试、生产环境中提供一致的网关运行环境
• API安全网关：对外部API请求进行认证、授权与合规性检查，保护后端服务
• 混合云架构桥接：实现多云环境或混合架构中不同服务集群的请求转发

4. 使用方法与配置说明

4.1 基本部署命令

通过docker run快速启动基础网关服务：

bash
docker run -d -p 8080:8080 --name supergateway supercorp-ai/supergateway:latest

说明：默认暴露8080端口作为网关服务端口，首次启动将使用内置默认配置

4.2 环境变量配置

通过环境变量自定义基础配置，常用参数如下：

示例：自定义端口与日志级别

bash
docker run -d -p 9000:9000 \
  -e GATEWAY_PORT=9000 \
  -e LOG_LEVEL=DEBUG \
  -e ADMIN_PASSWORD=SecurePass2024! \
  --name supergateway supercorp-ai/supergateway:latest

4.3 配置文件挂载

复杂场景建议通过挂载配置文件实现精细化配置，配置文件采用YAML格式：

1. 创建本地配置文件（示例config.yaml）：

yaml
server:
  port: 8080
  readTimeout: 30s
  writeTimeout: 30s

routes:
  - id: "user-service"
    uri: "[***]"
    predicates:
      - Path=/api/users/**filters:
      - name: "RateLimiter"
        args:
          redisAddress: "redis:6379"
          limit: 100
          period: 60

monitor:
  prometheus:
    enabled: true
    path: "/metrics"

2. 挂载配置文件启动容器：

bash
docker run -d -p 8080:8080 \
  -v $(pwd)/config.yaml:/etc/supergateway/config.yaml \
  --name supergateway supercorp-ai/supergateway:latest

4.4 Docker Compose集成示例

在微服务架构中，可通过docker-compose.yml实现网关与依赖服务的协同部署：

yaml
version: '3.8'

services:
  supergateway:
    image: supercorp-ai/supergateway:latest
    container_name: supergateway
    ports:
      - "8080:8080"
      - "9090:9090"  # 管理界面端口
    environment:
      - LOG_LEVEL=INFO
      - ADMIN_PASSWORD=SuperSecret!2024
      - REDIS_HOST=redis
    volumes:
      - ./config.yaml:/etc/supergateway/config.yaml
      - gateway-logs:/var/log/supergateway
    depends_on:
      - redis
      - user-service
    restart: unless-stopped

  redis:
    image: redis:7-alpine
    volumes:
      - redis-data:/data

  user-service:
    image: your-registry/user-service:latest
    environment:
      - SPRING_PROFILES_ACTIVE=prod

volumes:
  gateway-logs:
  redis-data:

4.5 常用运维命令

• 查看实时日志：

  bash
  docker logs -f --tail 100 supergateway
  

• 进入容器调试：

  bash
  docker exec -it supergateway /bin/sh
  

• 配置热更新（修改挂载配置文件后执行）：

  bash
  docker kill -s SIGHUP supergateway
  

• 版本升级：

  bash
  docker pull supercorp-ai/supergateway:latest && docker restart supergateway
  

5. 注意事项

• 安全加固：生产环境必须修改默认管理员密码，并限制管理界面访问IP
• 资源配置：根据流量规模调整容器资源限制（推荐配置：至少2核CPU/4GB内存）
• 持久化存储：日志与配置文件建议使用外部挂载卷，避免容器重建导致数据丢失
• 版本管理：生产环境建议使用具体版本标签（如:v1.2.3）而非:latest
• 备份策略：定期备份关键配置文件，避免配置丢失影响服务恢复

6. ***资源

• 项目仓库：[***]
• 完整配置文档：[***]
• Docker Hub镜像页：[***]
• 问题反馈：[***]