Portainer templates helper 镜像文档

镜像概述和主要用途

Portainer templates helper 是一个轻量级辅助容器，旨在对 Portainer 模板文件执行特定操作。其核心用途是将 Portainer < 2.0 版本使用的 templates.json 模板文件升级为 Portainer 2.0 及以上版本支持的格式，确保旧版本自定义模板在新版本 Portainer 中可正常加载和使用。

核心功能和特性

• 模板格式升级：将 Portainer < 2.0 版本的 templates.json 文件转换为 2.0+ 版本兼容的格式。
• 简单易用：通过 Docker 命令行直接运行，无需复杂配置或依赖。
• 非侵入式处理：通过文件挂载方式读取源模板并输出升级后文件，不修改原始文件。
• 明确输出：升级后的文件统一命名为 templates-upgraded.json，并保存至指定目录，结果清晰可追溯。

使用场景和适用范围

适用场景

用户从 Portainer < 2.0 版本升级到 2.0 及以上版本时，需将自定义的 templates.json 模板文件转换为新版本格式，以继续使用原有模板配置。

适用范围

仅支持 Portainer < 2.0 版本的 templates.json 文件升级，不涉及其他类型模板文件或功能。

详细使用方法和配置说明

前置条件

• 已安装 Docker 环境。
• 已获取 Portainer < 2.0 版本的 templates.json 源文件。

基础使用命令

通过 docker run 命令运行容器，挂载源模板文件和输出目录，即可完成升级操作。基本命令格式如下：

bash
docker run --rm \
  -v /本地源模板路径/templates.json:/src/templates.json \
  -v /本地输出目录:/dist \
  portainer/helper-templates

参数说明

操作示例

1. 准备源文件

假设本地源模板文件路径为 /tmp/templates.json，需创建输出目录（如 /tmp/output）。

2. 运行升级命令

bash
docker run --rm \
  -v /tmp/templates.json:/src/templates.json \
  -v /tmp/output:/dist \
  portainer/helper-templates

3. 查看输出结果

命令执行成功后，容器会输出日志：

2020/08/26 00:51:27 New template file successfully created at /dist/templates-upgraded.json

升级后的模板文件 templates-upgraded.json 会保存至本地输出目录（如 /tmp/output）：

bash
ls /tmp/output
# 输出：templates-upgraded.json

注意事项

• 确保本地源模板文件路径和输出目录路径正确，且 Docker 有权限访问（避免权限不足导致文件读取/写入失败）。
• 源文件必须命名为 templates.json，且挂载至容器内 /src/templates.json（容器内部仅读取此固定路径文件）。
• 升级后的 templates-upgraded.json 可直接导入 Portainer 2.0+ 版本使用。