Подготовка runbook
Сделай процедуру выполнимой
- Определи условие запуска, желаемый результат, целевую среду, необходимый доступ и человека или роль, которые могут выполнить процедуру. Давай ссылки на учётные данные, не вставляй их значения.
- Начни с наблюдений, отличающих нужный сбой от похожих симптомов. Runbook на все возможные аварии обычно скрывает решение, которое требуется оператору.
- Используй реальные команды проекта и поддерживаемые версии инструментов. Явно отмечай неопределённые параметры: правдоподобная команда с предполагаемым namespace или аккаунтом не является проверенной инструкцией.
Опиши точки принятия решений
- Отделяй диагностику только на чтение от действий, меняющих состояние. Для каждого изменения указывай предварительные условия, точный выбор цели, ожидаемый эффект и условие остановки или отката.
- Покажи, как интерпретировать значимые результаты и выбирать следующий шаг. Список команд без ожидаемых результатов не позволяет оператору понять, когда диагноз ошибочен.
- Укажи правила повторов для неидемпотентных операций, частичного завершения и асинхронных заданий. Изучи предыдущий результат перед повтором действия, способного продублировать работу.
- Предусмотри порядок действий при ограниченном или отсутствующем доступе к зависимостям самой процедуры, таким как идентификация, управление развёртыванием или мониторинг, и укажи пути эскалации.
- Заверши проверкой восстановления на уровне пользователя или данных и перечислением временных изменений, которые необходимо привести к согласованному состоянию. Один код завершения команды не является критерием готовности.
Проверь и передай результат
Пройди процедуру в доступной тестовой среде или по сохранённому тестовому сценарию в пределах запроса. Зафиксируй, какие шаги выполнены, какие только проверены по описанию, а какие заблокированы отсутствием доступа.
Предоставь процедуру, пригодную для выполнения без автора, с ответственными и действительно проверенными ссылками. Необязательный templates/runbook.md может задать структуру. Не придумывай дашборды, доступ, согласования или успешную учебную проверку. Разрушительные шаги должны оставаться в рамках политики проекта.
1---2name: runbook-authoring3description: Создать или исправить инструкцию оператора для конкретной штатной операции или вида отказа, с точками принятия решений, проверкой и эскалацией. Использовать, когда процедуру должен суметь выполнить другой человек позднее.4---56# Подготовка runbook78## Сделай процедуру выполнимой910- Определи условие запуска, желаемый результат, целевую среду, необходимый доступ и человека или роль, которые могут выполнить процедуру. Давай ссылки на учётные данные, не вставляй их значения.11- Начни с наблюдений, отличающих нужный сбой от похожих симптомов. Runbook на все возможные аварии обычно скрывает решение, которое требуется оператору.12- Используй реальные команды проекта и поддерживаемые версии инструментов. Явно отмечай неопределённые параметры: правдоподобная команда с предполагаемым namespace или аккаунтом не является проверенной инструкцией.1314## Опиши точки принятия решений15161. Отделяй диагностику только на чтение от действий, меняющих состояние. Для каждого изменения указывай предварительные условия, точный выбор цели, ожидаемый эффект и условие остановки или отката.172. Покажи, как интерпретировать значимые результаты и выбирать следующий шаг. Список команд без ожидаемых результатов не позволяет оператору понять, когда диагноз ошибочен.183. Укажи правила повторов для неидемпотентных операций, частичного завершения и асинхронных заданий. Изучи предыдущий результат перед повтором действия, способного продублировать работу.194. Предусмотри порядок действий при ограниченном или отсутствующем доступе к зависимостям самой процедуры, таким как идентификация, управление развёртыванием или мониторинг, и укажи пути эскалации.205. Заверши проверкой восстановления на уровне пользователя или данных и перечислением временных изменений, которые необходимо привести к согласованному состоянию. Один код завершения команды не является критерием готовности.2122## Проверь и передай результат2324Пройди процедуру в доступной тестовой среде или по сохранённому тестовому сценарию в пределах запроса. Зафиксируй, какие шаги выполнены, какие только проверены по описанию, а какие заблокированы отсутствием доступа.2526Предоставь процедуру, пригодную для выполнения без автора, с ответственными и действительно проверенными ссылками. Необязательный `templates/runbook.md` может задать структуру. Не придумывай дашборды, доступ, согласования или успешную учебную проверку. Разрушительные шаги должны оставаться в рамках политики проекта.
fbakiyev