一个用于自动生成 helm 图表 markdown 文档的工具
helm-docs 工具会自动从 helm 图表生成 Markdown 文件。生成的文件包含有关各自图表的元数据以及包含图表的每个值、其默认值和可选描述的表格，这些描述是从注释中解析的。Markdown 生成完全由 gotemplate 控制。该工具会解析图表中的元数据，并生成一系列子模板，这些模板可以在模板文件（默认情况下为 README.md.gotmpl）中引用。如果未提供模板文件，该工具将使用默认的内部模板，该模板会生成格式合理的 README。
此工具最有用的方面是自动检测字段描述来自注释:
| 关键字 | 类型 | 默认值 | 描述 |
|---|---|---|---|
| config.databasesToCreate[0] | 字符串 | "PostgreSQL" |
存储数据库元数据的默认数据库 |
| config.databasesToCreate[1] | 字符串 | "hashbash" |
hashbash 项目的数据库 |
| config.usersToCreate[0] | 对象 | {"admin":true,"name":"root"} |
管理员用户 |
| config.usersToCreate[1] | 对象 | {"name":"hashbash","readwriteDatabases":["hashbash"]} |
拥有与数据库同名访问权限的用户 |
| statefulset.extraVolumes | 列表 | [{"emptyDir":{},"name":"data"}] |
要挂载到数据库容器中的附加卷 |
| statefulset.image.repository | 字符串 | "jnorwood/PostgreSQL:11" |
用于部署的镜像,必须支持一个入口点,该入口点可从相应的配置文件创建用户/数据库 |
| statefulset.image.tag | 字符串 | "18.0831" |
您会注意到，有些复杂字段（列表和对象）有文档，而其他没有，有些简单的字段（如 statefulset.image.tag）即使没有描述注释也有文档。最终表中哪些字段有文档，哪些没有，将在本文档后面详细介绍。
暂无开放 Issues，或尚未同步最近议题。