使用 Kapitan 渲染 Helm 图表
Kapitan 通过 input_type: helm 原生渲染 Helm 图表。你将图表声明为依赖项(Kapitan 会获取它)和一个编译条目(Kapitan 使用你的值进行模板化)。渲染后的清单会出现在 compiled/ 目录中;你无需自行管理图表或运行 helm。
两个部分位于同一个 parameters.<app> 块下,通过 ${<app>:key} 自引用链接,使得一个值只需编写一次。
结构
parameters:
cert-manager:
chart_name: cert-manager
chart_version: "v1.4.0"
chart_dir: system/sources/charts/${cert-manager:chart_name}
application_version: "v1.4.0"
namespace: ${namespace}
helm_values:
installCRDs: true
prometheus:
enabled: true
kapitan:
dependencies:
- type: helm
output_path: ${cert-manager:chart_dir}
source: https://charts.jetstack.io/
version: ${cert-manager:chart_version}
chart_name: ${cert-manager:chart_name}
compile:
- input_type: helm
input_paths:
- ${cert-manager:chart_dir}
output_path: .
helm_params:
namespace: ${cert-manager:namespace}
release_name: ${cert-manager:chart_name}
helm_values: ${cert-manager:helm_values}
两个部分
- 依赖项(
type: helm):从source获取指定version的图表到output_path。仅在启用获取时运行,因此目标的首次编译需要一次获取;后续编译会重用已获取的图表。 - 编译(
input_type: helm):对获取的图表进行模板化。helm_params.release_name和helm_params.namespace对应helm template的标志;helm_values是传递给图表的 values 文档。
关键约定
chart_name、chart_version、namespace 和 helm_values 是你设置的值;其他所有值通过 ${<app>:...} 引用它们。确保 chart_dir 指向依赖项获取的位置,否则编译条目会模板化一个空目录而不输出任何内容。
某些库存清单(尤其是 OmegaConf 环境中的)会将整个块包装在自定义解析器中,一行即可展开为依赖项和编译条目,这使得图表可重复使用。底层约定仍然是上述两个部分;有关该重用机制,请参阅 kapitan-omegaconf-resolvers。
编辑后
编译并比对(kapitan_compile_diff)以审查渲染后的清单。图表升级是更改 chart_version 并重新获取,而不是手动编辑 compiled/ 目录。
已验证版本
Kapitan 0.34 到 0.36 版本,搭配 Helm 3。