Template のコメントと引用符

チャートでメモを残す方法は 2 つあります。通常の YAML コメントと特別な template comments です。これらはレンダリング時にまったく異なる動作をします。

シャープ記号で始まる行は通常の YAML コメントです。そのまま通過し、レンダリング後の出力にも残るため、誰でも読めます。

Helm には完全に消える独自のコメントがあります。テキストを {{/* */}} で囲むと、出力前にエンジンがその部分を取り除きます。

デプロイされた YAML の説明にはハッシュを使用します。ユーザーには決して見せない、テンプレートのロジックに関するメモにはテンプレートコメントを使用します。📝

テンプレートコメントはコードを無効にするのにも便利です。アクションを {{/* */}} で囲むと、Helm はそれをスキップするため、レンダリングもエラーも発生しません。

YAML は型を推測することがよくあります。値 1.10 は 1.1 になったり、yes は true に変わったりすることがあります。クォートすれば、代わりに明確な文字列として扱えます。

Helm には値を二重引用符で囲む quote 関数が用意されているため、レンダリングされたフィールドが明確に文字列になります。

通常、quote はアクションの末尾でパイプとして記述します。「値を受け取り、それをクォートする」という自然な読み方になります。

クォートしないと、1.20 のようなバージョンから末尾の 0 が暗黙的に失われて 1.2 になり、イメージ参照が壊れる可能性があります。クォートすればこれを防げます。⚠️

Kubernetes では、アノテーション内のポートのように、数値をテキストとして保持する必要がある場合があります。quote をパイプで通せば、安全に文字列として保持できます。

YAML にリテラルの引用符を自分で記述することもできます。quote 関数は、テンプレートから値を取得する場合にプログラムで引用符を付けてくれます。

デプロイされた YAML に表示したくないメモを追加します。

{{/* */}} でメモを非表示にし、ハッシュで表示するコメントを残し、quote 関数で文字列を適切に整えられるようになりました。🎯