Wie dokumentieren Sie ein Netzwerk?

66

Ich bin mir nicht sicher, wie ich diese Frage stellen soll, da ich nicht auf dem Gebiet bin. Angenommen, Sie sind ein Netzwerkadministrator und verlassen Ihren Job. Woher weiß der Neue, wo er anfangen soll?

Esteban Araya
quelle
6
Außerdem: Dank der Dokumentation können Sie eines Tages Urlaub machen und das Unternehmen schützen, wenn Sie zu krank oder verletzt sind, um zu arbeiten.
Kara Marfia

Antworten:

55

Dies hängt unter anderem von der Größe des Netzwerks, der Anzahl der Benutzer, der Anzahl der Knoten (Computer, Server, Drucker usw.) und der Größe Ihres IT-Personals ab.

Es hängt auch von Ihrem Ziel ab. Dokumentieren Sie das Netzwerk für Schulungs- und Wartungszwecke, Versicherungen / Schadenverhütung usw.?

Persönlich dokumentiere ich meine Netzwerke so , dass ich weiß , dass ich jedes fehlende Informationen ableiten kann , auf das, was ist , dokumentiert. Aus praktischer Sicht gibt es einen Punkt, an dem die Rendite abnimmt, wenn Ihre Dokumentation zu detailliert wird.

Eine gute Faustregel ist, dass sich an einem bekannten Ort Unterlagen befinden sollten, die gründlich genug sind, damit ein anderer Administrator das Kernnetzwerk am Laufen halten kann, wenn ich heute Abend von einem Bus angefahren werde, während er die fehlenden Teile über dem ausfüllt die nächsten Tage / Wochen.

Hier ist eine Übersicht über das, was ich an einem meiner Netzwerke für am wichtigsten halte. Dies ist ein reiner Windows-Shop mit ca. 100 Benutzern und 5 Büros.

  • Administratoranmeldeinformationen für alle Server. Dies sollte natürlich sicher aufbewahrt werden.
  • IP-Adressen und NetBIOS-Namen für jeden Knoten im Netzwerk mit einer statischen IP-Adresse, einschließlich Server, Arbeitsstationen, Drucker, Firewalls, Router, Switches usw.
  • Grundlegende Informationen zur Serverhardware, z. B. Service-Tags oder Ähnliches, Gesamtfestplattenkapazität, Gesamt-RAM usw.
  • Hauptrollen der einzelnen Server, z. B. Domänencontroller, Dateiserver, Druckserver, Terminalserver usw.
  • Speicherort der Backup-Bänder / Laufwerke.
  • Informationen zu Kontonummern und Anmeldeinformationen für Dienste wie Remote-Office-Sprach- und Datenanbieter.
  • Externes DNS für Websites und Routing.

Wenn an einem Setup oder Workflow etwas Seltsames war, das für einen neuen Administrator nicht sofort ersichtlich ist, würde ich auch eine kurze "kurze" Beschreibung schreiben.

Kyle Noland
quelle
8
+1 für das Hit-by-a-Bus-Szenario.
Romandas
11

Ich finde, es ist am besten, alle folgenden Punkte zu berücksichtigen:

  • Prosa: Ein allgemeiner Überblick in Absatzform, der beim anfänglichen Gesamtüberblick hilft und auch die Entwicklung über die Zeit beschreiben kann
  • Tabellen: Tabellarische Listen, entweder mit Adressschlüssel, Umgebungsschlüssel oder Maschinenschlüssel (vorzugsweise alle oben genannten)
  • Diagramme: Benötigen Sie unbedingt Diagramme mit mehreren Detailebenen. In Netzwerken mit vernünftiger Größe ist es einfach unmöglich, alles auf einer Seite festzuhalten und leicht verdaulich zu machen. Sie möchten ein Diagramm auf globaler Ebene mit Infrastrukturgeräten (Routern, Switches, Tunnelendpunkten usw.) und ein anderes Diagramm mit mehreren für die Rechenressourcen, auf die sich jeder dieser Router oder Endpunkte bezieht.

Zusätzliche Hinweise zu Diagrammen ... Die geografische Verteilung ist eine einfache Methode zur Segmentierung. Sie benötigen jedoch auch logische Ansichten, die auf der Installationsfunktion basieren. Beschriften Sie außerdem wie verrückt und nutzen Sie Schriftarten und Farben voll aus.

Adam D'Amico
quelle
5

