Files
home-network-k3s-impl/runbooks/keycloak-db.md
T
jakman85andClaude Opus 5 44983095e1 feat(runbooks): make the 42 alert runbook_url annotations resolve
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]>
2026-09-12 23:49:58 -05:00

9.2 KiB

keycloak-db — Keycloak's PostgreSQL is unavailable

Alert: KeycloakDatabaseDown (critical, 5m) File: platform/monitoring/alerts.yaml, group platform-health.identity Expression:

max(kube_pod_status_ready{namespace="keycloak", pod=~"keycloak-db-.*", condition="true"}) == 0
or absent(kube_pod_status_ready{namespace="keycloak", pod=~"keycloak-db-.*"})

What this means here

No ready keycloak-db-* pod for five minutes. keycloak-db is a CloudNativePG Cluster with 3 instances on Longhorn (3 replicas each), and it is the database the IdP cannot live without. The pod=~"keycloak-db-.*" scoping matters for the same reason as in /runbooks/keycloak-down: the namespace also holds the Keycloak server and operator pods, and an unscoped max() would be masked by those.

Blast radius is the whole platform's identity: Keycloak fails → kubectl OIDC, Grafana, Headlamp, Gitea and forward-auth all fail. The certificate-based kubeconfig is an independent break-glass path and still works. This page is deliberately served without forward-auth so it stays readable during exactly this outage.

The HA properties you are relying on, and why they are set the way they are

  • instances: 3. All three CNPG Clusters used to run instances: 1, and all three primaries had drifted onto one node — on 2026-09-07 that node took SSO, Nextcloud and Semaphore down together. Scale-out to 3 is what gives you a standby to fail over to.
  • podAntiAffinityType: required, not CNPG's default preferred. preferred is a scheduler hint and on the path that matters — recreating an instance after node loss — it co-locates. Recorded conclusion: "preferred is how a 3-instance cluster decays back into the single-node failure domain." The accepted cost is that an instance stays Pending until a node returns.
  • primaryUpdateMethod: switchover. The CRD default is restart, which is a delete-and-recreate of the primary — tens of seconds with no Postgres, i.e. an SSO outage. Constraint to remember: under switchover the operator rejects an update that changes imageName and a postgresql parameter in the same reconcile.
  • Synchronous replication method: any, number: 1, dataDurability: preferred — never required. required is a strict quorum: with fewer than number healthy standbys, writes BLOCK. On this database one degraded standby (a node reboot, a Longhorn rebuild, a Cilium restart) would become a total write outage. dataDurability is only honoured while standbyNamesPre/Post are unset.

And the thing that is easy to get wrong: "Standbys replicate corruption and deletions faithfully; only the Barman archive is a backup." Three ready replicas are not a recovery plan.

Running the commands in this runbook

kubectl does not work on the operator workstation. The toolchain lives only in the pinned dev container, and the host's k3s-oidc context hangs on a browser prompt once its token expires — that hang is not the cluster being down. Every command below runs as:

infra/devcontainer/dev.sh run bash -c 'kubectl --context k3s-prod get nodes'

Always pass --context k3s-prod explicitly. dev.sh merges both clusters into one kubeconfig and defaults its current-context to k3s-dev, so a command without --context silently answers about the wrong cluster. (CLUSTER=prod infra/devcontainer/dev.sh run kubectl ... is equivalent.) Do not run two dev.sh invocations at once — they share one container and interfere.

USE FULLY-QUALIFIED RESOURCE NAMES, ALWAYS. Three CRDs on this cluster register the kind Backup: longhorn.io/v1beta2, postgresql.cnpg.io/v1 and velero.io/v1. The bare short name resolves to Longhorn's, which holds zero objects — so kubectl get backup -A prints "No resources found" on a cluster holding 6 Velero backups and 27 CNPG backups. Verified on prod 2026-09-13. Reading that as "the backups are gone" and acting on it turns a false negative into real data loss. Write backups.velero.io, backups.postgresql.cnpg.io, clusters.postgresql.cnpg.io, settings.longhorn.io, volumes.longhorn.io, nodes.longhorn.io.

Mutating kubectl (apply, patch, annotate, rollout) and flux reconcile are blocked for agents here: every durable change goes through git (git push origin main is the deploy). Where this runbook gives a mutating command it is for an operator, and it says so.

First commands

The Cluster's own verdict first — fully-qualified, because cluster is an ambiguous short name:

infra/devcontainer/dev.sh run bash -c \
  'kubectl --context k3s-prod get clusters.postgresql.cnpg.io -A \
     -o custom-columns=NS:.metadata.namespace,NAME:.metadata.name,INSTANCES:.status.instances,READY:.status.readyInstances,PRIMARY:.status.currentPrimary,PHASE:.status.phase'

