k8spatterns/gomplate

动态模板处理Docker镜像

镜像概述和主要用途

该镜像基于静态编译的https://github.com/hairyhenderson/gomplate%E6%9E%84%E5%BB%BA%EF%BC%8C%E4%BD%BF%E7%94%A8%60scratch%60%E4%BD%9C%E4%B8%BA%E5%9F%BA%E7%A1%80%E9%95%9C%E5%83%8F%EF%BC%88%E5%9B%A0%E6%AD%A4%E4%BD%93%E7%A7%AF%E9%9D%9E%E5%B8%B8%E5%B0%8F%EF%BC%89%E3%80%82%E5%AE%83%E6%B7%BB%E5%8A%A0%E4%BA%86%E6%89%B9%E9%87%8F%E6%93%8D%E4%BD%9C%E6%94%AF%E6%8C%81%EF%BC%8C%E9%9D%9E%E5%B8%B8%E9%80%82%E5%90%88%E4%BD%9C%E4%B8%BAKubernetes pod中的init容器，用于预处理配置文件。该镜像在《Kubernetes Patterns》书中的https://github.com/k8spatterns/examples/tree/master/configuration/ConfigurationTemplate%E6%A8%A1%E5%BC%8F%E7%A4%BA%E4%BE%8B%E4%B8%AD%E4%BD%BF%E7%94%A8%E3%80%82

核心功能和特性

• 体积小巧：基于scratch基础镜像，镜像体积小
• 批量处理：支持批量模板处理操作
• Kubernetes兼容：特别适合作为Kubernetes init容器使用
• 灵活配置：通过数据源文件动态填充模板参数

使用场景和适用范围

• Kubernetes环境中作为init容器，在应用启动前预处理配置文件
• 需要根据外部数据源动态生成配置文件的场景
• 基于模板批量生成配置文件的场景

使用方法和配置说明

作为基础镜像使用

通常将该镜像作为基础镜像，将gomplate模板复制到/in目录：

Dockerfile
FROM docker.xuanyuan.run/k8spatterns/gomplate
COPY myconfig/ in/

运行时配置

运行时需挂载以下目录：

• /params：存放gomplate数据源文件的目录，通常从外部挂载（如Kubernetes ConfigMap支持的卷）
• /out：处理后的文件输出目录，需挂载为卷以便外部访问

核心参数说明

镜像的入口点为/gomplate，可通过CMD提供自定义参数。关键参数包括：

• --input-dir：模板目录，通常内置到镜像中（/in目录）
• --datasource：数据源目录，每个文件作为独立数据源，文件名作为引用键。例如，config.yml文件可在模板中通过{{ (datasource "config").someKeyFromYamlFile }}引用
• --output-dir：输出目录，生成的文件与输入文件同名（/out目录）

完整参数列表可通过以下命令查看：

bash
docker run -it docker.xuanyuan.run/k8spatterns/gomplate -h

Docker运行示例

bash
docker run -v $(pwd)/params:/params -v $(pwd)/out:/out docker.xuanyuan.run/k8spatterns/gomplate --input-dir /in --datasource /params --output-dir /out

重建镜像

重建镜像需要支持多阶段构建的Docker版本，可使用build.sh脚本进行重建。