Kapitanを使用したHelmチャートのレンダリング
Kapitanは、input_type: helmを使用してHelmチャートをネイティブにレンダリングします。チャートを依存関係(Kapitanが取得)として宣言し、コンパイルエントリ(Kapitanが値をテンプレート化)として宣言します。レンダリングされたマニフェストはcompiled/に配置されます。チャートをベンダリングしたり、自分でhelmを実行したりする必要はありません。
2つの部分が1つの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}
2つの部分
- 依存関係(
type: helm):sourceからversionのチャートをoutput_pathに取得します。フェッチが有効な場合のみ実行されるため、ターゲットの初回コンパイル時にはフェッチが必要です。以降のコンパイルでは、取得済みのチャートを再利用します。 - コンパイル(
input_type: helm):取得したチャートをテンプレート化します。helm_params.release_nameとhelm_params.namespaceはhelm templateフラグです。helm_valuesはチャートに渡される値ドキュメントです。
重要な契約
chart_name、chart_version、namespace、helm_valuesは設定する値です。その他はすべて${<app>:...}でそれらを参照します。chart_dirが依存関係のフェッチ先を指し示していることを確認してください。そうしないと、コンパイルエントリが空のディレクトリをテンプレート化し、何も出力しません。
一部のインベントリ(特にomegaconfのもの)では、このブロック全体をカスタムリゾルバでラップして、1行で依存関係とコンパイルエントリを展開できるようにしており、チャートの重複が容易になります。基本的な契約は上記の2つの部分と同じです。この再利用メカニズムの詳細については、kapitan-omegaconf-resolversを参照してください。
編集後
コンパイルと差分表示(kapitan_compile_diff)を行って、レンダリングされたマニフェストを確認します。チャートのバージョンアップはchart_versionの変更と再フェッチであり、compiled/を手動で編集することはありません。
検証済み
Kapitan 0.34から0.36、Helm 3で検証済み。