Не знаю, как задать этот вопрос, так как я не в этой области. Допустим, вы администратор сети и увольняетесь с работы. Как новичок знает, с чего начать?
Это зависит, помимо прочего, от размера сети, количества пользователей, количества узлов (компьютеров, серверов, принтеров и т. Д.) И размера вашего ИТ-персонала.
Это также зависит от вашей цели. Вы документируете сеть для обучения и технического обслуживания, страхования / предотвращения потерь и т. Д.?
Лично я документирую свои сети таким образом, чтобы знать, что я могу получить любую недостающую информацию на основе того, что является задокументировано. С практической точки зрения, когда ваша документация становится слишком детализированной, существует точка уменьшения отдачи.
Хорошее практическое правило, которое я использую, заключается в том, что в известном месте должна быть документация, которая должна быть достаточно тщательной, чтобы, если меня сегодня вечером сбьет автобус, другой администратор может поддерживать работоспособность базовой сети, пока он / она заполняет недостающие части по следующие несколько дней / недель.
Вот обзор того, что я считаю наиболее важным в одной из моих сетей. Для справки, это магазин только для Windows, около 100 пользователей и 5 офисов.
Если бы в настройке или рабочем процессе было что-то странное, что не сразу стало бы очевидным для нового администратора, я бы также написал об этом короткую «краткую информацию».
Я считаю, что лучше всего включить все следующее:
Дополнительные примечания к диаграммам ... Географическое распределение - это простой способ сегментирования, но вам также необходимы логические представления на основе функции установки. Кроме того, лейбл как сумасшедший, в полной мере используя шрифты и цвета.
Самый эффективный и тщательный способ начать этот процесс - построить его на основе сценария аварийного восстановления, например здание загорелось, и все, что у нас есть, - это резервные копии вне офиса. Что нам нужно будет купить в первую очередь и как это нужно будет настроить?
Кайл уже дал много подробностей, но я считаю, что подход DR помогает мне брать вещи по частям.
Я использую MikroTik Dude для автоматического отображения вещей, это отличное приложение, учитывая, что оно бесплатное. Он также может отслеживать текущий статус. Веб-страница чувака
Где я работаю - мы столкнулись с той же проблемой, когда я только начинал здесь. По мере увеличения количества серверов и сервисов вы обнаруживаете все больше и больше устаревшей документации, что неизбежно приводит к тому, что персонал не доверяет документации, по крайней мере, технической документации по именам серверов, группам серверов, сетям и т. Д.
Мы начали разработку проекта с открытым исходным кодом под названием горячий провод чтобы решить эту проблему ...
Объединив систему инвентаризации с системой сборки, мы гарантируем, что то, что находится в базе данных, согласуется с тем, что находится в наших центрах обработки данных, потому что теперь нам нужно сначала ввести данные в инвентарь, чтобы иметь возможность построить серверы. .
Затем на всех серверах устанавливается клиентская программа (funcwire) (как часть процесса сборки), которая затем динамически отслеживает оборудование сервера, как сообщает python-dmidecode, и что находится в инвентаре, поэтому, если что-то изменится, администраторы немедленно узнают.
Затем мы интегрировали нашу вики-систему, так что каждый сервер, стойка, проект, модель оборудования и т. Д. В Hotwire ссылается непосредственно на соответствующую вики-страницу.
Таким образом, мы «задокументировали» наши серверы / сеть / и т. Д. С помощью hotwire + wiki (здесь мы используем слияние, но подойдет любая приличная wiki). (Обратите внимание, однако, что после сборки серверов - hotwire никоим образом не изменяет их - текущее управление осуществляется через cfengine).
Ответ Кайла - отличный совет. Тем не менее, как минимум, вам, вероятно, сошло бы с рук перечисление:
Кайл Ноланд и другие плакаты много рассказали о том, как документировать. Мы работаем над созданием стандартного веб-программного обеспечения (размещаемого внутри вас), которое упрощает для сетевых и системных администраторов документирование своей сети.
На момент написания этой статьи (апрель 2012 г.) у нас были следующие аспекты, охваченные программным обеспечением:
Вы можете прочитать больше Вот и мы будем признательны за ваш отзыв.
Для получения дополнительных руководств о том, как / что документировать, есть networkdocumentation.com.
Для некоторых хороших примеров см. ratemynetworkdiagram.com. например Этот довольно хорошо, а этот здорово ;).
Подход к документированию сети как подход разработчика к разработке системы ...
Примите во внимание требования - это было хорошо отмечено выше, но примите во внимание, что КТО будет консультироваться с документом и для КАКОЙ ЦЕЛИ. Аудиторы будут искать и читать артефакты, отличные от однорангового SysAdmin.
Ведение документации - многие люди упоминали о ценности диаграмм и карт, и как визуальный мыслитель я полностью согласен. НО эти вещи могут быть аннулированы одним действием добавления / удаления хоста. Подумайте о «правильном уровне» doc-o - таком, который ваша группа действительно может поддерживать.
Датируйте все и включайте примечания относительно того, ПОЧЕМУ вы настроили сеть так, как вы это сделали. Многие, многие люди забывают указать дату, но ДАТА является указателем на историю сети. Бесценен для решения проблем и смягчает неизбежную устаревание большинства сетевых диаграмм.
Разгрузка документации в «процессы» - во многих случаях надежные и хорошо продуманные процедуры сборки / развертывания в конечном итоге приводят к упрощению «сетевой документации», поскольку детали конфигурации машины и именования лучше описаны в процедурах.
Ключевой вывод: документация подхода как «система»; он должен обеспечивать ценность с первого дня и несет с собой неотъемлемую ответственность за ее поддержание.
Обычно у вас есть несколько разных уровней детализации, подобных абстракциям в документации по разработке программного обеспечения. Вы также документируете общие методы / процедуры / конфигурацию устройства. Административные пароли, если применимо.
В идеальной ситуации почти все, что может понадобиться следующему человеку, легко доступно и задокументировано между вашим руководством и документами процедуры + схемами разводки сети.
На мой взгляд, руководящие и процедурные документы должны быть централизованы, где бы ни находились все ИТ-документы, а сетевые диаграммы могут иметь собственную структуру папок для нескольких мест.
В случае многих вспомогательных сайтов, таких как Walmart / Targer / Home Depot, у вас будет общий документ для всех филиалов, а затем некоторые подробные корпоративные документы о межсетевых соединениях главного офиса, а затем вы можете погрузиться в документы офисной локальной сети.
На нашем сайте мы используем несколько систем для документирования наших собственных сетей и сетей клиентов. Мы пробовали и потерпели неудачу с множеством методов / инструментов, которые не масштабировались, но теперь мы вполне уверены в следующем:
Если иметь дело с большим количеством IP-сетей, phpIP может быть подходящим решением IPAM.
Я использую такие инструменты, как Microsoft Visio или WhatsUp Gold, чтобы составить карту топологии сети, если это помогает.
Картирование и документирование вашей сети может быть хорошим способом передачи необходимой информации. MS Visio - это инструмент для создания диаграмм, но он статичен, и вам придется потратить на него много времени. Я обнаружил, что NetBrain - идеальный инструмент для построения сетевых диаграмм. Он может мгновенно задокументировать сеть, а документацию можно экспортировать в Visio или Word. Я могу настроить содержимое, которое хочу, при документировании моей сети. Настроенное содержимое включает:
Вы можете попробовать задокументируйте свою сеть на вебсайте.
Я предлагаю http://opennetadmin.com. Он делает многое из того, что люди предлагали в других комментариях.
Как уже упоминалось, это зависит от ряда факторов ...
Моя цель состояла в том, чтобы иметь достаточную документацию, чтобы я мог (по крайней мере концептуально) передать все это коллеге и сказать: «Увидимся через 3 недели», и знать, что все важные детали были там.
Мне так и не удалось сделать это полностью, но я стремился задокументировать все основные рутинные процессы - как были настроены серверы, как и что контролировалось, настройка и удаление учетной записи, резервное копирование и т. Д.
В моей предыдущей карьере ИТ-менеджера моя связка документации включала диаграмму Visio всех устройств, список распределения диапазонов IP-адресов, все ключи продукта для Windows / Office / Acrobat, инструкции о том, что необходимо установить на новом компьютеры с пошаговыми инструкциями, полная инвентаризация оборудования до уровня компонентов и, наконец, что не менее важно, список номеров телефонов для экстренных служб: техническая поддержка интернет-провайдера, техническая поддержка производителя маршрутизатора и т. д.
Обычно это не документируется, но если вы любезны, вы обычно делаете это в такой программе, как Visio или в эквиваленте с открытым исходным кодом. Самая важная информация - какое оборудование к чему подключено и пароли для любой консоли управления. Остальное обычно можно угадать.
MS Visio - хороший способ документировать сеть, но это не бесплатное решение. Gliffy - хороший продукт, если вы хотите снизить расходы.
Типичные сетевые схемы показывают, как информация проходит через ваши устройства (и обычно выходит в Интернет). Итак, у вас должна быть информация на диаграмме о том, где находятся ваши компьютеры, принтеры, точки доступа WAP, IP-телефоны (если применимо), коммутаторы и маршрутизаторы и как они подключены. IP-адреса также могут быть включены в имя вашего устройства. Это полезно, если вы хотите мгновенно просмотреть свою диаграмму для получения информации.
NodeSystems - это инструмент сетевой документации. В качестве приятного побочного эффекта он создаст для вас интерактивную диаграмму.
Посмотрите онлайн-демонстрацию: http://www.nodesystems.org/demo/