Victoria Metrics Common - contains shared templates for all Victoria Metrics helm charts
Documentation of Helm Chart #
Install helm-docs
following the instructions on this tutorial.
Generate docs with helm-docs
command.
cd charts/victoria-metrics-common
helm-docs
The markdown generation is entirely go template driven. The tool parses metadata from charts and generates a number of sub-templates that can be referenced in a template file (by default README.md.gotmpl
). If no template file is provided, the tool has a default internal template that will generate a reasonably formatted README.
Parameters #
The following table lists the template functions of the chart and description.
Key | Type | Default | Description |
---|---|---|---|
unitTest | bool |
|