Deployment Runbook
DevOps deployment runbook with prerequisites checklist, step-by-step commands, rollback procedures, and emergency contacts. Terminal-style design.
Available Variables
Use these variables with Handlebars syntax {{variableName}} in your content.
{{status}}READY
{{prereq1}}Access to production Kubernetes cluster
{{prereq2}}Approval from on-call lead
{{prereq3}}Verified staging deployment
{{prereq4}}Monitoring dashboards open
{{version}}v3.5.0
{{duration}}~15 minutes
{{step1Cmd}}kubectl get pods -n api-gateway && curl -s https://api.example.com/health
{{step2Cmd}}kubectl set image deployment/api-gateway api-gateway=registry.io/api-gateway:v3.5.0
{{step3Cmd}}kubectl rollout status deployment/api-gateway -w
{{step4Cmd}}npm run test:smoke -- --env=production
{{step1Desc}}Verify current production state before deployment
{{step1Time}}2 min
{{step2Desc}}Deploy the new version using rolling update strategy
{{step2Time}}5 min
{{step3Desc}}Watch the rollout progress and verify new pods are healthy
{{step3Time}}5 min
{{step4Desc}}Run smoke tests and verify metrics
{{step4Time}}3 min
{{step1Title}}Pre-deployment Health Check
{{step2Title}}Apply New Deployment
{{step3Title}}Monitor Rollout
{{step4Title}}Post-deployment Verification
{{description}}Production deployment runbook for the API Gateway service
{{environment}}Production
{{lastUpdated}}Jan 2025
{{serviceName}}API Gateway
{{step1Output}}All pods running, health check passed
{{contact1Info}}@sarah.chen
{{contact1Name}}Sarah Chen
{{contact1Role}}On-Call Lead
{{contact2Info}}#sre-oncall
{{contact2Name}}Platform Team
{{contact2Role}}SRE Team
{{contact3Info}}@mike.johnson
{{contact3Name}}VP Engineering
{{contact3Role}}Escalation
{{rollback1Cmd}}kubectl rollout undo deployment/api-gateway
{{rollback2Cmd}}kubectl rollout status deployment/api-gateway && curl -s https://api.example.com/health
{{step3Warning}}If error rate exceeds 1%, initiate rollback immediately
{{step4Success}}All smoke tests passed, deployment complete
{{rollback1Title}}Initiate Rollback
{{rollback2Title}}Verify Rollback
More technical Templates
Architecture Diagram
System architecture documentation with layered diagrams, tech stack overview, data flow visualization, and requirement cards. Perfect for technical specs.
System Design Doc
Comprehensive system design document with goals, constraints, capacity estimation, API design, and trade-offs. Interview-ready format.
Database Schema
Database documentation template with table cards, column types, relationship diagrams, and index listings. Dark terminal-inspired design.