Документация IT-инфраструктуры и эксплуатационные регламенты
Создаю техническую документацию, с которой инфраструктуру можно проверять, изменять и восстанавливать без догадок. Документирую фактическое состояние, а не идеальную схему, которая не совпадает с работающими системами.
Обсудить задачуДля каких ситуаций
Подходит компаниям, где знания о серверах хранятся в памяти одного специалиста, инструкции устарели или новый инженер не может определить связи между сервисами и безопасный порядок изменений.
- неизвестно, какие серверы и сервисы ещё используются
- конфиги есть, но неясно, какой из них активен
- нет схемы DNS, сети и внешних публикаций
- восстановление описано общими словами
- передача инфраструктуры новому специалисту занимает недели
Что входит в работу
- инвентаризация узлов, адресов, ролей и владельцев
- карта сервисов, зависимостей, DNS и сетевых связей
- расположение конфигов, журналов, секретов и резервных копий без раскрытия самих секретов
- runbook проверки, обновления, перезапуска и восстановления
- фиксация известных рисков и даты проверки сведений
Что получает заказчик
- актуальная карта инфраструктуры и ответственных
- понятный порядок типовых эксплуатационных действий
- новый инженер быстрее находит нужные системы и проверки
- устаревшие и неподтверждённые сведения явно отмечены
Как проходит работа
Частые вопросы
Вы записываете пароли в документацию?
Нет. Документируется место и способ получения секрета, правила доступа и ответственный, но сами пароли не должны храниться в обычном текстовом отчёте.
В каком формате передаётся результат?
Формат выбирается под используемые инструменты: Markdown, внутренний wiki, репозиторий или согласованный набор документов и схем.
Как поддерживать документацию актуальной?
Для каждого раздела задаются владелец, дата проверки и событие обновления. Часть инвентаря и отчётов можно формировать автоматически.