kong/kong-gateway-dev

Kong Gateway Nightly Builds 镜像文档

1. 镜像概述和主要用途

1.1 镜像概述

Kong Gateway Nightly Builds 是 Kong Gateway 的每日构建版本，基于 Kong 官方代码仓库的最新开发分支自动构建。该镜像包含 Kong 团队当前开发中的最新功能、Bug 修复及实验性特性，旨在为开发者提供提前体验和测试未来版本功能的途径。

1.2 主要用途

• 开发环境验证：供开发者在本地或 CI/CD 流程中测试最新功能，提前适配未来版本变更。
• 问题修复验证：验证特定 Bug 修复是否解决目标问题（需对应修复提交已合并至开发分支）。
• 实验性特性评估：体验处于开发阶段的实验性特性，为 Kong 社区提供反馈。

2. 核心功能和特性

2.1 基础功能

继承 Kong Gateway 标准版本的核心能力，包括：

• API 请求路由与负载均衡
• 认证与授权（JWT、OAuth2、Basic Auth 等）
• 流量控制（限流、熔断、请求大小限制）
• 监控与日志（Prometheus 指标、日志转发至文件/HTTP 端点）
• 插件扩展（支持官方及自定义插件）

2.2 Nightly 版本特有特性

• 最新功能预览：包含 Kong 开发分支中尚未发布的新功能（如插件增强、性能优化等）。
• 实时 Bug 修复：修复已在开发分支解决但未包含在稳定版中的问题。
• 实验性特性：可能包含标记为 "experimental" 的功能，需通过配置显式启用（不保证稳定性）。

2.3 注意事项

• 稳定性风险：Nightly 版本未经完整测试，可能存在未解决的 Bug、兼容性问题或性能波动。
• 无长期支持：不提供官方技术支持，且镜像标签可能随每日构建更新，历史版本不保留。

3. 使用场景和适用范围

3.1 适用场景

• 开发环境：本地开发时验证新功能对业务的适配性。
• 测试环境：CI/CD 流程中集成，提前发现与未来版本的兼容性问题。
• 社区贡献：参与 Kong 开源项目开发，测试代码提交效果。

3.2 不适用场景

• 生产环境：禁止用于生产部署，可能导致服务中断、数据丢失或安全风险。
• 关键业务系统：对稳定性、可靠性要求高的场景需使用 Kong 官方稳定版本（如 kong:3.x）。

4. 使用方法和配置说明

4.1 前提条件

• Docker Engine 20.10+ 或 Docker Desktop 对应版本。
• 若使用数据库模式（默认），需准备 PostgreSQL 11+ 或 Cassandra 3.11+；若使用无数据库模式（dbless），需准备 JSON/YAML 格式的配置文件。

4.2 拉取镜像

Nightly 镜像托管于 Docker Hub，标签为 kong/kong:nightly：

bash
docker pull kong/kong:nightly

4.3 基本运行命令

4.3.1 无数据库模式（Dbless）

适用于快速测试，配置通过文件或 API 动态加载，无需数据库：

bash
# 1. 准备 dbless 配置文件（示例：kong.yml）
cat > kong.yml << EOF
_format_version: "3.0"
services:
  - name: example-service
    url: https://httpbin.org
    routes:
      - name: example-route
        paths: ["/"]
EOF

# 2. 启动容器（挂载配置文件，暴露代理和管理端口）
docker run -d \
  --name kong-nightly-dbless \
  -p 8000:8000 \  # 代理端口（HTTP）
  -p 8443:8443 \  # 代理端口（HTTPS）
  -p 8001:8001 \  # 管理 API 端口（HTTP）
  -p 8444:8444 \  # 管理 API 端口（HTTPS）
  -v $(pwd)/kong.yml:/etc/kong/kong.yml:ro \
  -e KONG_DATABASE=off \  # 禁用数据库
  -e KONG_DECLARATIVE_CONFIG=/etc/kong/kong.yml \  # 指定 dbless 配置文件
  -e KONG_PROXY_LISTEN=0.0.0.0:8000, 0.0.0.0:8443 ssl \  # 代理监听地址
  -e KONG_ADMIN_LISTEN=0.0.0.0:8001, 0.0.0.0:8444 ssl \  # 管理 API 监听地址
  kong/kong:nightly

4.3.2 数据库模式（PostgreSQL）

