178c777c1e
For each chart, generate configuration docs for the values.yaml Install helm-docs into the tools directory since it's not available via distro packages. Change-Id: Icffec6637686871d10aba2f666075549d1d505a8 Signed-off-by: Doug Goldstein <cardoe@cardoe.com>
42 lines
1.2 KiB
Go Template
42 lines
1.2 KiB
Go Template
{{- define "chart.valueDefaultColumnRender" }}
|
|
{{- $defaultValue := (default .Default .AutoDefault) -}}
|
|
{{- $notationType := .NotationType }}
|
|
{{- if (and (hasPrefix "```" $defaultValue) (hasSuffix "```" $defaultValue) ) -}}
|
|
{{- $defaultValue = (toPrettyJson (fromJson (trimAll "```" (default .Default .AutoDefault) ) ) ) -}}
|
|
{{- $notationType = "json" }}
|
|
{{- end -}}
|
|
{{- if contains "\\n" $defaultValue }}
|
|
{{- $notationType = "default" }}
|
|
{{- end }}
|
|
{{- if eq $notationType "" -}}
|
|
{{ $defaultValue }}
|
|
{{- else -}}
|
|
.. code-block:: {{ $notationType }}
|
|
|
|
{{ (trimAll "`" $defaultValue | trimAll "\"" | replace "\\n" "\n") | indent 10 }}
|
|
{{- end }}
|
|
{{- end }}
|
|
|
|
{{ title .Name }}
|
|
{{ repeat (len .Name) "=" }}
|
|
|
|
There are various customizations you can do to tailor the deployment of
|
|
OpenStack {{ title .Name }}. You can find those below.
|
|
|
|
==================
|
|
General Parameters
|
|
==================
|
|
|
|
{{- define "chart.generalParamsvaluesTable" }}
|
|
{{- range .Values }}
|
|
* {{ .Key }}
|
|
|
|
* Type: {{ .Type }}
|
|
* Description: {{ if .Description }}{{ .Description }}{{ else }}{{ .AutoDescription }}{{ end }}
|
|
* {{ template "chart.valueDefaultColumnRender" . }}
|
|
|
|
{{- end }}
|
|
{{- end }}
|
|
|
|
{{ template "chart.generalParamsvaluesTable" . }}
|