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]>
77 lines
5.1 KiB
YAML
77 lines
5.1 KiB
YAML
# =============================================================================
|
|
# L0 STATIC — every alert's runbook_url resolves to a runbook that is actually served
|
|
# Catalog: docs/14 L0 row ("Pre-apply, in CI") — runs WITHOUT a cluster.
|
|
#
|
|
# Every platform-health alert rule in this repo carries
|
|
# `runbook_url: "https://${BASE_DOMAIN}/runbooks/<name>"` — 42 annotations across four files, over 34
|
|
# distinct names. For the whole of phases 4-6 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.
|
|
# So an alert reaching a human handed them a dead link at the one moment documentation is read, while the
|
|
# annotation made the problem look solved — the same green-surface-over-absent-mechanism class as the
|
|
# import Job that reported success while storing placeholder secrets, and the guard whose glob silently
|
|
# stopped matching.
|
|
#
|
|
# The link is served now (runbooks/, clusters/base/runbooks.yaml). This test is the guard that keeps it
|
|
# true, and it asserts BOTH halves of the claim 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. "The file exists"
|
|
# and "the URL resolves" are different claims; only the second one helps an operator.
|
|
#
|
|
# GIVEN every `runbook_url` annotation on every PrometheusRule in the repo,
|
|
# WHEN each is parsed out of git and resolved against runbooks/,
|
|
# THEN (1) each URL has EXACTLY the shape the server resolves — https://${BASE_DOMAIN}/runbooks/<name>,
|
|
# the ${BASE_DOMAIN} token (never a literal hostname), no `.md`, no trailing slash, no query;
|
|
# (2) every referenced <name> has a runbooks/<name>.md in git;
|
|
# (3) each runbook clears a QUALITY FLOOR — the four operator sections, a real body, and the
|
|
# dev-container kubectl invocation with --context k3s-prod — so a stub cannot satisfy (2) and
|
|
# make the link look fixed while still helping nobody;
|
|
# (4) every runbook is PROJECTED INTO THE SERVER by runbooks/kustomization.yaml's
|
|
# configMapGenerator under the extensionless key the URL asks for;
|
|
# (5) route, listener and server agree with the annotations (PathPrefix == the annotations' prefix,
|
|
# a sectionName that platform/gateway/gateway.yaml actually defines, the namespace opted in to
|
|
# the Gateway, and an nginx location for that same prefix with a text/plain default_type);
|
|
# (6) the Flux tier is wired into clusters/base AND declares NO postBuild.substituteFrom —
|
|
# substitution would run envsubst over the runbook prose and silently empty every `${...}`
|
|
# shell example in it (it fails open: DECISIONS-LOG 2026-09-01, the emptied Cilium
|
|
# k8sServiceHost), and the flux-postbuild-substitution check cannot see it because that check
|
|
# scans files reachable through `resources:`, not configMapGenerator inputs;
|
|
# AND (7) the check is LOAD-BEARING: ci/l0.sh runs it on every gate run (Stage 3f) and ci/gate.sh sets
|
|
# the merge block when the l0 stage fails.
|
|
#
|
|
# STATUS: EXECUTABLE. `check.sh` is a pure offline assertion script (standard library only);
|
|
# conformance/run.sh --layer l0 and ci/l0.sh run it directly, and this Chainsaw Test wraps the SAME
|
|
# script.
|
|
#
|
|
# NOT proven (named in check.sh's header): this does not FETCH the URL. That it returns HTTP 200 with
|
|
# real content was proven by an in-cluster probe recorded in the commit message; a live probe needs a
|
|
# cluster, which L0 by definition does not have. What is asserted here is every static precondition for
|
|
# that 200. It also does not judge whether a runbook is correct or current — (3) is a floor, not a
|
|
# review — and it does not prove Alertmanager delivers the annotation to a human (that is the L3
|
|
# `alerting` test). R-OBS-04 is tagged for the narrow slice only: the platform's own health alerts carry
|
|
# runbook links that resolve to real, served procedure rather than to a 404.
|
|
# =============================================================================
|
|
apiVersion: chainsaw.kyverno.io/v1alpha1
|
|
kind: Test
|
|
metadata:
|
|
name: alert-runbooks-resolvable
|
|
labels:
|
|
conformance.home.k3s/R-OBS-04: "true"
|
|
annotations:
|
|
conformance.home.k3s/requirements: "R-OBS-04"
|
|
conformance.home.k3s/layer: "L0"
|
|
conformance.home.k3s/safety-critical: "false"
|
|
conformance.home.k3s/executable: "true"
|
|
conformance.home.k3s/intent: >-
|
|
Every runbook_url on every alert rule resolves to a runbook that exists in git, clears a quality
|
|
floor, and is actually projected into the server that answers that path — so an alert can never
|
|
hand an operator a dead link.
|
|
spec:
|
|
steps:
|
|
- name: audit-every-alert-runbook-link
|
|
description: >-
|
|
Parse every runbook_url out of every PrometheusRule and assert the runbook exists, is real, is
|
|
served at that exact path, and that the serving tier is wired and unsubstituted.
|
|
try:
|
|
- script:
|
|
content: bash ./check.sh
|