kong/kong-build-tools

Kong构建工具

概述

Kong构建工具是一套用于开发、打包和发布Kong的Docker工具集，提供了从Kong源码开发到最终发行版发布的完整工作流支持。

核心功能和特性

• 快速搭建Kong开发环境，支持源码挂载和实时日志查看
• 提供Kong插件开发模板和集成方案
• 支持多平台（Ubuntu/CentOS/RHEL等）Kong发行版构建（DEB/RPM/APK包）
• 支持将构建的Kong资产打包为Docker容器
• 集成测试框架，支持功能测试和验证
• 提供发行版发布至Bintray的自动化流程

使用场景和适用范围

• Kong核心开发人员：本地开发和调试Kong源码
• 插件开发者：基于模板开发自定义Kong插件
• 运维人员：构建定制化Kong发行版（修改名称、版本、基础镜像等）
• DevOps工程师：将Kong打包为容器镜像用于部署
• 测试人员：执行Kong功能测试和验证

前提条件

使用前需确保环境已安装以下依赖：

• Kong源码（需克隆Kong仓库）
• Docker
• Make
• 测试功能额外依赖：Minikube、Helm（Linux环境可通过make setup_tests自动安装）

使用方法和配置说明

开发Kong

该工具需与Kong源码仓库配合使用（默认假定为同级目录），步骤如下：

bash
cd ~
git clone git@github.com:Kong/kong.git  # 克隆Kong源码
git clone git@github.com:Kong/kong-build-tools.git  # 克隆构建工具
cd kong-build-tools
make development  # 启动开发环境

开发环境中，Kong源码挂载于/src目录，所有日志输出至/src/servroot/*。

开发Kong插件

构建工具包含kong-plugin子模块，可作为插件开发模板使用：

1. 直接基于模板开发插件
2. 克隆自定义插件源码至该目录
3. 修改docker-compose.yml中的KONG_PLUGINS配置启用插件

构建Kong发行版

默认构建Ubuntu Xenial平台的Kong deb包（假定Kong源码位于同级目录），步骤如下：

bash
cd ~
git clone git@github.com:Kong/kong.git
git clone git@github.com:Kong/kong-build-tools.git
cd kong-build-tools
make package-kong  # 执行打包
ls output/  # 查看输出
kong-0.0.0.xenial.all.deb  # 生成的包文件

环境变量配置

所有可用环境变量可在https://github.com/Kong/kong-build-tools/blob/master/Makefile%E9%A1%B6%E9%83%A8%E6%9F%A5%E7%9C%8B%EF%BC%8C%E5%B8%B8%E7%94%A8%E5%8F%98%E9%87%8F%E5%A6%82%E4%B8%8B%EF%BC%9A

bash
KONG_SOURCE_LOCATION=/src/projects/custom-kong-location  # 自定义Kong源码路径
KONG_PACKAGE_NAME=custom-kong-name  # 自定义包名称
KONG_VERSION=v1.0.0  # 自定义版本号
RESTY_IMAGE_BASE=ubuntu|centos|rhel|debian|alpine|amazonlinux  # 基础镜像系统
RESTY_IMAGE_TAG=trusty|xenial|bionic|6|7|jessie|stretch|latest  # 基础镜像标签
PACKAGE_TYPE=deb|rpm|apk  # 包类型

RedHat平台额外需导出：

bash
export REDHAT_USERNAME=rhuser  # RedHat账户
export REDHAT_PASSWORD=password  # RedHat密码

构建容器

可将构建的Kong资产打包为Docker镜像，步骤如下：

bash
export KONG_TEST_CONTAINER_NAME=kong:testing  # 自定义镜像名称:标签
make build_test_container  # 构建容器

测试

执行测试需确保已安装Docker、Minikube和Helm（Linux环境可通过make setup_tests自动安装）：

bash
make test  # 执行测试

功能测试

Kong功能测试基于https://taverntesting.github.io/%E6%A1%86%E6%9E%B6%EF%BC%8C%E9%9C%80%E6%BB%A1%E8%B6%B3%E5%89%8D%E6%8F%90%E6%9D%A1%E4%BB%B6%EF%BC%9A

• Docker
• 已构建的Kong发行版（make package-kong）
• K8s和Helm（make setup-tests）

执行功能测试：

bash
make test

功能测试可通过环境变量自定义配置，默认值如下：

bash
TEST_ADMIN_PROTOCOL?=http://          # Admin API协议
TEST_ADMIN_PORT?=8001                 # Admin API端口
TEST_HOST?=localhost                  # 测试主机
TEST_ADMIN_URI?=$(TEST_ADMIN_PROTOCOL)$(TEST_HOST):$(TEST_ADMIN_PORT)  # Admin API地址
TEST_PROXY_PROTOCOL?=http://         # 代理协议
TEST_PROXY_PORT?=8000                 # 代理端口
TEST_PROXY_URI?=$(TEST_PROXY_PROTOCOL)$(TEST_HOST):$(TEST_PROXY_PORT)  # 代理地址

开发功能测试

在满足功能测试前提条件的基础上，开发测试用例：

bash
make test  # 执行现有测试
make develop_tests  # 启动测试开发环境
py.test test_your_test.tavern.yaml  # 运行自定义测试用例（可能会有HTTPS和结构相关警告）

发布Kong发行版

发布功能需基于已构建的发行版包（位于output目录），步骤如下：

bash
export BINTRAY_USR=user  # Bintray用户名
export BINTRAY_KEY=key   # Bintray密钥
export RESTY_IMAGE_BASE=ubuntu  # 基础镜像系统（参考构建发行版）
export RESTY_IMAGE_TAG=xenial   # 基础镜像标签（参考构建发行版）
export KONG_PACKAGE_NAME=kong   # 包名称
export KONG_VERSION=v1.2.3      # 版本号
make release-kong  # 执行发布

发布环境变量说明

必填变量：

• BINTRAY_USR: Bintray用户名
• BINTRAY_KEY: Bintray密钥

可选变量（有默认值）：

• RESTY_IMAGE_BASE: 基础镜像系统（默认ubuntu）
• RESTY_IMAGE_TAG: 基础镜像标签（默认xenial）
• KONG_PACKAGE_NAME: 包名称（默认kong）
• KONG_VERSION: 版本号（默认从源码获取）

仓库相关变量（未指定时按以下规则默认）：

发布路径格式：bintray.com/kong/${REPOSITORY_NAME}/${REPOSITORY_OS_NAME}/${KONG_VERSION}/${KONG_PACKAGE_NAME}-${KONG_VERSION}.${OUTPUT_FILE_SUFFIX}

默认发布路径示例：bintray.com/kong/kong-deb/ubuntu/0.0.0/kong-0.0.0.xenial.all.deb