jakman85andClaude Opus 5
44983095e1
Every platform-health alert rule carries `runbook_url: "https://${BASE_DOMAIN}/runbooks/<name>"` — 42 annotations over 34 distinct names, across platform/monitoring/alerts.yaml, platform/monitoring/pvc-capacity-alerts.yaml, platform/cnpg/alerts.yaml and platform/kubevirt/alerts.yaml. There was no runbooks/ directory and no HTTPRoute serving that path: an in-cluster probe of https://home.keithjackson.dev/runbooks/node-down returned HTTP 404. Every alert that reached a human handed them a dead link at the exact moment the documentation is read, and the annotation made it look solved — the same green-surface-over-absent-mechanism class as the import Job that reported success while storing placeholder secrets. No alerts.yaml is touched and no runbook_url value changes. The existing URL scheme is made to resolve instead. WHAT LANDS - runbooks/<34>.md — one per name, each grounded in this cluster's real topology and, where one exists, its real incident history: the 2026-09-07 k3s-prod-1 etcd I/O starvation (measured PSI 11.36 vs 0.75/1.29, the exact journal lines, the four mechanisms proven inert), the Longhorn reboot tax and the freeze/thaw of concurrent-replica-rebuild-per-node-limit, Cilium's once-resolved egress interface cache (Ifindex 3 against a live 1780) and the absence of OSS failover, the CNPG 38-hour ContinuousArchiving=False with its measured 6.8 MiB/h disk-full clock and the 2026-09-12 aggregation-scope fix, the 2026-09-06 Keycloak lockout in which all 12 clients held literal placeholder secrets behind an entirely green cluster, the Velero R2 x-amz-tagging NotImplemented incompatibility and its v1.14.3-rc.2 pin, and swap re-enabling itself across reboots via systemd-gpt-auto-generator. Each page states what the alert means HERE, the first diagnostic commands, likely causes ordered by probability with a remediation each, and when to escalate or stop. - Every page uses FULLY-QUALIFIED resource names and says why: three CRDs register the kind `Backup` here, the bare short name resolves to Longhorn's (zero objects), so `kubectl get backup -A` prints "No resources found" on a cluster holding 6 Velero and 27 CNPG backups. Acting on that false negative is how a CLI quirk becomes data loss. - Every page states that kubectl only works via `infra/devcontainer/dev.sh run bash -c '...'` with an explicit `--context k3s-prod`, because dev.sh defaults its current-context to k3s-dev. - Pages also record which alert groups are INERT today (measured 2026-09-13: no Longhorn, cert-manager, Flux-controller or Hubble scrape job exists, so 13 rules evaluate against nothing) so nobody reads their silence as health. SERVING — runbooks/serving/ plus clusters/base/runbooks.yaml A two-replica nginx-unprivileged serving a ConfigMap generated from runbooks/*.md, at the apex `/runbooks` prefix, in its own non-gating post-platform Flux tier (dependsOn platform-config, wait:false) — the platform/homepage pattern, file for file. - The service catalog cannot express this route: ingressRoutes[].host is pattern-bound to a single DNS label plus the apex, so the bare apex is unrepresentable, and there is no path field. - Rejected: redirecting to the Gitea web UI. A runbook is read when the platform is broken, and Gitea is an app-tier workload whose own dependencies several of these runbooks document; Gateway API's RequestRedirect also has no "append .md" modifier, so it would need 34 hand-maintained ReplaceFullPath rules. - configMapGenerator maps each file to an EXTENSIONLESS key (node-down=node-down.md), so /runbooks/node-down is a plain static lookup with no rewrite rule. Served as text/plain: the namespace has DNS-only egress, so a CDN markdown renderer could not load anyway. - The tier declares NO postBuild.substituteFrom, deliberately: envsubst would run over the prose and silently empty every ${...} shell example (it fails open — the 2026-09-01 emptied Cilium k8sServiceHost). The HTTPRoute omits `hostnames:` and inherits the https-apex listener's, so nothing needs substituting. AUTH — PUBLIC, deliberately auth-mode=none. Gating these pages behind oauth2-proxy/Keycloak would make runbooks/keycloak-down unreadable when Keycloak is down and runbooks/keycloak-client-secrets unreadable during the exact 2026-09-06 failure mode. An operator who cannot log in is this route's primary reader. Content is operational procedure only, no secrets. The rationale is recorded in an annotation on the HTTPRoute so the route is left OUT of the Gateway ext-authz attachment when forward-auth enforcement lands. PROVEN — in-cluster probe through the Gateway on prod /runbooks/node-down HTTP 200 8613 bytes text/plain; charset=utf-8 /runbooks/keycloak-down HTTP 200 9378 bytes text/plain; charset=utf-8 /runbooks/cnpg-archiving HTTP 200 11729 bytes text/plain; charset=utf-8 /runbooks/longhorn-faulted HTTP 200 9135 bytes text/plain; charset=utf-8 /runbooks/vpn-down HTTP 200 11092 bytes text/plain; charset=utf-8 /runbooks/backup-failure HTTP 200 9604 bytes text/plain; charset=utf-8 HTTPRoute Accepted by io.cilium/gateway-controller on sectionName https-apex; the `/runbooks` prefix wins over homepage's apex `/` by Gateway API longest-path precedence. GUARD — conformance/tests/l0-static/alert-runbooks-resolvable (R-OBS-04) 363 offline assertions. It checks BOTH halves, because the regression is silent in both directions: an alert with a new runbook_url and no runbook links to a 404, AND a runbook committed without its configMapGenerator entry is in git, reviewed, merged, and still 404s in the cluster. Also asserts a quality floor so a stub cannot make the link look fixed, and that route/listener/nginx prefix agree with the annotations. Proven to fail, then reverted: a bogus runbook_url (2 FAIL), a runbook removed from the generator (1 FAIL), and a 31-byte stub (7 FAIL). Co-Authored-By: Claude Opus 5 <[email protected]>
78 lines
4.8 KiB
YAML
78 lines
4.8 KiB
YAML
---
|
|
# North-south ingress for the runbooks at https://<apex>/runbooks/ — the exact prefix the alert
|
|
# annotations already point at (`runbook_url: "https://${BASE_DOMAIN}/runbooks/<name>"`, 42 of them
|
|
# across platform/monitoring/alerts.yaml, platform/monitoring/pvc-capacity-alerts.yaml,
|
|
# platform/cnpg/alerts.yaml and platform/kubevirt/alerts.yaml). Nothing about those annotations
|
|
# changes; this route is what finally makes them resolve.
|
|
#
|
|
# NO `hostnames:` — DELIBERATE, and the reason this manifest needs no Flux variable substitution.
|
|
# An HTTPRoute with no hostnames inherits the hostname of every listener it attaches to, and this
|
|
# route attaches to exactly one: `https-apex`, whose hostname is `${BASE_DOMAIN}`
|
|
# (platform/gateway/gateway.yaml). So the route is correct on dev and on prod with no
|
|
# `postBuild.substituteFrom` anywhere in this tier — which matters a great deal here, because the
|
|
# SAME Flux Kustomization renders the runbook markdown into a ConfigMap. With substitution enabled,
|
|
# Flux's envsubst would run over the runbook prose and silently EMPTY every `${...}` in every shell
|
|
# example a runbook contains (it fails open — DECISIONS-LOG 2026-09-01, the Cilium k8sServiceHost
|
|
# incident). Declaring no hostname removes the last reason to substitute, so the docs ship verbatim.
|
|
# See clusters/base/runbooks.yaml.
|
|
#
|
|
# PATH PRECEDENCE AGAINST HOMEPAGE. platform/homepage/httproute.yaml already binds `https-apex` with
|
|
# PathPrefix `/`. Gateway API resolves a conflict between rules on the same hostname by preferring
|
|
# the LONGEST path match, so `/runbooks` wins over `/` for these requests and homepage keeps
|
|
# everything else. The two routes coexist by specification, not by luck — and the live 200s recorded
|
|
# in the commit prove it on this Gateway implementation (Cilium).
|
|
#
|
|
# ============================ AUTH: THIS ROUTE IS PUBLIC ==============================
|
|
# auth-mode=none, deliberately, and it is the one route in this repo where that is the SAFE choice.
|
|
#
|
|
# THE CIRCULARITY. Every other exposed UI here declares forward-auth (oauth2-proxy -> Keycloak).
|
|
# Put these pages behind that and `runbooks/keycloak-down` becomes unreadable precisely when
|
|
# Keycloak is down; `runbooks/keycloak-db` unreadable when its CNPG database is down;
|
|
# `runbooks/keycloak-client-secrets` unreadable during the exact failure mode that broke all 12
|
|
# OIDC clients on 2026-09-06 while every health signal stayed green. An on-call who cannot log in
|
|
# is the primary reader of this route. Gating documentation on the identity provider it documents
|
|
# is a loop with no exit.
|
|
#
|
|
# WHAT IS ACTUALLY EXPOSED. Operational procedure: metric names, thresholds, kubectl invocations,
|
|
# component topology. No credentials, no secrets, no tokens, no internal IPs beyond the LAN ranges
|
|
# already written in the public spec repo. The content is the same text any reader of the git repo
|
|
# can see. The real cost is reconnaissance value — it names what runs here and how it fails — and
|
|
# that is accepted knowingly, against the certainty of a locked-out operator staring at a login page
|
|
# during an outage. If that trade is ever revisited, the correct fix is NOT forward-auth on this
|
|
# route; it is to keep it public and move sensitive specifics out of the runbooks.
|
|
#
|
|
# HONEST NOTE ON TODAY'S POSTURE. The Gateway ext-authz attachment that would ENFORCE forward-auth
|
|
# does not exist anywhere in this repo yet (platform/oauth2-proxy is the authenticator only; the one
|
|
# CiliumEnvoyConfig on the cluster is the Gateway's own). So every `forward-auth` route — homepage,
|
|
# pihole, jackett, qbittorrent, radarr, sonarr — is in practice reachable unauthenticated today.
|
|
# This route is therefore no more open than its neighbours right now; the difference is that when
|
|
# ext-authz does land, this one must be left OUT of it ON PURPOSE, and this comment is the record of
|
|
# that decision so nobody "fixes" it later and re-closes the loop.
|
|
apiVersion: gateway.networking.k8s.io/v1
|
|
kind: HTTPRoute
|
|
metadata:
|
|
name: runbooks
|
|
namespace: runbooks
|
|
labels:
|
|
app.kubernetes.io/name: runbooks
|
|
annotations:
|
|
homelab.keithjackson.dev/auth-mode: none
|
|
homelab.keithjackson.dev/auth-rationale: >-
|
|
Public on purpose. An operator locked out of Keycloak is this route's primary reader;
|
|
gating it behind Keycloak would make runbooks/keycloak-down unreadable exactly when it is
|
|
needed. Content is operational procedure only — no secrets. Do NOT add this route to the
|
|
Gateway ext-authz attachment when forward-auth enforcement lands.
|
|
spec:
|
|
parentRefs:
|
|
- name: shared
|
|
namespace: gateway
|
|
sectionName: https-apex # the apex listener; the wildcard `https` listener won't match it
|
|
rules:
|
|
- matches:
|
|
- path:
|
|
type: PathPrefix
|
|
value: /runbooks
|
|
backendRefs:
|
|
- name: runbooks
|
|
port: 80
|