Zum Inhalt springen
Trainingslager IT-Trainingslager

Tag 3: Values und Vorrang

Ziel: Werte aus values.yaml, -f und --set sicher kombinieren, die Listen-Falle umgehen und beim Upgrade genau wissen, welche Werte gelten. · Dauer: ca. 60 min · Voraussetzung: Tag 2

Briefing

  • values.yaml ist Standardkonfiguration und Doku deines Charts.
  • Vorrang von schwach nach stark: values.yaml < -f (links nach rechts) < --set (links nach rechts). Wer zuletzt spricht, gewinnt – aber --set schlägt jede Datei.
  • Maps werden zusammengeführt, Listen komplett ersetzt, null löscht einen Standard.
  • Beim Upgrade entscheidet ein Flag, ob alte Werte weiterleben. Ohne Flag hängt es davon ab, ob du überhaupt Werte angibst.
 values.yaml ──> -f dev.yaml ──> -f geheim.yaml ──> --set a=1 ──> --set a=2
 (schwach)                                                        (stark)

Drill 1: values.yaml als Doku

Das Chart bekommt Werte. Jeder Wert hat einen Kommentar – # -- ist die Konvention, die Werkzeuge wie helm-docs auslesen.

# auf prod
mkdir -p ~/helm/tag03 && cd ~/helm/charts
cat > notes/values.yaml <<'EOF'
# notes/values.yaml – Stand Tag 03

# -- Anzahl der notes-api-Pods
replicaCount: 2

image:
  # -- Image ohne Tag
  repository: ghcr.io/thomaszachmann/notes-api
  # -- Tag des Images
  tag: "0.7.1"

# -- API-Key (nur Labor! Ab Tag 8 aus einem Secret)
apiKey: lab-key-123

# -- Zusätzliche Umgebungsvariablen als Liste
env:
  - name: NOTES_LOG_LEVEL
    value: info
  - name: NOTES_PAGE_SIZE
    value: "20"

service:
  # -- Port des Service
  port: 80
EOF
cat > notes/templates/deployment.yaml <<'EOF'
# notes/templates/deployment.yaml – Stand Tag 03
apiVersion: apps/v1
kind: Deployment
metadata:
  name: notes-api
  labels: {app.kubernetes.io/name: notes-api}
spec:
  replicas: {{ .Values.replicaCount }}
  selector:
    matchLabels: {app.kubernetes.io/name: notes-api}
  template:
    metadata:
      labels: {app.kubernetes.io/name: notes-api}
    spec:
      containers:
        - name: notes-api
          image: "{{ .Values.image.repository }}:{{ .Values.image.tag }}"
          ports: [{name: http, containerPort: 8080}]
          env:
            - name: NOTES_API_KEY
              value: {{ .Values.apiKey | quote }}
            {{- with .Values.env }}
            {{- toYaml . | nindent 12 }}
            {{- end }}
          readinessProbe:
            httpGet: {path: /healthz, port: http}
EOF
sed -i 's/Stand Tag 02/Stand Tag 03/' notes/templates/service.yaml
sed -i 's/port: 80,/port: {{ .Values.service.port }},/' notes/templates/service.yaml
sed -i 's/^version: .*/version: 0.2.0/; s/Tag 02/Tag 03/' notes/Chart.yaml
helm template notes ./notes -s templates/deployment.yaml | sed -n '/env:/,/readiness/p'

Erwartet:

          env:
            - name: NOTES_API_KEY
              value: "lab-key-123"
            - name: NOTES_LOG_LEVEL
              value: info
            - name: NOTES_PAGE_SIZE
              value: "20"
          readinessProbe:

{{ .Values.replicaCount }} holt einen Wert, with, toYaml und nindent lernst du in Tag 4 und 5 genauer. Heute zählt nur: Was landet im YAML?

Fortschritt speichern? Kostenlos registrieren

Drill 2: Wer gewinnt?

# auf prod
cd ~/helm/tag03
printf 'replicaCount: 1\n' > a.yaml
printf 'replicaCount: 3\n' > b.yaml
C=~/helm/charts/notes
helm template notes $C -s templates/deployment.yaml | yq '.spec.replicas'
helm template notes $C -s templates/deployment.yaml -f a.yaml | yq '.spec.replicas'
helm template notes $C -s templates/deployment.yaml -f a.yaml -f b.yaml \
  | yq '.spec.replicas'
