{{- $requiredClass := "confkey-required" }}{{ $requiredText := "required" }} {{- with .Get "required" }} {{- if (eq . "no") }}{{ $requiredClass = "confkey-notrequired" }}{{ $requiredText = "not required" }} {{- else if (eq . "situational") }}{{ $requiredClass = "confkey-situational" }}{{ $requiredText = "situational" }} {{ end }}{{- end }} {{- $type := "string" }}{{ with .Get "type" }}{{ $type = . }}{{ end }} {{- $syntax := "" }}{{ with .Get "syntax" }}{{ $syntax = . }}{{ end }} {{- $structure := "" }}{{ with .Get "structure" }}{{ $structure = . }}{{ end }} {{- $ref := (.Get "common") }} {{- if not $ref }} {{- if eq $type "structure" }} {{- with $structure }}{{ $ref = . }}{{ end }} {{- else if eq $syntax "duration" }}{{ $ref = "duration" }} {{- else if eq $syntax "address" }}{{ $ref = "address" }} {{- else if eq $syntax "network" }}{{ $ref = "network" }} {{- end }} {{- end }}
{{- range $t := (split $type ",") }} {{ $t }} {{- end }} {{- with $syntax }} {{- if $ref }} {{ $syntax }} {{- else }} {{ $syntax }} {{- end }} {{- end }} {{- with $structure }} {{- if $ref }} {{ $structure }} {{- else }} {{ $structure }} {{- end }} {{- end }} {{- with .Get "default" }} {{ . }} {{- end }} {{ $requiredText }}
{{- if $ref }} {{- $description := "common syntax" }} {{- $text := "This configuration option uses a common syntax. " }} {{- if eq $ref "duration" }} {{- $description = "Common Syntax: Duration" }} {{- $text = "This configuration option uses a common syntax. " }} {{- else if eq $ref "address" }} {{- $description = "Common Syntax: Address" }} {{- $text = "This configuration option uses a common syntax. " }} {{- else if eq $ref "tls" }} {{- $description = "Common Structure: TLS" }} {{- $text = "This configuration option uses a common structure. " }} {{- else if eq $ref "server-buffers" }} {{- $description = "Common Structure: Server Buffers" }} {{- $text = "This configuration option uses a common structure. " }} {{- else if eq $ref "server-timeouts" }} {{- $description = "Common Structure: Server Timeouts" }} {{- $text = "This configuration option uses a common structure. " }} {{- end }} {{- with .Get "common-description" }}{{ $description := . }}{{ end }} {{- with .Get "common-text" }}{{ $text := . }}{{ end }}

Reference Note

{{ $text }}For more information please see both the configuration example and the {{ $description }} reference guide.

{{- end }} {{- with .Get "secret" }} {{- if eq . "yes" }}

Important Note

This can also be defined using a secret which is strongly recommended especially for containerized deployments.

{{- end }} {{- end }}