用于模板文件操作的容器助手
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 命令运行容器,挂载源模板文件和输出目录,即可完成升级操作。基本命令格式如下:
bashdocker run --rm \ -v /本地源模板路径/templates.json:/src/templates.json \ -v /本地输出目录:/dist \ docker.xuanyuan.run/portainer/helper-templates
参数说明
| 参数 | 说明 |
|---|---|
--rm | 容器运行完毕后自动删除,避免残留临时容器。 |
-v /本地源模板路径/templates.json:/src/templates.json | 将本地 Portainer < 2.0 的 templates.json 文件挂载到容器内固定路径 /src/templates.json(容器内部会读取此路径文件)。 |
-v /本地输出目录:/dist | 将本地目录挂载到容器内 /dist 目录,升级后的模板文件会输出至此目录。 |
portainer/helper-templates | 镜像名称。 |
操作示例
1. 准备源文件
假设本地源模板文件路径为 /tmp/templates.json,需创建输出目录(如 /tmp/output)。
2. 运行升级命令
bashdocker run --rm \ -v /tmp/templates.json:/src/templates.json \ -v /tmp/output:/dist \ docker.xuanyuan.run/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):
bashls /tmp/output # 输出:templates-upgraded.json
注意事项
- 确保本地源模板文件路径和输出目录路径正确,且 Docker 有权限访问(避免权限不足导致文件读取/写入失败)。
- 源文件必须命名为
templates.json,且挂载至容器内/src/templates.json(容器内部仅读取此固定路径文件)。 - 升级后的
templates-upgraded.json可直接导入 Portainer 2.0+ 版本使用。
镜像拉取方式
您可以使用以下命令拉取该镜像。请将 <标签> 替换为具体的标签版本。如需查看所有可用标签版本,请访问 标签列表页面。
轩辕镜像加速拉取命令点我查看更多 helper-templates 镜像标签
docker pull docker.xuanyuan.run/portainer/helper-templates:<标签>
DockerHub 原生拉取命令
docker pull portainer/helper-templates:<标签>
用户好评
来自真实用户的反馈,见证轩辕镜像的优质服务