helm template notes $C -s templates/deployment.yaml -f b.yaml -f a.yaml \
  | yq '.spec.replicas'
helm template notes $C -s templates/deployment.yaml -f b.yaml --set replicaCount=4 \
  -f a.yaml | yq '.spec.replicas'
helm template notes $C -s templates/deployment.yaml --set replicaCount=4 \
  --set replicaCount=5 | yq '.spec.replicas'

Erwartet:

2
1
3
1
4
5

Bei Dateien gewinnt die rechte. --set gewinnt gegen jede Datei – auch gegen eine, die in der Befehlszeile weiter rechts steht. Unter mehreren --set gewinnt wieder das rechte.

Fortschritt speichern? Kostenlos registrieren

Drill 3: Die Geschwister von –set

Welcher Typ entsteht? Ein Dry-Run gibt den Release als JSON aus, .config sind deine Werte:

# auf prod
printf 'Zeile 1\nZeile 2\n' > motd.txt
helm install x $C --dry-run=client -o json --set a=1 --set b=true --set c=0.7.10 \
  --set d=1.20 --set e=null | jq -c .config
helm install x $C --dry-run=client -o json --set-string a=1,b=true | jq -c .config
helm install x $C --dry-run=client -o json --set hosts=a.example.com,b.example.com
helm install x $C --dry-run=client -o json \
  --set-literal hosts=a.example.com,b.example.com | jq -c .config
helm install x $C --dry-run=client -o json --set 'hosts={a.example.com,b.example.com}' \
  | jq -c .config
helm install x $C --dry-run=client -o json \
  --set-json 'resources={"limits":{"memory":"128Mi"}}' | jq -c .config
helm install x $C --dry-run=client -o json --set-file motd=motd.txt | jq -c .config

Erwartet:

{"a":1,"b":true,"c":"0.7.10","d":"1.20","e":null}
{"a":"1","b":"true"}
Error: INSTALLATION FAILED: failed parsing --set data: key "com" has no value
{"hosts":"a.example.com,b.example.com"}
{"hosts":["a.example.com","b.example.com"]}
{"resources":{"limits":{"memory":"128Mi"}}}
{"motd":"Zeile 1\nZeile 2\n"}
Flag Wirkung
--set Ganzzahlen, true/false und null werden erkannt, alles andere ist String
--set-string immer String
--set-literal der ganze Text ist der Wert, Komma und Punkt ohne Sonderbedeutung
--set-json / --set-file Wert als JSON bzw. aus dem Inhalt einer Datei

Anders als oft behauptet macht --set aus 1.20 keine Zahl – nur ganze Zahlen werden umgewandelt. Das Komma trennt bei --set Zuweisungen; eine Liste schreibst du mit {…}.

Fortschritt speichern? Kostenlos registrieren

Drill 4: Die Listen-Falle

Pfade gehen auch in Listen: env[0].value. Was passiert mit dem Rest der Liste?

# auf prod
Q='.spec.template.spec.containers[0].env'
helm template notes $C -s templates/deployment.yaml --set 'env[0].value=debug' \
  | yq -o json -I0 "$Q"
printf 'env:\n  - name: NOTES_FEATURE_TAGS\n    value: "on"\n' > dev-liste.yaml
helm template notes $C -s templates/deployment.yaml -f dev-liste.yaml \
  | yq -o json -I0 "$Q"

Erwartet:

[{"name":"NOTES_API_KEY","value":"lab-key-123"},{"value":"debug"}]
[{"name":"NOTES_API_KEY","value":"lab-key-123"},
{"name":"NOTES_FEATURE_TAGS","value":"on"}]

Beide Male ist die Liste aus values.yaml weg. --set 'env[0].value=debug' ändert nicht das erste Element, es baut eine neue Liste, deren erstes Element nur noch value hat – ohne name würde Kubernetes das Deployment ablehnen. Die Datei ersetzt die Liste komplett. Ergänzbare Konfiguration gehört in eine Map:

# auf prod
cat > $C/values.yaml <<'EOF'
# notes/values.yaml – Stand Tag 03

# -- Anzahl der notes-api-Pods
replicaCount: 2

image:
  # -- Image ohne Tag
  repository: ghcr.io/thomaszachmann/notes-api
  # -- Tag des Images
  tag: "0.7.1"

# -- API-Key (nur Labor! Ab Tag 8 aus einem Secret)
apiKey: lab-key-123

