传递值给`range`内的`include`函数，使用合并时的默认值

huangapple
go评论79阅读模式
英文:

Passing values to include function inside range, using defaults with merge

问题

根据您提供的YAML文件，问题在于您的Helm模板逻辑和值的处理方式。特别是在extraContainers的循环中，当您定义了某些值后，这些值会在后续迭代中保留，除非您明确覆盖它们。这是因为Helm模板默认采用逐层覆盖的方式，而不是合并。

要实现您所期望的行为，您可以采取以下步骤：

  1. 修改您的values.yaml文件，将extraContainers的资源值设置为nil，以便在后续迭代中不继承之前的值。如下所示：
  1. extraContainers:
  2.   extra-container2:
  3.     image:
  4.       name: xxx.dkr.ecr.eu-west-1.amazonaws.com/foobar-two
  5.       tag: test
  6.     # 将资源设置为nil
  7.     resources: nil
  8.     command:
  9.       - sleep
  10.       - 10
  11.     envVars:
  12.       - name: FOO
  13.         value: BAR
  14.     probes:
  15.       readinessProbe:
  16.         path: /ContainerTwoReadinessPath
  17.       livenessProbe:
  18.         path: /ContainerTwoLivenessPath
  20.   extra-container3:
  21.     image:
  22.       name: xx.dkr.ecr.eu-west-1.amazonaws.com/foobar-three
  23.       tag: latest
  24.     # 将资源设置为nil
  25.     resources: nil
  26.     command:
  27.       - sleep
  28.       - 10
  29.     envVars:
  30.       - name: FOO
  31.         value: BAZ
  32.     probes:
  33.       readinessProbe:
  34.         enabled: false
  35.       livenessProbe:
  36.         enabled: false
  1. 在您的deployment.yaml模板中，确保在循环中检查资源是否为nil，如果为nil，则使用默认值。如下所示：
  1. {{- range $k, $v := .Values.extraContainers }}
  2. {{- $nameDict := dict "name" $k -}}
  3. {{- include "app.container" (mustMergeOverwrite $.Values.app $nameDict $v) | nindent 8 }}
  4. {{- include "ports" (merge $nameDict $v ) | nindent 8 }}
  5. {{- with $v.resources }}
  6.   resources:
  7.     limits:
  8.       cpu: {{ .limits.cpu | default .cpu | quote }}
  9.       memory: {{ .limits.memory | default .memory | quote }}
  10.     requests:
  11.       cpu: {{ .requests.cpu | default .cpu | quote }}
  12.       memory: {{ .requests.memory | default .memory | quote }}
  13. {{- end }}
  14. {{- end }}

通过将资源设置为nil，您可以确保extra-container3不会继承来自extra-container2的资源值，并且会使用默认的.values.app中的资源值。

英文:

Given this deployment.yaml

  1. apiVersion: apps/v1
  2. kind: Deployment
  3. metadata:
  4.   name: deployment
  5. spec:
  6.   revisionHistoryLimit: 5
  7.   template:
  8.     spec:
  9.       containers:
  10.       {{- include "app.container" (merge .Values.app $) | nindent 8 }}
  11.       {{- include "ports" (merge .Values.app ) | nindent 8 }}
  12.       {{- range $k, $v := .Values.extraContainers }}
  13.       {{- $nameDict := dict "name" $k -}}
  14.         {{- include "app.container" (mustMergeOverwrite $.Values.app $nameDict $v)  | nindent 8 }}
  15.         {{- include "ports" (merge $nameDict $v ) | nindent 8 }}
  16.       {{- end }}

