Skip to content

Instantly share code, notes, and snippets.

@timani

timani/RUNBOOK.md

Forked from voxxit/RUNBOOK.md
Created March 30, 2017 07:01
Show Gist options
  • Save timani/f41e93c5d880411082e8df8b3d56886b to your computer and use it in GitHub Desktop.
Save timani/f41e93c5d880411082e8df8b3d56886b 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

  1. Table of Contents
  2. 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
  3. Security and Access Control
  4. System Configuration
  5. Configuration Management
    • System Backup and Restore
      • Backup Requirements
        • Special Files
      • Backup Procedures
      • Restore Procedures
  6. Monitoring and Alerting
    • Error Messages
    • Events
    • Health Checks
    • Other Messages
  7. Operational Tasks
    • Deployment
    • Batch Processing
    • Power Procedures
    • Routine Checks
      • System Rebuilds
    • Troubleshooting
  8. Maintenance Tasks
    • Maintenance Procedures
      • Patching
        • Normal Cycle
        • Zero-Day Vulnerabilities
      • GMT/BST time changes
      • Cleardown Activities
        • Log Rotation
    • Testing
      • Technical Testing
      • Post-Deployment
  9. Failure and Recovery Procedures
    • Failover
    • Recovery
    • Troubleshooting Failover and Recovery
  10. Contact Details
@Shefalij
Copy link

Is there any example of any project? can you please share with us.

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