multiline string to a variable in a helm template?

Question

Is it possible to assign a multiline string to a variable in a helm template?

I have a variable as follows:

{{- $fullDescription := "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" -}}

but I would prefer to keep it in my code base as

{{- $fullDescription :|- "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
                          xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
                          xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" -}}

.. but this is not valid yaml.

Can this be done?

score 12 · Answer 1 · answered May 17 '22 at 03:35

Input

values.yaml

myFile: |
  This is a multiline
  value, aka heredoc.

myArray:
  - key1=value1
  - key2=value2

configmap.yaml

apiVersion: v1
kind: ConfigMap
metadata:
  name: myTemplate
data:
  myFile: {{- .Values.myFile | toYaml | indent 1 }}
  myArray: |
  {{- range $k, $v := .Values.myArray }}
    - {{ . | toYaml | indent 4 | trim }}
  {{- end }}

Output

apiVersion: v1
kind: ConfigMap
metadata:
  name: myTemplate
data:
  myFile: |
   This is a multiline
   value, aka heredoc.
  myArray: |
    - key1=value1
    - key2=value2

score 9 · Accepted Answer · answered Jul 03 '18 at 12:42

9

I worked around this issue by including the content I require from a separate file.

Eg.

  fullDescription: |-
{{ .Files.Get files/description.html | indent 4 }}

answered Jul 03 '18 at 12:42

MarkNS

3,811
2
43
60

2

how does this even work? I get the same error using this style like from answer below. – Aubergine Feb 11 '20 at 13:13

score 1 · Answer 3 · answered Jun 27 '18 at 07:35

1

I think it should work like this:

$fullDescription: | +
   "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
    xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
    xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

answered Jun 27 '18 at 07:35

S.Spieker

7,005
8
44
50

Thanks for the answer, but it doesn't work for me. I get `Error: UPGRADE FAILED: YAML parse error on x/y/z.yaml: error converting YAML to JSON: yaml: line 15: did not find expected comment or line break` – MarkNS Jul 03 '18 at 12:40

score 0 · Answer 4 · answered Jan 18 '22 at 13:27

You could've used values.yaml, which would save you from adding an extra file.

fullDescription: |+
  line1
  line2

then in template

fullDescription: |
{{ $fullDescription | indent 2}}

Probably not you wanted, but you could use newline char

{{- $fullDescription := "a\nb\nc\n" -}}

multiline string to a variable in a helm template?

4 Answers4

Input

Output

Linked