stephan/kiddo
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

release: 0.2.2

Browse Source
This commit is contained in:
Stephan Wilkens
2026-01-15 17:24:54 +01:00
parent fb096f7897
commit 835244b7e0
134 changed files with 563 additions and 168 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/ARCHITECTURE.md
View File

@ -1,4 +1,4 @@
ID: DOC_000012 | Version: 0.2.1 | Status: Draft
ID: DOC_000012 | Version: 0.2.2 | Status: Draft
By: Codex (GPT-5)
# Architektur

7
docs/CONFIGURATION.md
View File

@ -1,4 +1,4 @@
ID: DOC_000011 | Version: 0.2.1 | Status: Draft
ID: DOC_000011 | Version: 0.2.2 | Status: Draft
By: Codex (GPT-5)
# Konfiguration
@ -6,7 +6,8 @@ By: Codex (GPT-5)
## Speicherort
Die Konfiguration erfolgt per ENV-Dateien:
- `/etc/skd/env` (Core-App, Vorlage: `env.example`)
- `/etc/skd/update.env` (Update-Service, Vorlage: `env.update.example`)
- `/etc/skd/update.env` (Update-Service fuer Laufzeit, Vorlage: `env.update.example`)
- `update-addon.env` (lokal fuer Upload/Enrollment, Vorlage: `update-addon.env.example`)
## Authentifizierung
- `SKD_AUTH_MODE` (default `pam`): `pam` oder `oidc`. Ungueltige Werte fallen auf `pam` zurueck. Hinweis: Der Wert wird aktuell nicht zur Erzwingung genutzt; OIDC ist aktiv, sobald die OIDC-Variablen gesetzt sind.
@ -67,6 +68,8 @@ Hinweis: OIDC ist aktiv, sobald Issuer, Client-ID und Secret gesetzt sind.
- `SKD_UPDATE_STATUS_FILE` (default `/var/lib/skd/update_status.json`)
- `SKD_UPDATE_LOG_FILE` (default `/var/lib/skd/update_logs.jsonl`)
- `SKD_UPDATE_INTERVAL` (default `3600`): Hinweis: wird aktuell nur eingelesen, aber nicht automatisch genutzt.
- `SKD_UPDATE_UPLOAD_TOKEN` (optional; fuer Release-Upload)
- `SKD_UPDATE_UPLOAD_TOKEN_FILE` (optional; z.B. `/etc/skd/update.upload.token`)
## Dry-Run
- `SKD_DRY_RUN` (default `false`): Keine echten System-Aktionen, nur Logging.

22
docs/DEPLOYMENT.md
View File

@ -1,4 +1,4 @@
ID: DOC_000014 | Version: 0.2.1 | Status: Draft
ID: DOC_000014 | Version: 0.2.2 | Status: Draft
By: Codex (GPT-5)
# Deployment
@ -94,13 +94,31 @@ Hinweis: Der Update-Check ist erst moeglich, wenn der Langzeit-Token gespeichert
Enrollment-Tools:
- `scripts/manual_enroll.py`: Enrollment direkt gegen den Update-Service, schreibt Token in `SKD_UPDATE_TOKEN_FILE`.
- `scripts/enroll_local.py`: Enrollment ueber die lokale API (`/update/enroll`), benoetigt Admin-Session; `--token` setzen (Default-Token ist nur Prototyp-Altlast).
- `scripts/enroll_update_service.sh`: Holt den Langzeit-Token per curl vom Update-Service (liest `/etc/skd/env`).
- `scripts/enroll_update_service.sh`: Holt den Langzeit-Token per curl vom Update-Service (liest `update-addon.env`).
Beispiel (curl-Script):
```bash
sudo ./scripts/enroll_update_service.sh --enroll-token "enroll_example"
```
## Release-Upload (Dev/Prod)
Fuer Dev/Prod Uploads kann ein Release-Archiv (tar.gz) automatisiert gebaut und hochgeladen werden.
Beispiel:
```bash
./scripts/upload_release.sh --profile dev
```
Token-Quelle:
- `update-addon.env` (z.B. `DEV_UPDATE_UPLOAD_TOKEN_FILE=./upload.token`).
## Lokale update-addon.env
Fuer lokale Tests kann eine `update-addon.env` im Repo genutzt werden (gitignored).
Beispiel:
```bash
cp update-addon.env.example update-addon.env
```
Lokale Status/Logs:
- `SKD_UPDATE_STATUS_FILE` (default `/var/lib/skd/update_status.json`)
- `SKD_UPDATE_LOG_FILE` (default `/var/lib/skd/update_logs.jsonl`)

16
docs/DEVELOPMENT.md
View File

