docs: align versions and update update-service docs

This commit is contained in:
2026-01-15 08:40:54 +01:00
parent 589f9595f4
commit c41482a7b3
89 changed files with 266 additions and 104 deletions

View File

@ -1,4 +1,4 @@
ID: EPIC_000001 | Version: 0.1.0 | Status: Final
ID: EPIC_000001 | Version: 0.2.1 | Status: Final
By: Codex (GPT-5)
# EPIC_000001: Legacy CLI Account Control (sk.sh)

View File

@ -1,4 +1,4 @@
ID: EPIC_000002 | Version: 0.1.0 | Status: Final
ID: EPIC_000002 | Version: 0.2.1 | Status: Final
By: Codex (GPT-5)
# EPIC_000002: Backend API Service

View File

@ -1,4 +1,4 @@
ID: EPIC_000003 | Version: 0.1.0 | Status: Final
ID: EPIC_000003 | Version: 0.2.1 | Status: Final
By: Codex (GPT-5)
# EPIC_000003: Authentication & Sessions

View File

@ -1,4 +1,4 @@
ID: EPIC_000004 | Version: 0.1.0 | Status: Final
ID: EPIC_000004 | Version: 0.2.1 | Status: Final
By: Codex (GPT-5)
# EPIC_000004: Web UI

View File

@ -1,4 +1,4 @@
ID: EPIC_000005 | Version: 0.1.0 | Status: Final
ID: EPIC_000005 | Version: 0.2.1 | Status: Final
By: Codex (GPT-5)
# EPIC_000005: Automation Scripts

View File

@ -1,4 +1,4 @@
ID: EPIC_000006 | Version: 0.1.0 | Status: Final
ID: EPIC_000006 | Version: 0.2.1 | Status: Final
By: Codex (GPT-5)
# EPIC_000006: Systemd & Deployment Artifacts

View File

@ -1,4 +1,4 @@
ID: EPIC_000007 | Version: 0.1.0 | Status: Final
ID: EPIC_000007 | Version: 0.2.1 | Status: Final
By: Codex (GPT-5)
# EPIC_000007: Documentation & Runbook

View File

@ -1,4 +1,4 @@
ID: EPIC_000008 | Version: 0.1.0 | Status: Draft
ID: EPIC_000008 | Version: 0.2.1 | Status: Draft
By: Codex (GPT-5)
# EPIC_000008: Client-Side Update Mechanism

View File

@ -1,4 +1,4 @@
ID: EPIC_000009 | Version: 0.1.0 | Status: Draft
ID: EPIC_000009 | Version: 0.2.1 | Status: Draft
By: Codex (GPT-5)
# EPIC_000009: Update Webservice (External Team)

View File

@ -1,4 +1,4 @@
ID: EPIC_000010 | Version: 0.1.5 | Status: Done
ID: EPIC_000010 | Version: 0.2.1 | Status: Done
By: Codex (GPT-5)
# EPIC_000010: Update-Service v1 Migration (Major Release)

View File

@ -0,0 +1,43 @@
ID: EPIC_000011 | Version: 0.2.1 | Status: Done
By: Codex (GPT-5)
# EPIC_000011: Documentation and Configuration Alignment
## Beschreibung
Konsolidierung der Dokumentation, Beispiel-Konfigurationen und Ops-Hinweise mit dem
aktuellen Code-Stand, inklusive Version-Synchronisierung mit der zentralen VERSION.
## Ziel / Business Value
Reduziert Integrationsfehler, sorgt fuer konsistente Bedienung und verringert Support-Aufwand.
## Mission Statement
Stelle sicher, dass Dokumente, Beispiele und Automationshinweise den realen API- und
Konfigurationsstand widerspiegeln.
## Business Value & Metriken
- Weniger Fehlkonfigurationen durch korrekte ENV-Keys und Auth-Header.
- Erfolgsmetrik: 0 bekannte Abweichungen zwischen Code und Doku in den Update/Health-Flows.
## In-Scope (Kiddo Team)
- Doku-Versionen auf VERSION ziehen.
- Update-API Doku inkl. /update/enroll und Response-Feldern aktualisieren.
- ENV-Beispiele und Makefile-Healthcheck auf aktuelle Auth-Mechanik angleichen.
## Out-of-Scope
- Funktionale Aenderungen am Auth-Flow im Backend.
- Erweiterte Validierung durch Integrationstests.
## High-Level Akzeptanzkriterien
- Doku-Header nutzen die aktuelle VERSION.
- Update-API-Doku listet alle implementierten Update-Endpunkte.
- ENV-Beispiele nutzen die im Code verwendeten Update-Variablen.
- Healthcheck-Beispiel nutzt Authorization: Bearer.
## Technische Constraints & Risiken
- Dokumentation darf keine falschen Defaults oder veraltete Endpunkte nennen.
- Audit kann weitere Abweichungen aufdecken und Folgetickets noetig machen.
## Zugeordnete User Stories
- US_000036: Doku-Versionen auf VERSION synchronisieren
- US_000037: Update-API-Doku mit /update/enroll und Response-Feldern abgleichen
- US_000038: ENV-Beispiele und Makefile-Healthcheck an Auth/Update-Config angleichen

