Helm Chart README: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
|||
| (One intermediate revision by the same user not shown) | |||
| Line 1: | Line 1: | ||
=External= | =External= | ||
* https://helm.sh/docs/ | * https://helm.sh/docs/topics/charts/#chart-license-readme-and-notes | ||
=Internal= | =Internal= | ||
| Line 9: | Line 9: | ||
=Overview= | =Overview= | ||
An optional human-readable README file. | An optional human-readable README file. The file should be formatted in Markdown and it should generally contain: | ||
* A description of the application or service the chart provides | |||
* Any prerequisites or requirements to run the chart | |||
* Descriptions of options in [[Helm Chart values.yaml|values.yaml]] and default values | |||
* Any other information that may be relevant to the installation or configuration of the chart | |||
Latest revision as of 19:23, 14 December 2019
External
Internal
Overview
An optional human-readable README file. The file should be formatted in Markdown and it should generally contain:
- A description of the application or service the chart provides
- Any prerequisites or requirements to run the chart
- Descriptions of options in values.yaml and default values
- Any other information that may be relevant to the installation or configuration of the chart