Der effektivste und gründlichste Weg, um diesen Prozess zu starten, besteht darin, ihn aus einem Notfallwiederherstellungsszenario zu erstellen - z. B. ging das Gebäude in Flammen auf und wir haben nur die Offsite-Backups. Was müssen wir zuerst kaufen und wie muss es konfiguriert werden?

Kyle hat bereits großartige Details angegeben, aber ich finde, dass der DR-Ansatz mir hilft, die Dinge Stück für Stück zu erfassen.

Kara Marfia
quelle
4

Kyles Antwort ist ein toller Rat. Zumindest aber könnten Sie mit der Auflistung davonkommen:

  • Server (einschließlich Hostnamen, IPs und Rollen)
  • Netzwerkhardware (Switches, Router, Firewalls)
  • Master-Passwort-Archive (Domain-Passwörter, Admin-Passwörter)
  • Ein grobes Dokument, in dem Netzwerkrichtlinien und seltsame Einstellungen beschrieben werden (hier Ausreißer wie Computer, die nicht Teil der Domäne (n) sind).
kdmurray
quelle
4

Wo ich arbeite - wir hatten das gleiche Problem, als ich hier anfing. Mit zunehmender Anzahl von Servern und Diensten wird die Dokumentation immer veralteter. Dies führt zwangsläufig dazu, dass die Mitarbeiter der Dokumentation nicht vertrauen, zumindest der technischen Dokumentation zu Servernamen, Servergruppen, Netzwerken usw.

Wir haben mit der Entwicklung eines Open-Source-Projekts namens Hotwire begonnen , um dieses Problem zu lösen ...

  • Inventarsystem (Server, Netzwerke usw.)
  • Server-Builds - RHEL Kickstart, SuSE AutoYaST, (TODO: Debian Preseed, Solaris Jumpstart)

Durch die Kombination des Inventarsystems mit dem Buildsystem stellen wir sicher, dass die in der Datenbank enthaltenen Daten mit denen in unseren Rechenzentren übereinstimmen, da wir die Daten erst in das Inventar eingeben müssen, um die Server erstellen zu können .

Auf allen Servern wird dann ein Client-Programm (funcwire) installiert (als Teil des Erstellungsprozesses), das dann dynamisch die von python-dmidecode gemeldete Server-Hardware und den Bestand überwacht. Wenn sich also etwas ändert, die Administratoren werde es sofort wissen.

Anschließend haben wir unser Wiki-System so integriert, dass jeder Server, jedes Rack, jedes Projekt, jedes Hardwaremodell usw. über Hotwire direkt auf die entsprechende Wiki-Seite verweist.

Wir haben daher unsere Server / Netzwerke / etc mit Hilfe von Hotwire + einem Wiki "dokumentiert" (wir verwenden hier Zusammenfluss, aber jedes anständige Wiki wird dies tun). (Beachten Sie jedoch, dass die Server, sobald sie erstellt wurden, durch Hotwire in keiner Weise geändert werden. Die fortlaufende Verwaltung erfolgt über cfengine.)

Xerxes
quelle
3
"howtire" -Link funktioniert nicht; kann es auch nicht über Google finden. Ist es tot?
Markieren Sie den
4

Ich benutze MikroTik Dude, um Dinge automatisch zuzuordnen. Dies ist eine großartige Anwendung, wenn man bedenkt, dass sie kostenlos ist. Es kann auch den aktuellen Status überwachen. Geck Webseite

Sam Mackrill
quelle
2

Im Allgemeinen verfügen Sie über einige unterschiedliche Detaillierungsebenen, die Abstraktionen in der Software-Designdokumentation ähneln. Sie dokumentieren auch allgemeine Geräteverfahren / -prozeduren / -konfigurationen. Administrative Passwörter, falls zutreffend.

Im Idealfall ist fast alles, was die nächste Person benötigt, leicht zugänglich und zwischen Ihren Richtlinien- und Verfahrensdokumenten sowie den Netzwerk-Layout-Diagrammen dokumentiert.

Die Richtlinien- und Verfahrensdokumente sollten meiner Meinung nach überall dort zentralisiert werden, wo sich alle IT-Dokumente befinden, und die Netzwerkdiagramme können eine eigene Ordnerstruktur für mehrere Speicherorte haben.

Bei vielen Satellitenstandorten wie einem Walmart- / Targer- / Home-Depot hätten Sie ein generisches Dokument für alle Zweigstellen und dann einige detaillierte Unternehmensdokumente für die Zusammenschaltung der Hauptbüros und könnten dann in LAN-Dokumente für das Büro eintauchen.

