kong/kong-dev

Kong OSS 开发版、夜间构建版与 PR 镜像文档

1. 镜像概述

Kong OSS（Open Source Software）开发版、夜间构建版与 PR 镜像均为 Kong 开源 API 网关的特殊构建版本，旨在支持开发者与集成测试场景。三者基于 Kong OSS 核心架构（Nginx 驱动的高性能 API 网关），但定位与更新机制不同：

• 开发版（Development Images）：基于 Kong OSS 最新开发分支（如 next 或 main）构建，包含未正式发布的新功能与改进，供开发者提前体验与测试。
• 夜间构建版（Nightly Images）：每日从主分支（main）自动构建，集成最新代码提交与 bug 修复，用于持续验证主分支稳定性。
• PR 镜像（PR Images）：针对 Kong OSS 代码仓库的每个 Pull Request（PR）构建，用于验证特定 PR 的功能正确性与兼容性。

2. 核心功能与特性

2.1 基础功能（所有版本共享）

• 兼容 Kong OSS 核心能力：API 路由、负载均衡、流量控制、认证鉴权（JWT、OAuth2 等）、监控与日志。
• 支持插件扩展：可加载 Kong 官方插件（如 rate-limiting、cors）及自定义插件。
• 轻量级架构：基于 Nginx，高性能、低延迟，支持水平扩展。
• 多数据库支持：兼容 PostgreSQL、Cassandra 作为配置存储后端。

2.2 版本特有特性

3. 使用场景与适用范围

注意：所有版本均为非生产环境设计，稳定性与兼容性未经过正式发布流程验证，请勿用于生产部署。

4. 使用方法与配置说明

4.1 获取镜像

开发版

bash
# 拉取最新开发版（默认基于 main 分支）
docker pull kong/kong:dev
# 拉取指定开发分支（如 feature/new-plugin）
docker pull kong/kong:dev-feature-new-plugin

夜间构建版

bash
# 拉取最新夜间构建版（每日更新）
docker pull kong/kong:nightly

PR 镜像

bash
# 拉取指定 PR 的镜像（PR 编号为 1234）
docker pull kong/kong:pr-1234

4.2 基本运行命令（Docker Run）

开发版（独立模式，无数据库）

bash
docker run -d \
  --name kong-dev \
  -p 8000:8000  # 代理端口（HTTP） \
  -p 8443:8443  # 代理端口（HTTPS） \
  -p 8001:8001  # Admin API 端口 \
  -e KONG_DATABASE=off \  # 独立模式（无需数据库）
  -e KONG_PROXY_LISTEN=0.0.0.0:8000,0.0.0.0:8443 ssl \
  -e KONG_ADMIN_LISTEN=0.0.0.0:8001 \
  kong/kong:dev

夜间构建版（连接 PostgreSQL 数据库）

bash
# 1. 启动 PostgreSQL（需提前创建数据库 `kong`）
docker run -d \
  --name kong-db \
  -e POSTGRES_DB=kong \
  -e POSTGRES_USER=kong \
  -e POSTGRES_PASSWORD=kong \
  -p 5432:5432 \
  postgres:14-alpine

# 2. 启动夜间版 Kong，连接数据库
docker run -d \
  --name kong-nightly \
  --link kong-db:db \  # 关联数据库容器
  -p 8000:8000 \
  -p 8443:8443 \
  -p 8001:8001 \
  -e KONG_DATABASE=postgres \
  -e KONG_PG_HOST=db \
  -e KONG_PG_USER=kong \
  -e KONG_PG_PASSWORD=kong \
  -e KONG_PG_DATABASE=kong \
  kong/kong:nightly kong migrations bootstrap  # 初始化数据库迁移

4.3 核心环境变量配置

4.4 Docker Compose 配置示例（夜间构建版 + PostgreSQL）

yaml
version: '3.8'

services:
  kong-db:
    image: postgres:14-alpine
    container_name: kong-nightly-db
    environment:
      POSTGRES_DB: kong
      POSTGRES_USER: kong
      POSTGRES_PASSWORD: kong
    volumes:
      - kong-db-data:/var/lib/postgresql/data  # 持久化数据库数据
    ports:
      - "5432:5432"
    healthcheck:
      test: ["CMD-SHELL", "pg_isready -U kong"]
      interval: 5s
      timeout: 5s
      retries: 5

  kong:
    image: kong/kong:nightly
    container_name: kong-nightly
    depends_on:
      kong-db:
        condition: service_healthy
    environment:
      KONG_DATABASE: postgres
      KONG_PG_HOST: kong-db
      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
      KONG_LOG_LEVEL: debug  # 夜间版建议开启 debug 日志便于问题排查
    ports:
      - "8000:8000"   # 代理 HTTP
      - "8443:8443"   # 代理 HTTPS
      - "8001:8001"   # Admin API
    command: kong migrations bootstrap && kong start  # 初始化迁移并启动

volumes:
  kong-db-data:  # 持久化卷定义

5. 注意事项

1. 稳定性风险：开发版、夜间版与 PR 镜像可能包含未测试的功能或 bug，请勿用于生产环境。
2. API 兼容性：开发版与夜间版的 Admin API 或插件接口可能随代码迭代变化，需关注 Kong 官方开发文档的变更说明。
3. PR 镜像生命周期：PR 镜像仅在对应 PR 存在期间保留，合并或关闭后可能被清理，建议仅临时使用。
4. 资源需求：开发环境建议分配至少 2GB 内存，避免因资源不足导致启动失败或性能问题。
5. 数据清理：测试完成后，通过 docker rm -f <容器名> 及 docker volume rm <卷名> 清理临时容器与数据，避免残留影响。