Seminar Magda Architektur, Microservices und lokale Entwicklung

Das Seminar vermittelt die interne Architektur von Magda und führt eine lokale Entwicklungsumgebung bis zur lauffähigen, testbaren Änderung. Die Microservices, Datenflüsse, Build-Werkzeuge, Container, Helm-Komponenten und Entwicklungspraktiken werden nicht nur erläutert, sondern in einem zusammenhängenden Entwicklungsprojekt angewendet.

Inhaltsübersicht

1. Architekturüberblick und Systemgrenzen
2. Repository und Build-Struktur
3. Lokale Laufzeitumgebung
4. Registry- und Suchdatenfluss
5. Backend-Änderung entwickeln
6. Frontend-Änderung entwickeln
7. Container, Helm und Auslieferung
8. Test- und Beitragsprozess
9. Praxisübungen und Voraussetzungen

Zielgruppe

Softwarearchitektur, erfahrene Softwareentwicklung, Plattformengineering und technische Leitung.

Lernziele

• Kern- und Erweiterungskomponenten der Magda-Architektur sicher einordnen.
• Lokale Entwicklungs-, Test- und Build-Abläufe reproduzierbar einrichten.
• Servicegrenzen, Datenflüsse und Ereignisketten analysieren.
• Änderungen an Backend oder Frontend strukturiert implementieren und testen.
• Eigene Komponenten für Container- und Helm-basierte Bereitstellung vorbereiten.

Seminarinhalte

1. Architekturüberblick und Systemgrenzen

1. Schritt 1: Gateway, Registry, Suche, Indexer, Authentisierung, Autorisierung, Speicher und Weboberfläche zuordnen.
2. Schritt 2: Synchrone API-Aufrufe und ereignisgetriebene Verarbeitung unterscheiden.
3. Schritt 3: Abhängigkeiten und Fehlerauswirkungen in einem Komponentenmodell dokumentieren.

2. Repository und Build-Struktur

1. Schritt 1: Monorepo, Pakete, Arbeitsbereiche und wiederverwendbare Bibliotheken untersuchen.
2. Schritt 2: Abhängigkeiten installieren und einen kontrollierten Build durchführen.
3. Schritt 3: Build-Fehler anhand von Paketgrenzen und Werkzeugketten eingrenzen.

3. Lokale Laufzeitumgebung

1. Schritt 1: Erforderliche Dienste und Ports vorbereiten.
2. Schritt 2: Lokalen Cluster oder containerisierte Entwicklungsdienste starten.
3. Schritt 3: Gateway, Oberfläche und Kern-APIs mit definierten Prüfschritten verifizieren.

4. Registry- und Suchdatenfluss

1. Schritt 1: Änderungen an Records und Aspects bis zum Ereignisstrom verfolgen.
2. Schritt 2: Indexer-Verarbeitung und Suchindex-Aktualisierung nachvollziehen.
3. Schritt 3: Inkonsistenzen zwischen Registry und Suche systematisch untersuchen.

5. Backend-Änderung entwickeln

1. Schritt 1: Eine kleine Serviceanforderung in Schnittstelle, Validierung und Verarbeitung zerlegen.
2. Schritt 2: Implementierung mit automatisierten Tests absichern.
3. Schritt 3: Fehlerfälle, Protokollierung und Konfigurationsparameter ergänzen.

6. Frontend-Änderung entwickeln

1. Schritt 1: Datenzugriff und Zustandsfluss einer UI-Funktion nachvollziehen.
2. Schritt 2: Eine kleine Oberfläche oder Komponente implementieren.
3. Schritt 3: Barrierefreiheit, Fehlerzustände und automatisierte Prüfungen berücksichtigen.

7. Container, Helm und Auslieferung

1. Schritt 1: Komponente als Container bauen und lokal prüfen.
2. Schritt 2: Konfiguration für die Einbindung in Helm vorbereiten.
3. Schritt 3: Eine Vorschauinstallation durchführen und Rücknahmebedingungen definieren.

8. Test- und Beitragsprozess

1. Schritt 1: Unit-, Integrations- und End-to-End-Prüfungen passend auswählen.
2. Schritt 2: Änderungssatz, Dokumentation und Review-Unterlagen vorbereiten.
3. Schritt 3: Ein reproduzierbares Entwicklungs- und Freigabeverfahren festhalten.

Praxisübungen

• Aufbau einer lokalen Magda-Entwicklungsumgebung mit dokumentierter Prüfung.
• Nachverfolgung einer Metadatenänderung durch Registry, Indexer und Suche.
• Implementierung einer kleinen Backend- oder UI-Erweiterung.
• Containerisierung und Installation der Erweiterung in einer Testumgebung.
• Fehleranalyse eines absichtlich gestörten Serviceverbunds.

Voraussetzungen

Praxis in TypeScript oder einer vergleichbaren Sprache, Git, Containertechnik und grundlegenden Kubernetes-Konzepten. Ein leistungsfähiger Entwicklungsrechner ist erforderlich.