How-to¶

What belongs here¶

A how-to is a recipe for a reader who already knows what they want. It starts from a realistic situation, not a clean slate, and it is allowed to say "it depends" — that is the difference from a tutorial.

Admission test:

• It answers "how do I …?" for a goal the reader already has.
• It is a sequence of steps, not an explanation. Rationale goes in Explanation; tables of options go in Reference.
• It is specific to this cluster. If upstream documentation already covers it, link out instead of restating it.

Runbooks are how-to documents written for someone at 2am, and belong in this section once migrated.

Available now¶

• Expose an app on an ingress — which class, and why a public host needs two Ingresses
• Require a login — pocket-id, natively or through oauth2-proxy
• Log in with kubectl — passkey instead of a client certificate, and how pocket-id groups become RBAC subjects
• Choose a storage class — which class a workload belongs on, in the order the questions actually matter
• Roll a workload when its ConfigMap changes
• Silence alerts for maintenance — and the one matcher that must never match

Not written yet¶

Open documentation work is tracked as issues labelled documentation. Two runbooks are served from runbooks.thaum.xyz, a site whose repository was last touched in 2021; bringing them here is #1364.