argoproj/gateway-controller

网关控制器镜像文档

镜像概述

本镜像为轻量级网关控制器Docker镜像，旨在简化网关服务的部署、配置与生命周期管理。通过集成动态路由、流量控制、安全策略等核心能力，实现对网关服务的集中化管控，适用于各类微服务架构及云原生环境。

核心功能与特性

1. 动态路由配置

• 支持基于API或配置文件的路由规则动态更新，无需重启网关服务
• 支持路径匹配、请求头匹配、权重路由等多种路由策略
• 路由规则版本控制与回滚机制

2. 流量管理

• 内置负载均衡算法（轮询、加权轮询、最少连接）
• 支持请求限流、熔断与降级策略
• 流量镜像与灰度发布能力

3. 安全策略

• 集成认证授权机制（JWT、OAuth2.0、API Key）
• 支持TLS终止与证书自动更新
• IP黑白名单与请求过滤规则

4. 健康检查与自愈

• 网关实例健康状态实时监控
• 异常实例自动隔离与恢复
• 集群扩缩容时的路由自动调整

5. 监控与可观测性

• 支持Prometheus指标暴露（请求量、延迟、错误率）
• 集成ELK/EFK日志收集能力
• 分布式追踪支持（Jaeger/Zipkin）

使用场景

• 微服务架构：作为API网关的控制平面，统一管理服务间通信
• 云原生环境：与Kubernetes等容器编排平台集成，实现动态流量调度
• 多集群管理：跨集群网关实例的统一配置与状态同步
• 开发/测试环境：快速搭建模拟网关环境，验证路由与流量策略

使用方法

快速启动

通过docker run命令快速部署网关控制器：

bash
docker run -d \
  -p 8080:8080 \  # 控制器API端口
  -p 9090:9090 \  # 监控指标端口
  -e GATEWAY_ENDPOINT=http://gateway-service:8000 \  # 目标网关服务地址
  -e ADMIN_USER=admin \  # 管理员用户名
  -e ADMIN_PASSWORD=securepass \  # 管理员密码
  -v ./routes:/app/config/routes \  # 挂载路由配置文件目录
  --name gateway-controller \
  my-gateway-controller:latest

环境变量配置

路由配置文件示例

通过挂载配置文件目录（如./routes）实现路由规则持久化，配置文件采用YAML格式：

yaml
# ./routes/service-routes.yaml
routes:
  - id: service-user
    uri: http://user-service:8081
    predicates:
      - Path=/api/users/**filters:
      - name: RequestRateLimiter
        args:
          redis-rate-limiter.replenishRate: 10
          redis-rate-limiter.burstCapacity: 20
  - id: service-order
    uri: http://order-service:8082
    predicates:
      - Path=/api/orders/**
    filters:
      - name: CircuitBreaker
        args:
          name: orderServiceCircuitBreaker
          fallbackUri: forward:/fallback/orders

Docker Compose配置示例

yaml
version: '3.8'
services:
  gateway-controller:
    image: my-gateway-controller:latest
    ports:
      - "8080:8080"
      - "9090:9090"
    environment:
      - GATEWAY_ENDPOINT=http://gateway:8000
      - ADMIN_USER=admin
      - ADMIN_PASSWORD=securepass
      - LOG_LEVEL=debug
    volumes:
      - ./routes:/app/config/routes
      - ./tls:/app/config/tls  # TLS证书目录
    depends_on:
      - gateway
      - redis  # 用于限流、熔断等状态存储

  gateway:
    image: my-gateway:latest
    ports:
      - "8000:8000"

  redis:
    image: redis:alpine
    ports:
      - "6379:6379"

注意事项

• 确保控制器与目标网关服务网络连通（建议使用Docker网络或Kubernetes Service）
• 生产环境中建议通过-v挂载配置文件与证书，避免敏感信息通过环境变量暴露
• 高可用部署时，可部署多个控制器实例并通过负载均衡器（如Nginx）实现请求分发
• 监控指标端口建议仅对内暴露，通过Prometheus等工具采集监控数据