readme.md

Awesome Runbook

A curated list of awesome runbook documents, guidebooks, software, and resources.

What is a runbook?

Contents

• Runbook Software
• Runbook Documents
  • Elasticsearch
  • Kubernetes
  • Linux
  • PostgreSQL
  • Prometheus
  • Miscellaneous
• Templates
• Contribute

Runbook Software

• Azure Automation - A process automation tool provided by Microsoft Azure.
• Datadog Workflow Automation - An automation software for remediation processes.
• Doctor Droid - A framework for automating investigations.
• Octopus Deploy / Runbooks - A runbook automation tool supported by CI/CD software: Octopus Deploy.
• Runbear - AI-powered notebook-style runbook automation software.
• Rubix - Python library that makes it easy to perform common DevOps tasks inside Jupyter Notebooks.
• Rundeck - A runbook automation service that enables self-service operations and simplifies routine data center tasks. It is managed by PagerDuty.
• Runme - Interactive runbook dev tool.
• Runbook - A framework for gradual system automation, written in Ruby and managed by Braintree.
• Savvy - The easiest way to create, share, and run runbooks from the terminal

Runbook Documents

Elasticsearch

• Elasticsearch Runbook - A blog post that contains ES runbooks.

Kubernetes

• Awesome Runbook / Kubernetes - Kubernetes runbooks managed by awesome-runbook.
• Container Solutions / Kubernetes - Kubernetes runbooks sponsored by Container Solutions.

Linux

• Container Solutions / Linux - Linux runbooks sponsored by Container Solutions.
• OpenShift - Runbooks for alert rules shipped with OpenShift.

PostgreSQL

• Awesome Runbook / PostgreSQL - PostgreSQL runbooks managed by awesome-runbook.
• Gitlab Troubleshooting / PostgreSQL - PostgreSQL troubleshooting runbooks managed by Gitlab.

Prometheus

• Prometheus Operator Runbooks - The official runbooks for the alerts sent out by components of the prometheus-operator ecosystem.

Miscellaneous

• GitLab On-call Run Books - A guidance for Gitlab Infrastructure Reliability Engineers and Managers.
• Shoreline / Pre-built automations & runbooks - Shoreline's runbook library.

Templates

• SkeltonThatcher/run-book-template - A Runbook / Operations Manual template for modern software systems.
• DevOps runbook template - A Confluence runbook template for DevOps, proposed by Atlassian.

Contribute

Contributions welcome! Read the contribution guidelines first.