Zum Inhalt springen
Trainingslager IT-Trainingslager

Tag 9: Externe Referenzen

Ziel: Die Plattform gibt zentral vor, welches Image alle NotesApps nutzen, und veröffentlicht Ankündigungen. kro liest beides aus fremden ConfigMaps und reagiert sofort auf Änderungen. · Dauer: ca. 45 min · Voraussetzung: Tag 8

Briefing

  • externalRef statt template: kro liest ein vorhandenes Objekt, legt es aber nie an, ändert es nie und löscht es nie.
  • Zwei Formen: mit name genau ein Objekt, mit selector eine Liste aller passenden Objekte.
  • Externe Objekte sind Knoten im Graphen wie alle anderen. Fehlt das Objekt, wartet kro.
  • kro beobachtet externe Objekte. Ändert sich eins, gleicht kro alle betroffenen Instanzen sofort ab.
  • Bei ConfigMaps und Secrets kennt kro die Schlüssel unter data nicht. Du liest sie mit ? und orValue.
 Namespace platform                     Namespace app
 ConfigMap notes-platform ─(image)───►  NotesApp/notes ─► Deployment
 ConfigMaps mit Label     ─(Liste)───►  status.announcements
   notes.lab/announcement=true

Drill 1: Zwei externe Objekte

mkdir -p ~/kro-lab/tag09
cd ~/kro-lab/tag09
cp ../tag08/notesapp-rgd.yaml .

Füge ganz vorn unter resources: (vor - id: secret) ein:

  resources:
    - id: platform
      externalRef:
        apiVersion: v1
        kind: ConfigMap
        metadata:
          name: notes-platform
          namespace: platform
    - id: announcements
      externalRef:
        apiVersion: v1
        kind: ConfigMap
        metadata:
          namespace: platform
          selector:
            matchLabels:
              notes.lab/announcement: "true"
    - id: secret

Ersetze im Deployment beide Zeilen image: ${schema.spec.image} (Init-Container und Container) durch:

                  image: ${platform.data.?image.orValue(schema.spec.image)}

Und ergänze unter checks: im Status:

      checks: ${size(checkJobs)}
      announcements: ${announcements.map(a, a.metadata.name).join(",")}
  • Steht in der Plattform-ConfigMap ein image, gewinnt es. Sonst gilt das Feld der Instanz. Die Plattform kann damit eine Version für alle durchsetzen.
  • announcements ist eine Liste, also funktionieren map und join.
kubectl apply -f notesapp-rgd.yaml
kubectl get rgd notesapp -o jsonpath='{.status.topologicalOrder}{"\n"}'
kubectl -n app get notesapp

Erwartet:

resourcegraphdefinition.kro.run/notesapp configured
["platform","announcements","secret","dbSecret","dbData","database","dbService",
"deployment","service","dbPolicy","budget","checkJobs"]
NAME    REPLICAS   AVAILABLE   PORT    STATE
notes   1          1           30080   ERROR

Ein neues Status-Feld, also wieder die Eigenheit aus Tag 6:

kubectl -n kro-system rollout restart deploy/kro
kubectl -n kro-system rollout status deploy/kro

Fortschritt speichern? Kostenlos registrieren

Drill 2: kro wartet

kubectl -n app get notesapp
kubectl -n app get notesapp notes \
  -o jsonpath='{.status.conditions[?(@.type=="Ready")].message}{"\n"}'

Erwartet:

NAME    REPLICAS   AVAILABLE   PORT   STATE
notes   1                             IN_PROGRESS
waiting for unresolved resource: apply "platform" (ref): external ref ConfigMap
"platform/notes-platform" not found: executor: node not ready

Die ConfigMap gibt es noch nicht, also hält kro den ganzen Graphen an. Die laufenden Pods bleiben unberührt, kro ändert nur nichts mehr. AVAILABLE und PORT sind leer, weil kro die Status-Felder erst wieder schreibt, wenn der Graph vollständig ist.

Fortschritt speichern? Kostenlos registrieren

Drill 3: Die Plattform liefert

Die Plattform-ConfigMap gehört dem Plattform-Team, nicht kro:

kubectl create namespace platform
cat > platform.yaml <<'EOF'
apiVersion: v1
kind: ConfigMap
metadata:
  name: notes-platform
  namespace: platform
data:
  image: ghcr.io/thomaszachmann/notes-api:0.5.1
