The runbook you need at three in the morning

Source of concept: On-call- Google SRE Workbook. The format and sample of this note is an independent proposal design for operational documentation.

A useful documentary should clarify the next decision at a moment when the focus is too low. For me, to start a detailed page is better than a large folder with old commands. Of course, a page is the only entry point; specialized details can be included in link documents.

What should be on the first page?

• Application and importance: What does this service do for the user and what does it do?
• Owner and referral path: Where is technical, successor and organizational contact method?
• Attachments: What is the logical name of the necessary services, location and review order?
• Health and Evidence: What are the successful user tests, location, and known error signs?
• Recovery and Return: What is the confirmed procedure link, the backup reference location and the terms of halting operations?
• Documentary Credit: Who and what date has it adapted to the real situation?

A hypothetical sample.

For “internal reporting” it can be written: duty is a daily reporting show; essential affiliation, database report; health test is the entry of the test account and the opening of the sample report; in case of error, the event time and the application ID is checked and then the application log. True names and routes must be completed by the same environment.

The value of this sample is not in the number of fields; the next person understands where to start and which results are valid. Orders such as “If it’s broken, start-up” are not reliable guide without a condition, side effect and measure of success.

The documentary needs the test.

Ask the author not to follow a test scenario with the same guide. Wherever he had to ask an oral question, a real ambiguity was probably found. Review the document after the important change of service.

My suggestion: Don’t leave the password, token and private key inside the page; just mention the method of accessing the safe tank. The document must be found and tailored to the level of audience access. Keep the public version or educational sample separate from real network information.

Related study: Check the list before the start..