How can I pass the entire JSON string to a Helm chart value?
I have values.yml
where the config value should contain entire JSON with a configuration of an application
...
config: some JSON here
...
and I need to pass this value to a secret template and then mount it as a volume to a Kubernetes pod.
{{- $env := default "integration" .Values.env}}
apiVersion: v1
kind: Secret
metadata:
name: {{ .Release.Name }}-{{ $env }}
type: Opaque
data:
config.json: {{ .Values.config | b64enc | quote }}
However the obvious approach of passing single quoted string like '{"redis": "localhost:6379"}'
fails because Helm for some reason deletes all double quotes in the string (even if I escape them) so I end up with {redis: localhost:6379}
which is not a valid JSON.
Is there any other possibility how to pass configuration to the pod all at once without loading template files with tpl
function and making all needed fields accessible via values.yml
separately?
Using the 'tpl' Function The tpl function allows developers to evaluate strings as templates inside a template. This is useful to pass a template string as a value to a chart or render external configuration files.
One thing that most people might not know is that YAML is a superset of JSON. This means that any JSON is a valid YAML file! YAML just extends the JSON syntax to provide more features (like comments etc) and alternatives to represent the same data structures.
If .Values.config
contains json then you can use it in your templated secret with
{{ .Values.config | toJson | b64enc | quote }}
It may seem strange to use toJson
to convert JSON to JSON but helm doesn't natively treat it as JSON until you tell it to. See the SO question How do I use json variables in a yaml file (Helm) for an example of doing this.
If you love us? You can donate to us via Paypal or buy me a coffee so we can maintain and grow! Thank you!
Donate Us With