Skip to content

Instantly share code, notes, and snippets.

@noahlz

noahlz/runbook-sketch.md

Created August 5, 2014 16:01
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save noahlz/6d781c2f945674f70171 to your computer and use it in GitHub Desktop.
Save noahlz/6d781c2f945674f70171 to your computer and use it in GitHub Desktop.
Download ZIP
Thoughts on what goes in a runbook
Raw
runbook-sketch.md

Here's my idea of what goes in a run book for an application:

  • On which servers it is installed
  • Databases to which it connects (externally managed, not embedded)
  • how to start/stop, i.e. actual command line or script to execute
  • Scheduled batch jobs / EOD processes. Not the actual schedule, but when they generally run (EOD, overnight, etc)
  • Where to find log files
  • How to verify that it's actually running
  • A screen shot of the login page and one or two application pages is helpful.

Architecture diagrams and/or a complete description of the architecture should be optional.

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