hairyhenderson/gomplate

gomplate 镜像文档

概述

gomplate是一款功能强大的命令行模板渲染工具，支持多种数据源集成与Go模板语法，能够灵活处理和生成各类模板文件。其核心优势在于对丰富数据源的支持，包括JSON（含EJSON加密JSON）、YAML、AWS EC2元数据、BoltDB数据库、Hashicorp Consul服务发现及Hashicorp Vault密钥管理等，适用于动态配置生成、环境驱动内容处理等场景。

核心功能与特性

• 多数据源兼容：支持文件型（JSON/YAML）、网络型（HTTP/HTTPS）、云服务型（AWS EC2元数据）及密钥管理型（Vault/Consul）等多种数据源。
• Go模板语法：完全兼容Go语言模板语法，支持条件判断（if）、循环（range）、变量赋值等高级逻辑操作。
• 丰富内置函数：提供数学运算（如mul乘法）、字符串处理（如toUpper大写转换）、序列生成（如seq）等实用函数库。
• 灵活命令行交互：支持通过管道输入、文件输入或直接指定模板字符串进行渲染，参数配置简洁直观。

使用场景

• 动态配置生成：结合环境变量或外部数据源（如Vault密钥）生成应用配置文件（如Kubernetes manifests、服务配置）。
• 环境适配处理：根据不同部署环境（开发/测试/生产）自动调整模板内容，实现配置差异化。
• 外部数据集成：从Consul获取服务列表、从AWS EC2元数据获取实例信息，动态注入模板生成运行时内容。
• 加密数据处理：支持EJSON解密，安全集成加密配置数据到模板中。

使用方法与示例

基础用法

gomplate通过命令行参数指定模板内容和数据源，基本语法为：gomplate [选项]。常用选项包括：

• -i：直接指定模板字符串
• -f：指定模板文件路径
• -d：定义数据源（格式：名称=URL）
• -H：为数据源添加HTTP请求头

环境变量示例

console
$ # 基础用法：结合环境变量渲染
$ echo '当前用户：{{ .Env.USER }}' | gomplate
当前用户：hairyhenderson

内置函数示例

console
$ # 使用数学函数计算
$ gomplate -i '计算结果：{{ mul 6 7 }}'
计算结果：42

Go模板语法示例

console
$ # 循环与条件判断结合
$ gomplate -i '{{ range seq 5 1 }}{{ . }} {{ if eq . 1 }}{{ "发射" | toUpper }}{{ end }}{{ end }}'
5 4 3 2 1 发射

数据源应用示例

本地文件数据源（YAML）

console
$ # 创建测试YAML文件
$ cat config.yaml
foo:
  bar:
    baz: qux
$ # 指定YAML数据源并提取值
$ gomplate -d config=./config.yaml -i '目标值：{{ (datasource "config").foo.bar.baz }}'
目标值：qux

网络数据源（HTTP）

console
$ # 从网络API获取数据并渲染
$ gomplate -d ip=https://ipinfo.io -i '国家代码：{{ (ds "ip").country }}'
国家代码：CA

标准输入数据源（JSON）

console
$ # 标准输入作为JSON数据源
$ echo '{"cities":["伦敦", "约翰内斯堡", "温得和克"]}' | gomplate -d city=stdin:///in.json -i '{{ range (ds "city").cities }}{{.}}, {{end}}'
伦敦, 约翰内斯堡, 温得和克, 

Docker环境使用

通过Docker镜像可快速部署和使用gomplate，无需本地安装。基础命令格式：

bash
docker run --rm hairyhenderson/gomplate [参数]

Docker使用示例

1. 环境变量渲染：

bash
docker run --rm -e USER=demo hairyhenderson/gomplate -i 'Hello, {{ .Env.USER }}'
Hello, demo

2. 挂载本地文件作为数据源：

bash
# 假设本地有config.yaml文件
docker run --rm -v $(pwd)/config.yaml:/data/config.yaml hairyhenderson/gomplate -d config=/data/config.yaml -i '值：{{ (datasource "config").foo.bar.baz }}'

3. 复杂模板文件渲染：

bash
# 挂载模板文件并指定数据源
docker run --rm -v $(pwd)/template.tmpl:/data/tmpl -v $(pwd)/data.yaml:/data/data.yaml hairyhenderson/gomplate -f /data/tmpl -d data=/data/data.yaml

参考与资源

• 官方文档：docs.gomplate.ca
• Docker镜像：https://hub.docker.com/r/hairyhenderson/gomplate
• 社区支持：Gophers Slack #gomplate频道

许可证

http://opensource.org/licenses/MIT%EF%BC%88Copyright © 2016-2019 Dave Henderson）