用于 2 组注释的 Helm 模板

Question

我目前有一个用于部署的 helm 模板，定义为

apiVersion: apps/v1
kind: Deployment
metadata:
  name: demo
  labels:
    {{- include "demo.labels" . | nindent 4 }}
    app.kubernetes.io/component: "server"
spec:
  replicas: {{ .Values.replicaCount }}
  selector:
    matchLabels:
      app.kubernetes.io/name: demo
      app.kubernetes.io/instance: {{ .Release.Name }}
      app.kubernetes.io/component: "server"
  template:
    metadata:
      {{- with .Values.deployment.annotations }}
      annotations:
        {{- toYaml . | nindent 8 }}
      {{- end }}

对于注释，它工作正常，因为我们可以从 values.yml 传递注释。但是，现在我还想在模板中添加一组具有预定义值的保险库注释：

{{- if .Values.vault.enabled -}}
vault.hashicorp.com/agent-inject: {{ .Values.vault.enabled | quote }}
vault.hashicorp.com/agent-cache-enable: "true"
vault.hashicorp.com/agent-cache-use-auto-auth-token: "force"
vault.hashicorp.com/role: {{ .Values.vault.role | quote }}
vault.hashicorp.com/ca-cert: "/run/secrets/kubernetes.io/serviceaccount/ca.crt"
vault.hashicorp.com/agent-init-first: "true"
traffic.sidecar.istio.io/excludeOutboundPorts: "8200"
{{- $systemcontext := .Values.vault.systemcontext -}}
{{- $releasename := .Release.Name -}}
{{- range .Values.vault.secretkeys}}
{{- $secretpath := printf "kv/%s/restricted/%s/%s" $systemcontext $releasename . }}
{{- $annotatefilename := printf "vault.hashicorp.com/agent-inject-secret-%s.yaml" . }}
{{ $annotatefilename }}: {{ $secretpath }}
{{ $annotatefilename }}: |
  {{ printf "%s%s%s" `{{- with secret ` ($secretpath | quote) ` -}}{{ range $k, $v := .Data.data }}{{ $k }}: {{ $v }}
  {{ end }}{{- end -}}`}}
{{- end -}}

即使 vault.enabled=false 或 deployment.annotations 为空值，我如何定义模板才能呈现两组注释？

例如我们的 values.yml:

deployment:
  annotations:
    test-annotation: "hello world"
    test2-annotations: "foo"

vault:
  enabled: true
  role: myrole
  systemcontext: "foo"

谢谢

Answer 1

您可以将附加注释集定义为命名模板，它发出 key: value 对，在第一列对齐。

{{- define "annotations.vault" }}
{{- if .Values.vault.enabled -}}
vault.hashicorp.com/agent-inject: {{ .Values.vault.enabled | quote }}
...
{{ end -}}
{{ end -}}

然后当你需要使用它的时候，你可以使用Helm include扩展来调用它。这个 returns 是一个字符串，所以你可以将它与 indent 组合起来适当地缩进。

您的原始模板代码使用 with 完全跳过 annotations: 块（如果没有任何内容），因此您可以在顶层使用相同的技术。（您需要注意，如果控件被禁用，模板不会发出任何内容，甚至不会发出新行。）

metadata:
  labels: { as: above }
{{- with include "annotations.vault . }}
{{- . | indent 4 }}
{{- end }}

在 pod 规范中，注释可能来自两个地方。创建语法上有效的 annotations: 块的最简单方法是包含人工 key: value 对：

spec:
  template:
    metadata:
      annotations:
        _: '' # meaningless, but forces a YAML dictionary
{{- with .Values.deployment.annotations }}
{{- toYaml . | indent 8 }}
{{- end }}
{{- with include "annotations.vault" . }}
{{- indent 8 . }}
{{- end }}

或者，您可以将两个注释集都捕获到变量中，并以此为基础进行逻辑运算。

spec:
  template:
    metadata:
{{- $a := .Values.deployment.annotations }}
{{/*           if $a    then   (toYaml $a) else "" end */}}
{{- $manual :=    $a | ternary (toYaml $a)      "" }}
{{- $vault := include "annotations.vault" . }}
{{- $annotations := printf "%s%s" $manual $vault }}
{{- with $annotations }}
      annotations: {{- nindent 8 . }}
{{- end }}

用于 2 组注释的 Helm 模板

Helm templating for 2 sets of annotations

kubernetes

hashicorp-vault

kubernetes-helm