Устройство сервиса, типичные симптомы, команды диагностики, способы восстановления и контакты.
Инструкция с обзором сервиса, симптомами, диагностикой, восстановлением и действиями после сбоя.
Кому пригодится
Дежурным инженерам и владельцам сервисов.
Требования и ограничения
Подготовить инструкцию для дежурного инженера
Скилл помогает описать действия при сбое конкретного сервиса. Он нужен при запуске новой системы или когда эксплуатационные знания остаются у нескольких сотрудников. Документ объясняет, как распознать проблему, какую проверку выполнить первой, как уменьшить последствия и к кому обратиться за помощью.
Собрать сведения о сервисе
Для работы понадобятся назначение сервиса, его зависимости, цели надёжности, существующие оповещения, ссылки на панели наблюдения и контакты дежурных. Также передают допустимые способы восстановления и ограничения доступа. Краткое описание системы должно помогать во время инцидента; история разработки и длинное обоснование архитектуры остаются в другой документации.
Превратить диагностику в последовательность действий
Оригинал предлагает начать со здоровья сервиса и доли ошибок, затем проверить зависимости, последние развёртывания, загрузку ресурсов и первое появление характерной ошибки в журнале. У каждого шага указывают конкретную команду или ссылку, ожидаемый результат и дальнейшее действие при успехе и при сбое. Шаги с дополнительными правами помечают отдельно.
Упорядочить способы восстановления
Меры группируют по времени выполнения и риску. Быстрые действия могут включать откат изменения или отключение функции; более длительные — увеличение числа экземпляров либо восстановление данных. Применимость каждого способа устанавливают для данного сервиса. Высокорисковые действия в исходной процедуре требуют согласования с руководителем инцидента, поэтому такое условие сохраняют в инструкции.
Назвать ответственных и действия после сбоя
Путь эскалации начинается с команды сервиса, затем при необходимости переходит к инфраструктурной команде или поставщику. Нужны действующие контакты и правила вызова, а не общая фраза «обратитесь к поддержке». После восстановления инструкция направляет к шаблону разбора инцидента и указывает, какие дополнительные проверки или оповещения должны сработать.
Как выглядит готовый документ
На выходе получается отдельная инструкция на сервис из шести частей: обзор, симптомы, диагностика, восстановление, эскалация и действия после инцидента. Её хранят рядом с кодом в системе версий. Перед использованием проверяют ссылки, команды и обе ветви каждого диагностического шага. Учебные команды из оригинала нельзя переносить в рабочую среду без подстановки фактических сведений и проверки их назначения.
Автор и источник
Оригинальное название: runbook-writer
Автор или репозиторий: SkillMedev/skills
Лицензия: MIT
Открыть первоисточник