⎈ Helm Templexer

使用显式配置渲染多个环境中的 Helm 图表，同时保持开销最小。

该 helm-templexer 封装了 Helm v3+，请确保已安装并添加到 PATH。

cat > my-app.yaml <<EOF
version: v2
chart: tests/data/nginx-chart
release_name: my-app
output_path: manifests
deployments:
  - name: edge
  - name: stage
  - name: prod
EOF

helm-templexer render my-app.yaml

结果

❯ exa -T manifests
manifests
├── edge
│  └── my-app
│     └── manifest.yaml
├── prod
│  └── my-app
│     └── manifest.yaml
└── stage
   └── my-app
      └── manifest.yaml

配置

配置可以以 YAML 格式提供。

所有路径在执行期间相对于配置文件进行评估。

查找 v1 架构？请参阅 helm-templexer 1.x。

部署可以覆盖几个顶级字段

渲染命令的附加选项

扩展 helm template 调用

使用 --additional-options 将数据传递给底层的 helm template 调用。请注意，这些附加选项会添加到 每个 调用中，即每个部署。

我们找到的一个常见用例是提供容器标签

helm-templexer render --additional-options="--set-string image.tag=${revision}" my-app.yaml

渲染部署的子集

使用 --filter 来渲染特定的部署。例如：要渲染只有 prod，将正则表达式传递给过滤器选项。

helm-templexer render --filter="prod" my-app.yaml

在渲染部署之前更新 Helm 依赖项

使用 --update-dependencies 来运行 helm dependencies update 一次 在开始渲染部署之前。

helm-templexer render --update-dependencies my-app.yaml

在写入磁盘之前通过工具（工具集）将清单输出

使用 --pipe 将清单输出通过一个工具或工具集传递，然后再写入文件。

请注意，此选项 需要 等号（=），即 `--pipe=""。

helm-templexer render --pipe="kbld -f -" my-app.yaml

您可以多次定义参数；命令将按出现顺序添加到最终命令中。

helm-templexer render --pipe="kbld -f -" --pipe="tee /dev/stdout" my-app.yaml

如果发生任何意外情况，您可以使用 -v，-vv 和 -vvv 来增加日志级别并查看底层命令。

安装

Docker

# create the directory where helm-templexer will render to
mkdir -p tests/data/manifests

# let helm-templexer's user id (1001) own the directory
sudo chown -R 1001 tests/data/manifests

# pull and run the image
docker pull ghcr.io/hendrikmaus/helm-templexer
docker run --rm --volume $(pwd):/srv --workdir /srv/tests/data ghcr.io/hendrikmaus/helm-templexer render config_example.yaml 

将 helm-templexer 包含到您的 Dockerfile 中

FROM ghcr.io/hendrikmaus/helm-templexer AS helm-templexer-provider
COPY --from=helm-templexer-provider /usr/bin/helm-templexer /usr/bin
COPY --from=helm-templexer-provider /usr/bin/helm /usr/bin

预编译的二进制文件

请根据需要设置/替换 $TARGET 和 $VERSION。

wget https://github.com/hendrikmaus/helm-templexer/releases/download/v$VERSION/helm-templexer-$VERSION-$TARGET.tar.gz -O - | tar xz && mv helm-templexer /usr/bin/helm-templexer

例如 VERSION=2.0.0 和 TARGET=aarch64-apple-darwin

将 mv 到 /usr/bin 可能需要 sudo。

与校验和验证

为了验证下载的 存档 与校验和

wget https://github.com/hendrikmaus/helm-templexer/releases/download/v$VERSION/helm-templexer-$VERSION-$TARGET.tar.gz
echo "$(wget https://github.com/hendrikmaus/helm-templexer/releases/download/v$VERSION/helm-templexer-$VERSION-$TARGET.tar.gz.sha256 -O -) helm-templexer-$VERSION-$TARGET.tar.gz" | sha256sum --check --strict --status

Homebrew

brew tap hendrikmaus/tap
brew install helm-templexer

Cargo 安装

Helm Templexer是用 Rust 编写的。您需要 rustc 版本 1.35.0 或更高。安装 Rust 的推荐方法是来自官方网站。一旦设置好，简单的 make install 命令将编译 helm-templexer 并将其安装到 $HOME/.cargo/bin。

如果您正在使用 Cargo 的最新版本（0.5.0 或更高），您可以使用 cargo install 命令

cargo install helm-templexer

货物将构建二进制文件并将其放置在 $HOME/.cargo/bin（此位置可以通过设置--root选项来覆盖）。