# -- Zusätzliche Umgebungsvariablen: Name -> Wert (Map, damit -f ergänzen kann)
env:
  NOTES_LOG_LEVEL: info
  NOTES_PAGE_SIZE: "20"

service:
  # -- Port des Service
  port: 80
EOF
cat > $C/templates/deployment.yaml <<'EOF'
# notes/templates/deployment.yaml – Stand Tag 03
apiVersion: apps/v1
kind: Deployment
metadata:
  name: notes-api
  labels: {app.kubernetes.io/name: notes-api}
spec:
  replicas: {{ .Values.replicaCount }}
  selector:
    matchLabels: {app.kubernetes.io/name: notes-api}
  template:
    metadata:
      labels: {app.kubernetes.io/name: notes-api}
    spec:
      containers:
        - name: notes-api
          image: "{{ .Values.image.repository }}:{{ .Values.image.tag }}"
          ports: [{name: http, containerPort: 8080}]
          env:
            - name: NOTES_API_KEY
              value: {{ .Values.apiKey | quote }}
            {{- range $name, $value := .Values.env }}
            - name: {{ $name }}
              value: {{ $value | quote }}
            {{- end }}
          readinessProbe:
            httpGet: {path: /healthz, port: http}
EOF
printf 'env:\n  NOTES_FEATURE_TAGS: "on"\n' > dev-map.yaml
helm template notes $C -s templates/deployment.yaml -f dev-map.yaml \
  | yq -o json -I0 "$Q"
helm template notes $C -s templates/deployment.yaml --set env.NOTES_LOG_LEVEL=debug \
  | yq -o json -I0 "$Q"

Erwartet:

[{"name":"NOTES_API_KEY","value":"lab-key-123"},
{"name":"NOTES_FEATURE_TAGS","value":"on"},{"name":"NOTES_LOG_LEVEL","value":"info"},
{"name":"NOTES_PAGE_SIZE","value":"20"}]
[{"name":"NOTES_API_KEY","value":"lab-key-123"},
{"name":"NOTES_LOG_LEVEL","value":"debug"},{"name":"NOTES_PAGE_SIZE","value":"20"}]

Die Datei ergänzt, --set ändert genau einen Eintrag. range über eine Map läuft alphabetisch sortiert – die Ausgabe bleibt stabil (Tag 5).

Fortschritt speichern? Kostenlos registrieren

Drill 5: null löscht einen Standard

# auf prod
helm template notes $C -s templates/deployment.yaml --set env.NOTES_PAGE_SIZE=null \
  | yq -o json -I0 "$Q"
printf 'env:\n  NOTES_PAGE_SIZE: null\n' > ohne-page.yaml
helm template notes $C -s templates/deployment.yaml -f ohne-page.yaml \
  | yq -o json -I0 "$Q"

Erwartet:

[{"name":"NOTES_API_KEY","value":"lab-key-123"},
{"name":"NOTES_LOG_LEVEL","value":"info"}]
[{"name":"NOTES_API_KEY","value":"lab-key-123"},
{"name":"NOTES_LOG_LEVEL","value":"info"}]

null entfernt den Schlüssel aus dem Ergebnis – nicht „leer“, sondern weg. So schaltet ein Nutzer einen Standard ab, ohne das Chart zu ändern.

Fortschritt speichern? Kostenlos registrieren

Drill 6: Werte pro Umgebung

Gleiches Chart, gleiche Version, verschiedene Werte. Die Dateien liegen im Repo neben dem Chart, nicht darin – sie gehören dem Betrieb, nicht dem Paket.

# auf prod
cd ~/helm/charts && mkdir -p values
cat > values/dev.yaml <<'EOF'
# values/dev.yaml – Stand Tag 03
replicaCount: 1
env:
  NOTES_LOG_LEVEL: debug
  NOTES_FEATURE_TAGS: "on"
EOF
cat > values/prod.yaml <<'EOF'
# values/prod.yaml – Stand Tag 03
replicaCount: 2
env:
  NOTES_LOG_LEVEL: warn
EOF
helm upgrade notes ./notes -n notes -f values/prod.yaml --wait | grep REVISION
helm get values notes -n notes

Erwartet:

REVISION: 2
USER-SUPPLIED VALUES:
env:
  NOTES_LOG_LEVEL: warn
replicaCount: 2

Fortschritt speichern? Kostenlos registrieren

Drill 7: Werte beim Upgrade

