Як документувати мережу?


66

Я не впевнений, як поставити це запитання, оскільки я не в полі. Скажіть, ви адміністратор мережі і ви залишаєте свою роботу. Звідки новий хлопець знає, з чого почати?


6
Також: Документація дозволяє коли-небудь взяти відпустку, а також захистити компанію, якщо ви занадто хворі / травмовані на роботі.
Кара Марфія

Відповіді:


55

Це залежить від розміру мережі, кількості користувачів, кількості вузлів (комп'ютерів, серверів, принтерів тощо) та розміру вашого ІТ-персоналу.

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

Особисто я документувати свою мережу таким чином , що я знаю , що може отримати інформацію, якої бракує , засновану на тому, що це документально. З практичної точки зору, дедалі зменшується прибуток, коли ваша документація стає надто детальною.

Хорошим правилом, яке я використовую, є те, що у відомій місцевості повинна бути документація, яка є достатньо ґрунтовною, що якщо мене сьогодні автобусом вдарить автобус, інший адміністратор може продовжувати роботу основної мережі, поки він / вона заповнює пропущені фрагменти над наступні кілька днів / тижнів.

Ось огляд того, що, на мою думку, є найважливішим у одній із моїх мереж. Для запису це магазин для Windows, який містить близько 100 користувачів та 5 офісів.

  • Повноваження адміністратора для всіх серверів. Очевидно, що це слід тримати в безпеці.
  • IP-адреси та назви NetBIOS для будь-якого вузла в мережі зі статичною IP-адресою, включаючи сервери, робочі станції, принтери, брандмауері, маршрутизатори, комутатори тощо.
  • Основна інформація про апаратне забезпечення сервера, наприклад теги служби або еквівалент, загальна ємність диска, загальна оперативна пам’ять тощо.
  • Основні ролі кожного сервера, такі як контролер домену, файловий сервер, сервер друку, термінальний сервер тощо.
  • Розташування резервних стрічок / дисків.
  • Інформація про номери рахунків та облікові дані для таких послуг, як віддалений офіс, голосові дані та постачальники даних.
  • Зовнішній DNS для веб-сайтів та маршрутизації.

Якщо у налаштуваннях чи робочих процесах було щось дивне, що не було б очевидним для нового адміністратора, я також напишу короткий "короткий" про це.


8
+1 для сценарію "автобус".
romandas

11

Я вважаю, що найкраще включати в себе все наступне:

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

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


5

Найефективніший і ґрунтовний спосіб розпочати цей процес - це побудувати його за сценарієм відновлення після аварій - наприклад, будівля загорілася полум'ям, і все, що ми маємо, - це резервні копії за межами місця. Що нам потрібно буде придбати спочатку і як це потрібно буде налаштувати?

Кайл вже дав чудові деталі, але я вважаю, що підхід до ДР допомагає мені сприймати речі по черзі.


4

Відповідь Кайла - чудова порада. Хоча, як мінімум, ви можете піти з переліку:

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

4

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

Для вирішення цього питання ми почали розробляти проект з відкритим кодом під назвою hotwire ...

  • Система інвентаризації (сервери, мережі тощо)
  • Налаштування сервера - RHEL Kickstart, SuSE AutoYaST, (TODO: Debian Preseed, Solaris Jumpstart)

Поєднуючи систему інвентаризації з системою збірки, ми гарантували, що те, що знаходиться в базі даних, відповідає тому, що знаходиться в наших центрах обробки даних, тому що тепер ми повинні ввести дані спочатку в інвентар, щоб мати можливість створювати сервери .

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

Потім ми інтегрували нашу систему wiki, щоб кожен сервер, стійка, проект, модель апаратури тощо в гарячих провідних посиланнях безпосередньо на відповідну сторінку wiki.

Таким чином, ми «задокументували» наші сервери / мережу / тощо за допомогою гарячої проводки + вікі (тут ми використовуємо злиття, але будь-яка гідна вікі це зробить). (Однак зауважте, що як тільки сервери побудовані - гарячий провід не змінює їх жодним чином - постійне управління здійснюється за допомогою cfengine).


3
посилання "howtire" не працює; не можна знайти його і через Google. Він мертвий?
відмітка

4

Я використовую MikroTik Dude для автоматичного відображення речей, це дивовижна програма, враховуючи, що вона безкоштовна. Він також може контролювати поточний стан. Чувак веб-сторінки


2

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

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

На мою думку, керівні та процедурні документи повинні бути централізованими там, де всі IT-документи, і мережеві діаграми можуть мати власну структуру папок для декількох локацій.

У випадку багатьох супутникових сайтів, таких як walmart / targer / home depot, у вас є загальний документ для всіх відділень, а потім детальні цілі документи корпорації з основних зв'язків головного офісу, і тоді ви можете зануритися в офісні документи LAN.


2

Підхід до документування мережі як розробник підходить до розробки системи ...

  • Розгляньте вимоги - це вже було добре зазначено вище, але врахуйте, хто збирається проконсультуватися з док-ом і щодо того, ЩО МЕТА. Аудитори будуть шукати та читати різні артефакти, ніж аналогічний SysAdmin.

  • Робота з технічним обслуговуванням документів - багато людей згадували значення діаграм і карт, і я, як візуальний мислитель, щиро погоджуюся. АЛЕ ці речі можна визнати недійсними одним актом додавання / видалення хоста. Подумайте про "правильний рівень" doc-o - той, який може насправді підтримувати ваша група.

  • Датуйте все та включайте примітки щодо ЧОМУ ви налаштували мережу так, як це зробили. Багато, багато людей забувають включити дату - але ДАТА дає вказівку на історію мережі. Цінна для вирішення проблем і пом’якшує властиву застарілість більшості мережних діаграм.

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

Ключовий винос: підхідна документація як "система"; вона повинна надати цінність з 1-го дня, і вона несе в собі невід'ємну відповідальність за її утримання.


2

На нашому сайті ми використовуємо кілька систем для документування власної та клієнтської мереж. Ми спробували і не вдалися з багатьма методами / інструментами, які не масштабували, але тепер ми готові до наступного:

  • DokuWiki для порад, детального опису конфігурацій та
  • Таблиці (Patchport / MAC / IP / Ім'я хоста / Роль / Пошук адміністраторів для всіх пристроїв, Мереж / VLAN / VPN, Огляд обладнання тощо)
  • RSS для поширення змін на сторінках вікі
  • Visio (найкраща компанія, яку M $ коли-небудь купував ...) малював схеми всього
  • KeePass для паролів, включаючи вхід для системних квитків постачальників
  • RackTables документує, де розташовані пристрої та виправлені
  • Система квитків, доступна для клієнтів
  • WhatsUp Gold та інші інструменти для моніторингу та звітності
  • Списки розсилки для інформування людей

Якщо стосується безлічі IP-мереж, phpIP може бути підходящим рішенням IPAM.



2

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

Станом на цей текст (у квітні 2012 р.) У програмному забезпеченні є такі аспекти:

  • Документація Центру обробки даних
  • Деталі пристрою (включаючи деталі HW / OS)
  • Управління IP-адресами
  • Зображення залежності додатків
  • Відносини пристрою - від будівель до віртуалів / лез.

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


1

Зазвичай це не задокументовано, але якщо ви добрі, зазвичай це робите в такій програмі, як Visio або еквівалент з відкритим кодом. Найважливіша інформація - це те, яке обладнання підключено до чого, і паролі для будь-якої консолі управління. Решту, як правило, можна розгадати.


2
Зазвичай це задокументовано в місці з великою мережею. Напевно, не в деталях, що це повинно бути, або, можливо, трохи відстає від поточного, але зазвичай це документально підтверджено.
sclaron

1
Я намагався бути язиком у щоці.
jedberg

1

У моїй попередній кар'єрі ІТ-менеджера моє в'яжуче документування включало діаграму Visio всіх пристроїв, список розподілу діапазону IP-адрес, усі ключі продукту для Windows / Office / Acrobat, інструкції щодо того, що потрібно встановити на нових комп’ютери з покроковими інструкціями, як завершити інвентаризацію обладнання до рівня компонентів, і останнє, але не в останню чергу, список телефонних номерів екстрених служб: технічна підтримка провайдера, технічна підтримка виробника маршрутизаторів тощо.


1

Як було сказано, це залежить від ряду факторів ...

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

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

Мені ніколи не вдалося це зробити повністю, але я мав на меті задокументувати всі основні рутинні процеси - як налаштовано сервери, як і що відстежували, налаштування та видалення облікових записів, резервне копіювання тощо.



1

Зробити карту та документувати вашу мережу може бути хорошим способом передачі необхідної інформації. MS Visio - це інструмент діаграм, але він є статичним, і вам доведеться витратити на нього багато часу. Я виявив, що NetBrain є ідеальним інструментом мережевої діаграми для цього. Він може документувати мережу миттєво, а документацію можна експортувати у Visio або Word. Я можу налаштувати потрібний вміст під час документування своєї мережі. Індивідуальний вміст включає: 

  1. Вміст, пов'язаний з інвентарем, таким як серійний номер, версія ОС тощо. Etc
  2. Зміст, пов’язаний з дизайном, наприклад, динамічна маршрутизація, QoS, фільтрація трафіку 
  3. Вміст, пов’язаний з трафіком……
  4. Вміст, пов’язаний з файлом конфігурації 
  5. Діаграма

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


1

Я використовую такі інструменти, як Microsoft Visio або WhatsUp Gold, щоб скласти топологію мережі, якщо це допомагає.


0

MS Visio - це хороший спосіб документувати мережу, але це не безкоштовне рішення. Gliffy - це приємний продукт, якщо ви хочете, щоб ваші витрати були низькими.

Типові діаграми мережі показують, як інформація протікає через ваші пристрої (і, як правило, в Інтернет). Отже, у вашій діаграмі має бути інформація про те, де розміщені ваші комп’ютери, принтери, WAP, IP-телефони (якщо це можливо), комутатори та маршрутизатори та як вони підключені. IP-адреси можуть також бути додані до імені вашого пристрою. Це корисно, якщо ви хочете переглянути свою діаграму, щоб дізнатися інформацію про льоту.


-1

NodeSystems саме це - інструмент мережевої документації. Як хороший побічний ефект, він створить для вас інтерактивну діаграму.

Перегляньте демонстрацію в Інтернеті: http://www.nodesystems.org/demo/

Використовуючи наш веб-сайт, ви визнаєте, що прочитали та зрозуміли наші Політику щодо файлів cookie та Політику конфіденційності.
Licensed under cc by-sa 3.0 with attribution required.