Standardize documentation with headers and archive old files
Applied a unified header format to all documentation files for better status identification, referencing, and ownership tracking. Archived outdated roadmaps, reports, and journal entries. Updated playbooks with new responsibilities, lifecycle rules, and consistent handover formats to align with the new archiving strategy.
This commit is contained in:
@@ -1,12 +1,13 @@
|
||||
# MASTER ROADMAP Q1 2026: "Operation Tracer Bullet"
|
||||
|
||||
**Status:** ACTIVE / SINGLE SOURCE OF TRUTH
|
||||
**Owner:** Lead Software Architect
|
||||
**Letztes Update:** 15.01.2026
|
||||
|
||||
---
|
||||
type: Roadmap
|
||||
status: ACTIVE
|
||||
owner: Lead Architect
|
||||
last_update: 2026-01-15
|
||||
---
|
||||
|
||||
## 1. Strategisches Ziel
|
||||
# MASTER ROADMAP Q1 2026: "Operation Tracer Bullet"
|
||||
|
||||
**Strategisches Ziel:**
|
||||
Wir validieren die gesamte Architektur-Kette (Frontend -> Gateway -> Service -> DB) anhand des **Ping-Service**. Dieser Service dient als **technischer Blueprint** (Vorlage) für alle kommenden Fach-Services. Er muss "Production Ready" gehärtet sein, bevor wir Fachlichkeit implementieren.
|
||||
|
||||
**Aktueller technischer Stand:**
|
||||
|
||||
@@ -1,64 +1,11 @@
|
||||
---
|
||||
type: Roadmap
|
||||
status: ARCHIVED
|
||||
owner: Lead Architect
|
||||
last_update: 2026-01-15
|
||||
---
|
||||
|
||||
# Roadmap Q1 2026: "Operation Tracer Bullet"
|
||||
|
||||
**Status:** Draft
|
||||
**Owner:** Lead Software Architect
|
||||
**Ziel:** Stabilisierung der Architektur und Durchstich ("Tracer Bullet") mit dem `ping-service`.
|
||||
|
||||
---
|
||||
|
||||
## Phase 1: Fundament & Stabilisierung (Woche 1-2)
|
||||
|
||||
Das Ziel dieser Phase ist es, die Entwicklungsumgebung (Build, Docker, Dependencies) so zu stabilisieren, dass alle Entwickler (und Agenten) reibungslos arbeiten können.
|
||||
|
||||
### 1.1 Build-System & Dependencies (Architect)
|
||||
- [ ] **Spring Cloud Fix:** Downgrade von `2025.1.0` (Oakwood) auf `2025.0.1` (Northfields) in `libs.versions.toml` und `platform-bom`.
|
||||
- [ ] **Wasm Build Fix:** Analyse und Behebung der `Worker` / `Unresolved reference` Fehler im Frontend-Build. Ggf. explizite Dependency für `kotlinx-browser` prüfen.
|
||||
- [ ] **Dependency Cleanup:** Entfernen von redundanten Datenbank-Libs (Entscheidung: SQLDelight für KMP Client, Room entfernen wenn nicht genutzt; Exposed im Backend auf `1.0.0-rc-4` heben).
|
||||
- [ ] **Micrometer Upgrade:** Explizites Setzen von Micrometer `1.16.1` für besseren Java 25 Support.
|
||||
|
||||
### 1.2 Infrastruktur & Docker (DevOps)
|
||||
- [ ] **Gateway CircuitBreaker:** Behebung des `ClassNotFoundException` / `NoSuchMethodError` im Gateway (vermutlich Folge des Spring Cloud Konflikts).
|
||||
- [ ] **Docker Stabilität:** Sicherstellen, dass `docker compose up` zuverlässig alle Services (Consul, Keycloak, Postgres) startet und vernetzt.
|
||||
- [ ] **Keycloak Config:** Validierung der Realm-Konfiguration (`meldestelle`) und der Client-Scopes für den `ping-service`.
|
||||
|
||||
---
|
||||
|
||||
## Phase 2: Backend Implementation "Ping" (Woche 2-3)
|
||||
|
||||
Implementierung des ersten vertikalen Durchstichs.
|
||||
|
||||
### 2.1 Modul-Struktur & API (Backend Dev)
|
||||
- [ ] **Refactoring `core-utils`:** Verschieben von JVM-spezifischem Code (`DatabaseUtils`) nach `:backend:infrastructure:persistence`. `core-utils` muss "pure KMP" sein.
|
||||
- [ ] **API Definition:** Erstellung von `:contracts:ping-api` mit KMP-kompatiblen DTOs (`PingResponse`).
|
||||
|
||||
### 2.2 Service Implementation (Backend Dev)
|
||||
- [ ] **Ping Service:** Implementierung von `:backend:services:ping:ping-service` mit Spring Boot 3.5.9.
|
||||
- [ ] **Security:** Integration von OAuth2 Resource Server (Keycloak) und Absicherung des `/secure` Endpoints.
|
||||
- [ ] **Discovery:** Registrierung bei Consul.
|
||||
- [ ] **Observability:** Tracing mit Zipkin und Metrics mit Prometheus aktivieren.
|
||||
|
||||
---
|
||||
|
||||
## Phase 3: Frontend Integration (Woche 3-4)
|
||||
|
||||
Anbindung des Frontends an den neuen Service.
|
||||
|
||||
### 3.1 HTTP Client & Sync (Frontend Expert)
|
||||
- [ ] **Ktor Client:** Konfiguration des HTTP-Clients für die Kommunikation mit dem Gateway (`http://localhost:8080`).
|
||||
- [ ] **Auth:** Implementierung des OIDC-Flows im Frontend (Login via Keycloak), Speichern des Tokens.
|
||||
- [ ] **Integration:** Aufruf von `/api/ping` und `/api/ping/secure` und Anzeige im UI.
|
||||
|
||||
### 3.2 Offline-Sync Basis (Frontend Expert)
|
||||
- [ ] **Sync-Logik:** Erste Implementierung eines Sync-Mechanismus (z.B. Queue für Offline-Requests) basierend auf SQLDelight.
|
||||
|
||||
---
|
||||
|
||||
## Phase 4: Review & Hardening (Woche 4)
|
||||
|
||||
### 4.1 Quality Assurance (QA Specialist)
|
||||
- [ ] **Integrationstests:** Automatisierte Tests, die den gesamten Flow (Frontend -> Gateway -> Service) prüfen.
|
||||
- [ ] **Lasttests:** Einfache Lasttests auf den `ping-service` zur Validierung der Virtual Threads.
|
||||
|
||||
### 4.2 Documentation (Curator)
|
||||
- [ ] **Update Docs:** Aktualisierung der Architektur-Dokumentation basierend auf den Erkenntnissen.
|
||||
- [ ] **Onboarding:** Sicherstellen, dass neue Entwickler das Projekt mit einem Befehl starten können.
|
||||
**MOVED:** This file has been archived to `_archive/2026-01-15_Roadmap_2026_Q1.md`.
|
||||
Please use `MASTER_ROADMAP_2026_Q1.md` as the Single Source of Truth.
|
||||
|
||||
@@ -1,9 +1,11 @@
|
||||
# DEPRECATED
|
||||
|
||||
⚠️ **Dieses Dokument ist veraltet.**
|
||||
|
||||
Bitte nutze ausschließlich die **[MASTER ROADMAP](MASTER_ROADMAP_2026_Q1.md)** für aktuelle Aufgaben und Planung.
|
||||
|
||||
---
|
||||
(Originalinhalt archiviert)
|
||||
...
|
||||
type: Roadmap
|
||||
status: ARCHIVED
|
||||
owner: Lead Architect
|
||||
last_update: 2026-01-15
|
||||
---
|
||||
|
||||
# Roadmap: System Hardening & Stability
|
||||
|
||||
**MOVED:** This file has been archived to `_archive/2026-01-15_Roadmap_System_Hardening.md`.
|
||||
Please use `MASTER_ROADMAP_2026_Q1.md` as the Single Source of Truth.
|
||||
|
||||
@@ -0,0 +1,73 @@
|
||||
---
|
||||
type: Roadmap
|
||||
status: ARCHIVED
|
||||
owner: Lead Architect
|
||||
last_update: 2026-01-15
|
||||
---
|
||||
|
||||
# Roadmap Q1 2026: "Operation Tracer Bullet"
|
||||
|
||||
**Hinweis:** Dieses Dokument ist veraltet. Bitte nutze die `MASTER_ROADMAP_2026_Q1.md` als Single Source of Truth.
|
||||
|
||||
**Status:** Draft
|
||||
**Owner:** Lead Software Architect
|
||||
**Ziel:** Stabilisierung der Architektur und Durchstich ("Tracer Bullet") mit dem `ping-service`.
|
||||
|
||||
---
|
||||
|
||||
## Phase 1: Fundament & Stabilisierung (Woche 1-2)
|
||||
|
||||
Das Ziel dieser Phase ist es, die Entwicklungsumgebung (Build, Docker, Dependencies) so zu stabilisieren, dass alle Entwickler (und Agenten) reibungslos arbeiten können.
|
||||
|
||||
### 1.1 Build-System & Dependencies (Architect)
|
||||
- [ ] **Spring Cloud Fix:** Downgrade von `2025.1.0` (Oakwood) auf `2025.0.1` (Northfields) in `libs.versions.toml` und `platform-bom`.
|
||||
- [ ] **Wasm Build Fix:** Analyse und Behebung der `Worker` / `Unresolved reference` Fehler im Frontend-Build. Ggf. explizite Dependency für `kotlinx-browser` prüfen.
|
||||
- [ ] **Dependency Cleanup:** Entfernen von redundanten Datenbank-Libs (Entscheidung: SQLDelight für KMP Client, Room entfernen wenn nicht genutzt; Exposed im Backend auf `1.0.0-rc-4` heben).
|
||||
- [ ] **Micrometer Upgrade:** Explizites Setzen von Micrometer `1.16.1` für besseren Java 25 Support.
|
||||
|
||||
### 1.2 Infrastruktur & Docker (DevOps)
|
||||
- [ ] **Gateway CircuitBreaker:** Behebung des `ClassNotFoundException` / `NoSuchMethodError` im Gateway (vermutlich Folge des Spring Cloud Konflikts).
|
||||
- [ ] **Docker Stabilität:** Sicherstellen, dass `docker compose up` zuverlässig alle Services (Consul, Keycloak, Postgres) startet und vernetzt.
|
||||
- [ ] **Keycloak Config:** Validierung der Realm-Konfiguration (`meldestelle`) und der Client-Scopes für den `ping-service`.
|
||||
|
||||
---
|
||||
|
||||
## Phase 2: Backend Implementation "Ping" (Woche 2-3)
|
||||
|
||||
Implementierung des ersten vertikalen Durchstichs.
|
||||
|
||||
### 2.1 Modul-Struktur & API (Backend Dev)
|
||||
- [ ] **Refactoring `core-utils`:** Verschieben von JVM-spezifischem Code (`DatabaseUtils`) nach `:backend:infrastructure:persistence`. `core-utils` muss "pure KMP" sein.
|
||||
- [ ] **API Definition:** Erstellung von `:contracts:ping-api` mit KMP-kompatiblen DTOs (`PingResponse`).
|
||||
|
||||
### 2.2 Service Implementation (Backend Dev)
|
||||
- [ ] **Ping Service:** Implementierung von `:backend:services:ping:ping-service` mit Spring Boot 3.5.9.
|
||||
- [ ] **Security:** Integration von OAuth2 Resource Server (Keycloak) und Absicherung des `/secure` Endpoints.
|
||||
- [ ] **Discovery:** Registrierung bei Consul.
|
||||
- [ ] **Observability:** Tracing mit Zipkin und Metrics mit Prometheus aktivieren.
|
||||
|
||||
---
|
||||
|
||||
## Phase 3: Frontend Integration (Woche 3-4)
|
||||
|
||||
Anbindung des Frontends an den neuen Service.
|
||||
|
||||
### 3.1 HTTP Client & Sync (Frontend Expert)
|
||||
- [ ] **Ktor Client:** Konfiguration des HTTP-Clients für die Kommunikation mit dem Gateway (`http://localhost:8080`).
|
||||
- [ ] **Auth:** Implementierung des OIDC-Flows im Frontend (Login via Keycloak), Speichern des Tokens.
|
||||
- [ ] **Integration:** Aufruf von `/api/ping` und `/api/ping/secure` und Anzeige im UI.
|
||||
|
||||
### 3.2 Offline-Sync Basis (Frontend Expert)
|
||||
- [ ] **Sync-Logik:** Erste Implementierung eines Sync-Mechanismus (z.B. Queue für Offline-Requests) basierend auf SQLDelight.
|
||||
|
||||
---
|
||||
|
||||
## Phase 4: Review & Hardening (Woche 4)
|
||||
|
||||
### 4.1 Quality Assurance (QA Specialist)
|
||||
- [ ] **Integrationstests:** Automatisierte Tests, die den gesamten Flow (Frontend -> Gateway -> Service) prüfen.
|
||||
- [ ] **Lasttests:** Einfache Lasttests auf den `ping-service` zur Validierung der Virtual Threads.
|
||||
|
||||
### 4.2 Documentation (Curator)
|
||||
- [ ] **Update Docs:** Aktualisierung der Architektur-Dokumentation basierend auf den Erkenntnissen.
|
||||
- [ ] **Onboarding:** Sicherstellen, dass neue Entwickler das Projekt mit einem Befehl starten können.
|
||||
@@ -0,0 +1,62 @@
|
||||
---
|
||||
type: Roadmap
|
||||
status: ARCHIVED
|
||||
owner: Lead Architect
|
||||
last_update: 2026-01-15
|
||||
---
|
||||
|
||||
# Roadmap: System Hardening & Stability
|
||||
|
||||
**Hinweis:** Dieses Dokument ist veraltet. Die Inhalte wurden in die `MASTER_ROADMAP_2026_Q1.md` integriert.
|
||||
|
||||
**Status:** Draft
|
||||
**Priorität:** Hoch (Blocker für Feature-Entwicklung)
|
||||
|
||||
## 1. Backend & Build System (Architect / Backend Dev)
|
||||
|
||||
### 1.1 Dependency Management
|
||||
- [ ] **Spring Cloud 2025.0.1 Downgrade:**
|
||||
- `libs.versions.toml`: Spring Cloud Version auf `2025.0.1` setzen.
|
||||
- `platform/build.gradle.kts`: BOM Import prüfen.
|
||||
- Ziel: Behebung der `ClassNotFoundException` im Gateway (CircuitBreaker).
|
||||
- [ ] **Micrometer 1.16.1:**
|
||||
- Explizites Upgrade in `libs.versions.toml` für Java 25 Kompatibilität.
|
||||
- [ ] **KMP Database Cleanup:**
|
||||
- Entscheidung: SQLDelight für KMP Client.
|
||||
- Entfernen von Room Dependencies (falls nicht zwingend benötigt).
|
||||
- Exposed Version im Backend prüfen (`0.5x` vs `1.0.0-rc`).
|
||||
|
||||
### 1.2 Modul-Struktur
|
||||
- [ ] **`core-utils` Refactoring:**
|
||||
- Verschieben von `DatabaseUtils` (JVM-Code) aus `core-utils` nach `:backend:infrastructure:persistence`.
|
||||
- Sicherstellen, dass `core-utils` rein `commonMain` kompatibel ist.
|
||||
|
||||
---
|
||||
|
||||
## 2. Infrastructure & DevOps (DevOps Engineer)
|
||||
|
||||
### 2.1 Docker Environment
|
||||
- [ ] **Redis -> Valkey Migration:**
|
||||
- Prüfen, ob wir Redis durch Valkey (Open Source Fork) ersetzen, um Lizenzprobleme zu vermeiden.
|
||||
- Update `docker-compose.yaml`.
|
||||
- [ ] **Keycloak Härtung:**
|
||||
- Export der Realm-Config (`meldestelle-realm.json`) und Mounten im Container (statt manueller Config).
|
||||
- Sicherstellen, dass `frontend-client` korrekte Redirect-URIs für Desktop & Web hat.
|
||||
|
||||
### 2.2 Observability
|
||||
- [ ] **Zipkin Integration:**
|
||||
- Prüfen, ob Traces vom Gateway bis zur DB durchgereicht werden.
|
||||
- Ggf. `micrometer-tracing-bridge-brave` konfigurieren.
|
||||
|
||||
---
|
||||
|
||||
## 3. Frontend (Frontend Expert)
|
||||
|
||||
### 3.1 Build Fixes
|
||||
- [ ] **Wasm Worker Fix:**
|
||||
- Behebung der `Unresolved reference: Worker` Fehler im `composeApp:wasmJsBrowserDistribution` Task.
|
||||
- Prüfen der `kotlinx-browser` Version.
|
||||
|
||||
### 3.2 Auth Integration
|
||||
- [ ] **OIDC Client:**
|
||||
- Implementierung des Login-Flows mit `ktor-client-auth` und Keycloak.
|
||||
Reference in New Issue
Block a user