メインコンテンツまでスキップ
バージョン: 3.19.0

一般的な規約

ベストプラクティスガイドのこの部分では、一般的な規約について説明します。

chart 名

chart 名は英小文字と数字で構成する必要があります。単語はダッシュ(-)で区切ることが できます

例:

drupal
nginx-lego
aws-cluster-autoscaler

英大文字やアンダースコアは chart 名に使用できません。ドットも chart 名には使用しないでください。

バージョン番号

Helm は可能な限り SemVer 2 を使用してバージョン番号を表現します。(Docker イメージタグは必ずしも SemVer に従わないため、この規則の例外と見なされています。)

SemVer バージョンを Kubernetes ラベルに保存する場合、+ 文字を _ に置き換える慣習があります。ラベルの値として + 記号が許可されていないためです。

YAML のフォーマット

YAML ファイルは スペース 2 つ でインデントしてください(タブは使用しないでください)。

Helm と chart という用語の使い方

Helm および helm という用語の使い方にはいくつかの規約があります。

  • Helm はプロジェクト全体を指します
  • helm はクライアントサイドのコマンドを指します
  • chart という用語は固有名詞ではないため、大文字にする必要はありません
  • ただし、ファイル名は大文字小文字を区別するため、Chart.yaml は正確に記述する必要があります

迷った場合は、Helm(大文字の「H」)を使用してください。

chart テンプレートと namespace

chart テンプレートの metadata セクションで namespace プロパティを定義することは避けてください。レンダリングされたテンプレートを適用する namespace は、--namespace などのフラグを通じて Kubernetes クライアントへの呼び出し時に指定してください。Helm はテンプレートをそのままレンダリングして、Kubernetes クライアント(Helm 自身、kubectl、flux、spinnaker など)に送信します。