Was passiert mit prod.yaml, wenn du beim nächsten Upgrade nur schnell die Replikas änderst? Und was, wenn du gar nichts angibst?

# auf prod
J='{.spec.replicas} {range .spec.template.spec.containers[0].env[*]}'
J="$J{.name}={.value} {end}"
helm upgrade notes ./notes -n notes --set replicaCount=3 --wait | grep REVISION
helm get values notes -n notes
helm upgrade notes ./notes -n notes --wait | grep REVISION
helm get values notes -n notes
kubectl -n notes get deploy notes-api -o jsonpath="$J"; echo

Erwartet:

REVISION: 3
USER-SUPPLIED VALUES:
replicaCount: 3
REVISION: 4
USER-SUPPLIED VALUES:
replicaCount: 3
3 NOTES_API_KEY=lab-key-123 NOTES_LOG_LEVEL=info NOTES_PAGE_SIZE=20

Revision 3: Sobald du irgendeinen Wert angibst, rechnet Helm mit Chart-Standards plus diesem Wert – warn aus prod.yaml ist weg. Revision 4: Gibst du gar keinen Wert an, übernimmt Helm die Werte der letzten deployed-Revision. Die Regel „ohne Flag gelten nur die Standards“ stimmt also nur halb.

Jetzt die drei Flags. Dafür stellst du den Stand wieder her und änderst im Chart einen Standard: Seitengröße 50 statt 20, Version 0.2.1.

# auf prod
helm upgrade notes ./notes -n notes -f values/prod.yaml --set replicaCount=3 --wait \
  | grep REVISION
sed -i 's/^version: 0.2.0/version: 0.2.1/' notes/Chart.yaml
sed -i 's/NOTES_PAGE_SIZE: "20"/NOTES_PAGE_SIZE: "50"/' notes/values.yaml
for f in --reuse-values --reset-then-reuse-values --reset-values; do
  helm upgrade notes ./notes -n notes $f --wait > /dev/null
  echo "$f"; kubectl -n notes get deploy notes-api -o jsonpath="$J"; echo
done

Erwartet:

REVISION: 5
--reuse-values
3 NOTES_API_KEY=lab-key-123 NOTES_LOG_LEVEL=warn NOTES_PAGE_SIZE=20
--reset-then-reuse-values
3 NOTES_API_KEY=lab-key-123 NOTES_LOG_LEVEL=warn NOTES_PAGE_SIZE=50
--reset-values
2 NOTES_API_KEY=lab-key-123 NOTES_LOG_LEVEL=info NOTES_PAGE_SIZE=50
Flag Ergebnis
--reuse-values alte Werte und alte Standards – der neue Standard 50 fehlt
--reset-then-reuse-values neue Standards, darüber deine alten Werte
--reset-values nur die neuen Standards, deine Werte sind weg

--reuse-values ist die Falle: Es nimmt die zusammengeführten Werte des alten Charts. Ein neuer oder geänderter Standard kommt nie an. Am sichersten bleibt: bei jedem Upgrade alle Werte aus Dateien angeben.

# auf prod
helm upgrade notes ./notes -n notes -f values/prod.yaml --wait | grep REVISION
kubectl -n notes get deploy notes-api -o jsonpath="$J"; echo

Erwartet:

REVISION: 9
2 NOTES_API_KEY=lab-key-123 NOTES_LOG_LEVEL=warn NOTES_PAGE_SIZE=50

Fortschritt speichern? Kostenlos registrieren

Übung: Speed-Drills

  1. Zeig alle zusammengeführten Werte des Releases notes. Zeitziel: 10 s
  2. Rendere das Deployment mit 0 Replikas und zeig nur .spec.replicas. Zeitziel: 30 s
  3. Zeig, welche Werte du in Revision 5 gesetzt hattest. Zeitziel: 15 s
  4. Setz NOTES_FEATURE_TAGS auf den String true und beweise den Typ. Zeitziel: 45 s

Lösung

# auf prod
helm get values notes -n notes --all
helm template notes ./notes -s templates/deployment.yaml --set replicaCount=0 \
  | yq .spec.replicas
helm get values notes -n notes --revision 5
helm install x ./notes --dry-run=client -o json \
  --set-string env.NOTES_FEATURE_TAGS=true | jq -c .config

Erwartet (gekürzt):

COMPUTED VALUES:
apiKey: lab-key-123
env:
  NOTES_LOG_LEVEL: warn
  NOTES_PAGE_SIZE: "50"