This helpers file...

  1. {{/* vim: set filetype=helm: */}}
  3. {{/*
  4. app container base
  5. */}}
  6. {{- define "app.containerBase" -}}
  7. - name: {{ .name | default "app" }}
  8.   image: {{ .image.name }}:{{ .image.tag }}
  9.   {{- if .command }}
  10.   command:
  11.     {{- range .command }}
  12.     - {{ . | quote }}
  13.     {{- end }}
  14.   {{- end }}
  15.   {{- if .args }}
  16.   args:
  17.     {{- range .args }}
  18.     - {{ . | quote }}
  19.       {{- end }}
  20.   {{- end }}
  21.     {{- range .envVars }}
  22.     - name: {{ .name }}
  23.       {{- with .value }}
  24.       value: {{ . | quote }}
  25.       {{- end }}
  26.       {{- with .valueFrom }}
  27.       valueFrom:
  28.         {{- toYaml . | nindent 8 }}
  29.       {{- end }}
  30.     {{- end }}
  31.   {{- if or .Values.configMaps .Values.secrets .Values.configMapRef }}
  32.   envFrom:
  33.     {{- if .Values.configMaps }}
  34.     - configMapRef:
  35.         name: "{{- include "app.fullname" $ }}"
  36.     {{- end }}
  37.     {{- range .Values.configMapRef }}
  38.     - configMapRef:
  39.         name: {{ . }}
  40.     {{- end }}
  41.     {{- range $name, $idk := $.Values.secrets }}
  42.     - secretRef:
  43.         name: "{{- include "app.fullname" $ }}-{{ $name }}"
  44.     {{- end }}
  45.   {{- end }}
  46. {{- end -}}
  48. {{/*
  49. app container
  50. */}}
  51. {{- define "app.container" -}}
  52. {{- include "app.containerBase" . }}
  53.   resources:
  54.     limits:
  55.       cpu: {{ .resources.limits.cpu | default "100m" | quote }}
  56.       memory: {{ .resources.limits.memory | default "128Mi" | quote }}
  57.       {{- if .resources.limits.ephemeralStorage }}
  58.       ephemeral-storage: {{ .resources.limits.ephemeralStorage }}
  59.       {{- end }}
  60.     requests:
  61.       cpu: {{ .resources.requests.cpu | default "100m" | quote }}
  62.       memory: {{ .resources.requests.memory | default "128Mi" | quote }}
  63.       {{- if .resources.requests.ephemeralStorage }}
  64.       ephemeral-storage: {{ .resources.requests.ephemeralStorage }}
  65.       {{- end }}
  66.   securityContext:
  67.     runAsNonRoot: true
  68.     runAsUser: {{ .securityContext.runAsUser }}
  69.     runAsGroup: {{ .securityContext.runAsGroup }}
  70.     allowPrivilegeEscalation: false
  71. {{- end -}}
  73. {{/*
  74. ports
  75. */}}
  76. {{- define "ports" -}}
  77. {{- if .port }}
  78.   ports:
  79.   - containerPort: {{ .port }}
  80.   protocol: {{ .protocol | default "tcp" | upper }}
  81.   {{- range .extraPorts}}
  82.     - containerPort: {{ required ".port is required." .port }}
  83.     {{- if .name }}
  84.       name: {{ .name }}
  85.     {{- end }}
  86.     {{- if .protocol }}
  87.       protocol: {{ .protocol | upper }}
  88.     {{- end }}
  89.   {{- end }}
  90. {{- end }}
  91. {{- end -}}

This values.yaml

  1. extraContainers:
  2.   extra-container2:
  3.     image:
  4.       name: xxx.dkr.ecr.eu-west-1.amazonaws.com/foobar-two
  5.       tag: test
  6.     command:
  7.       - sleep
  8.       - 10
  9.     envVars:
  10.       - name: FOO
  11.         value: BAR
  12.     probes:
  13.       readinessProbe:
  14.         path: /ContainerTwoReadinessPath
  15.       livenessProbe:
  16.         path: /ContainerTwoLivenessPath
  17.     resources:
  18.       limits:
  19.         cpu: 200Mi
  20.         memory: 2Gi
  21.       requests:
  22.         cpu: 200Mi
  23.         memory: 2Gi
  24.   extra-container3:
  25.     image:
  26.       name: xx.dkr.ecr.eu-west-1.amazonaws.com/foobar-three
  27.       tag: latest
  28.     command:
  29.       - sleep
  30.       - 10
  31.     envVars:
  32.       - name: FOO
  33.         value: BAZ
  34.     probes:
  35.       readinessProbe:
  36.         enabled: false
  37.       livenessProbe:
  38.         enabled: false
  40. app:
  41.   image:
  42.     name: xx.dkr.ecr.eu-west-1.amazonaws.com/foobar
  43.     tag: latest
  44.   probes:
  45.     readinessProbe:
  46.       path: /_readiness
  47.       enabled: true
  48.     livenessProbe:
  49.       path: /_liveness
  50.       enabled: true
  51.   port: 100
  52.   resources:
  53.     limits:
  54.       cpu: 100Mi
  55.       memory: 1Gi
  56.     requests:
  57.       cpu: 100Mi
  58.       memory: 1Gi

