Jak dokumentujesz sieć?

66

Nie jestem pewien, jak zadać to pytanie, ponieważ nie jestem w terenie. Powiedz, że jesteś administratorem sieci i porzucisz pracę. Skąd nowy facet wie, od czego zacząć?

Esteban Araya
źródło
6
Ponadto: Dokumentacja pozwala pewnego dnia wziąć urlop, a także chronić firmę, jeśli zachorujesz / doznasz obrażeń ciała do pracy.
Kara Marfia

Odpowiedzi:

55

Zależy to między innymi od wielkości sieci, liczby użytkowników, liczby węzłów (komputerów, serwerów, drukarek itp.) Oraz wielkości personelu IT.

To zależy również od twojego celu. Czy dokumentujesz sieć w celach szkoleniowych i konserwacyjnych, ubezpieczenia / zapobiegania stratom itp.?

Osobiście dokumentuję swoje sieci w taki sposób, że wiem, że mogę uzyskać wszelkie brakujące informacje na podstawie tego, co zostało udokumentowane. Z praktycznego punktu widzenia istnieje sens malejących zwrotów, gdy twoja dokumentacja staje się zbyt szczegółowa.

Dobrą zasadą, której używam, jest to, że w znanej lokalizacji powinna istnieć dokumentacja, która jest wystarczająco dokładna, aby w razie gdyby wieczorem trafił mnie autobus, inny administrator może utrzymać działanie sieci bazowej, podczas gdy on / ona uzupełnia brakujące elementy następne kilka dni / tygodni.

Oto przegląd tego, co uważam za najważniejsze w jednej z moich sieci. Dla przypomnienia jest to sklep tylko dla systemu Windows z około 100 użytkownikami i 5 biurami.

  • Poświadczenia administratora dla wszystkich serwerów. Oczywiście należy to zabezpieczyć.
  • Adresy IP i nazwy NetBIOS dla dowolnego węzła w sieci ze statycznym adresem IP, w tym serwerów, stacji roboczych, drukarek, zapór ogniowych, routerów, przełączników itp.
  • Podstawowe informacje o sprzęcie serwera, takie jak znaczniki serwisowe lub równoważne, całkowita pojemność dysku, całkowita pamięć RAM itp.
  • Główne role każdego serwera, takie jak kontroler domeny, serwer plików, serwer wydruku, serwer terminali itp.
  • Lokalizacja taśm / napędów kopii zapasowych.
  • Informacje o numerach kont i poświadczeniach dla usług takich jak zdalni biurowi dostawcy głosu i danych.
  • Zewnętrzny DNS dla stron internetowych i routingu.

Jeśli było coś dziwnego w konfiguracji lub przepływie pracy, które nie byłyby od razu oczywiste dla nowego administratora, napisałbym również o tym „krótkie”.

Kyle Noland
źródło
8
+1 za scenariusz uderzenia autobusu.
romy
11

Uważam, że najlepiej jest uwzględnić wszystkie następujące elementy:

  • Proza: ogólny przegląd w formie akapitu, który pomaga uzyskać początkowy duży obraz, a także może opisywać ewolucję w czasie
  • Tabele: Listy tabelaryczne, z kluczem adresowym, kluczem środowiskowym lub kluczem maszynowym (najlepiej wszystkie powyższe)
  • Diagramy: zdecydowanie potrzebujesz diagramów z wieloma poziomami szczegółowości. W sieci o przyzwoitym rozmiarze po prostu niemożliwe jest przechwycenie tego wszystkiego na jednej stronie i uczynienie go łatwym do strawienia. Potrzebujesz jednego diagramu na poziomie globalnym z urządzeniami infrastruktury (routerami, przełącznikami, punktami końcowymi tunelu itp.), A jeszcze innych dla zasobów obliczeniowych na czele każdego z tych routerów lub punktów końcowych.

Dodatkowe uwagi na temat diagramów ... Rozkład geograficzny jest łatwym sposobem na segmentację, ale potrzebujesz również logicznych widoków opartych na funkcji instalacji. Etykietuj jak szalony, w pełni wykorzystując kroje i kolory.

Adam D'Amico
źródło
5

