2.10.8　创建一个NOTES.txt文件

本节将介绍NOTES.txt文件，这个文件的信息用来给用户介绍当前Chart的用法。在helm install中，helm upgrade命令运行完毕后，Helm会打印出一大串很有用的信息，这些信息就是由NOTES.txt渲染而来的。

想要展示这些信息，首先需要创建一个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了解下一步的使用方法。在实际生产中，非常推荐为每个Chart创建一个NOTES.txt。

在实际生产运行中，有很多情况会导致Helm模板编写不正确，下面介绍几个可用来调试模板的命令。

·helm lint：可以检测Chart的编写是否遵循最佳实践。

·helm install--dry-run--debug：这个命令已经使用过多次，它可以模拟渲染文件，然后显示对外的输出结果。

·helm get manifest：通过这个命令能够看到我们已经安装到集群中的资源信息。