mirror of
https://github.com/VictoriaMetrics/VictoriaMetrics.git
synced 2024-11-21 14:44:00 +00:00
45 lines
1.6 KiB
Markdown
45 lines
1.6 KiB
Markdown
|
 
|
||
|
|
[](https://artifacthub.io/packages/helm/victoriametrics/victoria-metrics-common)
|
||
|
|
|
||
|
|
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](https://docs.victoriametrics.com/helm/requirements/).
|
||
|
|
|
||
|
|
Generate docs with ``helm-docs`` command.
|
||
|
|
|
||
|
|
```bash
|
||
|
|
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.
|
||
|
|
|
||
|
|
<table class="helm-vars">
|
||
|
|
<thead>
|
||
|
|
<th class="helm-vars-key">Key</th>
|
||
|
|
<th class="helm-vars-type">Type</th>
|
||
|
|
<th class="helm-vars-default">Default</th>
|
||
|
|
<th class="helm-vars-description">Description</th>
|
||
|
|
</thead>
|
||
|
|
<tbody>
|
||
|
|
<tr>
|
||
|
|
<td>unitTest</td>
|
||
|
|
<td>bool</td>
|
||
|
|
<td><pre class="helm-vars-default-value" language-yaml" lang="">
|
||
|
|
<code class="language-yaml">false
|
||
|
|
</code>
|
||
|
|
</pre>
|
||
|
|
</td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
|