Операційна інструкція

Що це таке

Операційна інструкція, або _runbook_, містить перевірені кроки для
виконання завдання з експлуатації. Вона пояснює умови застосування,
потрібні ресурси, послідовність роботи й ознаки успіху. Кроки може
виконати людина або автоматизована система, а інструкція
пояснюватиме, як працює автоматизація і за чим стежити. Прикладом є
тест відновлення резервної копії, планова заміна сертифіката або
повернення до відомої конфігурації.

AWS у рекомендаціях з експлуатації називає _runbook_ послідовністю
дій для повторюваної задачі, а _playbook_ — настановою для
дослідження проблем. У різних командах значення слів відрізняються.
Корисно з’ясувати, що має знати читач на початку. Якщо необхідна
операція відома, кроки ведуть від визначеного стану до бажаного
результату. Якщо причину чи потрібну операцію ще треба знайти,
спочатку збирають спостереження й визначають, як вони впливають на
вибір.

Навіть коротка інструкція може назвати систему, середовище,
потрібний доступ, відповідальну людину й умови початку. Вона описує
ознаки результату та випадки, коли треба спинитися й звернутися по
допомогу. Повідомлення, що команда виконалася, і підтвердження, що
служба працює для людей, — різні спостереження. На кожному кроці має
бути зрозуміло, яке з них потрібно.

Чому це важливо

Під час перебою черговий може знати застосунок, але мати мало
досвіду з конкретним інструментом відновлення. Інструкція звільняє
його від необхідності відновлювати весь процес із пам’яті. За нею
можна перевірити назву системи, відомості про дані та типовий
результат перед наступним кроком. Це особливо корисно, коли
чергування змінюються або кілька відділів докладаються до однієї
роботи.

Підготовка інструкції виявляє негласні припущення. Хтось вважає
копію готовою, щойно завдання копіювання завершилося. Інша людина на
тренуванні помічає, що для наступного засобу потрібен додатковий
доступ або що звіт не перелічує пропущених записів. Інструкція може
пояснити різницю. Вона також допомагає вирішити, які дії можна
автоматизувати, а які потребують людської оцінки умов.

Інструкція старіє, коли змінюються служби, права чи залежності. Її
можна зберігати поряд із кодом або налаштуванням і призначити людину
для перегляду. Попросіть іншого колегу виконати вправу, щоб знайти
умови, які автор вважає очевидними. Варто також перевірити, як люди
дістануть інструкцію та підтвердять результат, якщо звичний вхід або
панель спостереження недоступні.

Як це виглядає на практиці

Уявімо регулярну перевірку резервної копії бази звітів. Інструкція
називає базу, ізольоване середовище й обліковий запис із дозволом
прочитати копію та створити тестову базу. Вона просить перевірити
джерело й вік копії та впевнитися, що жоден робочий застосунок не
скеровує запити до тестової бази. Виконавець занотовує ідентифікатор
копії й час початку.

Наступний крок вказує засіб відновлення та розташування журналу.
Після відновлення виконавець запускає відомий звіт, зіставляє кілька
значень і перевіряє дату найновішого відновленого запису.
Неочікуване джерело, відсутні рядки чи збій звіту означають паузу й
звернення до названої людини. Після успішної вправи фіксують
тривалість. Тимчасову копію й доступ видаляють за узгодженим
порядком.

Колега повторює перші кроки із застарілою копією, вибраною навмисно.
Різницю потрібно побачити перед відновленням. Колега має знати, де
повідомити про неї і що зафіксувати. Після вправи відповідальний
уточнює незрозумілі кроки та додає тривалість правильно проведеної
перевірки. Вона показує, що було можливе саме за цих умов.

Окремо продумайте, як записати результат без даних клієнтів. У звіті
можна назвати середовище, початок вимірювання та результат кожної
перевірки. Якщо копія відкрилася, але звіт пропустив записи,
зафіксуйте обидва факти. За ними команда зрозуміє, що змінити в
наступній вправі.

Випадок резервних копій, які справді були відновлені описує
практичну перевірку відновлення. Він показує, скільки може лишатися
невідомим після сповіщення про успішне копіювання. База звітів тут
слугує прикладом перевірюваної інструкції.

Попросіть людину, яка не бачила цього процесу, описати межу між
успіхом команди та успіхом завдання своїми словами. Якщо вона може
лише повторити текст сповіщення, додайте перевірку результату.
Наприклад, уточніть, який звіт виконати, за якими даними зіставити
рядки й кому повідомити про розбіжність перед прибиранням тимчасової
бази.

Де виникають проблеми

Кроки розраховані на звичайні умови. Якщо основна документація чи
обліковий запис недоступні, людям усе одно потрібен дозволений
спосіб знайти кроки й перевірити передумови. Випробуйте цей спосіб
заздалегідь.

Написано, куди натиснути, але не що перевірити. Після зміни
інтерфейсу давній знімок екрана може не допомогти. Опишіть потрібну
дію, очікуване спостереження і відхилення, за яких роботу зупиняють.

Ту саму інструкцію застосовують за будь-яких симптомів. Схожу
поведінку можуть спричинити різні помилки. Спершу визначте, за якої
умови потрібна саме ця операція. Лише тоді виконуйте кроки.

Інструкцію випробував лише автор. Дайте іншій людині безпечний
сценарій і попросіть позначити місця, де довелося вгадувати назву,
шукати доступ або припускати очікуваний результат.

Що почитати далі

  * AWS про операційні інструкції — заздалегідь підготовлені
процедури, відповідальність і оновлення.

  * AWS про настанови для розслідування — спостереження, потрібні до
вибору операції.

  * Google SRE про аварійні заходи — вправи та висновки з попередніх
інцидентів.

hЦя сторінка у вебі	URL:https://engineer.company/uk/glossary/runbook/	engineer.company	70
