Seminar Crossplane API-Design und Platform Contracts

Inhaltsverzeichnis

1. Seminarüberblick
2. Einordnung und Praxisbezug
3. Schrittweise Seminarinhalte
4. Praxisübungen
5. Zielgruppe und Voraussetzungen

Seminarüberblick

Interne Plattformen werden dauerhaft nur dann akzeptiert, wenn ihre APIs verständlich, stabil und evolvierbar sind. Der Schwerpunkt liegt deshalb nicht auf einzelnen YAML-Dateien, sondern auf der Übersetzung organisatorischer Anforderungen in belastbare technische Verträge.

An einem durchgängigen Beispieldienst entsteht schrittweise eine Plattform-API. Dabei werden Schema, Scope, Standardwerte, Validierungsregeln, Statusmodell, Sicherheitsgrenzen und Upgradepfade so ausgearbeitet, dass Plattformteam und konsumierende Teams unabhängig voneinander arbeiten können.

Einordnung und Praxisbezug

• Trennung zwischen fachlicher Plattform-Schnittstelle und providerabhängigen Implementierungsdetails.
• Nachvollziehbare Entscheidungen zu namespaced oder clusterweitem Scope, Versionen und Kompatibilität.
• Einheitliche Regeln für Composition-Auswahl, Freigabekanäle, Statusinformationen und Secrets.
• Prüfbare API-Verträge als Grundlage für Automatisierung, Governance und Self-Service.

Schrittweise Seminarinhalte

Schritt 1: Plattform-APIs als Produkt definieren

• Konsumentengruppen, Verantwortlichkeiten und Servicegrenzen erfassen.
• Golden Paths, Freiheitsgrade und ausdrücklich nicht unterstützte Varianten festlegen.

Schritt 2: XRDs in der v2-Architektur modellieren

• API-Gruppe, Kind, Plural, Scope und Namensräume konsistent entwerfen.
• Nutzerfelder von Crossplane-Steuerfeldern und Implementierungsdetails trennen.

Schritt 3: OpenAPI-Schemata belastbar ausarbeiten

• Pflichtfelder, Standardwerte, Enumerationen, Formate und Grenzen definieren.
• Fehlermeldungen und Validierung aus Sicht der konsumierenden Teams prüfen.

Schritt 4: Status und Betriebszustände entwerfen

• Synced-, Ready- und fachliche Statusinformationen unterscheiden.
• Statusfelder für Automatisierung, Support und Service-Level nutzbar machen.

Schritt 5: Versionierung und Kompatibilität planen

• Alpha-, Beta- und stabile API-Stufen mit Freigabekriterien verbinden.
• Additive Änderungen, Deprecation, Migrationsfenster und Rückwärtskompatibilität festlegen.

Schritt 6: Compositions kontrolliert auswählen

• Explizite Auswahl, Label-Selektion und erzwungene Compositions vergleichen.
• Revisions- und Channel-Modelle für Entwicklung, Test und Produktion aufbauen.

Schritt 7: Secrets und Verbindungsdaten als Vertrag behandeln

• Ausgabeformate, Besitz, Namensräume und Rotationsanforderungen festlegen.
• Aggregierte Verbindungsdaten über komponierte Secret-Ressourcen modellieren.

Schritt 8: API-Qualität automatisiert prüfen

• Beispielressourcen, Schema-Tests und Rendering-Tests in die Entwicklung integrieren.
• Review-Checklisten und Release-Gates für Plattform-APIs formulieren.

Praxisübungen

1. Entwurf einer namespaced Datenbank-API für mehrere Produktteams.
2. Erstellung und Prüfung eines XRD-Schemas mit Pflichtfeldern, Defaults und Statusfeldern.
3. Simulation einer inkompatiblen Änderung und Entwicklung eines migrationsfähigen Versionspfads.
4. Definition eines Freigabemodells für mehrere Composition-Revisionsstände.

Zielgruppe und Voraussetzungen

Zielgruppe: Platform Engineers, Cloud Architects, Kubernetes-Entwickler, API-Verantwortliche und technische Produktverantwortliche für interne Plattformen.

Voraussetzungen: Sichere Kubernetes-Grundlagen, YAML-Kenntnisse und ein grundlegendes Verständnis von Crossplane-Ressourcen und Compositions.