Almindelig dokumentation forklarer ofte et system eller en funktion, mens et runbook primært beskriver konkrete handlinger, der skal udføres i en bestemt situation.
Begreb
Runbook
Et runbook er en dokumenteret, trinvis procedure til at udføre en tilbagevendende driftsopgave eller håndtere en bestemt type hændelse. Formålet er at gøre arbejdet ensartet, reproducerbart og mindre afhængigt af enkeltpersoners hukommelse.
Hvorfor er begrebet vigtigt?
Runbooks er vigtige, fordi driftsopgaver og fejl ofte skal håndteres hurtigt og på samme måde hver gang. En tydelig procedure reducerer risikoen for oversete trin og gør det lettere for flere personer at udføre samme opgave korrekt.
For virksomheder kan runbooks forkorte reaktionstiden ved hændelser, gøre oplæring lettere og skabe et mere dokumenteret grundlag for drift og compliance.
Typisk misforståelse
Den mest almindelige fejl er at betragte et runbook som statisk dokumentation, der kun skrives én gang. Et godt runbook skal løbende opdateres, når systemer, afhængigheder, ansvar eller procedurer ændrer sig.
Eksempel
Et runbook for en utilgængelig webtjeneste kan beskrive, hvordan status kontrolleres, hvilke logs og metrics der undersøges, hvordan en sikker genstart udføres, hvornår der eskaleres, og hvordan hændelsen dokumenteres bagefter.
Best practice
Beskriv konkrete trin i den rækkefølge, de skal udføres.
Angiv nødvendige adgangsrettigheder, værktøjer og forudsætninger.
Definér tydelige kriterier for eskalering og stop.
Inkludér validering, så det kan kontrolleres, om proceduren virkede.
Gennemgå og test runbooks regelmæssigt.
Placer dem et sted, som relevante personer kan tilgå under en hændelse.
Frequently asked questions
Ja. Veldefinerede runbooks kan helt eller delvist omsættes til scripts, workflows eller automatiseringsværktøjer, men automatiseringen bør stadig dokumenteres og kontrolleres.
Ansvar bør placeres hos den funktion eller det team, der ejer den relevante tjeneste eller proces, så ændringer i systemet også fører til opdatering af proceduren.