创建 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
文件,尽管这不是必需的。