NOTES.txtファイルの作成

このセクションでは、チャートのユーザーに指示を提供するHelmのツールを見ていきます。helm installまたはhelm upgradeの最後に、Helmはユーザー向けに役立つ情報のブロックを出力できます。この情報は、テンプレートを使用して高度にカスタマイズ可能です。

インストールノートをチャートに追加するには、templates/NOTES.txtファイルを作成するだけです。このファイルはプレーンテキストですが、テンプレートのように処理され、通常のテンプレート関数とオブジェクトがすべて利用可能です。

簡単なNOTES.txtファイルを作成してみましょう。

Thank you for installing {{ .Chart.Name }}.

Your release is named {{ .Release.Name }}.

To learn more about the release, try:

  $ helm status {{ .Release.Name }}
  $ helm get all {{ .Release.Name }}

次に、helm install rude-cardinal ./mychartを実行すると、このメッセージが下部に表示されます。

RESOURCES:
==> v1/Secret
NAME                   TYPE      DATA      AGE
rude-cardinal-secret   Opaque    1         0s

==> v1/ConfigMap
NAME                      DATA      AGE
rude-cardinal-configmap   3         0s


NOTES:
Thank you for installing mychart.

Your release is named rude-cardinal.

To learn more about the release, try:

  $ helm status rude-cardinal
  $ helm get all rude-cardinal

このようにNOTES.txtを使用することは、新しくインストールしたチャートの使用方法について、ユーザーに詳細な情報を提供するのに最適な方法です。NOTES.txtファイルの作成は強く推奨されますが、必須ではありません。