View File

@ -1,4 +1,4 @@
ID: US_000001 | Version: 0.1.0 | Status: Final
ID: US_000001 | Version: 0.2.1 | Status: Final
By: Codex (GPT-5)
# US_000001: Nutzerkonto per CLI deaktivieren

View File

@ -1,4 +1,4 @@
ID: US_000002 | Version: 0.1.0 | Status: Final
ID: US_000002 | Version: 0.2.1 | Status: Final
By: Codex (GPT-5)
# US_000002: Nutzerkonto per CLI aktivieren

View File

@ -1,4 +1,4 @@
ID: US_000003 | Version: 0.1.0 | Status: Final
ID: US_000003 | Version: 0.2.1 | Status: Final
By: Codex (GPT-5)
# US_000003: Health-Status abfragen

View File

@ -1,4 +1,4 @@
ID: US_000004 | Version: 0.1.0 | Status: Final
ID: US_000004 | Version: 0.2.1 | Status: Final
By: Codex (GPT-5)
# US_000004: Verfuegbare Nutzer auflisten

View File

@ -1,4 +1,4 @@
ID: US_000005 | Version: 0.1.0 | Status: Final
ID: US_000005 | Version: 0.2.1 | Status: Final
By: Codex (GPT-5)
# US_000005: Nutzer per API deaktivieren

View File

@ -1,4 +1,4 @@
ID: US_000006 | Version: 0.1.0 | Status: Final
ID: US_000006 | Version: 0.2.1 | Status: Final
By: Codex (GPT-5)
# US_000006: Nutzer per API aktivieren

View File

@ -1,4 +1,4 @@
ID: US_000007 | Version: 0.1.0 | Status: Final
ID: US_000007 | Version: 0.2.1 | Status: Final
By: Codex (GPT-5)
# US_000007: PAM-Login mit Token

View File

@ -1,4 +1,4 @@
ID: US_000008 | Version: 0.1.0 | Status: Final
ID: US_000008 | Version: 0.2.1 | Status: Final
By: Codex (GPT-5)
# US_000008: OIDC-Login Flow

View File

@ -1,4 +1,4 @@
ID: US_000009 | Version: 0.1.0 | Status: Final
ID: US_000009 | Version: 0.2.1 | Status: Final
By: Codex (GPT-5)
# US_000009: Autorisierung und /me-Identitaet

View File

@ -1,4 +1,4 @@
ID: US_000010 | Version: 0.1.0 | Status: Final
ID: US_000010 | Version: 0.2.1 | Status: Final
By: Codex (GPT-5)
# US_000010: Index-Seite ausliefern

View File

@ -1,4 +1,4 @@
ID: US_000011 | Version: 0.1.0 | Status: Final
ID: US_000011 | Version: 0.2.1 | Status: Final
By: Codex (GPT-5)
# US_000011: Virtualenv und Abhaengigkeiten erstellen

View File

@ -1,4 +1,4 @@
ID: US_000012 | Version: 0.1.0 | Status: Final
ID: US_000012 | Version: 0.2.1 | Status: Final
By: Codex (GPT-5)
# US_000012: Service lokal starten

View File

@ -1,4 +1,4 @@
ID: US_000013 | Version: 0.1.0 | Status: Final
ID: US_000013 | Version: 0.2.1 | Status: Final
By: Codex (GPT-5)
# US_000013: Service installieren

View File

@ -1,4 +1,4 @@
ID: US_000014 | Version: 0.1.0 | Status: Final
ID: US_000014 | Version: 0.2.1 | Status: Final
By: Codex (GPT-5)
# US_000014: Service aktualisieren

View File

@ -1,4 +1,4 @@
ID: US_000015 | Version: 0.1.0 | Status: Final
ID: US_000015 | Version: 0.2.1 | Status: Final
By: Codex (GPT-5)
# US_000015: Remote-Deployment durchfuehren

View File

