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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Для некоторых хороших примеров, см. ht tp://www.ratemynetworkdiagram.com/. Например, это довольно хорошо, и это здорово;).

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

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

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

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

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

• Рассмотрите требования - это было хорошо отмечено выше, но учтите, что ВОЗ собирается проконсультироваться с doc-o и для ЧЕГО НАЗНАЧЕНИЯ. Аудиторы будут искать и читать другие артефакты, чем одноранговый SysAdmin.

• Ведение документации - многие люди упомянули ценность диаграмм и карт, и как визуальный мыслитель я от всего сердца согласен. НО эти вещи могут быть признаны недействительными с помощью одного акта добавления / удаления хоста. Подумайте о "правильном" уровне документа, который ваша группа может поддерживать.

• Дата все и включите заметки о том, почему вы настроили сеть так, как вы сделали. Многие, многие забывают указать дату, но DATE предоставляет указатель на историю сети. Незаменим для решения проблем, и это уменьшает внутреннюю устаревание большинства сетевых диаграмм.

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

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

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

• DokuWiki для советов, подробных описаний конфигураций и
• Таблицы (Patchport/MAC/IP/Hostname/Role/Admin-Lookup для всех устройств, Сети /VLAN /VPN, обзор оборудования и т. Д.)
• RSS для распространения изменений на вики-страницах
• Visio (лучшая компания, которую когда-либо покупали M$) рисовать диаграммы всего
• KeePass for Passwords, включая логины для тикет-систем поставщиков
• RackTables для документирования, где устройства расположены и исправлены
• Система билетов, доступная для клиентов
• WhatsUp Gold и другие инструменты для мониторинга и отчетности
• Списки рассылки, чтобы держать людей в курсе

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

NodeSystems это именно то, что инструмент сетевой документации. Как приятный побочный эффект, он создаст для вас интерактивную диаграмму.

Проверьте онлайн демо: http://www.nodesystems.org/demo/