Why does helm template result in the below:

  1. ---
  2. # Source: corp-service/templates/deployment.yaml
  3. apiVersion: apps/v1
  4. kind: Deployment
  5. metadata:
  6.   name: deployment
  7. spec:
  8.   revisionHistoryLimit: 5
  9.   template:
  10.     spec:
  11.       containers:
  12.         - name: app
  13.           image: xx.dkr.ecr.eu-west-1.amazonaws.com/foobar:latest
  14.           resources:
  15.             limits:
  16.               cpu: "100Mi"
  17.               memory: "1Gi"
  18.             requests:
  19.               cpu: "100Mi"
  20.               memory: "1Gi"
  21.           securityContext:
  22.             runAsNonRoot: true
  23.             runAsUser: 2000
  24.             runAsGroup: 2000
  25.             allowPrivilegeEscalation: false
  26.         
  27.           ports:
  28.           - containerPort: 100
  29.           protocol: TCP
  30.         - name: extra-container2
  31.           image: xx.dkr.ecr.eu-west-1.amazonaws.com/foobar-two:test
  32.           command:
  33.             - "sleep"
  34.             - "10"
  35.             - name: FOO
  36.               value: "BAR"
  37.           resources:
  38.             limits:
  39.               cpu: "200Mi"
  40.               memory: "2Gi"
  41.             requests:
  42.               cpu: "200Mi"
  43.               memory: "2Gi"
  44.           securityContext:
  45.             runAsNonRoot: true
  46.             runAsUser: 2000
  47.             runAsGroup: 2000
  48.             allowPrivilegeEscalation: false
  49.         
  50.         - name: extra-container3
  51.           image: xx.dkr.ecr.eu-west-1.amazonaws.com/foobar-three:latest
  52.           command:
  53.             - "sleep"
  54.             - "10"
  55.             - name: FOO
  56.               value: "BAZ"
  57.           resources:
  58.             limits:
  59.               cpu: "200Mi"
  60.               memory: "2Gi"
  61.             requests:
  62.               cpu: "200Mi"
  63.               memory: "2Gi"
  64.           securityContext:
  65.             runAsNonRoot: true
  66.             runAsUser: 2000
  67.             runAsGroup: 2000
  68.             allowPrivilegeEscalation: false

i.e why does extra-container3 have resources: set with values from extra-container2 instead of taking them from the default set of resources found under .values.app.

essentially, i want extracontainers to use default values from .values.app unless i explicitly set them inside the extracontainers section. however it seems that if a previous iteration of the loop over extracontainers defines some values, they are used in the next iteration if they are not overriden.

the resources for extra-container3 i am expecting are:

  1. resources:
  2.     limits:
  3.       cpu: 100Mi
  4.       memory: 1Gi
  5.     requests:
  6.       cpu: 100Mi
  7.       memory: 1Gi

what am i doing wrong?

答案1

