Zum Inhalt springen
Trainingslager IT-Trainingslager

Tag 5: Status und Readiness

Ziel: Die Instanz zeigt verfügbare Pods, Image und Port. Sie ist erst bereit, wenn notes-api wirklich antwortet, und meldet eigene Conditions. · Dauer: ca. 45 min · Voraussetzung: Tag 4

Briefing

  • Unter schema.status stehen Felder, die kro aus den Objekten ausliest. Die Typen leitet kro aus den Ausdrücken ab und schreibt sie in die CRD.
  • readyWhen an einem Objekt sagt, wann es als bereit gilt. In einer RGD warten alle abhängigen Objekte, bis es so weit ist. readyWhen darf nur auf das eigene Objekt schauen.
  • Eigene Conditions baust du mit runtime.newCondition({type, status, reason, message}). Sobald du welche angibst, gehört die Liste status.conditions dir, und kros vier Standard-Conditions verschwinden daraus. Lesbar bleiben sie über runtime.condition(schema, '…').
  • status.state (ACTIVE, IN_PROGRESS, ERROR …) setzt kro immer selbst.

Drill 1: Status-Felder

mkdir -p ~/kro-lab/tag05
cd ~/kro-lab/tag05
cp ../tag04/notesapp-rgd.yaml .

Füge im Editor direkt unter nodePort: … (gleiche Einrückung wie spec:) den Block status und die Spalten ein:

      nodePort: integer | required=true minimum=30000 maximum=32767
    status:
      availableReplicas: ${deployment.status.?availableReplicas.orValue(0)}
      image: ${deployment.spec.template.spec.containers[0].image}
      port: ${service.spec.ports[0].nodePort}
    additionalPrinterColumns:
      - name: Replicas
        type: integer
        jsonPath: .spec.replicas
      - name: Available
        type: integer
        jsonPath: .status.availableReplicas
      - name: Port
        type: integer
        jsonPath: .status.port
      - name: State
        type: string
        jsonPath: .status.state
  • availableReplicas fehlt im Status eines Deployments, solange kein Pod bereit ist. Deshalb ? und orValue(0).
  • containers[0] liest das erste Element einer Liste.
kubectl apply -f notesapp-rgd.yaml
kubectl get rgd notesapp
kubectl -n app get notesapp

Erwartet:

resourcegraphdefinition.kro.run/notesapp configured
NAME       APIVERSION   KIND       STATE    READY   AGE
notesapp   v1alpha1     NotesApp   Active   True    94s
NAME    REPLICAS   AVAILABLE   PORT    STATE
notes   1          1           30080   ACTIVE

Fortschritt speichern? Kostenlos registrieren

Drill 2: readyWhen

notes-api hat einen Endpunkt /healthz. Eine Readiness-Probe sagt Kubernetes, wann ein Pod Anfragen bekommen darf, und readyWhen sagt kro, wann das ganze Deployment fertig ist.

Ergänze im Container api nach dem env-Block die Probe und hänge an das Objekt deployment (auf Höhe von template:) die Bedingung an:

                          key: apiKey
                  readinessProbe:
                    httpGet:
                      path: /healthz
                      port: 8080
      readyWhen:
        - ${deployment.status.?availableReplicas.orValue(0) == deployment.spec.replicas}
    - id: service
kubectl apply -f notesapp-rgd.yaml
kubectl get rgd notesapp

Erwartet: STATE Active.

Jetzt die kaputte Instanz von gestern, als eigene Instanz:

cat > kaputt.yaml <<'EOF'
apiVersion: lab.example.com/v1alpha1
kind: NotesApp
metadata:
  name: kaputt
  namespace: app
spec:
  image: ghcr.io/thomaszachmann/notes-api:9.9.9
  apiKey: lab-api-key-123
  nodePort: 30081
EOF
kubectl apply -f kaputt.yaml
kubectl -n app get notesapp

Erwartet (nach etwa 30 Sekunden):

NAME     REPLICAS   AVAILABLE   PORT    STATE
kaputt   1          0                   IN_PROGRESS
notes    1          1           30080   ACTIVE

IN_PROGRESS statt ACTIVE. Und PORT ist leer, denn den Service gibt es noch gar nicht:

kubectl -n app get deploy,svc,secret -l kro.run/instance-name=kaputt

Erwartet:

NAME                     READY   UP-TO-DATE   AVAILABLE   AGE
deployment.apps/kaputt   0/1     1            0           31s

NAME                TYPE     DATA   AGE
secret/kaputt-api   Opaque   1      31s

Der Service hängt am Deployment, und das Deployment ist nicht bereit. Also wartet kro. Kein Team bekommt einen Port zu einer App, die nicht läuft.

Fortschritt speichern? Kostenlos registrieren

Drill 3: Eigene Conditions