Najbardziej skutecznym i dokładnym sposobem na rozpoczęcie tego procesu jest zbudowanie go ze scenariusza odzyskiwania po awarii - np. Budynek stanął w płomieniach, a wszystko, co mamy, to kopie zapasowe poza siedzibą firmy. Co będziemy musieli najpierw kupić i jak trzeba to skonfigurować?

Kyle podał już wspaniałe szczegóły, ale uważam, że podejście DR pomaga mi brać rzeczy po jednym kawałku.

Kara Marfia
źródło
4

Odpowiedź Kyle'a to świetna rada. Co najmniej, prawdopodobnie możesz uciec od wypisania:

  • Serwery (obejmują nazwy hostów, adresy IP i role)
  • Sprzęt sieciowy (przełączniki, routery, zapory ogniowe)
  • Główne archiwa haseł (hasła domeny, hasła administratora)
  • Szorstki dokument przedstawiający zasady sieciowe i wszelkie dziwne konfiguracje (w tym przypadku wszelkie wartości odstające, takie jak komputery, które nie są częścią domen)
kdmurray
źródło
4

Tam, gdzie pracuję - napotkaliśmy ten sam problem, kiedy zaczynałem tutaj. Wraz ze wzrostem liczby serwerów i usług, pojawia się coraz więcej nieaktualnych dokumentów, a wraz z tym przychodzi nieuchronne podejście pracowników do nieufności do dokumentacji, przynajmniej dokumentacji technicznej dotyczącej nazw serwerów, grup serwerów, sieci itp.

Zaczęliśmy rozwijać projekt open source o nazwie hotwire, aby rozwiązać ten problem ...

  • System zapasów (serwery, sieci itp.)
  • Kompilacje serwerów - RHEL Kickstart, SuSE AutoYaST, (TODO: Debian Preseed, Solaris Jumpstart)

Łącząc system ekwipunku z systemem kompilacji, upewniamy się, że zawartość bazy danych jest zgodna z tym, co znajduje się w naszych centrach danych, ponieważ teraz musimy najpierw wprowadzić dane do ekwipunku, aby móc zbudować serwery .

Program kliencki (funcwire) jest następnie instalowany na wszystkich serwerach (w ramach procesu kompilacji), który następnie dynamicznie kontroluje sprzęt serwera, jak zgłasza Python-dmidecode i co znajduje się w inwentarzu, więc jeśli coś się zmieni, administratorzy będzie wiedział natychmiast.

Następnie zintegrowaliśmy nasz system wiki, dzięki czemu każdy serwer, stojak, projekt, model sprzętu itp. W linkach Hotwire prowadzi bezpośrednio do odpowiedniej strony wiki.

Dlatego „udokumentowaliśmy” nasze serwery / sieć / etc za pomocą Hotwire + wiki (używamy tutaj zbieżności, ale każda przyzwoita wiki zrobi). (Należy jednak pamiętać, że po zbudowaniu serwerów Hotwire nie modyfikuje ich w żaden sposób - bieżące zarządzanie odbywa się za pośrednictwem cfengine).

Kserkses
źródło
3
link „howtire” nie działa; też nie mogę go znaleźć przez Google. Czy to jest martwe
znak
4

Używam MikroTik Dude do automatycznego mapowania rzeczy, jest to niesamowita aplikacja, biorąc pod uwagę, że jest darmowa. Może także monitorować bieżący stan. Koleś

Sam Mackrill
źródło
2

Zasadniczo masz kilka różnych poziomów szczegółowości podobnych do abstrakcji w dokumentacji projektowej oprogramowania. Dokumentujesz także ogólne praktyki / procedury / konfiguracje urządzeń. Hasła administracyjne, jeśli dotyczy.

W idealnej sytuacji prawie wszystko, czego może potrzebować następna osoba, jest łatwo dostępne i udokumentowane między dokumentami z wytycznymi i dokumentacją + schematami układu sieci.

Moim zdaniem dokumenty z wytycznymi i procedurami powinny być scentralizowane wszędzie tam, gdzie są wszystkie dokumenty IT, a diagramy sieciowe mogą mieć własną strukturę folderów dla wielu lokalizacji.

W przypadku wielu witryn satelitarnych, takich jak Walmart / Targer / Home Depot, miałbyś ogólny dokument dla wszystkich oddziałów, a następnie kilka szczegółowych dokumentów całej korporacji dotyczących wzajemnych połączeń między biurami, a następnie mógłbyś zanurzyć się w dokumentach LAN w biurze.

