voltagepark/charts-echo

OCI Helper Chart 镜像文档

镜像概述

本镜像是一个专注于通用模板处理的OCI（Open Container Initiative）辅助工具，旨在为容器化环境提供模板生成、渲染和管理能力。通过集成OCI标准兼容性与模板处理功能，该工具可简化容器应用部署过程中的模板应用流程，支持各类OCI相关场景下的模板化需求。

核心功能与特性

1. 通用模板支持

• 兼容多种模板格式，支持自定义模板规则，满足不同场景下的模板需求
• 提供灵活的模板变量替换机制，支持动态参数注入

2. OCI生态兼容性

• 遵循OCI容器标准，可无缝集成到OCI镜像构建、分发等流程中
• 支持OCI镜像元数据相关的模板生成与管理

3. 模板处理能力

• 内置模板渲染引擎，支持模板文件的解析与生成
• 提供模板版本管理与多环境适配功能

4. 轻量级设计

• 镜像体积精简，资源占用低，适合在各类容器环境中部署
• 无复杂依赖，部署与使用流程简单

使用场景

1. 容器化应用配置模板

用于生成容器化应用的动态配置文件，支持多环境（开发、测试、生产）配置模板的统一管理与渲染

2. OCI镜像构建辅助

辅助生成OCI镜像构建过程中的Dockerfile模板、镜像元数据模板等，简化镜像构建流程

3. 容器编排模板管理

为Kubernetes、Docker Compose等编排工具提供模板生成能力，支持基于模板的编排配置自动化

4. 多环境模板统一处理

在复杂容器环境中，实现跨环境的模板标准化与动态适配

使用方法

基本使用示例

通过以下命令运行镜像，进行模板处理：

bash
docker run --rm \
  -v /path/to/local/templates:/templates \  # 挂载本地模板目录
  -v /path/to/output:/output \             # 挂载输出目录
  oci-helper-chart:latest \
  process \
  --input /templates \                     # 指定容器内模板目录
  --output /output                         # 指定容器内输出目录

核心参数说明

环境变量配置

通过环境变量自定义模板处理行为：

高级使用示例（带环境变量）

bash
docker run --rm \
  -e TEMPLATE_DEBUG=true \
  -e OCI_REGISTRY=my-private-registry.example.com \
  -v $(pwd)/templates:/templates \
  -v $(pwd)/generated-configs:/output \
  docker.xuanyuan.run/oci-helper-chart:latest \
  process \
  --input /templates \
  --output /output \
  --format yaml

注意事项

1. 挂载目录权限：确保本地挂载目录具有读写权限，避免容器内权限不足导致的文件处理失败
2. 模板格式要求：模板文件需符合工具支持的语***范，复杂模板建议先进行本地语法校验
3. 资源配置：处理大型模板文件时，可通过--memory和--cpus参数调整容器资源限制，避免处理超时

bash
# 处理大型模板时调整资源限制示例
docker run --rm \
  --memory=2g --cpus=1 \
  -v /templates:/templates -v /output:/output \
  oci-helper-chart:latest process --input /templates --output /output