docs: add operator runbooks (outage, catalog, backup restore, admin revoke) - #87
Merged
Merged
Conversation
Ground each runbook in the actual service-layer/handler/MCP code rather than the spec's aspirational description: announcements have no MCP tool at all (form/HTTP API only), catalog service soft-delete has no reactivate path, session revocation for a compromised admin needs either registered back-channel logout or a direct DB session delete since there's no admin-facing "kill this user's sessions" endpoint, and there's no backup automation in the repo yet so the restore runbook documents restoring from a manually-taken pg_dump. Link the four runbooks from README's new Operations section and from the docs/04 §5 Runbooks bullet.
This was referenced Aug 28, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds the four operator runbooks named in
docs/04-development-plan.md§5, each grounded in the actual service-layer/handler/MCP code (not the spec's aspirational description):docs/runbooks/outage-announcement.mddocs/runbooks/manage-service.mddocs/runbooks/restore-postgres.mddocs/runbooks/revoke-admin.mdLinked from a new README "Operations" section and from the
docs/04§5 "Runbooks:" bullet.Gaps found while writing these (flagging per CLAUDE.md, not silently working around them)
No MCP tool exists for announcements. The admin MCP server (
cmd/mcp) only exposesservice.*/category.*/search.insightsplus thepropose_*/change.confirmstaged-write flow for catalog services. Announcements can only be created/edited/deleted via the admin web form / HTTP API (POST|PATCH|DELETE /api/admin/announcements*). The runbook documents the HTTP-API fallback for scripting this, but there's no staged propose→confirm path for announcements today.No reactivate/undelete path for a soft-deleted catalog service.
DELETE /api/admin/services/{id}andservice.propose_delete→change.confirmboth setis_active = false; there is no HTTP endpoint, MCP tool, or form action to flip it back, and editing an inactive service (UpdateService) never touchesis_active. The only way back is to re-create the service as a new row (new id — breaks any favorites/role-defaults referencing the old one) or hand-edit the DB.No automated backup job exists in the repo. Searched
scripts/,.github/workflows/,deploy/, both compose files, and the Makefile forpg_dump/pg_basebackup/cron/backup automation — none exists. The restore runbook documents restoring from whateverpg_dumpartifact the operator already has; it does not (and cannot) document a "tested restore" of an automated backup, because there is no automated backup to test. This is a real product gap againstdocs/04§5's "regular Postgres backups + a tested restore" aspiration.No admin-facing way to force-end a specific user's wolke session(s).
DeleteSessionsBySID/DeleteSessionsByOIDCSubexist ininternal/storebut are only ever called from the OIDC back-channel-logout handler — there's no HTTP/MCP admin action to invoke them directly. The revoke-admin runbook's "immediate lockout" path therefore either relies on the IdP having back-channel logout registered (documented indocs/oidc-keycloak.md) and triggering a logout there, or falls back to a directDELETE FROM sessions ... WHERE oidc_sub = ...viapsql. An admin-facing "kill this user's sessions" action would close this gap.Test plan