需先启动 PostgreSQL 并初始化 Kong 数据库：

bash
# 1. 启动 PostgreSQL（示例）
docker run -d \
  --name kong-nightly-db \
  -e POSTGRES_DB=kong \
  -e POSTGRES_USER=kong \
  -e POSTGRES_PASSWORD=kong \
  -p 5432:5432 \
  postgres:14-alpine

# 2. 初始化 Kong 数据库（migrations）
docker run --rm \
  --link kong-nightly-db:postgres \
  -e KONG_DATABASE=postgres \
  -e KONG_PG_HOST=postgres \
  -e KONG_PG_PORT=5432 \
  -e KONG_PG_USER=kong \
  -e KONG_PG_PASSWORD=kong \
  -e KONG_PG_DATABASE=kong \
  kong/kong:nightly kong migrations bootstrap

# 3. 启动 Kong Nightly（连接数据库）
docker run -d \
  --name kong-nightly \
  --link kong-nightly-db:postgres \
  -p 8000:8000 \
  -p 8443:8443 \
  -p 8001:8001 \
  -p 8444:8444 \
  -e KONG_DATABASE=postgres \
  -e KONG_PG_HOST=postgres \
  -e KONG_PG_PORT=5432 \
  -e KONG_PG_USER=kong \
  -e KONG_PG_PASSWORD=kong \
  -e KONG_PG_DATABASE=kong \
  -e KONG_PROXY_LISTEN=0.0.0.0:8000, 0.0.0.0:8443 ssl \
  -e KONG_ADMIN_LISTEN=0.0.0.0:8001, 0.0.0.0:8444 ssl \
  kong/kong:nightly

4.4 Docker Compose 配置示例

以下为数据库模式的 docker-compose.yml 示例，集成 Kong Nightly 和 PostgreSQL：

yaml
version: "3.8"

services:
  postgres:
    image: postgres:14-alpine
    container_name: kong-nightly-db
    environment:
      POSTGRES_DB: kong
      POSTGRES_USER: kong
      POSTGRES_PASSWORD: kong
    ports:
      - "5432:5432"
    healthcheck:
      test: ["CMD-SHELL", "pg_isready -U kong -d kong"]
      interval: 5s
      timeout: 5s
      retries: 5

  kong:
    image: kong/kong:nightly
    container_name: kong-nightly
    depends_on:
      postgres:
        condition: service_healthy
    environment:
      KONG_DATABASE: postgres
      KONG_PG_HOST: postgres
      KONG_PG_PORT: 5432
      KONG_PG_USER: kong
      KONG_PG_PASSWORD: kong
      KONG_PG_DATABASE: kong
      KONG_PROXY_LISTEN: 0.0.0.0:8000, 0.0.0.0:8443 ssl
      KONG_ADMIN_LISTEN: 0.0.0.0:8001, 0.0.0.0:8444 ssl
    ports:
      - "8000:8000"  # 代理 HTTP
      - "8443:8443"  # 代理 HTTPS
      - "8001:8001"  # 管理 API HTTP
      - "8444:8444"  # 管理 API HTTPS
    command: >
      sh -c "kong migrations bootstrap && kong start"

启动命令：

bash
docker-compose up -d

4.5 关键配置参数（环境变量）

4.6 验证部署

部署后可通过管理 API 验证 Kong 是否正常运行：

bash
# 检查 Kong 版本（nightly 版本号格式如 `3.6.0-nightly-<commit-hash>`）
curl http://localhost:8001/ | jq .version

# 测试代理路由（以 dbless 模式示例中的 "example-service" 为例）
curl http://localhost:8000/anything

5. 注意事项

1. 版本更新：Nightly 镜像每日自动构建，kong/kong:nightly 标签会覆盖旧版本，建议通过 docker pull 定期更新。
2. 数据迁移：Nightly 版本的数据库迁移脚本可能变更，重新部署时需先执行 kong migrations up（而非 bootstrap）。
3. 备份与回滚：开发/测试环境中建议定期备份配置（如 dbless 配置文件、数据库数据），出现问题时可回滚至稳定版。
4. 社区反馈：使用中发现 Bug 或功能问题，可通过 Kong GitHub 仓库（https://github.com/Kong/kong%EF%BC%89%E6%8F%90%E4%BA%A4 Issue。