Как вы документируете сеть?

Question

Я не уверен, как задать этот вопрос, так как я не в поле. Допустим, вы администратор сети и уходите с работы. Как новый парень знает, с чего начать?

Kyle Noland · Accepted Answer

Это зависит, помимо прочего, от размера сети, количества пользователей, количества узлов (компьютеров, серверов, принтеров и т.д.) И численности вашего ИТ-персонала.

Это также зависит от вашей цели. Вы документируете сеть для целей обучения и обслуживания, страхования/предотвращения потерь и т.д.?

Лично я документирую свои сети таким образом, что я знаю, что могу получить любую недостающую информацию на основе того, что is задокументировано. С практической точки зрения, есть смысл уменьшить отдачу, когда ваша документация становится слишком детальной.

Хорошее эмпирическое правило, которое я использую, заключается в том, что в известном месте должна быть достаточно тщательная документация, чтобы, если сегодня вечером меня ударит автобус, другой администратор сможет сохранить работоспособность базовой сети, пока он/она заполняет недостающие фрагменты над следующие несколько дней/недель.

Вот краткий обзор того, что я считаю наиболее важным в одной из моих сетей. Для справки: это магазин для Windows, в котором около 100 пользователей и 5 офисов.

Учетные данные администратора для всех серверов. Очевидно, что это должно быть в безопасности.
IP-адреса и имена NetBIOS для любого узла в сети со статическим IP-адресом, включая серверы, рабочие станции, принтеры, брандмауэры, маршрутизаторы, коммутаторы и т.д.
Основная информация об оборудовании сервера, такая как метки обслуживания или эквивалент, общая емкость диска, общая память и т.д.
Основные роли каждого сервера, такие как контроллер домена, файловый сервер, сервер печати, сервер терминалов и т.д.
Расположение резервных копий лент/дисков.
Информация о номерах учетных записей и учетных данных для таких служб, как поставщики голосовых услуг и данных удаленного офиса.
Внешний DNS для сайтов и маршрутизации.

Если бы в настройке или рабочем процессе было что-то странное, что не было бы сразу очевидно для нового администратора, я бы также написал краткое "краткое" об этом.

Adam D&#39;Amico · Answer

Я считаю, что лучше всего включить все следующее:

Проза: общий обзор в форме абзаца, который помогает с начальной общей картиной, а также может описать эволюцию с течением времени
Таблицы: Табличные списки, с адресной, экологической или машинной (желательно все вышеперечисленное)
Диаграммы: обязательно нужны диаграммы с несколькими уровнями детализации. В любой приличной сети просто невозможно разумно захватить все это на одной странице и сделать ее легко усваиваемой. Вам нужна одна диаграмма на глобальном уровне с инфраструктурными устройствами (маршрутизаторы, коммутаторы, конечные точки туннеля и т.д.), А другая - для вычислительных ресурсов, предоставляемых каждым из этих маршрутизаторов или конечных точек.

Дополнительные примечания о диаграммах ... Географическое распределение - это простой способ сегментировать, но вам также нужны логические представления, основанные на функции установки. Кроме того, маркируйте как сумасшедшие, полностью используя шрифты и цвета.

Kara Marfia · Answer

Наиболее эффективный и тщательный способ запустить этот процесс - создать его из сценария аварийного восстановления, например здание загорелось, и все, что у нас есть, это резервные копии за пределами площадки. Что нам нужно сначала купить, и как это нужно будет настроить?

Кайл уже дал отличные детали, но я обнаружил, что подход DR помогает мне разбирать вещи по одному.

Xerxes · Answer

Где я работаю - мы столкнулись с той же проблемой, когда я впервые начал здесь. По мере увеличения количества серверов и сервисов вы найдете все больше устаревшей документации, и с этим неизбежно возникает необходимость для персонала не доверять документации, по крайней мере технической документации по именам серверов, группам серверов, сетям и т.д.

Мы начали разработку проекта с открытым исходным кодом под названием hotwire , чтобы решить эту проблему ...

Система инвентаризации (серверы, сети и т.д.)
Сборки сервера - RHEL Kickstart, SuSE AutoYaST, (TODO: Debian Preseed, Solaris Jumpstart)