EOF
kubectl apply -f platform.yaml
kubectl -n app get notesapp
kubectl -n app get notesapp notes -o jsonpath='{.status.image} [{.status.announcements}]{"\n"}'

Erwartet:

namespace/platform created
configmap/notes-platform created
NAME    REPLICAS   AVAILABLE   PORT    STATE
notes   1          1           30080   ACTIVE
ghcr.io/thomaszachmann/notes-api:0.5.1 []

Eine Ankündigung:

cat > wartung.yaml <<'EOF'
apiVersion: v1
kind: ConfigMap
metadata:
  name: wartung
  namespace: platform
  labels:
    notes.lab/announcement: "true"
data:
  text: Samstag 10 Uhr Wartung
EOF
kubectl apply -f wartung.yaml
kubectl -n app get notesapp notes -o jsonpath='{.status.image} [{.status.announcements}]{"\n"}'

Erwartet:

configmap/wartung created
ghcr.io/thomaszachmann/notes-api:0.5.1 [wartung]

Eine neue ConfigMap mit dem richtigen Label, und die Collection ist um ein Element länger. kro hat das ohne Neustart bemerkt.

Fortschritt speichern? Kostenlos registrieren

Drill 4: Eine neue Version für alle

Das Plattform-Team rollt eine neue Version von notes-api aus:

kubectl -n platform patch configmap notes-platform --type merge \
  -p '{"data":{"image":"ghcr.io/thomaszachmann/notes-api:0.6.0-rc.1"}}'
kubectl -n app rollout status deploy/notes
curl -s localhost:30080/version

Erwartet:

configmap/notes-platform patched
Waiting for deployment "notes" rollout to finish: 1 old replicas are pending termination...
deployment "notes" successfully rolled out
0.6.0-rc.1

Keine Änderung an der Instanz, keine Änderung an der RGD. Die Plattform hat eine Zeile in ihrer ConfigMap geändert, und jede NotesApp im Cluster rollt aus. Die Notizen liegen weiter in Postgres:

curl -s localhost:30080/notes

Erwartet:

[{"id":"5953a797-216a-45be-a2f9-fe1e5782a1f4","text":"bleibt erhalten"}]

Zurück auf die getestete Version:

kubectl apply -f platform.yaml
kubectl -n app rollout status deploy/notes

Fortschritt speichern? Kostenlos registrieren

Kontrollpunkt

kubectl -n app get notesapp notes

Erwartet: STATE ACTIVE.

curl -s localhost:30080/version

Erwartet: 0.5.1.

kubectl -n platform get configmap notes-platform --show-labels

Erwartet:

NAME             DATA   AGE   LABELS
notes-platform   1      10m   <none>

Keine kro.run-Labels: kro hat das Objekt nur gelesen, nicht übernommen.

diff notesapp-rgd.yaml ~/kro-lab/code/loesung/tag09/notesapp-rgd.yaml

Erwartet: keine Ausgabe.

Challenge

Lösche die Ankündigung wartung. Was steht danach in status.announcements, und was passiert mit dem Deployment von notes-api?

Hinweis: Eine leere Liste ist auch eine Liste.

Lösung

kubectl -n platform delete configmap wartung
kubectl -n app get notesapp notes -o jsonpath='[{.status.announcements}]{"\n"}'
kubectl -n app get notesapp notes

Erwartet:

configmap "wartung" deleted from platform namespace
[]
NAME    REPLICAS   AVAILABLE   PORT    STATE
notes   1          1           30080   ACTIVE

Eine leere Collection ist kein Fehler. Anders als bei notes-platform wartet kro nicht, denn ein Selector, der nichts findet, ergibt einfach eine leere Liste. Das Deployment bleibt, wie es ist.

Fortschritt speichern? Kostenlos registrieren

Enterprise-Notiz

  • Rechte: kro liest externe Objekte mit seinen eigenen Rechten. Im Modus aggregation (Tag 12) muss kro get, list und watch auf diese Arten haben.
  • Zentrale Vorgaben: Image-Versionen, Speicherklassen, Domains oder Ressourcen- Grenzen gehören in eine Plattform-ConfigMap. Die Teams sehen sie nicht und müssen sich nicht darum kümmern.
  • Vorsicht vor dem großen Knall: Eine Zeile in der Plattform-ConfigMap rollt alle Instanzen gleichzeitig aus. Für echte Rollouts gehört das in Stufen (erst dev, dann prod), etwa mit einer ConfigMap pro Umgebung oder mit GitOps (Tag 14).