szkarłat
źródło
2

Podejście dokumentujące sieć jako podejście programisty do opracowania systemu ...

  • Rozważ wymagania - zostało to dobrze odnotowane powyżej, ale zastanów się, kto KTO skonsultuje się z doc-o i w JAKIM CELU. Audytorzy będą szukać i czytać inne artefakty niż rówieśnik SysAdmin.

  • Robienie konserwacji dokumentów - wielu ludzi wspomniało o wartości diagramów i map, a jako wizualny myśliciel szczerze się z tym zgadzam. ALE te rzeczy można unieważnić jednym aktem dodania / usunięcia hosta. Pomyśl o „właściwym poziomie” doc-o - takim, który twoja grupa może faktycznie utrzymać.

  • Datuj wszystko i dołącz notatki dotyczące tego, DLACZEGO skonfigurowałeś sieć w taki sposób. Wielu, wielu ludzi zapomina podać datę - ale DATA zapewnia wskaźnik do historii sieci. Jest nieoceniony przy rozwiązywaniu problemów i łagodzi nieodłączny brak danych w większości diagramów sieciowych.

  • Przeładuj dokumentację na „procesy” - wiele razy solidne i dobrze dopracowane procedury kompilacji / wdrażania upraszczają „dokumentację sieci”, ponieważ szczegóły konfiguracji komputera i nazewnictwa są lepiej opisane w procedurach.

Kluczowe wynos: podejść do dokumentacji jako „systemu”; musi dostarczać wartość od pierwszego dnia i niesie ze sobą nieodłączną odpowiedzialność za jej utrzymanie.

Netais LLC
źródło
2

Na naszej stronie używamy kilku systemów do dokumentowania sieci własnych i klientów. Próbowaliśmy i nie powiodło się z wieloma technikami / narzędziami, które nie były skalowane, ale teraz jesteśmy dość nastawieni na następujące:

  • DokuWiki dla wskazówek, szczegółowych opisów konfiguracji i
  • Tabele (Patchport / MAC / IP / nazwa hosta / rola / wyszukiwanie administratora dla wszystkich urządzeń, sieci / sieci VLAN / VPN, przegląd sprzętu itp.)
  • RSS do rozpowszechniania zmian stron wiki
  • Visio (najlepsza firma, jaką M $ kiedykolwiek kupił ...), aby narysować diagramy wszystkiego
  • KeePass dla haseł, w tym logowania do systemów biletów dostawców
  • RackTables do dokumentowania lokalizacji i łatania urządzeń
  • System biletów, dostępny dla klientów
  • WhatsUp Gold i inne narzędzia do monitorowania i raportowania
  • Listy mailingowe, aby ludzie byli na bieżąco

Jeśli mamy do czynienia z wieloma sieciami IP, phpIP może być odpowiednim rozwiązaniem IPAM.

PEra
źródło
2

Kyle Noland i inni plakaty opisali wiele sposobów dokumentowania. Pracujemy nad stworzeniem standardowego oprogramowania internetowego (hostowanego wewnętrznie przez Ciebie), które ułatwia administratorom sieci i systemów dokumentowanie ich sieci.

Począwszy od tego pisania (kwiecień 2012 r.) W oprogramowaniu uwzględniono następujące aspekty:

  • Dokumentacja centrum danych.
  • Dane urządzenia (w tym dane HW / OS)
  • Zarządzanie adresami IP
  • Mapowanie zależności aplikacji
  • Relacje z urządzeniami - od budynków po wirtualnych / ostrza.

Możesz przeczytać więcej tutaj i będziemy wdzięczni za Twoją opinię.

Raj J
źródło
1

Zwykle nie jest to udokumentowane, ale jeśli jesteś uprzejmy, zwykle robisz to w programie takim jak Visio lub ekwiwalent open source. Najważniejsze informacje to, z jakim sprzętem jest podłączony, oraz hasła do dowolnej konsoli zarządzania. Resztę zwykle można wróżić.

jedberg
źródło
2
Zazwyczaj jest to dokumentowane w miejscu o dużej sieci. Prawdopodobnie nie w szczegółach, które powinny być, a może nieco za prądem, ale zwykle jest to udokumentowane.
sclarson
1
Starałem się mówić z przymrużeniem oka.
jedberg
1

