建立 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 檔案，但這並非必要項目。