Skip to main content

Runbooks

Standard operating procedures for platform operators. Each runbook states when to run it, what must be true before you start, the steps with the expected result of each, how to verify the outcome, and how to roll back.

Deploy and Hand Over​

ProcedureWhen to Run
Deployment RunbookA new installation, end to end, phase by phase.
Deployment ValidationAfter every install or upgrade, before handing the platform to users.

Upgrade​

ProcedureWhen to Run
Upgrade ProcedureMoving to a new platform release.
Upgrade Keycloak from 24 to 26Crossing the release boundary that moves Keycloak to 26.
Enable Redis Authentication and TLSCrossing the release boundary that requires Redis authentication.

Maintain​

ProcedureWhen to Run
Rotating CredentialsOn your rotation schedule, or after a suspected credential exposure.

Recover​

ProcedureWhen to Run
Verifying a StandbyOn a schedule, and before relying on a standby region.
Disaster RecoveryWhen automatic failover cannot restore service.

If a procedure fails or the symptom is not listed here, start at Troubleshooting.