云原生应用管理:原理与实践
上QQ阅读APP看书,第一时间看更新

2.1.2 Chart license,README notes

在Helm中,Chart也提供了描述安装和配置过程的文件。license是一个文本文件,这里可以包含Chart的license信息。如果在template文件中有一些安装或者其他逻辑,或者不想让别人编辑此文件,可以添加一个license文件到Chart文件夹中。

README是用来介绍Chart使用方法和功能的文件。这个文件必须是Markdown格式的,一般包含以下信息:

·描述Chart提供的应用或者服务;

·一些Chart需要的前置依赖;

·values.yaml中一些需要解释的可选配置信息;

·任何其他安装或者编辑Chart相关的信息。

Chart也能在templates/Notes.txt提供一个简短的介绍,该文件的信息会在用户执行helm install后直接在终端打印出来。同样在执行helm status的时候也会显示文件的信息。由于该文件在templates文件夹中,因此文件一般用于显示使用声明,表明下一步如何继续使用该Chart提供的服务,或者其他Chart提供的安装组件信息。例如,notes文件可以指导用户如何连接数据库,或者去哪里查看部署好的UI。由于文件内容只是被显示在stdout中,因此建议在notes里放一些简单的信息,复杂的信息最好放到README中。