Warum wartet kaputt? Bisher musst du dafür die Conditions von kro lesen. Besser ist eine Condition, die in Worten sagt, wie viele Pods laufen. Füge unter port: ${service…} ein:

      port: ${service.spec.ports[0].nodePort}
      conditions:
        - |-
          ${runtime.newCondition({
            type: 'Ready',
            status: runtime.condition(schema, 'ResourcesReady').status,
            reason: 'Lifecycle',
            message: runtime.condition(schema, 'ResourcesReady').message
          })}
        - |-
          ${runtime.newCondition({
            type: 'ApiAvailable',
            status: deployment.status.?availableReplicas.orValue(0) > 0 ? 'True' : 'False',
            reason: 'AvailableReplicas',
            message: string(deployment.status.?availableReplicas.orValue(0)) + ' von ' + string(schema.spec.replicas) + ' Pods bereit'
          })}
  • |- ist ein YAML-Block: Der Ausdruck darf über mehrere Zeilen gehen.
  • Strings in CEL stehen hier in einfachen Anführungszeichen. So beißen sie sich nicht mit YAML.
  • Die erste Condition Ready reicht kros eigene Condition ResourcesReady weiter. Ohne sie hätte die Instanz gar kein Ready mehr, und kubectl wait liefe ins Leere.
kubectl apply -f notesapp-rgd.yaml
kubectl -n app get notesapp kaputt \
  -o jsonpath='{range .status.conditions[*]}{.type}={.status} {.reason}: {.message}{"\n"}{end}'

Erwartet:

Ready=False Lifecycle: waiting for unresolved resource: apply "deployment": node
"deployment": readyWhen "deployment.status.?availableReplicas.orValue(0) ==
deployment.spec.replicas" is false: waiting for readiness (executor: node not ready)
ApiAvailable=False AvailableReplicas: 0 von 1 Pods bereit

Eine Zeile reicht jetzt, um zu sehen, woran es hängt: Das Deployment hat keinen fertigen Pod. Bei notes ist alles grün:

kubectl -n app get notesapp notes \
  -o jsonpath='{range .status.conditions[*]}{.type}={.status} {.reason}: {.message}{"\n"}{end}'

Erwartet:

Ready=True Lifecycle: all resources are created and ready
ApiAvailable=True AvailableReplicas: 1 von 1 Pods bereit

Fortschritt speichern? Kostenlos registrieren

Drill 4: Warten wie ein Skript

Weil die Instanz eine Condition Ready hat, funktioniert kubectl wait. Das brauchst du in Pipelines:

kubectl -n app wait notesapp/notes --for=condition=Ready --timeout=60s
kubectl -n app wait notesapp/kaputt --for=condition=Ready --timeout=10s

Erwartet:

notesapp.lab.example.com/notes condition met
error: timed out waiting for the condition on notesapps/kaputt

Fortschritt speichern? Kostenlos registrieren

Kontrollpunkt

kubectl -n app get notesapp notes

Erwartet:

NAME    REPLICAS   AVAILABLE   PORT    STATE
notes   1          1           30080   ACTIVE
kubectl -n app get notesapp notes -o jsonpath='{.status.image}{"\n"}'

Erwartet: ghcr.io/thomaszachmann/notes-api:0.5.1.

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

Erwartet: keine Ausgabe.

Challenge

Repariere kaputt, ohne die Instanz zu löschen, und sieh zu, wie der Service entsteht. Lösche die Instanz danach.

Hinweis: Ohne image greift der Default.

Lösung

kubectl -n app patch notesapp kaputt --type json \
  -p '[{"op":"remove","path":"/spec/image"}]'
kubectl -n app wait notesapp/kaputt --for=condition=Ready --timeout=90s
kubectl -n app get notesapp kaputt
kubectl -n app delete notesapp kaputt

Erwartet:

notesapp.lab.example.com/kaputt patched
notesapp.lab.example.com/kaputt condition met
NAME     REPLICAS   AVAILABLE   PORT    STATE
kaputt   1          1           30081   ACTIVE
notesapp.lab.example.com "kaputt" deleted from app namespace

Sobald das Deployment bereit war, hat kro den Service angelegt und den Port in den Status geschrieben.

Fortschritt speichern? Kostenlos registrieren

Enterprise-Notiz

  • Readiness ist Pflicht: Ohne readyWhen meldet eine Plattform-API „fertig“, nur weil der API-Server ein Objekt angenommen hat. Pipelines, die auf Ready warten, laufen dann ins Leere. Definiere readyWhen für alles, was Zeit braucht.
  • Fachliche Conditions: ApiAvailable sagt dem Team mehr als ResourcesReady. Mit dem Feature Gate InstanceConditionEvents (Tag 12) erzeugt kro bei jedem Wechsel ein Event, und dein Monitoring kann darauf reagieren.
  • Status ist Schnittstelle: Andere RGDs (Tag 10) und Werkzeuge wie Backstage lesen den Status. Benenne Felder so, wie du API-Felder benennen würdest, und ändere sie nicht leichtfertig. Ein entferntes Status-Feld ist ein Breaking Change (Tag 11).