agent merge logic does not properly handle booleans

[wmcdona89]

the merge function does not properly handle booleans as true overwrites false - see helm issue 7313

merge

Merge two or more dictionaries into one, giving precedence to the dest dictionary:

the chart uses merge to merge agent into additionalAgents to ensure they at least have the default values

the following boolean values are impacted:
agent.privileged
agent.alwaysPullImage
agent.TTYEnabled

test template

{{- range $name, $additionalAgent := .Values.additionalAgents }}
  {{- $additionalAgent := merge $additionalAgent $.Values.agent }}
  {{- $name }}:
  {{- toYaml $additionalAgent | nindent 2 }}
{{- end }}

given:

values.yaml

agent:
  alwaysPullImage: true
  privileged: true
  TTYEnabled: true
additionalAgents:
  maven:
    alwaysPullImage: false
    privileged: false
    TTYEnabled: false

expected result:

maven:
  alwaysPullImage: false
  privileged: false
  TTYEnabled: false

actual result:

maven:
  alwaysPullImage: true
  privileged: true
  TTYEnabled: true

Fix

using mergeOverwrite with deepCopy resolves the issue...but requires helm v2.16.0 and above
deepCopy was added in sprig v2.22 which was introduced in helm v2.16.0
mergeOverwrite was added in sprig v2.18 which was introduced in helm v2.13.0

mergeOverwrite

Merge two or more dictionaries into one, giving precedence from right to left, effectively overwriting values in the dest dictionary. This is a deep merge operation but not a deep copy operation. Nested objects that are merged are the same instance on both dicts. If you want a deep copy along with the merge than use the deepCopy function along with merging.

deepCopy

The deepCopy function takes a value and makes a deep copy of the value. This includes dicts and other structures.

test template

{{- range $name, $additionalAgent := .Values.additionalAgents }}
  {{- $additionalAgent := mergeOverwrite (deepCopy $.Values.agent) $additionalAgent }}
  {{- $name }}:
  {{- toYaml $additionalAgent | nindent 2 }}
{{- end }}

given:

values.yaml

agent:
  alwaysPullImage: true
  privileged: true
  TTYEnabled: true
additionalAgents:
  maven:
    alwaysPullImage: false
    privileged: false
    TTYEnabled: false

expected result:

maven:
  alwaysPullImage: false
  privileged: false
  TTYEnabled: false

actual result:

maven:
  alwaysPullImage: false
  privileged: false
  TTYEnabled: false

[stale]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Any further update will cause the issue/pull request to no longer be considered stale. Thank you for your contributions.

[stale]

This issue is being automatically closed due to inactivity.