portworx/kong

PDS Kong Docker镜像文档

概述

PDS Kong是基于Kong构建的定制化API网关Docker镜像，针对PDS（产品数据服务/项目数据系统）环境优化。集成Kong核心API管理能力，提供高性能、可扩展的API路由、流量控制、认证授权及监控功能，适用于PDS微服务架构中的API统一治理。

核心功能与特性

• API路由与负载均衡：支持HTTP/HTTPS协议，基于路径、主机、Header的灵活路由规则，集成轮询、一致性哈希等负载均衡策略。
• 认证与授权：内置JWT、OAuth2.0、API密钥等认证机制，支持细粒度访问控制策略配置。
• 流量管理：提供限流（Rate Limiting）、熔断（Circuit Breaking）、请求/响应转换功能，保障API稳定性。
• 监控与日志：集成Prometheus指标暴露、日志收集能力，支持与PDS监控系统对接，便于性能分析与问题排查。
• PDS定制化配置：预配置PDS系统常用API策略模板，支持通过环境变量或配置文件快速定制部署。

使用场景与适用范围

• PDS微服务架构中的API网关层，统一管理内部服务间及外部客户端的API请求。
• 需要对PDS系统API进行认证、授权和流量控制的场景。
• 需监控PDS API调用情况、分析性能瓶颈的场景。
• 快速部署API网关以减少PDS系统集成复杂度的场景。

使用方法与配置说明

快速启动

通过以下命令启动基础PDS Kong容器（无数据库模式）：

bash
docker run -d --name pds-kong \
  -p 8000:8000 \  # HTTP代理端口
  -p 8443:8443 \  # HTTPS代理端口
  -p 8001:8001 \  # Admin API端口
  -e "KONG_DATABASE=off" \
  -e "KONG_PROXY_ACCESS_LOG=/dev/stdout" \
  -e "KONG_ADMIN_ACCESS_LOG=/dev/stdout" \
  -e "KONG_PROXY_ERROR_LOG=/dev/stderr" \
  -e "KONG_ADMIN_ERROR_LOG=/dev/stderr" \
  pds-kong:latest

环境变量配置

支持通过环境变量配置核心参数，常用变量如下：

Docker Compose示例

以下是Docker Compose部署示例（含PostgreSQL数据库支持动态配置）：

yaml
version: '3.8'

services:
  pds-kong:
    image: pds-kong:latest
    container_name: pds-kong
    ports:
      - "8000:8000"   # HTTP代理端口
      - "8443:8443"   # HTTPS代理端口
      - "8001:8001"   # Admin API端口
    environment:
      - KONG_DATABASE=postgres
      - KONG_PG_HOST=pds-postgres
      - KONG_PG_USER=pdsuser
      - KONG_PG_PASSWORD=pdspassword
      - KONG_PG_DATABASE=pds_kong
      - KONG_PDS_PLUGINS=pds-auth,pds-monitor
    depends_on:
      - pds-postgres
    restart: unless-stopped

  pds-postgres:
    image: postgres:13
    container_name: pds-postgres
    environment:
      - POSTGRES_USER=pdsuser
      - POSTGRES_PASSWORD=pdspassword
      - POSTGRES_DB=pds_kong
    volumes:
      - pds-postgres-data:/var/lib/postgresql/data
    restart: unless-stopped

volumes:
  pds-postgres-data:

注意事项

• 生产环境建议使用数据库模式（PostgreSQL/Cassandra）以支持动态配置和高可用性。
• PDS定制插件需通过KONG_PDS_PLUGINS环境变量启用，并确保插件配置文件正确挂载。
• 监控指标可通过http://<kong-ip>:8001/metrics端点获取，建议集成Prometheus和Grafana进行可视化监控。