@ -1,4 +1,4 @@
ID: US_000016 | Version: 0.1.0 | Status: Final
ID: US_000016 | Version: 0.2.1 | Status: Final
By: Codex (GPT-5)
# US_000016: OIDC-Client registrieren

View File

@ -1,4 +1,4 @@
ID: US_000017 | Version: 0.1.0 | Status: Final
ID: US_000017 | Version: 0.2.1 | Status: Final
By: Codex (GPT-5)
# US_000017: Systemd-Unit im Repo

View File

@ -1,4 +1,4 @@
ID: US_000018 | Version: 0.1.0 | Status: Final
ID: US_000018 | Version: 0.2.1 | Status: Final
By: Codex (GPT-5)
# US_000018: Konfigurations-Templates verfuegbar

View File

@ -1,4 +1,4 @@
ID: US_000019 | Version: 0.1.0 | Status: Final
ID: US_000019 | Version: 0.2.1 | Status: Final
By: Codex (GPT-5)
# US_000019: Deployment-Archiv vorhanden

View File

@ -1,4 +1,4 @@
ID: US_000020 | Version: 0.1.0 | Status: Final
ID: US_000020 | Version: 0.2.1 | Status: Final
By: Codex (GPT-5)
# US_000020: Makefile-Automation bereitstellen

View File

@ -1,4 +1,4 @@
ID: US_000021 | Version: 0.1.0 | Status: Final
ID: US_000021 | Version: 0.2.1 | Status: Final
By: Codex (GPT-5)
# US_000021: Konfiguration per ENV steuern

View File

@ -1,4 +1,4 @@
ID: US_000022 | Version: 0.1.0 | Status: Final
ID: US_000022 | Version: 0.2.1 | Status: Final
By: Codex (GPT-5)
# US_000022: Web-UI Aktionen ausfuehren

View File

@ -1,4 +1,4 @@
ID: US_000023 | Version: 0.1.0 | Status: Final
ID: US_000023 | Version: 0.2.1 | Status: Final
By: Codex (GPT-5)
# US_000023: Runbook und Security-Hinweise dokumentieren

View File

@ -1,4 +1,4 @@
ID: US_000024 | Version: 0.1.0 | Status: Done
ID: US_000024 | Version: 0.2.1 | Status: Done
By: Codex (GPT-5)
# US_000024: Watchtower Theme fuer Web-UI

View File

@ -1,4 +1,4 @@
ID: US_000025 | Version: 0.1.0 | Status: Draft
ID: US_000025 | Version: 0.2.1 | Status: Draft
By: Codex (GPT-5)
# US_000025: OIDC End-to-End Validierung und Runbook

View File

@ -1,4 +1,4 @@
ID: US_000026 | Version: 0.1.0 | Status: Done
ID: US_000026 | Version: 0.2.1 | Status: Done
By: Codex (GPT-5)
# US_000026: Client bezieht Updates (Pull)

View File

@ -1,4 +1,4 @@
ID: US_000027 | Version: 0.1.0 | Status: Done
ID: US_000027 | Version: 0.2.1 | Status: Done
By: Codex (GPT-5)
# US_000027: Client verifiziert und wendet Updates an

View File

@ -1,4 +1,4 @@
ID: US_000028 | Version: 0.1.0 | Status: Done
ID: US_000028 | Version: 0.2.1 | Status: Done
By: Codex (GPT-5)
# US_000028: Client meldet Update-Status

View File

@ -1,4 +1,4 @@
ID: US_000029 | Version: 0.1.0 | Status: Done
ID: US_000029 | Version: 0.2.1 | Status: Done
By: Codex (GPT-5)
# US_000029: Update-Status im Web-UI anzeigen

View File

@ -1,4 +1,4 @@
ID: US_000030 | Version: 0.1.0 | Status: Done
ID: US_000030 | Version: 0.2.1 | Status: Done
By: Codex (GPT-5)
# US_000030: Update-Check im Web-UI ausloesen

View File

@ -1,4 +1,4 @@
ID: US_000031 | Version: 0.1.0 | Status: Done
ID: US_000031 | Version: 0.2.1 | Status: Done
By: Codex (GPT-5)
# US_000031: Update im Web-UI anstossen

View File

@ -1,4 +1,4 @@
ID: US_000032 | Version: 0.1.0 | Status: Done
ID: US_000032 | Version: 0.2.1 | Status: Done
By: Codex (GPT-5)
# US_000032: Update-Logs im Web-UI anzeigen

View File

