Zum Inhalt springen
shellyshale

Betriebshandbuch als Wiki

Jede Änderung am Homelab endet in der Dokumentation, nicht im Code. MkDocs Material, gebaut und ausgerollt über dieselbe Pipeline.

Warum

Ein Homelab ohne Dokumentation ist nach drei Monaten ein Rätsel, auch für die Person, die es gebaut hat. Darum gilt eine einfache Regel: Eine Arbeit ist erst fertig, wenn die Seite im Wiki stimmt.

Aufbau

Markdown in einem eigenen Repo, MkDocs Material als Generator. Die CI baut mit mkdocs build --strict, damit tote Links und kaputte Verweise den Build anhalten. Ausgerollt wird, indem die CI eine Annotation am Deployment im Cluster-Repo ändert; Argo CD sieht die Änderung, der Pod startet neu und baut die Seite frisch.

Inhalt

Pro Dienst eine Seite mit derselben Gliederung: wozu, wo die Manifeste liegen, wie man ihn ausrollt, was schon einmal schiefging. Dazu Seiten für den Cluster selbst: Speicher, Zertifikate, Registry, Neustarts ohne Ausfall.