使用 Kapitan 渲染 Helm Charts
Kapitan 原生支援以 input_type: helm 渲染 Helm charts。你只需將 chart 宣告為相依性(Kapitan 會自動擷取),並設定編譯項目(Kapitan 會用你的 values 進行模板化)。渲染後的 manifest 會放置在 compiled/ 目錄中;你完全不需要手動下載 chart 或執行 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擷取 chart 到output_path。僅在啟用擷取時執行,因此目標的第一次編譯需要先進行擷取;後續編譯會重複使用已擷取的 chart。 - 編譯 (
input_type: helm):將擷取的 chart 進行模板化。helm_params.release_name與helm_params.namespace對應helm template的參數;helm_values則是傳遞給 chart 的 values 文件。
關鍵約定
chart_name、chart_version、namespace 與 helm_values 是你需要設定的值;其餘所有項目都透過 ${<app>:...} 來參考它們。請確保 chart_dir 指向相依性擷取的位置,否則編譯項目會對一個空目錄進行模板化,不會產生任何輸出。
某些庫存(特別是 omegaconf 版本)會將整個區塊包裝在自訂解析器中,因此單一行就能展開為相依性與編譯項目,使得 charts 可以重複使用。底層的約定仍然是上述的兩階段結構;詳見 kapitan-omegaconf-resolvers 以了解該重複使用機制。
編輯後
使用 kapitan_compile_diff 進行編譯與差異比較,以審查渲染後的 manifests。要升級 chart 版本,只需變更 chart_version 並重新擷取,切勿手動編輯 compiled/ 目錄。
已驗證版本
Kapitan 0.34 至 0.36,搭配 Helm 3。