Объединяя систему инвентаризации с системой сборки, мы гарантируем, что то, что находится в базе данных, согласуется с тем, что находится в наших центрах обработки данных, потому что теперь мы должны сначала ввести данные в инвентаризацию, чтобы иметь возможность строить серверы ,.

Клиентская программа (funcwire) затем устанавливается на все серверы (как часть процесса сборки), которая затем динамически следит за аппаратным обеспечением сервера, о чем сообщает python-dmidecode , и что находится в инвентаре, так что если что-то изменится, администраторы узнают об этом немедленно.

Затем мы интегрировали нашу вики-систему так, чтобы каждый сервер, стойка, проект, модель оборудования и т.д. В hotwire связывались непосредственно с соответствующей вики-страницей.

Следовательно, мы "задокументировали" наши серверы/сеть/и т.д., Используя hotwire + вики (здесь мы используем слияние, но подойдет любая приличная вики). (Обратите внимание, что после того, как серверы построены - hotwire не изменяет их каким-либо образом - текущее управление осуществляется через cfengine).

Sam Mackrill · Answer

Я использую MikroTik Dude для автоматического планирования, это замечательное приложение, учитывая, что оно бесплатное. Он также может отслеживать текущее состояние. Чувак веб-страница

kdmurray · Answer

Ответ Кайла - отличный совет. Хотя, по крайней мере, вы могли бы уйти с перечисления:

Серверы (включая имена хостов, IP-адреса и роли)
Сетевое оборудование (коммутаторы, маршрутизаторы, межсетевые экраны)
Архивы мастер-паролей (доменные пароли, пароли администратора)
Грубый документ с изложением сетевых политик и любых странных настроек (включая здесь любые выбросы, такие как машины, которые не являются частью домена (ов))

Raj J · Answer

Кайл Ноланд и другие постеры много рассказали о том, как документировать. Мы работаем над созданием стандартного веб-программного обеспечения (размещенного вами внутри), которое позволит сетевым и системным администраторам документировать свою сеть.

На момент написания этой статьи (апрель 2012 г.) у нас есть следующие аспекты, касающиеся программного обеспечения:

Документация по центру обработки данных.
Сведения об устройстве (включая сведения о HW/OS)
Управление IP-адресами
Отображение зависимости приложения
Отношения устройств - от зданий до виртуалов/блейдов.

Вы можете прочитать больше здесь , и мы будем благодарны за ваш отзыв.

Dan · Answer

Для получения дополнительных руководств о том, как/что документировать, есть networkdocumentation.com .

Для некоторых хороших примеров см. ratemynetworkdiagram.com . например Этот довольно хорошо , а этот --- классно ;).

Netais LLC · Answer

Подход к документированию сети как разработчик подходит к разработке системы ...

Рассмотрите требования - это было хорошо отмечено выше, но учтите, что ВОЗ собирается проконсультироваться с doc-o и для ЧЕГО НАЗНАЧЕНИЯ. Аудиторы будут искать и читать другие артефакты, чем одноранговый SysAdmin.
Ведение документации - многие люди упомянули ценность диаграмм и карт, и как визуальный мыслитель я от всего сердца согласен. НО эти вещи могут быть признаны недействительными одним актом добавления/удаления хоста. Подумайте о "правильном" уровне документа, который ваша группа может поддерживать.
Дата все и включите заметки о том, почему вы настроили сеть так, как вы сделали. Многие, многие забывают указать дату, но DATE предоставляет указатель на историю сети. Незаменим для решения проблем, и это уменьшает внутреннюю устаревание большинства сетевых диаграмм.
Перенесите документацию в "процессы" - во многих случаях надежные и тщательно продуманные процедуры сборки/развертывания в конечном итоге оптимизируют "сетевую документацию", поскольку подробности конфигурации и наименования компьютеров лучше описаны в процедурах.

Ключевые выводы: подход к документации как "система"; он должен обеспечивать ценность с первого дня и несет с собой неотъемлемую ответственность за его поддержание.

PEra · Answer

На нашем сайте мы используем несколько систем для документирования наших собственных сетей и сетей клиентов. Мы попробовали и потерпели неудачу с помощью множества методов/инструментов, которые не масштабировались, но теперь мы вполне готовы к следующему:

Если кто-то имеет дело с большим количеством IP-сетей, phpIP может быть подходящим решением IPAM.

sclarson · Answer

