创建一个NOTES.txt文件

该部分会介绍为chart用户提供说明的Helm工具。在helm install 或 helm upgrade命令的最后，Helm会打印出对用户有用的信息。 使用模板可以高度自定义这部分信息。

要在chart添加安装说明，只需创建templates/NOTES.txt文件即可。该文件是纯文本，但会像模板一样处理， 所有正常的模板函数和对象都是可用的。

让我们创建一个简单的NOTES.txt文件：

  1. Thank you for installing {{ .Chart.Name }}.
  3. Your release is named {{ .Release.Name }}.
  5. To learn more about the release, try:
  7.   $ helm status {{ .Release.Name }}
  8.   $ helm get all {{ .Release.Name }}

现在如果我们执行helm install rude-cardinal ./mychart 会在底部看到：

  1. RESOURCES:
  2. ==> v1/Secret
  3. NAME                   TYPE      DATA      AGE
  4. rude-cardinal-secret   Opaque    1         0s
  6. ==> v1/ConfigMap
  7. NAME                      DATA      AGE
  8. rude-cardinal-configmap   3         0s
  11. NOTES:
  12. Thank you for installing mychart.
  14. Your release is named rude-cardinal.
  16. To learn more about the release, try:
  18.   $ helm status rude-cardinal
  19.   $ helm get all rude-cardinal

使用NOTES.txt这种方式是给用户提供关于如何使用新安装的chart细节信息的好方法。尽管并不是必需的，强烈建议创建一个NOTES.txt文件。

Prev← 命名模板

Next在模板内部访问文件 →