...
0
USER-SUPPLIED VALUES:
env:
  NOTES_LOG_LEVEL: warn
replicaCount: 3
{"env":{"NOTES_FEATURE_TAGS":"true"}}

Fortschritt speichern? Kostenlos registrieren

Kontrollpunkt

# auf prod
helm list -n notes

Erwartet:

NAME   NAMESPACE  REVISION  UPDATED  STATUS    CHART        APP VERSION
notes  notes      9         ...      deployed  notes-0.2.1  0.7.1
# auf prod
helm get values notes -n notes

Erwartet: genau der Inhalt von values/prod.yaml (NOTES_LOG_LEVEL: warn, replicaCount: 2).

# auf prod
kubectl -n notes get deploy notes-api -o jsonpath="$J"; echo

Erwartet: 2 NOTES_API_KEY=lab-key-123 NOTES_LOG_LEVEL=warn NOTES_PAGE_SIZE=50 ($J stammt aus Drill 7; in einer neuen Shell zuerst die beiden J=-Zeilen ausführen).

Challenge

Ergänze eine Umgebung staging (2 Replikas, Log-Level aus dem Chart, Feature NOTES_FEATURE_TAGS an). Rendere alle drei Umgebungen in einer Schleife mit Replikas und Umgebungsvariablen und installiere dev als Release notes-dev in tag03.

Hinweis: Eine for-Schleife über die Umgebungsnamen und yq mit zwei Ausdrücken.

Lösung

# auf prod
cat > values/staging.yaml <<'EOF'
# values/staging.yaml – Stand Tag 03
replicaCount: 2
env:
  NOTES_FEATURE_TAGS: "on"
EOF
for env in dev staging prod; do echo "== $env"; helm template notes ./notes \
  -f values/$env.yaml -s templates/deployment.yaml | yq '.spec.replicas,
  (.spec.template.spec.containers[0].env[] | .name + "=" + .value)' \
  | grep -v API_KEY; done
helm install notes-dev ./notes -n tag03 --create-namespace -f values/dev.yaml \
  --wait | grep STATUS
kubectl -n tag03 get deploy

Erwartet:

== dev
1
NOTES_FEATURE_TAGS=on
NOTES_LOG_LEVEL=debug
NOTES_PAGE_SIZE=50
== staging
2
NOTES_FEATURE_TAGS=on
NOTES_LOG_LEVEL=info
NOTES_PAGE_SIZE=50
== prod
2
NOTES_LOG_LEVEL=warn
NOTES_PAGE_SIZE=50
STATUS: deployed
NAME        READY   UP-TO-DATE   AVAILABLE   AGE
notes-api   1/1     1            1           3s

Dieselbe Chart-Version wandert durch alle Stufen, nur die Werte wechseln. In CI renderst du jede Umgebung und prüfst sie (Tag 17).

Fortschritt speichern? Kostenlos registrieren

Aufräumen

# auf prod
helm uninstall notes-dev -n tag03
kubectl delete namespace tag03
git add -A
git commit -qm "Tag 03: Values, Werte-Dateien pro Umgebung, notes 0.2.1"

Erwartet:

release "notes-dev" uninstalled
namespace "tag03" deleted

Interview-Notiz

  • In welcher Reihenfolge greifen die Werte? values.yaml des Charts, dann Werte des Eltern-Charts (Tag 9), dann -f von links nach rechts, dann --set von links nach rechts.
  • Warum ist --reuse-values riskant? Es übernimmt die alten Werte samt den alten Chart-Standards. Neue oder geänderte Standards kommen nicht an; --reset-then-reuse-values ist die bessere Wahl.
  • Wie machst du Konfiguration ergänzbar? Maps statt Listen, weil Helm Maps zusammenführt und Listen ersetzt.

Enterprise-Notiz

  • Werte-Dateien pro Umgebung im Git, bei jedem Upgrade alle mitgeben. --set nur für das, was CI erzeugt, etwa einen Image-Tag.
  • Geheimnisse gehören nie in diese Dateien – auch nicht in values.yaml wie hier der Labor-API-Key (Tag 8, 16).
  • helm get values --all vor jedem manuellen Eingriff sichern: Es ist der einzige Nachweis, mit welchen Werten ein Release gerade läuft.
  • GitOps-Werkzeuge rechnen immer mit allen Werten aus dem Repo und umgehen die Upgrade-Fallen von Hand-Upgrades (Tag 18).