得分: 3

  1. 所以这里涉及到了一些事情，但大多数情况下答案是 `(mergeMustOverwrite)` **改变** 了 `$dest` 映射，这会导致你的范围“记住”了它所看到的最后一个值，根据你的问题，这并不是你想要的行为。最简单的答案是将 `(deepCopy $.Values.app)` 用作 `$dest`，但由于我们稍后将要讨论的另一个错误，这里有一个星号。
  3. 你看，`(deepCopy $.Values.app)` 会因为你莫名其妙地使用了 `(merge .Values.app $)` 而在 `helm` 中导致堆栈溢出，它会引入 `Chart`、`Files`、`Capabilities` 和整个世界。我猜想你的 `_helpers.tpl` 必须是从别处复制粘贴过来的，这解释了在 `define` 中错误的相对 `.Values` 引用。修复的一种方式是移除 `.Values.configMaps`，这样它将跟踪 `.app` 上下文，就像我猜测你想要的那样，或者你可以将第一个 `(merge)` 更改为人为地创建一个 `"Values": {}` 项，只是为了在尝试引用 `.app.Values.configMaps` 时防止模板崩溃。正确的方法将取决于你的意图，但 `(merge .Values.app $)` 几乎肯定不是它。
  5. 所以，要么：
  7. ```diff
  8. --- a/templates/_helpers.tpl
  9. +++ b/templates/_helpers.tpl
  10. @@ -28,13 +28,13 @@ app container base
  11.          {{- toYaml . | nindent 8 }}
  12.        {{- end }}
  13.      {{- end }}
  14. -  {{- if or .Values.configMaps .Values.secrets .Values.configMapRef }}
  15. +  {{- if or .configMaps .secrets .configMapRef }}
  16.    envFrom:
  17. -    {{- if .Values.configMaps }}
  18. +    {{- if .configMaps }}
  19.      - configMapRef:
  20.          name: "{{- include "app.fullname" $ }}"
  21.      {{- end }}
  22. -    {{- range .Values.configMapRef }}
  23. +    {{- range .configMapRef }}
  24.      - configMapRef:
  25.          name: {{ . }}
  26.      {{- end }}

或者：

  1.        containers:
  2. -      {{- include "app.container" (merge .Values.app $) | nindent 8 }}
  3. +      {{- include "app.container" (merge .Values.app (dict "Values" (dict))) | nindent 8 }}
  4.        {{- include "ports" (merge .Values.app ) | nindent 8 }}
  2. <details>
  3. <summary>英文:</summary>
  5. So there are a couple of things going on here, but mostly the answer is that `(mergeMustOverwrite)` **mutates** the `$dest` map, which causes your range to &quot;remember&quot; the last value it saw, which according to your question isn&#39;t the behavior you want. The simplest answer is to use `(deepCopy $.Values.app)` as the `$dest`, but there&#39;s an asterisk to that due to another bug we&#39;ll cover in a second
  7. ```diff
  8.        {{- $nameDict := dict &quot;name&quot; $k -}}
  9. -        {{- include &quot;app.container&quot; (mustMergeOverwrite $.Values.app $nameDict $v)  | nindent 8 }}
  10. +        {{- include &quot;app.container&quot; (mustMergeOverwrite (deepCopy $.Values.app) $nameDict $v)  | nindent 8 }}
  11.          {{- include &quot;ports&quot; (merge $nameDict $v ) | nindent 8 }}
  12.        {{- end }}

You see, (deepCopy $.Values.app) stack-overflows helm because of your inexplicable use of (merge .Values.app $) drags in Chart, Files, Capabilities and the whole world. I'm guessing your _helpers.tpl must have been copy-pasted from somewhere else, which explains the erroneous relative .Values reference inside that define. One way to fix that is to remove the .Values.configMaps, so it will track the .app context like I expect you meant, or you can change the first (merge) to artificially create a &quot;Values&quot;: {} item just to keep the template from blowing up when in tries to reference .app.Values.configMaps. The correct one will depend on what you were intending, but (merge .Values.app $) is almost certainly not it

so, either:

  1. --- a/templates/_helpers.tpl
  2. +++ b/templates/_helpers.tpl
  3. @@ -28,13 +28,13 @@ app container base
  4.          {{- toYaml . | nindent 8 }}
  5.        {{- end }}
  6.      {{- end }}
  7. -  {{- if or .Values.configMaps .Values.secrets .Values.configMapRef }}
  8. +  {{- if or .configMaps .secrets .configMapRef }}
  9.    envFrom:
  10. -    {{- if .Values.configMaps }}
  11. +    {{- if .configMaps }}
  12.      - configMapRef:
  13.          name: &quot;{{- include &quot;app.fullname&quot; $ }}&quot;
  14.      {{- end }}
  15. -    {{- range .Values.configMapRef }}
  16. +    {{- range .configMapRef }}
  17.      - configMapRef:
  18.          name: {{ . }}
  19.      {{- end }}

or

  1.        containers:
  2. -      {{- include &quot;app.container&quot; (merge .Values.app $) | nindent 8 }}
  3. +      {{- include &quot;app.container&quot; (merge .Values.app (dict &quot;Values&quot; (dict))) | nindent 8 }}
  4.        {{- include &quot;ports&quot; (merge .Values.app ) | nindent 8 }}

huangapple
  • 本文由 发表于 2023年2月18日 03:25:57
  • 转载请务必保留本文链接：https://go.coder-hub.com/75488507.html
  • go-templates
  • kubernetes
  • kubernetes-helm
  • sprig-template-functions
匿名

发表评论

匿名网友

:?: :razz: :sad: :evil: :!: :smile: :oops: :grin: :eek: :shock: :???: :cool: :lol: :mad: :twisted: :roll: :wink: :idea: :arrow: :neutral: :cry: :mrgreen:

确定