Runbook — инструкция для повторяющейся операции с известной целью. Например, восстановить обработку очереди после знакомого сбоя, выпустить новую версию приложения или заменить истёкший ключ. Читателю должно быть понятно не только что нажать, но и когда инструкция применима, какие права нужны и какой результат считать успешным.
Представьте, что после обновления сервис перестал обрабатывать заявки. Плохая инструкция говорит «проверьте логи и перезапустите». Полезная называет нужный журнал, время последнего успешного запуска и условия, при которых можно откатить конкретное обновление. Если симптомы другие, дежурный не повторяет команды наугад, а передаёт проблему ответственному.
Runbook не обязательно описывает аварии. Инструкция плановой проверки резервной копии тоже является runbook, если в ней есть действия и критерий результата. Это может быть обычный документ, а не программа. Скрипт автоматизирует часть процедуры, но не заменяет объяснение границ применения и того, что делать при ошибке.
Рядом часто встречается слово playbook. В практике эксплуатации playbook помогает исследовать ещё не понятную проблему: какие гипотезы и признаки проверить. Runbook ведёт к определённому результату в уже описанной ситуации. Названия в командах могут различаться, но разницу полезно сохранять: поиск причины и исправление известной причины не одно и то же.
AI-агент может найти подходящую инструкцию, собрать сведения из разрешённых журналов и предложить следующий шаг. Это не даёт ему права выполнять любую команду из документа. Проверки на чтение и действия, меняющие систему, разделяют; для опасного действия нужны отдельно заданные разрешения и подтверждение человека.
Рабочую инструкцию проверяет коллега на тестовой среде. Если ему приходится угадывать имя сервиса или нужную версию, документ ещё не готов. У runbook должен быть ответственный, дата проверки и порядок обновления после изменения системы. Во время сбоя устаревшая инструкция способна навредить больше, чем отсутствие подробной команды.
Шаблон runbook
Заполните поля для одного знакомого сбоя. Команды берите из проверенной инструкции своей команды, а не из ответа AI.
Ситуация: при каких симптомах применяется инструкция
Границы: когда её выполнять нельзя
Ответственный: владелец сервиса и контакт дежурного
Диагностика: логи, показатели и последние изменения
Проверки: команды только для чтения и ожидаемый вывод
Действие: условие запуска, необходимые права и подтверждение
Откат: как вернуть прежнее состояние, если стало хуже
Успех: проверяемый результат и время наблюдения
Остановка: когда прекратить действия и кому передать проблему
Проверено: дата, версия сервиса, имя проверяющего
Примеры
- Проверка резервной копии: восстановить тестовую копию в отдельной среде, открыть контрольную запись и зафиксировать дату успешной проверки.
- Откат неудачного обновления: сверить симптомы с описанными, получить разрешение, вернуть проверенную версию и наблюдать оговорённые показатели.
- AI-помощник читает разрешённые логи и предлагает дежурному шаг из актуальной инструкции; восстановление выполняется только после подтверждения.
Где используется
- Повторяемые операции эксплуатации и выпуск версий.
- Обучение нового сотрудника работе с конкретным сервисом.
- Восстановление после известных сбоев и проверка резервных копий.
Связанные термины
Частые вопросы
Runbook — это обязательно аварийная инструкция?
Нет. Он подходит и для плановой операции: выпуска версии, проверки резервной копии или замены ключа. Важно, чтобы цель и критерий результата были конкретными.
Чем отличается от обычного чек-листа?
Короткий runbook сам может быть чек-листом. Для рискованной операции нужны дополнительные сведения: условия применения, права, ожидаемый вывод, остановка и восстановление прежнего состояния.
Можно ли поручить выполнение AI-агенту?
Часть проверок можно автоматизировать после испытаний. Изменение рабочей системы требует отдельных разрешений и правил подтверждения. Текст инструкции не должен сам выдавать агенту новые права.
Что делать, если симптомы не совпадают?
Остановиться и передать проблему ответственному или перейти к процедуре диагностики. Не подбирать команды восстановления по сходству названий ошибок.
Как понять, что инструкция готова?
Другой сотрудник проходит её в тестовой среде без догадок, достигает описанного результата и понимает, когда нужно остановиться. После изменения системы проверку повторяют.