krakend/builder

Plugin Builder Docker镜像文档

概述和主要用途

Plugin Builder是KrakenD官方提供的Docker镜像，用于构建和编译KrakenD网关的自定义插件。由于KrakenD官方容器基于Alpine镜像构建，自定义插件需在Alpine环境中编译，并匹配KrakenD使用的Go和Glibc版本。本镜像旨在简化这一过程，确保插件编译环境与目标KrakenD部署环境完全兼容。

核心功能和特性

• 环境一致性：基于Alpine镜像构建，与KrakenD官方容器的基础环境完全一致。
• 版本匹配：内置与目标KrakenD版本对应的Go编译器和Glibc库，避免版本不兼容问题。
• 架构支持：默认支持AMD64架构插件编译；可通过交叉编译支持ARM64架构（如Docker on Mac环境）。

使用场景和适用范围

适用于所有需要为KrakenD网关开发自定义插件，并通过Docker部署KrakenD的场景。尤其解决了手动配置Alpine编译环境的复杂性，确保插件在编译阶段即可兼容目标运行环境，避免因基础依赖或架构差异导致的插件加载失败。

使用方法和配置说明

1. 拉取镜像

需根据目标部署的KrakenD版本拉取对应标签的builder镜像，标签必须与KrakenD版本完全一致。

bash
docker pull krakend/builder:YOUR-KRAKEND-VERSION

示例：若部署KrakenD 2.5.0版本，需拉取 krakend/builder:2.5.0。

2. 构建自定义插件

在插件源代码所在目录执行以下命令，编译生成插件文件（.so格式）：

bash
docker run -it -v "$PWD:/app" -w /app krakend/builder:YOUR-KRAKEND-VERSION go build -buildmode=plugin -o yourplugin.so .

命令参数说明：

• -it：以交互模式运行容器，便于查看编译过程输出。
• -v "$PWD:/app"：将当前目录（插件源代码目录）挂载到容器内的/app目录。
• -w /app：设置容器工作目录为/app，确保编译路径正确。
• go build -buildmode=plugin -o yourplugin.so .：使用Go编译器以插件模式编译当前目录代码，生成名为yourplugin.so的插件文件（可自定义文件名）。

3. 插件部署

编译生成的.so文件需复制到KrakenD容器中，并按照插件注入文档的说明加载。注意：KrakenD容器的版本必须与构建插件时使用的builder镜像版本完全一致，否则可能导致插件加载失败。

4. 架构支持

• 默认架构：镜像默认编译AMD64架构的插件。
• ARM64架构：如需在ARM64环境（如Docker on Mac）加载插件，需进行交叉编译，具体方法参考KrakenD插件构建文档。

扩展说明

如需更详细的插件开发和编译指导，请参考KrakenD官方文档：构建插件。