Обычно у вас есть несколько разных уровней детализации, похожих на абстракции в документации по разработке программного обеспечения. Вы также документируете общие практики/процедуры/настройки устройства. Административные пароли в зависимости от обстоятельств.

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

Руководящие и процедурные документы, на мой взгляд, должны быть централизованы, где бы ни находились все документы по ИТ, а сетевые диаграммы могут иметь собственную структуру папок для нескольких мест.

В случае многих спутниковых сайтов, таких как Walmart/Targer/Home Depot, у вас будет общий документ для всех филиалов, а затем некоторые подробные документы всей корпорации о соединениях в главном офисе, а затем вы сможете погрузиться в документы локальной сети офиса.

Matt P · Answer

Я предлагаю http://opennetadmin.com . Это многое из того, что люди предложили в других комментариях.

user64604 · Answer

Карта и документация вашей сети может стать хорошим способом передачи необходимой информации. MS Visio - это инструмент для построения диаграмм, но он статичен и на него приходится тратить много времени. Я обнаружил, что NetBrain - это идеальный инструмент для построения сетевых диаграмм. Он может мгновенно документировать сеть, а документацию можно экспортировать в Visio или Word. Я могу настроить содержимое, которое я хочу, при документировании моей сети. Индивидуальное содержание включает в себя: 

Содержимое инвентаря, такое как серийный номер, версия ОС и т.д. 
Содержание, связанное с дизайном, такое как динамическая маршрутизация, QoS, фильтрация трафика 
Содержание, связанное с трафиком… 
Содержимое файла конфигурации 
Схема

Вы можете попытаться задокументировать свою сеть на сайте.

Ward - Reinstate Monica · Answer

Как уже упоминалось, это зависит от ряда факторов ...

Моя цель состояла в том, чтобы иметь достаточную документацию, чтобы я мог (по крайней мере, концептуально) передать все это коллеге и сказать: "Увидимся через 3 недели" и знать, что все важные детали были там.

Пароли для всех серверов и устройств (коммутаторы, принтеры и т.д.)
Пароли для любых сайтов, требующих регистрации - ISP, регистрация доменного имени, гарантии на оборудование, центры сертификации и т.д.
Карта используемых IP-адресов - внутренний, внешний, dmz, блоки DHCP и т.д.
Подробная информация о каждом сервере: стандартные данные, такие как серийный номер, количество диска, оперативной памяти и т.д., Но мы также вели постоянный журнал всего, что было сделано с коробкой, начиная с замечаний по установке (o/s и app. Install), потом буду конфигурацию и последующие изменения.

Мне никогда не удавалось сделать это полностью, но я стремился документировать все основные рутинные процессы - как настроить серверы, как и что контролировалось, настройка и удаление аккаунта, резервное копирование и т.д.

jedberg · Answer

Обычно это не документируется, но если вы добры, вы обычно делаете это в таких программах, как Visio или эквивалент с открытым исходным кодом. Наиболее важной информацией является то, какое оборудование к чему подключено, и пароли для любой консоли управления. Остальное обычно можно угадать.

Scott · Answer

В моей предыдущей карьере в качестве ИТ-менеджера моя папка для документации включала диаграмму Visio для всех устройств, список распределений диапазонов IP-адресов, все ключи продукта для Windows/Office/Acrobat, инструкции по установке на новых компьютеры с пошаговыми инструкциями, как выполнить полную инвентаризацию оборудования до уровня компонентов и, наконец, список телефонов экстренной помощи, но не в последнюю очередь: техническая поддержка интернет-провайдера, техническая поддержка производителя маршрутизатора и т. д.

user3943 · Answer

Я использую такие инструменты, как Microsoft Visio или WhatsUp Gold, чтобы наметить топологию сети, если это поможет.

zewsk · Answer

MS Visio - это хороший способ документировать сеть, но это не бесплатное решение. Gliffy - это хороший продукт, если вы хотите снизить расходы.

Типичные сетевые диаграммы показывают, как информация течет через ваши устройства (и обычно выходит в Интернет). Таким образом, на вашей диаграмме должна быть информация о том, где находятся ваши компьютеры, принтеры, WAP, IP-телефоны (если применимо), коммутаторы и маршрутизаторы и как они подключены. IP-адреса также могут быть включены с именем вашего устройства. Это полезно, если вы хотите взглянуть на диаграмму для получения информации на лету.