Where the instances are, and whether they are all on one node (the 2026-09-07 defect):

infra/devcontainer/dev.sh run bash -c \
  'kubectl --context k3s-prod -n keycloak get pods -l cnpg.io/cluster=keycloak-db -o wide'

Why a pod is not ready:

infra/devcontainer/dev.sh run bash -c \
  'kubectl --context k3s-prod -n keycloak describe pod keycloak-db-2 | sed -n "/Events:/,\$p"; echo ====; \
   kubectl --context k3s-prod -n keycloak logs keycloak-db-2 -c postgres --tail=80 2>&1 | tail -40'

The conditions that matter for recoverability — check these before any recovery action:

infra/devcontainer/dev.sh run bash -c \
  'kubectl --context k3s-prod get clusters.postgresql.cnpg.io -n keycloak keycloak-db \
     -o custom-columns=ARCHIVING:.status.conditions[?\(@.type==\"ContinuousArchiving\"\)].status,LASTBACKUP:.status.conditions[?\(@.type==\"LastBackupSucceeded\"\)].status,FIRSTPITR:.status.firstRecoverabilityPoint'
infra/devcontainer/dev.sh run bash -c \
  'kubectl --context k3s-prod get backups.postgresql.cnpg.io -n keycloak'

kubectl get backup -A prints "No resources found" here even with 27 CNPG backups present — three CRDs register the kind Backup and the short name resolves to Longhorn's, which has none. Never decide anything from the short name.

Storage underneath:

infra/devcontainer/dev.sh run bash -c \
  'kubectl --context k3s-prod -n keycloak get pvc; \
   kubectl --context k3s-prod -n longhorn-system get volumes.longhorn.io -o custom-columns=NAME:.metadata.name,ROBUST:.status.robustness | grep -v healthy'

Likely causes, most likely first

1. A node is down or was rebooted

The instances live on Longhorn with hard anti-affinity, so a node loss takes one instance. With instances: 3 the cluster should survive it and promote; with podAntiAffinityType: required the lost instance stays Pending until a node returns, which is expected and accepted. Go to /runbooks/node-down.

2. The data PVC filled up

The most dangerous cause, because the mechanism is a backup fault presenting as a storage failure. With archive_mode=on and a failing archive_command, Postgres refuses to recycle unarchived WAL; pg_wal shares the data PVC on every Cluster here (no walStorage: configured) and grows until the volume is full and the postmaster PANICs. Measured on this very database: 17 unarchived segments / ~268 MiB on a 5 GiB PVC, growing ~6.8 MiB/h — about 29 days from 93% free to dead. Go to /runbooks/cnpg-archiving and /runbooks/pvc-capacity. Never delete WAL by hand.

3. A Longhorn volume is degraded or faulted

/runbooks/longhorn-degraded, /runbooks/longhorn-faulted.

4. An upgrade is stuck mid-switchover

Signature: the operator refusing an update that changes imageName and a postgresql parameter together. Split the change in git. See /runbooks/update-rollback.

5. The database is up and Keycloak still fails

Then read /runbooks/keycloak-down and, more likely, /runbooks/keycloak-client-secrets — the 2026-09-06 lockout had all 12 OIDC clients holding literal placeholder secrets behind an entirely green cluster.

When to escalate or stop

  • Escalate immediately. This is SSO's foundation; a 5m for on a critical is already generous.
  • Never change dataDurability to required while trying to "make replication safer" — it converts one degraded standby into a total write outage on the SSO database.
  • Do not delete a CNPG pod or PVC to force a rebuild. The operator manages instance lifecycle; deleting a PVC destroys that instance's data and, if it is the primary, may lose transactions that the archive does not have.
  • Do not attempt a restore before checking firstRecoverabilityPoint and ContinuousArchiving. Prod ran 38+ hours from bootstrap with ContinuousArchiving=False and firstRecoverabilityPoint: null on all three Clusters and nothing said so. Know what you actually have before you destroy what you have.
  • Standbys are not backups. Recovery is from the Barman archive in R2 (CNPG_BACKUP_PATH = s3://k3s-prod-backup/barman, 30d retention), which is an operator operation.

Source of truth: runbooks/keycloak-db.md. Index: /runbooks/ Records: commits f338e91 (instances 3), e8d8601 (required anti-affinity + switchover), cac413e (sync replication, dataDurability: preferred); platform/cnpg/alerts.yaml header (the 2026-09-06 archiving incident and the measured WAL fill rate).