W mojej poprzedniej karierze menedżera IT mój dokumentator zawierał diagram Visio wszystkich urządzeń, listę przydziałów zakresu adresów IP, wszystkie klucze produktu dla Windows / Office / Acrobat, instrukcje dotyczące tego, co należy zainstalować na nowym komputery z instrukcjami krok po kroku, jak wykonać inwentaryzację sprzętu aż do poziomu komponentu, a także listę numerów alarmowych: wsparcie techniczne dostawcy usług internetowych, wsparcie techniczne producenta routera itp.

Scott
źródło
1

Jak wspomniano, zależy to od wielu czynników ...

Moim celem było posiadanie wystarczającej dokumentacji, która mogłabym (przynajmniej koncepcyjnie) przekazać wszystko współpracownikowi i powiedzieć „do zobaczenia za 3 tygodnie” i wiedzieć, że były tam wszystkie ważne szczegóły.

  • Hasła do wszystkich serwerów i urządzeń (przełączników, drukarek itp.)
  • Hasła do witryn wymagających rejestracji - usługodawca internetowy, rejestracja nazwy domeny, gwarancje sprzętowe, urzędy certyfikacji itp.
  • Mapa używanych adresów IP - wewnętrzny, zewnętrzny, dmz, bloki DHCP itp.
  • Szczegóły każdego serwera: standardowe rzeczy, takie jak numer seryjny, ilość dysku, pamięci RAM itp., Ale prowadziliśmy również dziennik wszystkich działań, które zostały wykonane na urządzeniu, poczynając od notatek instalacyjnych (o / s i instalacja aplikacji), następnie konfiguracja i kolejne zmiany.

Nigdy nie udało mi się tego zrobić całkowicie, ale starałem się udokumentować wszystkie główne rutynowe procesy - jak skonfigurowano serwery, jak i co było monitorowane, konfigurację i usuwanie konta, tworzenie kopii zapasowych itp.

Totem
źródło
1

Mapowanie i dokumentowanie sieci może być dobrym sposobem na przesłanie niezbędnych informacji. MS Visio to narzędzie do tworzenia diagramów, ale jest statyczne i musisz poświęcić mu dużo czasu. Odkryłem, że NetBrain to idealne narzędzie do tworzenia diagramów sieci. Może natychmiast udokumentować sieć, a dokumentację można wyeksportować do Visio lub Word. Mogę dostosować treść, którą chcę, podczas dokumentowania mojej sieci. Dostosowane treści obejmują: 

  1. Treści związane z zapasami, takie jak numer seryjny, wersja systemu operacyjnego itp. 
  2. Treści związane z projektem, takie jak routing dynamiczny, QoS, Filtrowanie ruchu 
  3. Treść związana ze ścieżką ruchu… 
  4. Zawartość związana z plikiem konfiguracyjnym 
  5. Diagram

Możesz spróbować udokumentować swoją sieć na stronie internetowej.

użytkownik64604
źródło
1

Używam narzędzi takich jak Microsoft Visio lub WhatsUp Gold do mapowania topologii sieci, jeśli to pomaga.

użytkownik3943
źródło
0

MS Visio to dobry sposób na udokumentowanie sieci, ale nie jest to bezpłatne rozwiązanie. Gliffy to fajny produkt, jeśli chcesz utrzymać niskie koszty.

Typowe diagramy sieciowe pokazują, w jaki sposób informacje przepływają przez twoje urządzenia (i zwykle do Internetu). Powinieneś więc mieć na swoim schemacie informacje o tym, gdzie znajdują się twoje komputery, drukarki, WAP, telefony IP (jeśli dotyczy), przełączniki i routery oraz jak są one połączone. Adresy IP mogą być również dołączone do nazwy twojego urządzenia. Jest to pomocne, jeśli chcesz rzucić okiem na diagram w celu uzyskania informacji w locie.


źródło
-1

NodeSystems jest właśnie tym - narzędziem do dokumentacji sieci. Jako miły efekt uboczny stworzy dla ciebie interaktywny schemat.

Sprawdź demo online: http://www.nodesystems.org/demo/

Phaedrus
źródło