温玉的WIKI博客

创建一个 NOTES.txt 文件

在本节中，我们将看看 Helm 工具如何向你的 chart 用户提供说明。在 helm install 或 helm upgrade 结束时，Helm 可以为用户打印出一大堆有用的信息。这些信息是使用模板高度定制的。

要将安装说明添加到 chart，只需创建一个 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 {{ .Release.Name }}

现在，如果我们运行 helm install ./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 rude-cardinal

使用NOTES.txt这种方式是一种很好的方式，可以为用户提供有关如何使用新安装chart的详细信息。强烈建议创建一个文件NOTES.txt，尽管这不是必需的。

搜索