Skip to main content

Runbooks

Runbooks provide step-by-step operational procedures for common tasks and incident response. Each runbook should be self-contained and actionable.

Available Runbooks

RunbookDescription
Deploy to ProductionSteps to deploy a new release to production
Rollback ReleaseEmergency rollback procedures
Get Electron LogsDebug electron processes

Runbook Standards

All runbooks should follow these guidelines:

  1. Be Specific: Include exact commands, URLs, and credentials locations (never actual credentials)
  2. Include Prerequisites: List required access, tools, and permissions
  3. Define Success Criteria: How to verify the procedure completed successfully
  4. Document Rollback Steps: Every action should have a way to undo it
  5. Include Contact Information: Who to escalate to if something goes wrong

Template

When creating a new runbook, use the Runbook Template as a starting point.