Tag 4: Mehrere Ressourcen, ein Graph
Ziel: Die API
NotesApplegt Secret, Deployment und Service für notes-api an. kro leitet die Reihenfolge selbst aus den Ausdrücken ab. · Dauer: ca. 45 min · Voraussetzung: Tag 3
Briefing
- Verweist ein Objekt per
${…}auf ein anderes, entsteht eine Kante im Graphen:${secret.metadata.name}im Deployment heißt „Secret zuerst“. - Aus allen Kanten berechnet kro die topologische Reihenfolge. Angelegt wird in dieser Reihenfolge, gelöscht in der umgekehrten. Die Reihenfolge in der Datei ist egal.
- Ein Kreis (A braucht B, B braucht A) ist verboten. kro lehnt die RGD ab.
- Eine Instanz von
NotesAppersetzt die fünf Befehle von Tag 0.
NotesApp/notes
├─ secret notes-api (apiKey)
├─ deployment notes ◄─ secret.metadata.name
└─ service notes (30080) ◄─ deployment.spec.selector.matchLabels
Drill 1: Die RGD
mkdir -p ~/kro-lab/tag04
cd ~/kro-lab/tag04
cat > notesapp-rgd.yaml <<'EOF'
apiVersion: kro.run/v1alpha1
kind: ResourceGraphDefinition
metadata:
name: notesapp
spec:
schema:
apiVersion: v1alpha1
kind: NotesApp
group: lab.example.com
spec:
image: string | default="ghcr.io/thomaszachmann/notes-api:0.5.1"
replicas: integer | default=1 minimum=1 maximum=5
apiKey: string | required=true minLength=12
nodePort: integer | required=true minimum=30000 maximum=32767
resources:
- id: secret
template:
apiVersion: v1
kind: Secret
metadata:
name: ${schema.metadata.name}-api
stringData:
apiKey: ${schema.spec.apiKey}
- id: deployment
template:
apiVersion: apps/v1
kind: Deployment
metadata:
name: ${schema.metadata.name}
spec:
replicas: ${schema.spec.replicas}
selector:
matchLabels:
app: ${schema.metadata.name}
template:
metadata:
labels:
app: ${schema.metadata.name}
spec:
containers:
- name: api
image: ${schema.spec.image}
ports:
- containerPort: 8080
env:
- name: NOTES_API_KEY
valueFrom:
secretKeyRef:
name: ${secret.metadata.name}
key: apiKey
- id: service
template:
apiVersion: v1
kind: Service
metadata:
name: ${schema.metadata.name}
spec:
type: NodePort
selector: ${deployment.spec.selector.matchLabels}
ports:
- port: 80
targetPort: 8080
nodePort: ${schema.spec.nodePort}
EOF- Das Team setzt nur vier Felder, und zwei davon haben einen Default.
${secret.metadata.name}holt den Namen des Secrets aus dem Objektsecret. Der Name ist derselbe wie${schema.metadata.name}-api, aber der Verweis macht die Abhängigkeit sichtbar.selector: ${deployment.spec.selector.matchLabels}übernimmt eine ganze Map. Der Typ passt, denn beide Felder sindmap[string]string.
kubectl apply -f notesapp-rgd.yaml
kubectl get rgd notesapp -o wideErwartet:
resourcegraphdefinition.kro.run/notesapp created
NAME APIVERSION KIND STATE READY TOPOLOGICALORDER AGE
notesapp v1alpha1 NotesApp Active True ["secret","deployment","service"] 6s
Die Reihenfolge hat kro aus den Verweisen berechnet.
Fortschritt speichern? Kostenlos registrieren
Drill 2: Die Instanz
cat > notes.yaml <<'EOF'
apiVersion: lab.example.com/v1alpha1
kind: NotesApp
metadata:
name: notes
namespace: app
spec:
apiKey: lab-api-key-123
nodePort: 30080
EOF
kubectl apply -f notes.yaml
kubectl -n app get notesapp -wErwartet (mit Strg+C beenden):
notesapp.lab.example.com/notes created
NAME STATE READY AGE
notes 1s
notes ACTIVE True 1s
Neun Zeilen YAML statt fünf Befehlen. Was entstanden ist:
kubectl -n app get deploy,svc,secret -l kro.run/instance-name=notesErwartet:
NAME READY UP-TO-DATE AVAILABLE AGE
deployment.apps/notes 1/1 1 1 25s
NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE
service/notes NodePort 10.43.48.122 <none> 80:30080/TCP 25s
NAME TYPE DATA AGE
secret/notes-api Opaque 1 25s
curl -s localhost:30080/version
curl -s -H "X-API-Key: lab-api-key-123" -d '{"text":"erste Notiz"}' localhost:30080/notes
curl -s localhost:30080/notesErwartet (die ID weicht ab):
0.5.1
{"id":"2378d513-f86b-4e0e-a514-edc8c1809aae","text":"erste Notiz"}
[{"id":"2378d513-f86b-4e0e-a514-edc8c1809aae","text":"erste Notiz"}]
Fortschritt speichern? Kostenlos registrieren
Drill 3: ACTIVE ist nicht gleich bereit
Sieh dir in der Ausgabe von Drill 2 die Zeiten an: Die Instanz war
nach einer Sekunde ACTIVE, das Deployment hatte zu dem
Zeitpunkt aber noch keinen fertigen Pod. Ohne weitere Angaben gilt für
kro ein Objekt als bereit, sobald es angelegt ist.
Probiere es mit einem Image, das es nicht gibt:
kubectl -n app patch notesapp notes --type merge \
-p '{"spec":{"image":"ghcr.io/thomaszachmann/notes-api:9.9.9"}}'
kubectl -n app get notesapp notes
kubectl -n app get podsErwartet:
notesapp.lab.example.com/notes patched
NAME STATE READY AGE
notes ACTIVE True 3m
NAME READY STATUS RESTARTS AGE
notes-6d8b7f5c9-2kq4x 0/1 ErrImagePull 0 8s
notes-86b5dd7468-lsqd9 1/1 Running 0 3m
Die Instanz meldet ACTIVE, obwohl der neue Pod nie
startet. Das behebst du an Tag 5. Vorerst das Image zurück:
kubectl -n app patch notesapp notes --type json \
-p '[{"op":"remove","path":"/spec/image"}]'Ohne image greift wieder der Default aus dem Schema.
Fortschritt speichern? Kostenlos registrieren
Drill 4: Ein Kreis
Was passiert, wenn das Deployment den Namen des Service wissen will? Lege eine zweite RGD an. Statt die ganze Datei abzutippen, kopierst du sie und änderst drei Stellen im Editor:
cp notesapp-rgd.yaml zyklus.yamlname: notesapp→name: notesapp-zykluskind: NotesApp→kind: NotesAppZyklus- im Container über
- name: NOTES_API_KEYzwei Zeilen einfügen:
env:
- name: NOTES_SVC
value: ${service.metadata.name}
- name: NOTES_API_KEY
kubectl apply -f zyklus.yaml
kubectl get rgd notesapp-zyklus \
-o jsonpath='{.status.state}: {.status.conditions[?(@.type=="GraphAccepted")].message}{"\n"}'Erwartet:
resourcegraphdefinition.kro.run/notesapp-zyklus created
Inactive: failed to build dependency graph: graph contains a cycle: service ->
deployment -> service
Der Service braucht den Selector des Deployments, das Deployment den
Namen des Service. Eine Reihenfolge gibt es nicht. Brauchst du den Namen
wirklich, schreibst du ihn als Text
(${schema.metadata.name}), der hängt von keinem Objekt
ab.
kubectl delete -f zyklus.yamlFortschritt speichern? Kostenlos registrieren
Kontrollpunkt
kubectl get rgd notesapp -o wideErwartet: Active, TOPOLOGICALORDER
["secret","deployment","service"].
kubectl -n app get notesappErwartet:
NAME STATE READY AGE
notes ACTIVE True 6m
curl -s localhost:30080/versionErwartet: 0.5.1.
diff notesapp-rgd.yaml ~/kro-lab/code/loesung/tag04/notesapp-rgd.yamlErwartet: keine Ausgabe.
Challenge
Skaliere notes auf drei Replikas, aber nicht am
Deployment, sondern an der Instanz. Was passiert, wenn du danach das
Deployment von Hand auf eine Replika setzt?
Hinweis: Tag 1, Drill 5.
Lösung
kubectl -n app patch notesapp notes --type merge -p '{"spec":{"replicas":3}}'
kubectl -n app get deploy notes
kubectl -n app scale deploy notes --replicas=1
kubectl -n app get deploy notesErwartet:
notesapp.lab.example.com/notes patched
NAME READY UP-TO-DATE AVAILABLE AGE
notes 3/3 3 3 7m
deployment.apps/notes scaled
NAME READY UP-TO-DATE AVAILABLE AGE
notes 3/3 3 3 7m
kro setzt replicas sofort wieder auf den Wert der
Instanz. Zurück auf eins:
kubectl -n app patch notesapp notes --type merge -p '{"spec":{"replicas":1}}'Fortschritt speichern? Kostenlos registrieren
Enterprise-Notiz
- Schlanke API: Gib dem Team nur die Felder, die es wirklich entscheiden soll. Alles andere (Probes, Ressourcen, Sicherheitskontext) legt die Plattform in der RGD fest.
- Secrets in der Instanz: Ein API-Key im
speceiner Instanz steht im Klartext in etcd und in jedemkubectl get -o yaml. Fürs Lab ist das in Ordnung. Im Betrieb kommen Geheimnisse aus einem Secret-Manager (siehe „OpenBao-Secrets zum Anfassen“) oder werden erzeugt (Tag 6). - Wer wird gewinnen? Ein HorizontalPodAutoscaler und
kro würden sich um
replicasstreiten. Feld weglassen (Feature GateCELOmitFunction, Tag 12) oder den Autoscaler gar nicht erst anbieten.