Sclarson
quelle
2

Ansatz, ein Netzwerk zu dokumentieren, während sich ein Entwickler der Entwicklung eines Systems nähert ...

  • Berücksichtigen Sie die Anforderungen - dies wurde bereits oben ausführlich erwähnt. Beachten Sie jedoch, dass die WHO das Dokument und zu WAS ZWECK konsultieren wird. Auditoren suchen und lesen andere Artefakte als Peer-SysAdmin.

  • Doing Doc Maintenance - Viele Leute haben den Wert von Diagrammen und Karten erwähnt, und als visueller Denker stimme ich voll und ganz zu. ABER diese Dinge können mit einem einzigen Vorgang des Hinzufügens / Entfernens eines Hosts ungültig gemacht werden. Denken Sie an die „richtige Ebene“ von doc-o - eine, die Ihre Gruppe tatsächlich aufrechterhalten kann.

  • Zeichnen Sie alles auf und geben Sie an, warum Sie das Netzwerk so konfiguriert haben, wie Sie es getan haben. Viele, viele Leute vergessen, ein Datum anzugeben - aber das DATE bietet einen Hinweis auf die Geschichte des Netzwerks. Von unschätzbarem Wert für die Problemlösung, um die inhärente Unaktualität der meisten Netzwerkdiagramme zu mindern.

  • Auslagern von Dokumentation in "Prozesse" - Viele solide und gut ausgearbeitete Erstellungs- / Bereitstellungsverfahren führen zu einer Optimierung der "Netzwerkdokumentation", da die Details der Maschinenkonfiguration und -benennung in den Verfahren besser beschrieben werden.

Key Takeaway: Dokumentation als 'System' betrachten; Sie muss ab dem ersten Tag einen Wert liefern und trägt die inhärente Verantwortung, diesen zu erhalten.

Netais LLC
quelle
2

An unserem Standort verwenden wir mehrere Systeme, um unsere eigenen und Kundennetze zu dokumentieren. Wir haben versucht und sind mit vielen Techniken / Werkzeugen gescheitert, die nicht skaliert wurden.

  • DokuWiki für Tipps, detaillierte Beschreibungen der Konfigurationen und
  • Tabellen (Patchport / MAC / IP / Hostname / Rolle / Admin-Lookup für alle Geräte, Netzwerke / VLANs / VPNs, Hardwareübersicht usw.)
  • RSS, um Änderungen von Wiki-Seiten zu verbreiten
  • Visio (das beste Unternehmen, das M $ je gekauft hat ...), um Diagramme von allem zu zeichnen
  • KeePass für Kennwörter, einschließlich Anmeldungen für Anbieter-Ticketsysteme
  • RackTables, um zu dokumentieren, wo sich die Geräte befinden und gepatcht sind
  • Ticketsystem, zugänglich für Kunden
  • WhatsUp Gold und andere Tools zur Überwachung und Berichterstellung
  • Mailinglisten, um die Leute auf dem Laufenden zu halten

Wenn man sich mit vielen IP-Netzwerken befasst, könnte phpIP eine geeignete IPAM-Lösung sein.

PEra
quelle
2

Kyle Noland und andere Plakate haben viel darüber berichtet, wie man dokumentiert. Wir arbeiten an einer webbasierten Standardsoftware (von Ihnen intern gehostet), die es Netzwerk- und Systemadministratoren erleichtert, ihr Netzwerk zu dokumentieren.

Wir haben die folgenden Aspekte in der Software zum Zeitpunkt dieses Schreibens (April 2012) abgedeckt:

  • Datacenter-Dokumentation.
  • Gerätedetails (einschließlich HW / OS-Details)
  • IP-Adressverwaltung
  • Anwendungsabhängigkeitszuordnung
  • Gerätebeziehungen - von Gebäuden zu Virtuals / Blades.

Sie können hier mehr lesen und wir würden uns über Ihr Feedback freuen.

Raj J
quelle
1

Es ist normalerweise nicht dokumentiert, aber wenn Sie freundlich sind, tun Sie es normalerweise in einem Programm wie Visio oder einem Open-Source-Äquivalent. Die wichtigsten Informationen sind, welche Geräte mit welchen Geräten verbunden sind und welche Kennwörter für eine Verwaltungskonsole erforderlich sind. Der Rest kann normalerweise erraten werden.

