docs: define update status reporting

This commit is contained in:
2025-12-28 23:51:01 +01:00
parent c41a4560c1
commit 37087e7925
6 changed files with 34 additions and 1 deletions

View File

@ -25,6 +25,7 @@ By: Codex (GPT-5)
| 28.12.2025 | ⚙️ Code | ID: Update-Config Keys in Settings/ENV/README definiert. By: Codex (GPT-5) |
| 28.12.2025 | 📝 Req | ID: Update-Flow fuer Client dokumentiert. By: Codex (GPT-5) |
| 28.12.2025 | 📝 Req | ID: Update-Flow Prototyp dokumentiert. By: Codex (GPT-5) |
| 28.12.2025 | 📝 Req | ID: Update-Status-Schema dokumentiert. By: Codex (GPT-5) |
| 28.12.2025 | ⚙️ Code | ID: Update-Client Prototyp-Skript hinzugefuegt. By: Codex (GPT-5) |
---

View File

@ -36,6 +36,7 @@ Set in `/etc/skd/env` (see `env.example`):
- `SKD_UPDATE_URL` (default `https://update.wlkns.org`)
- `SKD_UPDATE_TOKEN` (API token for update service)
- `SKD_UPDATE_INTERVAL` (seconds; default 3600)
- `SKD_UPDATE_STATUS_URL` (default `https://update.wlkns.org/status`)
Notes:
- `./scripts/install.sh` will create `/etc/skd/env` from `env.example` if missing (edit afterwards) and ensure the `skd` service user/group exist.

View File

@ -42,3 +42,7 @@ Beispiel:
## Constraints
- Update-Service ist extern (update.wlkns.org).
- Service muss als root stoppen/starten koennen.
## Status Reporting
- Status wird per HTTP POST an `https://update.wlkns.org/status` gemeldet.
- Schema siehe `docs/update-status.md`.

25
docs/update-status.md Normal file
View File

@ -0,0 +1,25 @@
ID: DOC_000005 | Version: 0.1.0 | Status: Draft
By: Codex (GPT-5)
# Update Status Reporting
## Purpose
Definiert das Status-Schema fuer Update-Resultate und den Uebertragungsweg.
## Status Schema (JSON)
```json
{
"device_id": "<hostname>",
"version": "0.1.2",
"status": "success|failed",
"error": "<optional message>",
"timestamp": "2025-12-28T12:34:56Z"
}
```
## Transport
- HTTP POST an `https://update.wlkns.org/status`
- Auth: Bearer Token (`SKD_UPDATE_TOKEN`)
## Notes
- Statusmeldungen sind best-effort; Fehler beim Senden blockieren kein Update.

View File

@ -25,5 +25,6 @@ SKD_NOTIFY_TIMEOUT=5
SKD_UPDATE_URL=https://update.wlkns.org
SKD_UPDATE_TOKEN=
SKD_UPDATE_INTERVAL=3600
SKD_UPDATE_STATUS_URL=https://update.wlkns.org/status
# Set to true to test without performing real system changes
SKD_DRY_RUN=false

View File

@ -1,4 +1,4 @@
ID: TASK_000029 | Version: 0.1.0 | Status: Draft
ID: TASK_000029 | Version: 0.1.0 | Status: In Progress
By: Codex (GPT-5)
# TASK_000029: Report update status
@ -13,6 +13,7 @@ US_000028
- Status-Schema definieren (Version, Ergebnis, Fehler, Zeitpunkt).
- Transportweg festlegen (z.B. HTTP POST oder Log-Export).
- Erfolg/Fehler konsistent dokumentieren.
- Schema dokumentiert in `docs/update-status.md`.
## Definition of Done (DoD)
- Status-Schema dokumentiert.