pegasystems/detemplatize

detemplatize镜像发布工具镜像

镜像概述

本镜像为发布detemplatize类型镜像的必要工具，旨在标准化和自动化detemplatize镜像的发布流程。通过提供模板解析、配置注入及发布前预处理能力，简化从模板文件到可发布镜像的转换过程，适用于需要动态处理模板内容以生成目标镜像的场景。

核心功能与特性

核心功能

• 模板文件处理：支持解析各类模板文件（如Dockerfile模板、配置模板等），提取或替换动态内容
• 配置参数注入：支持通过环境变量或配置文件向模板注入动态参数，实现配置与模板分离
• 发布前预处理：提供发布前的镜像元数据校验、文件格式转换等预处理能力
• 发布流程集成：可与主流镜像仓库（如Docker Hub、私有Registry）的发布流程集成，支持推送前的必要检查

特性

• 轻量级设计，最小化镜像体积，减少发布流程资源占用
• 支持多类型模板引擎（如Go template、Jinja2等），适配不同模板语法
• 提供灵活的配置方式，支持环境变量、命令行参数及配置文件多种参数传递方式
• 内置错误处理机制，确保模板处理及发布过程中的异常可追溯

使用场景

• 开发团队发布detemplatize镜像：开发人员在构建需要动态配置或内容的镜像时，通过本工具处理模板文件，生成符合发布要求的目标镜像
• CI/CD流水线集成：在CI/CD流程中集成本镜像，实现模板解析、配置注入到镜像发布的自动化流程
• 多环境镜像发布：针对开发、测试、生产等不同环境，通过模板参数动态调整镜像配置，实现多环境镜像的高效发布

使用方法与配置说明

基础使用（docker run）

bash
docker run --rm \
  -v /path/to/local/templates:/templates \
  -v /path/to/output:/output \
  -e TEMPLATE_ENGINE=go \
  -e TARGET_REGISTRY=my-registry.example.com \
  detemplatize-publish-tool:latest

参数说明

环境变量

命令行参数

可通过命令行参数覆盖默认配置，格式为 --<参数名> <值>，例如：

bash
docker run --rm detemplatize-publish-tool:latest --template-engine jinja2 --output-dir /custom-output

支持的命令行参数与环境变量对应，参数名与环境变量名小写并以 - 连接（如 template-engine 对应 TEMPLATE_ENGINE）。

配置文件使用

支持通过挂载配置文件（默认路径 /config/config.yaml）进行批量配置，示例配置文件：

yaml
template:
  engine: jinja2
  path: /templates/app
output:
  dir: /output/app
registry:
  url: my-registry.example.com
  username: ${REGISTRY_USER}  # 支持引用环境变量
  password: ${REGISTRY_PWD}

使用配置文件的启动命令：

bash
docker run --rm \
  -v /local/templates:/templates \
  -v /local/output:/output \
  -v /local/config.yaml:/config/config.yaml \
  -e REGISTRY_USER=myuser \
  -e REGISTRY_PWD=mypwd \
  detemplatize-publish-tool:latest

注意事项

• 模板文件需确保挂载至容器内的 TEMPLATE_PATH 目录，或通过 --template-path 参数指定正确路径
• 目标镜像仓库需提前配置访问权限（如通过环境变量注入用户名密码，或挂载Docker配置文件）
• 调试模式下（DEBUG=true），工具会输出详细处理日志至标准输出，便于问题排查