arc42-Architekturdokumentation¶
Diese Dokumentation beschreibt die Architektur der Open Data Infrastruktur Schleswig-Holstein (ODI) nach dem arc42-Standard. arc42 ist ein praxiserprobtes Gliederungsschema für Software-Architekturdokumentation; es strukturiert das Wissen in zwölf Kapitel, die zusammen ein vollständiges Bild des Systems ergeben – von den Qualitätszielen über die Bausteinsicht bis zu den konkreten Architekturentscheidungen.
Die Dokumentation richtet sich an Entwickler:innen, Betreiber:innen und technisch Interessierte aus Verwaltung und Zivilgesellschaft. Sie ergänzt die bestehenden Seiten zur Zielarchitektur und zur Architektur-Übersicht Staging, die einen schnellen Einstieg bieten. Wer sich zum ersten Mal mit der ODI beschäftigt, liest dort zuerst.
Wie man diese Dokumentation liest¶
Für einen ersten strukturierten Überblick empfiehlt sich die Reihenfolge Kapitel 1 → 3 → 4 → 5: Ziele kennen, dann den Kontext verstehen, dann die Lösungsstrategie und schließlich die Bausteine. Kapitel 6 und 7 vertiefen, wie das System zur Laufzeit und in der Infrastruktur aussieht. Kapitel 8 behandelt Konzepte, die quer durch alle Dienste gelten.
Wer gezielt eine Frage hat – zur Deployment-Umgebung, zur Authentifizierung oder zur Entscheidung hinter einer Technologiewahl –, kann direkt in das jeweilige Kapitel einsteigen. Alle Kapitel verlinken aufeinander und auf die übrige Dokumentation.
Kapitelübersicht¶
| # | Titel | Inhalt |
|---|---|---|
| 1 | Einführung und Ziele | Zweck der ODI, Qualitätsziele, Stakeholder |
| 2 | Randbedingungen | Technische, organisatorische und rechtliche Rahmenbedingungen |
| 3 | Kontextabgrenzung | Schnittstellen nach außen – fachlich und technisch |
| 4 | Lösungsstrategie | Architekturprinzipien und grundlegende Entwurfsentscheidungen |
| 5 | Bausteinsicht | Stacks, Dienste und ihre Verantwortlichkeiten (Ebene 1 und 2) |
| 6 | Laufzeitsicht | Abläufe zur Laufzeit: CSV-Upload-Prozess und Authentifizierung |
| 7 | Verteilungssicht | Kubernetes-Cluster, Namespaces und GitOps-Auslieferung |
| 8 | Querschnittliche Konzepte | Identität, Datenformate, Fehlerbehandlung, hexagonale Architektur |
| 9 | Architekturentscheidungen | Die wichtigsten Entwurfsentscheidungen im ADR-Format |
| 10 | Qualitätsanforderungen | Qualitätsziele und konkrete Qualitätsszenarien |
| 11 | Risiken und technische Schulden | Offene Risiken und noch ausstehende Themen |
| 12 | Glossar | Begriffserklärungen zu Fach- und Technikbegriffen der ODI |
Diagramme und Konventionen¶
Alle Architekturdiagramme in dieser Dokumentation folgen einer einheitlichen Farbwelt:
- Dunkelblau (
#003064) – Rahmen, Titelbalken, Bezeichner von ODI-Systemen - Hellblau (
#eaf0f7) – Flächen ODI-eigener Bausteine - Magenta (
#d4004b) – Identitätssystem Keycloak und den Dataport Identity Provider - Weiß mit grauem Rand – externe Systeme und Nachbarsysteme
Jedes Diagramm enthält einen Header mit Titel und Kontext, eine Legende und einen Footer mit Urheberangabe. Ein Klick auf ein Diagramm öffnet es groß und zoombar.