3 ms·
I don't write enough 'runbooks' (I call them playbooks). But I do write them, normally in four ways: - every three months I spend a day updating my 'what can g
by Normal_gaussian 5y ago
I don't write enough 'runbooks' (I call them playbooks). But I do write them, normally in four ways:
- every three months I spend a day updating my 'what can go wrong' documents. List of issues, explanation of effects, possible technical and human solutions. A lot of these link to one or more playbooks, but some do not.
- when a new system is created or a long process discussed I'll throw the links and thoughts in an untidy playbook or a nearby README, whichever feels more appropriate. I'll tidy it up more if its going to be part of training.
- Randomly when I think about something.
- during an incident, or it the post-incident handling.
--
When actually writing the book I give an overall guide to whats going on in prose at the top, then several sections with relevant things. It might be a series of commands to run, a list of things to bear in mind, a series of links to relevant documentation/blogs/etc, or a mix of the lot. Again, as appropriate.
All the playbooks are in a repo of markdown files whoch gitlab renders and supports crosslinking. I do use a greasemonkey script to give copy+hide hover buttons on all scripts, as well as making large scripts scrollable, which are great ease of use features I haven't seen any more concrete solution do.