@ -1,4 +1,4 @@
ID: US_000033 | Version: 0.1.0 | Status: Done
ID: US_000033 | Version: 0.2.1 | Status: Done
By: Codex (GPT-5)
# US_000033: Rollback im Web-UI anstossen

View File

@ -1,4 +1,4 @@
ID: US_000034 | Version: 0.1.5 | Status: Done
ID: US_000034 | Version: 0.2.1 | Status: Done
By: Codex (GPT-5)
# US_000034: Enrollment fuer Langzeit-Token

View File

@ -1,4 +1,4 @@
ID: US_000035 | Version: 0.1.5 | Status: Done
ID: US_000035 | Version: 0.2.1 | Status: Done
By: Codex (GPT-5)
# US_000035: v1 Update-Endpoints und Status-Schema

View File

@ -0,0 +1,13 @@
ID: US_000036 | Version: 0.2.1 | Status: Done
By: Codex (GPT-5)
# US_000036: Doku-Versionen auf VERSION synchronisieren
Als Maintainer moechte ich, dass Doku-Header und Spezifikationen die zentrale VERSION
verwenden, damit Releases konsistent dokumentiert sind.
## Akzeptanzkriterien
- Given die VERSION ist 0.2.1
- When Doku-Header oder OpenAPI-Info Versionen angegeben sind
- Then entsprechen sie 0.2.1
- And es gibt keine widerspruechlichen 0.1.0-Header in den betroffenen Doku-Dateien

View File

@ -0,0 +1,14 @@
ID: US_000037 | Version: 0.2.1 | Status: Done
By: Codex (GPT-5)
# US_000037: Update-API-Doku mit /update/enroll abgleichen
Als Betreiber moechte ich eine korrekte Update-API-Dokumentation, damit Clients die
Update-Endpunkte inkl. Enrollment korrekt nutzen.
## Akzeptanzkriterien
- Given die Backend-API implementiert /update/enroll
- When die Update-API-Doku gelesen wird
- Then /update/enroll ist beschrieben (Request und Response)
- And /update/status enthaelt das Feld enrolled
- And /update/logs beschreibt die aktuellen Felder (timestamp, status, message, version, device_id, error)

View File

@ -0,0 +1,14 @@
ID: US_000038 | Version: 0.2.1 | Status: Done
By: Codex (GPT-5)
# US_000038: ENV-Beispiele und Healthcheck-Auth angleichen
Als Operator moechte ich, dass ENV-Beispiele und Healthcheck-Header mit dem aktuellen
Auth- und Update-Config-Stand uebereinstimmen, damit Deployments nicht scheitern.
## Akzeptanzkriterien
- Given das Backend akzeptiert Authorization: Bearer Tokens
- When der Healthcheck aus dem Makefile ausgefuehrt wird
- Then wird der Header Authorization: Bearer verwendet
- And env.example/README listen SKD_UPDATE_SERVICE_URL und SKD_UPDATE_PROJECT_ID
- And nicht verwendete Update-Variablen werden nicht als Pflicht-Keys aufgefuehrt

View File

@ -0,0 +1,14 @@
ID: US_000039 | Version: 0.2.1 | Status: Done
By: Codex (GPT-5)
# US_000039: Doku-Audit fuer verbleibende Abweichungen
Als Maintainer moechte ich eine systematische Pruefung der verbleibenden Doku-Dateien,
damit keine Versions- oder Inhaltsabweichungen zwischen Code und Dokumentation bestehen.
## Akzeptanzkriterien
- Given die zentrale VERSION ist bekannt
- When alle Doku-Dateien geprueft werden
- Then sind Header-Versionen konsistent mit VERSION
- And API-/ENV-Beschreibungen entsprechen dem aktuellen Code-Stand
- And Abweichungen sind dokumentiert oder korrigiert

View File

@ -1,4 +1,4 @@
ID: TASK_000025 | Version: 0.1.0 | Status: Blocked
ID: TASK_000025 | Version: 0.2.1 | Status: Blocked
By: Codex (GPT-5)
# TASK_000025: OIDC E2E validation

View File

@ -1,4 +1,4 @@
ID: TASK_000026 | Version: 0.1.0 | Status: Blocked
ID: TASK_000026 | Version: 0.2.1 | Status: Blocked
By: Codex (GPT-5)
# TASK_000026: OIDC runbook update

View File

@ -1,4 +1,4 @@
ID: TASK_000027 | Version: 0.1.0 | Status: Done
ID: TASK_000027 | Version: 0.2.1 | Status: Done
By: Codex (GPT-5)
# TASK_000027: Update endpoint config

View File

