Skip to content

Homelab documentation

Hand-written homelab / cluster docs for nerd.dad. Published on GitHub Pages: https://nerd.dad/latest/homelab/

GitOps manifests live in truecharts. Prose docs live only here.

Guides

Guide What it’s for
Cluster guide Architecture, namespaces, GitOps habits, troubleshooting
Navigation Repo map, app discovery, deploy workflow
kubectl quick reference Observe-only commands (get/describe/logs/flux)
Jellyfin watch history Finding playback / watch history
Hearth triage sandbox LLM-agnostic incident sandbox (MCP + terminal)
Hearth Agent Hermes core sidecar in the Hearth pod
Retire Hermes WebUI triage WebUI/hermes-oncall retirement (done)

Service docs & runbooks

Layout under kubernetes/ mirrors the cluster tree in truecharts.

Pattern Use
mk_*.md Area or service docs
mk_runbook_*.md Alert runbooks (kubernetes/my-apps/observability/runbooks/)

Keep runbooks out of truecharts clusters/ so ClusterTool genconfig stays happy.

Alert runbook_url

In truecharts PrometheusRules:

runbook_url: https://nerd.dad/latest/homelab/kubernetes/my-apps/observability/runbooks/mk_runbook_<alert-kebab>/

Where to edit

Content Location
Guides, runbooks, service notes this repodocs/homelab/
Snippets includes/homelab/runbook/
HelmRelease / alerts / Flux YAML truecharts clusters/

Workflow

  1. Edit under docs/homelab/.
  2. Push to main and deploy Pages (mike / your usual build).
  3. Confirm at https://nerd.dad/latest/homelab/....