Skip to content

Instantly share code, notes, and snippets.

@steinbrueckri

steinbrueckri/RUNBOOK.md

Forked from voxxit/RUNBOOK.md
Last active June 16, 2019 18:58
Show Gist options
  • Save steinbrueckri/8bc4934865b10c4f82882e6c58e8d279 to your computer and use it in GitHub Desktop.
Save steinbrueckri/8bc4934865b10c4f82882e6c58e8d279 to your computer and use it in GitHub Desktop.
Download ZIP
Example of a solid run book/operations manual
Raw
RUNBOOK.md

Run Book / Operations Manual

System Overview

Service Overview

Contributing Applications, Daemons, and Windows Services

Hours of Operation

Execution Design

Infrastructure and Network Design

Resilience, Fault Tolerance and High-Availability

Throttling and Partial Shutdown

Required Resources

Expected Traffic and Load

Hot or Peak Periods

Warm Periods

Cool or Quiet Periods

Environmental Differences

Tools

Security and Access Control

System Configuration

Configuration Management

System Backup and Restore

Backup Requirements

Special Files

Backup Procedures

Restore Procedures

Monitoring and Alerting

Error Messages

Events

Health Checks

Other Messages

Operational Tasks

Deployment

Batch Processing

Power Procedures

Routine Checks

System Rebuilds

Troubleshooting

Maintenance Tasks

Maintenance Procedures

Patching

Normal Cycle

Zero-Day Vulnerabilities

GMT/BST time changes

Cleardown Activities

Log Rotation

Testing

Technical Testing

Post-Deployment

Failure and Recovery Procedures

Failover

Recovery

Troubleshooting Failover and Recovery

Contacts

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment