objectiflibre/jinja-init

jinja-init Docker镜像文档

镜像概述

jinja-init是一个适用于Kubernetes环境的初始化容器镜像，通过Jinja2模板系统，结合配置映射（ConfigMap）、密钥（Secret）和环境变量生成应用所需的配置文件，帮助实现配置的动态注入与管理。

核心功能

1. 基于Jinja2模板语法生成配置文件
2. 支持从ConfigMap读取模板文件
3. 支持从Secret读取敏感配置变量
4. 通过环境变量注入非敏感配置变量
5. 可配置模板源路径、目标文件路径及密钥目录

使用场景

• Kubernetes中需要动态生成配置的应用（如PHP、Python服务）
• 需从密钥或环境变量注入敏感/非敏感配置的场景
• 多环境下配置模板复用的需求

配置说明

镜像支持以下环境变量配置：

• JINJA_SRC_FILE: 模板源文件路径，默认值/config_src/template.j2
• JINJA_DEST_FILE: 生成的目标配置文件路径，默认值/config/settings.py
• JINJA_SECRETS_DIR: 密钥文件所在目录，目录内文件名作为变量名，文件内容作为变量值，默认值/secrets
• VERBOSE: 开启 verbose 模式（输出额外日志），可设置为"1"
• JINJA_VAR_*: 自定义模板变量，前缀JINJA_VAR_会被移除，变量名区分大小写

使用示例

1. 拉取镜像

bash
docker pull docker.xuanyuan.run/objectiflibre/jinja-init

2. Kubernetes部署步骤

步骤1：创建ConfigMap存储模板文件

bash
cat > template.php.j2 << EOF
<?php
\$db_pass = '{{ db_pass }}';
\$db_host = '{{ db_host }}';
\$db_user = '{{ db_user }}';
?>
EOF
kubectl create configmap config-template --from-file=template.php.j2

步骤2：创建Secret存储敏感变量

bash
PASSWORD=$(echo -n 's3cr3t' | base64)
cat > secrets.yml << EOF
apiVersion: v1
kind: Secret
metadata:
  name: secrets
data:
  db_pass: $PASSWORD
EOF
kubectl apply -f secrets.yml

步骤3：部署应用（含初始化容器）

bash
cat > deployment.yml << EOF
apiVersion: apps/v1
kind: Deployment
metadata:
  name: test
  labels:
    app: test
spec:
  replicas: 1
  selector:
    matchLabels:
      app: test
  template:
    metadata:
      labels:
        app: test
    spec:
      initContainers:
      - name: config
        image: docker.xuanyuan.run/objectiflibre/jinja-init
        env:
        - name: JINJA_SRC_FILE
          value: /config_src/template.php.j2
        - name: JINJA_DEST_FILE
          value: /config/config.php
        - name: VERBOSE
          value: "1"
        - name: JINJA_VAR_db_host
          value: "127.0.0.1"
        - name: JINJA_VAR_db_user
          value: app_user
        volumeMounts:
        - name: config-template
          mountPath: /config_src
        - name: config
          mountPath: /config
        - name: secrets
          mountPath: /secrets
      containers:
      - name: busybox
        image: docker.xuanyuan.run/busybox
        command: ["cat", "/config/config.php"]
        volumeMounts:
        - name: config
          mountPath: /config
      volumes:
      - name: config-template
        configMap:
          name: config-template
      - name: config
        emptyDir: {}
      - name: secrets
        secret:
          secretName: secrets
EOF
kubectl apply -f deployment.yml
# 查看生成的配置文件
kubectl logs deployment/test

贡献

欢迎通过Issues或Pull Requests提出改进建议，共同完善该工具。