dinutac/jinja2docker

Jinja2 Docker 模板渲染工具

镜像概述和主要用途

本Docker镜像提供了基于Jinja2的模板渲染功能，允许用户通过模板文件和变量文件动态生成配置文件或其他文本内容。无需在本地安装Jinja2环境，直接通过Docker容器即可完成模板渲染，简化了配置生成流程，提高了环境一致性。

核心功能和特性

• 多格式支持：默认支持YAML、JSON、XML、TOML等变量文件格式
• 环境变量注入：可通过环境变量传递动态参数，在模板中使用environ('变量名')获取
• 灵活挂载：支持本地模板目录和变量目录挂载到容器指定路径
• 自定义渲染：可覆盖默认渲染逻辑，实现自定义模板处理需求
• 轻量级：基于精简基础镜像，减少资源占用

使用场景和适用范围

• 配置文件动态生成（如Docker Compose、Kubernetes配置文件）
• 环境差异化配置管理（开发/测试/生产环境配置分离）
• 批量生成结构化文档或代码
• CI/CD流程中的自动化配置生成

使用方法和配置说明

基本使用步骤

1. 将包含模板文件的目录挂载到容器的/templates目录
2. 将包含变量文件的目录挂载到容器的/variables目录
3. 通过-e参数传递所需环境变量
4. 在Jinja2模板中使用environ('环境变量名')获取环境变量

支持的变量格式

默认支持以下格式（可通过--format参数指定）：

• YAML
• JSON
• XML
• TOML

更多格式支持可参考https://github.com/mattrobenolt/jinja2-cli%E6%96%87%E6%A1%A3%E3%80%82

基础语法

bash
docker run --rm \
-v [本地模板目录]:/templates \ 
-v [本地变量目录]:/variables  \
-e [自定义环境变量]=[值] \
dinutac/jinja2docker:latest /templates/[模板文件] /variables/[变量文件] --format=[格式] > [输出文件]

使用示例

示例1：生成Docker Compose配置

bash
docker run --rm \
-v $PWD/inputs/templates:/templates \
-v $PWD/inputs/variables:/variables \
-e DATABASE=mysql56 -e IMAGE=latest \
dinutac/jinja2docker:latest /templates/standalone.j2 /variables/variables.yml --format=yaml > docker-compose.yml

示例2：生成JSON配置

bash
docker run --rm \
-v $PWD/inputs/templates:/templates \
-v $PWD/inputs/variables:/variables \
dinutac/jinja2docker:latest /templates/json.j2 /variables/json.json --format=json

模板示例

模板文件（template.json）

txt
Os: {{os}}
Flavour: {{flavour}}
   
Path: {{environ('PATH')}}

变量文件（variables.json）

json
{
  "os": "Linux",
  "flavour": "CentOS"
}

渲染结果（result.json）

json
Os: Linux
Flavour: CentOS

Path: /usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin

嵌入式自定义渲染

如需使用内置自定义渲染功能，需覆盖容器入口点为/scripts/entities/render.py，该模式支持YAML和JSON格式：

bash
docker run --rm --entrypoint /scripts/entities/render.py \
-e DATABASE=mysql56 -e IMAGE=latest \
dinutac/jinja2docker:latest json.j2 /variables/json.json

注意：模板文件需直接通过名称引用（而非路径），且必须存在于/templates目录中。

自定义渲染逻辑

如需实现自定义Jinja2渲染逻辑：

1. 创建自定义render.py文件，覆盖容器内/scripts/entities/render.py路径
2. 根据需求修改Dockerfile，添加所需Python依赖包（通过requirements.txt）

镜像信息

• Docker Hub地址：https://hub.docker.com/r/dinutac/jinja2docker
• GitHub镜像包：https://github.com/dinuta/jinja2docker/packages/546841%EF%BC%88%E9%80%82%E7%94%A8%E4%BA%8EDocker Hub速率限制场景）
• 最新版本：2.1.6