@ -1,4 +1,4 @@
ID: DOC_000013 | Version: 0.2.1 | Status: Draft
ID: DOC_000013 | Version: 0.2.2 | Status: Draft
By: Codex (GPT-5)
# Development
@ -23,6 +23,20 @@ Standard: `0.0.0.0:80`. Fuer andere Ports:
HOST=127.0.0.1 PORT=8000 ./scripts/run.sh
```
## Release-Upload (Dev/Prod)
Das Update-Artefakt wird als tar.gz gebaut und ueber den Update-Service hochgeladen.
Das Script nutzt `VERSION` und laedt ein vollstaendiges Release (kein Delta).
Vorbereitung:
```bash
cp update-addon.env.example update-addon.env
```
Beispiel (Dev):
```bash
./scripts/upload_release.sh --profile dev
```
## Tests und Lint
Im Repo sind keine automatisierten Tests enthalten. Verfuegbare Checks:
- Bash-Syntax: `bash -n sk.sh`

2
docs/FAQ.md
View File

@ -1,4 +1,4 @@
ID: DOC_000015 | Version: 0.2.1 | Status: Draft
ID: DOC_000015 | Version: 0.2.2 | Status: Draft
By: Codex (GPT-5)
# FAQ

2
docs/FOR_USERS.md
View File

@ -1,4 +1,4 @@
ID: DOC_000017 | Version: 0.2.1 | Status: Draft
ID: DOC_000017 | Version: 0.2.2 | Status: Draft
By: Codex (GPT-5)
# Fuer Nutzerinnen und Nutzer

2
docs/GETTING_STARTED.md
View File

@ -1,4 +1,4 @@
ID: DOC_000009 | Version: 0.2.1 | Status: Draft
ID: DOC_000009 | Version: 0.2.2 | Status: Draft
By: Codex (GPT-5)
# Getting Started

2
docs/TROUBLESHOOTING.md
View File

@ -1,4 +1,4 @@
ID: DOC_000016 | Version: 0.2.1 | Status: Draft
ID: DOC_000016 | Version: 0.2.2 | Status: Draft
By: Codex (GPT-5)
# Troubleshooting

5
docs/USAGE.md
View File

@ -1,4 +1,4 @@
ID: DOC_000010 | Version: 0.2.1 | Status: Draft
ID: DOC_000010 | Version: 0.2.2 | Status: Draft
By: Codex (GPT-5)
# Usage
@ -61,6 +61,9 @@ Alle Update-Endpunkte erfordern Admin-Auth.
- `POST /update/rollback`
- `GET /update/logs?limit=200`
### System-API (lokal)
- `GET /system/metrics` (CPU %, RAM, GPU VRAM, Netzwerk Mbps)
Beispiel (Enrollment):
```bash
ENROLL_TOKEN="example-enroll-token"

2
docs/_archive/admin-token-operations.md
View File

@ -1,4 +1,4 @@
ID: DOC_000006 | Version: 0.2.1 | Status: Draft
ID: DOC_000006 | Version: 0.2.2 | Status: Draft
Archived – superseded by new documentation.
By: Codex (GPT-5)

2
docs/_archive/client-quickstart.md
View File

@ -1,4 +1,4 @@
ID: DOC_000008 | Version: 0.2.1 | Status: Draft
ID: DOC_000008 | Version: 0.2.2 | Status: Draft
Archived – superseded by new documentation.
# Client Quickstart

2
docs/_archive/oidc-validation.md
View File

@ -1,4 +1,4 @@
ID: DOC_000003 | Version: 0.2.1 | Status: Draft
ID: DOC_000003 | Version: 0.2.2 | Status: Draft
Archived – superseded by new documentation.
By: Codex (GPT-5)

2
docs/_archive/third-party-api.md
View File

@ -1,4 +1,4 @@
ID: DOC_000005 | Version: 0.2.1 | Status: Draft
ID: DOC_000005 | Version: 0.2.2 | Status: Draft
Archived – superseded by new documentation.
By: Codex (GPT-5)

2
docs/_archive/update-api.md
View File

@ -1,4 +1,4 @@
ID: DOC_000006 | Version: 0.2.1 | Status: Draft
ID: DOC_000006 | Version: 0.2.2 | Status: Draft
Archived – superseded by new documentation.
By: Codex (GPT-5)

2
docs/_archive/update-client.md
View File

@ -1,4 +1,4 @@
ID: DOC_000004 | Version: 0.2.1 | Status: Draft
ID: DOC_000004 | Version: 0.2.2 | Status: Draft
Archived – superseded by new documentation.
By: Codex (GPT-5)

2
docs/_archive/update-status.md
View File

@ -1,4 +1,4 @@
ID: DOC_000005 | Version: 0.2.1 | Status: Draft
ID: DOC_000005 | Version: 0.2.2 | Status: Draft
Archived – superseded by new documentation.
By: Codex (GPT-5)