jedberg
quelle
2
Es wird normalerweise an einem Ort mit einem großen Netzwerk dokumentiert. Wahrscheinlich nicht in dem Detail, das es sein sollte, oder vielleicht etwas hinter dem aktuellen, aber es ist in der Regel dokumentiert.
Sclarson
1
Ich habe versucht, frech zu sein.
Jedberg
1

In meiner früheren Karriere als IT-Manager enthielt mein Dokumentationsordner ein Visio-Diagramm aller Geräte, eine Liste der IP-Adressbereichszuordnungen, alle Product Keys für Windows / Office / Acrobat sowie Anweisungen zur Neuinstallation Computer mit schrittweisen Anleitungen, wie Sie das Hardwareinventar bis auf Komponentenebene vervollständigen und nicht zuletzt die Liste der Notfalltelefonnummern: Technischer Support des Internetdienstanbieters, Technischer Support des Routerherstellers usw.

Scott
quelle
1

Wie bereits erwähnt, hängt es von einer Reihe von Faktoren ab ...

Mein Ziel war es, über ausreichende Unterlagen zu verfügen, die ich (zumindest konzeptionell) an einen Kollegen weitergeben und "Bis in drei Wochen" sagen und wissen konnte, dass alle wichtigen Details vorhanden waren.

  • Passwörter für alle Server und Geräte (Switches, Drucker usw.)
  • Kennwörter für Websites, für die eine Registrierung erforderlich ist - ISP, Registrierung von Domänennamen, Hardwaregarantien, Zertifizierungsstellen usw.
  • Karte der verwendeten IP-Adressen - intern, extern, dmz, DHCP-Blöcke usw.
  • Details zu jedem Server: Standardmaterial wie Seriennummer, Menge der Festplatte, RAM, etc., aber wir haben auch ein laufendes Protokoll von allem geführt, was mit der Box gemacht wurde, angefangen mit den Installationsnotizen (O / S und App. Install). dann ll Konfiguration und nachfolgende Änderungen.

Ich habe es nie vollständig geschafft, aber ich wollte alle wichtigen Routineprozesse dokumentieren - wie Server eingerichtet wurden, wie und was überwacht wurde, Kontoeinrichtung und -entfernung, Sicherung usw.

Ward
quelle
1

Das Zuordnen und Dokumentieren Ihres Netzwerks ist möglicherweise eine gute Methode zum Übertragen der erforderlichen Informationen. MS Visio ist ein Diagrammtool, aber es ist statisch und Sie müssen viel Zeit darauf verwenden. Ich fand, dass NetBrain ein ideales Netzwerkdiagrammwerkzeug ist, um dies zu tun. Es kann das Netzwerk sofort dokumentieren und die Dokumentation kann nach Visio oder Word exportiert werden. Ich kann die gewünschten Inhalte anpassen, während ich mein Netzwerk dokumentiere. Zu den benutzerdefinierten Inhalten gehören: 

  1. Inventarbezogene Inhalte wie Seriennummer, Betriebssystemversion usw. 
  2. Designbezogene Inhalte wie dynamisches Routing, QoS, Verkehrsfilterung
  3. Verkehrswegbezogene Inhalte… 
  4. Inhalt der Konfigurationsdatei 
  5. Diagramm

Sie können versuchen, Ihr Netzwerk auf der Website zu dokumentieren .

user64604
quelle
1

Ich verwende Tools wie Microsoft Visio oder WhatsUp Gold, um die Netzwerktopologie zuzuordnen, wenn dies hilfreich ist.

user3943
quelle
0

MS Visio ist eine gute Möglichkeit, ein Netzwerk zu dokumentieren, aber keine kostenlose Lösung. Gliffy ist ein gutes Produkt, wenn Sie Ihre Kosten niedrig halten möchten.

Typische Netzwerkdiagramme zeigen, wie Informationen über Ihre Geräte (und normalerweise über das Internet) übertragen werden. Daher sollten Sie in Ihrem Diagramm Informationen darüber haben, wo sich Ihre Computer, Drucker, WAPs, IP-Telefone (falls zutreffend), Switches und Router befinden und wie sie verbunden sind. IP-Adressen können auch im Namen Ihres Geräts enthalten sein. Dies ist hilfreich, wenn Sie in Ihrem Diagramm nach Informationen suchen möchten.


quelle
-1

NodeSystems ist genau das - ein Netzwerkdokumentationstool. Als netter Nebeneffekt wird ein interaktives Diagramm für Sie erstellt.

Schauen Sie sich die Online-Demo an: http://www.nodesystems.org/demo/

Phaedrus
quelle