@ -1,4 +1,4 @@
ID: TASK_000028 | Version: 0.1.0 | Status: Done
ID: TASK_000028 | Version: 0.2.1 | Status: Done
By: Codex (GPT-5)
# TASK_000028: Verify and apply update

View File

@ -1,4 +1,4 @@
ID: TASK_000029 | Version: 0.1.0 | Status: Done
ID: TASK_000029 | Version: 0.2.1 | Status: Done
By: Codex (GPT-5)
# TASK_000029: Report update status

View File

@ -1,4 +1,4 @@
ID: TASK_000030 | Version: 0.1.0 | Status: Done
ID: TASK_000030 | Version: 0.2.1 | Status: Done
By: Codex (GPT-5)
# TASK_000030: UI update status view

View File

@ -1,4 +1,4 @@
ID: TASK_000031 | Version: 0.1.0 | Status: Done
ID: TASK_000031 | Version: 0.2.1 | Status: Done
By: Codex (GPT-5)
# TASK_000031: UI update check trigger

View File

@ -1,4 +1,4 @@
ID: TASK_000032 | Version: 0.1.0 | Status: Done
ID: TASK_000032 | Version: 0.2.1 | Status: Done
By: Codex (GPT-5)
# TASK_000032: UI update apply action

View File

@ -1,4 +1,4 @@
ID: TASK_000033 | Version: 0.1.0 | Status: Done
ID: TASK_000033 | Version: 0.2.1 | Status: Done
By: Codex (GPT-5)
# TASK_000033: UI update logs view

View File

@ -1,4 +1,4 @@
ID: TASK_000034 | Version: 0.1.0 | Status: Done
ID: TASK_000034 | Version: 0.2.1 | Status: Done
By: Codex (GPT-5)
# TASK_000034: UI rollback action

View File

@ -1,4 +1,4 @@
ID: TASK_000035 | Version: 0.1.1 | Status: Done
ID: TASK_000035 | Version: 0.2.1 | Status: Done
By: Codex (GPT-5)
# TASK_000035: Login-Landing und Header-Version

View File

@ -1,4 +1,4 @@
ID: TASK_000036 | Version: 0.1.2 | Status: Done
ID: TASK_000036 | Version: 0.2.1 | Status: Done
By: Codex (GPT-5)
# TASK_000036: Login-Landing und Dashboard-Redirect

View File

@ -1,4 +1,4 @@
ID: TASK_000037 | Version: 0.1.3 | Status: Done
ID: TASK_000037 | Version: 0.2.1 | Status: Done
By: Codex (GPT-5)
# TASK_000037: OIDC-Button neben Anmelden

View File

@ -1,4 +1,4 @@
ID: TASK_000038 | Version: 0.1.4 | Status: Done
ID: TASK_000038 | Version: 0.2.1 | Status: Done
By: Codex (GPT-5)
# TASK_000038: Logo und Favicon einbinden

View File

@ -1,4 +1,4 @@
ID: TASK_000039 | Version: 0.1.5 | Status: Done
ID: TASK_000039 | Version: 0.2.1 | Status: Done
By: Codex (GPT-5)
# TASK_000039: Login-Text und Panel-Layout

View File

@ -1,4 +1,4 @@
ID: TASK_000040 | Version: 0.1.5 | Status: Done
ID: TASK_000040 | Version: 0.2.1 | Status: Done
By: Codex (GPT-5)
# TASK_000040: Enrollment-Flow implementieren

View File

@ -1,4 +1,4 @@
ID: TASK_000041 | Version: 0.1.5 | Status: Done
ID: TASK_000041 | Version: 0.2.1 | Status: Done
By: Codex (GPT-5)
# TASK_000041: v1 Endpunkte im Update-Client umstellen

View File

@ -0,0 +1,20 @@
ID: TASK_000042 | Version: 0.2.1 | Status: Done
By: Codex (GPT-5)
# TASK_000042: Doku-Audit verbleibender Dateien
## Outcome
Alle relevanten Doku-Dateien sind geprueft und konsistent mit VERSION und Code-Stand.
## Story-Bezug
US_000039
## Beschreibung
- Liste verbleibender Doku-Dateien mit Header-Versionen pruefen.
- Abgleich mit Code fuer API- und ENV-Beschreibungen.
- Abweichungen korrigieren oder als Follow-up dokumentieren.
## Definition of Done (DoD)
- Keine verbleibenden Doku-Header mit falscher Version.
- Doku nennt nur genutzte ENV-Keys und korrekte Endpunkte.
- Ergebnis im CHANGELOG dokumentiert.