掌舵值的最佳实践

Question

我是 helm 新手，不确定除了强制值之外是否还应将所有可选值都包含在打包的

value.yml

文件中。由于其他 helm 开发人员可能会使用外部

values.yml

文件覆盖这些值，因此他们需要知道哪些值可用于图表。特别是像 helm-docs 这样的文档工具会选择这些值来创建文档。所以我想知道是否有最佳实践，或者出于文档原因，所有值是否都应该包含在打包的

values.yml

文件中。

Answer 1

使用图表的人实际上只有三个有关可配置内容的信息源：

README.md

文件、JSON 架构（如果存在）以及

values.yaml

文件的内容。我建议至少记录一个位置（甚至可能是所有位置）可以设置的所有内容。

Helm 文档 建议：

values.yaml

中定义的每个属性都应记录在案。文档字符串应以它所描述的属性名称开头，然后至少给出一句话描述。

请注意，Helm 文档中的文档字符串格式与您引用的工具不同。

您偶尔会遇到一个值，其中“未设置”是一个很好的值。我倾向于将这些包含在

values.yaml

文件中，但最自然的格式是工具很难自动提取的格式。

# externalSecret provides the name of a Secret that provides the password.
# Either this or password: must be provided.
# externalSecret: secretName

# extraConfiguration is appended to the generated configuration file.
# extraConfiguration: |-
#   [section]
#   key=value

我不知道对此有一个真正通用的答案，并且文档提取工具不是 Helm 的核心部分。