[ARTIKEL | ERFAHRUNGSBERICHT] Dokumentation im Heimnetz

tiermutter

Well-known member
[EPILOG]
Eine Dokumentation, egal von was, war schon immer wichtig und wird mit steigender Komplexität eines Systems oder einer Anlage immer bedeutsamer, so auch im Heimnetz. Das ist nichts Neues und eigentlich klar. Eigentlich, denn nichts ist lästiger als jedes Mal wenn ein Patchkabel umgesteckt oder eine IP Adresse geändert wird die Doku entsprechend zu pflegen.
Ich finde, dass ich schon ganz ordentlich dokumentiere, nur eben nicht alles, was erforderlich wäre, was mir nun ein wenig zum Verhängnis geworden ist als ich einem Gerät am Switch Port einem VLAN zuweisen wollte. Aber von Vorne…

[MEINE BISHERIGE DOKU]
Meine Doku besteht im Wesentlichen aus zwei Teilen: Der Zuordnung der Endstellen zum Patchfeld sowie die Zuordnung von Geräten und IP Adressen.
Bei der Doku der Endstellen geht es im wesentlichen darum zu dokumentieren, welcher Port der Patchfelder zu welcher Endstelle, also in welchen Raum führt. Natürlich sind Dosen und Patchfelder eindeutig beschriftet, sodass man immer den richtigen Port erwischt, die Doku erspart mir aber die Lauferei und Sucherei. Bei mir sieht das so aus:

doku_endstellen.PNG

„Port Endstelle“ beinhaltet die entsprechende Dose samt Port, so wie sie auch beschriftet ist, der Aufbau ist ETAGE.RAUM.DOSE.PORT. „Port p“ steht für Port passiv und ist der Port auf dem entsprechenden Patchfeld. Hier sehen wir auch schon ein altes Relikt, um das es mir primär geht: Neben „passiv“ gibt es noch die ausgeblendete Spalte „aktiv“, die den Port am Switch beschreibt, auf den die Dose gepatcht ist. Diese Spalte hatte ich einst ausgeblendet, weil es mir zu blöd war hier ständig Änderungen vornehmen zu müssen, hier muss eine praktisch brauchbare Lösung her!
Im Kommentarfeld stehen entsprechende Infos, zB dass die Dose auf der Terasse aus Sicherheitsgründen nur bei Bedarf gepatcht wird oder dass eine Dose nicht nach meinem üblichen Standard (EIA/TIA 568A) verdrahtet ist. Neben einer Skizze der Räume zwecks schnellerer Zuordnung habe ich auch dokumentiert was die Patchkabelfarben für eine Bedeutung haben. Wie die einzelnen fest verlegten Kabel beschriftet sind ist eigentlich nur informativ und war nur während der Errichtungsphase von Bedeutung. Bis auf die fehlende Doku der Switch Ports doch schonmal nicht schlecht, oder? Aber ich habe da ja auch noch die Doku der IP Adressen, die sich wie folgt darstellt:

doku_IP_1.PNG
In diesem Teilabschnitt sind die IPs und die zugehörigen Geräte aus dem „Administrationsbereich“, also für Geräte mit administrativer Funktion wie Server, Switch, Router, … sowie statische DHCP Adressen dokumentiert. Leider ist der Adminbereich mit seinen 20 Adressen mittlerweile etwas zu knapp geraten, sodass ich hier mal aufräumen und umstrukturieren muss :( .

Im nächsten Teilabschnitt sind statische IP Adressen der Clients dokumentiert sowie weitere Bereiche im LAN, sprich welcher Bereich für DHCP, zum Testen und für zukünftige Anwendungen reserviert ist. Auch habe ich andere Subnetze dokumentiert, wie z.B. Adressbereiche und vergebene IPs meiner VPN Verbindungen und welche Geräte sich in welchem VLAN befinden, inkl. Angabe der Switch Ports, die dem VLAN zugeordnet wurden. Der aufmerksame Heimnetz.de Leser wird sicherlich feststellen, dass die Doku nicht aktuell ist… aber um dieses Leid geht es ja irgendwie 😉.
doku_IP_2.PNG
„DVS“ steht bei mir übrigens für „Datenverteilerschrank“, also für einen Netzwerkschrank, da ich zwei davon habe und entsprechend unterscheiden muss.

[DIE ERWEITERTE DOKU]
Wie man sieht habe ich schon eine recht ordentliche Doku, finde ich jedenfalls. Wie ich ja nun aber feststellen musste, ist längst nicht alles Erforderliche dokumentiert, das muss ich ändern. Dabei erinnere ich mich an die Doku eines Automobilherstellers, für den ich jahrelang tätig war. Da gab es ein eigenes System für die Dokumentation des Netzwerks. Ohne dass dort etwas angemeldet und bereits das Vorhaben dokumentiert wurde, durfte nichtmal ein Patchkabel ein- oder ausgesteckt werden. So weit darf es dann aber auch nicht gehen, es muss ja eben für den Heimgebraucht praktikabel bleiben.
Ich muss also dokumentieren, welche Geräte (Teilnehmer) an welchem Switchport stecken, will den Aufwand aber in Grenzen halten und nicht jedes Mal die Doku anpassen müssen. Das ist auch nicht für alle Teilnehmer erforderlich, denn ich kann zum Beispiel die Patchkabel zum Patchfeld sehr einfach nachverfolgen, sodass ich die Endstellen nicht in der erweiterten Doku aufnehmen muss, zumal sich dort in der Regel ohnehin keine Teilnehmer befinden, für die der verwendete Port von Relevanz ist. Auch muss ich nicht jene Teilnehmer in der erweiterten Doku aufnehmen, die ohnehin nur als Test- und Spielobjekte dienen und ständig wechseln. Es bleiben also die Teilnehmer aus dem Administrationsbereich, die ich in der erweiterten Doku erfassen muss. Diese sind glücklicherweise ohnehin schon auf die letzten Ports meines 48 Port Switches gelegt, sodass ich mir hier einen Portbereich definieren kann, der fein säuberlich dokumentiert wird, viele Änderungen finden hier auch nicht statt, sodass sich der Aufwand in Grenzen hält, zumindest nachdem ich einmalig alles auseinandergepflückt und dokumentiert habe. Das ist nämlich gar nicht so einfach, da ich die Kabel vieler Geräte in meinem Netzwerkschrank gar nicht einfach nachverfolgen kann.

Aber wie stelle ich das nun an? Betrachte ich meine Doku der Patchfelder, wo sich die ausgeblendete Spalte für die Switch Ports befindet muss ich leider feststellen, dass dieser Ort nicht für die Doku geeignet ist, da sich hier nur abbilden lässt, welche Endstelle auf welchen Switch Port gepatcht ist, nicht aber wo welches direkt angeschlossene Gerät steckt. Auch bei den IP Adressen finde ich die Doku der Ports etwas unglücklich, also muss wohl eine weitere Tabelle her. Diese habe ich analog unter die Doku der Patchfelder erstellt und sieht im Entwurf wie folgt aus:

doku_switch.png

Der graue Bereich beinhaltet dann die Endstellen, die ohnehin nicht dokumentiert werden sollen. Ich denke dass ich mit diesen relevanten 3 Spalten eine ganze Menge an Überblick gewinnen werde und mir so ein Durcheinander nicht nochmal passiert, entsprechende Pflege vorausgesetzt. Drei Spalten und ein paar Zeilen, die einem das Leben so einfach machen…

[EPILOG]
Ich möchte nicht vorenthalten, dass meine Doku noch einen weiteren Part beinhaltet, nämlich den Aufbau, bzw. die Bestückung des Racks… aber auch hier wieder Schande über mein Haupt: Es ist nicht auf aktuellem Stand, brauche ich aber auch nur, wenn mal wieder ein etwas umfangreicherer Umbau bevorsteht. Die Doku wie die Steckdosenleisten belegt sind und wie diese auf der USV liegen erspare ich euch an dieser Stelle.

doku_rack.PNG

Unterm Strich bleibt eigentlich nur festzuhalten, was eingangs schon gesagt wurde: Doku ist wichtig, wenn auch manchmal lästig, aber nunmal auch unumgänglich. Manchmal ist der Aufwand aber gar nicht so übel wie man glauben mag, sodass es nur ein bisschen Fleiß erfordert. Wichtig ist aber auch, dass alles Wesentliche dokumentiert wird, also vorher Gedanken machen oder einfach das Ergebnis meines Leids als Leitfaden nehmen 😊.

Cheers! 🍻
 
Zuletzt bearbeitet:

the other

Well-known member
Moinsen,
Dokumentation ist imho wichtiger als so manche wochenlange Entscheidung, ob nun Gerät Firma x oder y neu angeschafft werden sollen(mal etwas provokant in den virtuellen Raum gestellt).

Klar, bei einer Fritzbox und direkt daran drei Clients mag das eher überflüssig erscheinen, aber auch dort gäbe es genug Konfigurationsmöglichkeiten. Bei einem Heimnetz, wie du @tiermutter es hast, geht meiner Meinung nach sehr schnell nur noch sehr wenig, wenn weder ausreichend Gedächtnisleistung noch Doku vorhanden ist.

Spätestens nach der ersten Einrichtung kommt doch meist der folgende Effekt: nach viel Recherche eingerichtet...läuft...dann etwas mutiger hier und da die feinere Konfiguration...und dort noch, und hier auch...und schwupps hat man sich in den vielen Seiten des Menüs verrannt, hier und da Haken gesetzt oder auch entfernt und: geht plötzlich nicht. Meist erst ein paar Wochen später...wehe, wenn dann keine Übersicht mehr vorhanden ist.

Ich habe das bei der letzten großen Umstellung im Heimnetz ähnlich gemacht, zB:
- ein Handbuch für das Netzwerk selber (wer, wie, was, warum), Angaben zu VLANs, DHCP, DNS, Firewall, Portbelegungen und Wireless Einrichtungen. Auch zu den diversen Arten der Zugänge...also user/password oder publickey oder oder oder...
- ein Handbuch für die NAS-Geräte (mit Angaben zu Diensten, Protokollen, usern, Freigaben, Firewall usw)
- ein Handbuch für die Raspis (ebenfalls mit Stand der Konfig, links zu ggf. Anleitungen zur Einrichtung usw)

Viel Arbeit, nicht zu vergessen, dass Änderungen eingepflegt werden müssen, screenshots aktualisiert werden müssen und das regelmäßig.
Vorteil ist dabei für mich persönlich ganz klar: es ist schon laaange nicht mehr passiert, dass die Übersicht verloren ging. Dank der Handbücher ist alles geordneter, ich kann gezielter nachschauen ("wie war das doch?") und damit schließe ich mich @tiermutter an: Dokumentiert eure Arbeiten bzw. Veränderungen!! Der Aufwand lohnt spätestens, wenn IRGENDWAS unbekannterweise rumzickt...
:)
 
Zuletzt bearbeitet:

HennesyNet

Member
Kennt jemand eine APP (iOS) oder ein sonstiges Programm, mit welchem so eine Doku übersichtlich zu machen ist?
 

tiermutter

Well-known member
Excel ;)
Ich kenne da tatsächlich überhaupt gar nichts, ist sicherlich auch die frage, was und wie etwas dokumentiert werden soll.

Mir ist übrigens grad eingefallen, welches Tool bei dem erwähnten automobilhersteller zum Einsatz kommt:
 

the other

Well-known member
Moinsen,
ich bin ja dahingehend eher oldschool:
meine Tools dafür sind noch immer die gleichen...
Word bzw LibreOfficeWriter, Excel bzw.LibreOfficeCalc und Visio bzw. LibreOfficeDraw

Damit lässt sich alles abdecken. Klar, für die 1. Version viel Umstand. Danach (bei den Änderungen) dafür nur noch wenig. Und ich kann die drei Darstellungsebenen in einem Dokument zusammenfassen (und als pdf exportieren), damit im Alltag der Zugriff auf die Doku leichter wird.
Ich mache zB die Netzwerktopografie mit Draw (als schematische Übersicht des Netzwerkes), die Segmente mit MAC und IPs per Calc und die Beschreibungen eben per Writer (wobei ergänzend ein Screenshot-Tool zum Einsatz kommt).
Ist bis dato für mich immer noch am einfachsten und praktikabelsten sowie flexibel...und es ist ein HEIMNETZ!
;)
 

the other

Well-known member
Moinsen,
scheint bei den Usern im geschäftlichen Umfeld auch gerade Thema zu sein:

Aber auch da...ich fang ja eh immer mit Bleistift und Schmierblatt an...Hauptsache machen, egal ob mit Aquarell, Kohle oder Öl. 🖌️🖍️📝:ninja:
 

rednag

Well-known member
Cool. Gleich mal paar Ideen abgeguckt. So bisschen mit Farben ist auch nicht verkehrt. Bei mir alles weiß. Erfüllt seinen Zweck, aber "schön" ist es halt nicht. :)
Meine Doku sollte ich auch mal wieder überarbeiten.
Ist das alles Excel? Wie hast Du die Unterteilung zweispaltige Anordnung in Zeile 27-32 hinbekommen?
Also zwei Geräte nebeneinander?
 

tiermutter

Well-known member
Jo ist alles Excel, ich liebe Excel :love:
Du meinst bei der Rackansicht? Die Breite des Racks besteht aus mehreren Spalten, die verbunden sind, dort wo mehrere Geräte nebeneinander stehen sind die Spalten ubd Zeilen dann halt an entsprechender Stelle verbunden statt über die gesamte Breite.
 

blurrrr

Well-known member
Excel dürfte für private Umgebungen wohl auch eher das Mittel der Wahl sein. Ansonsten schmeiss ich einfach nochmal phpipam, racktables und netbox in die Runde (alternativ ggf. noch i-doit.org). Dürfte aber für die paar Geräte in heimischen Netzen doch ziemlich übertrieben sein, aber wer will, kann sich die o.g. Dinge ja mal anschauen 🙃
 

Progof

-
Moderator
@tiermutter

Hat es einen bestimmten Grund warum der Post mit "Erfahrungsbericht" tituliert ist, aber dennoch unter Theorie -> Sonstiges veröffentlicht wurde?
Bitte bei weiteren Artikeln auch die Groß,- Kleinschreibung regelkonform anwenden.
Durchgehend Großbuchstaben stören den Lesefluss.
 

rednag

Well-known member
Gefällt mir gut die Dokumentation von Dir.
Muß ich hier auch mal umsetzen.
Bin schon ewig genervt, weil ich den Switch nicht vernünftig in Excel beschrifen kann.
Der Text von den Geräten passt nie ganz in die zugehörigen Felder.
Und abgeschnitten sieht das furchtbar aus.

switch.JPG
 

tiermutter

Well-known member
Ne, hat keinen speziellen Grund, war mir nur nicht sicher ob dieses theoretische Thema in die Erfahrungsberichte gehört, dieses Forum verbinde ich eher mit praktischen Erfahrungsberichten zu Geräten.
Die Titulierung habe ich entsprechend nur angefügt damit es entsprechend rüber kommt und nicht aussieht als würde es sich um zB eine Frage handeln.
Sind hier eigentlich Tags möglich? Wäre damit auch zu realisieren, habe aber keine Möglichkeit gefunden...
 

tiermutter

Well-known member
@rednag
Die Ansicht mit dem Switch macht auf jeden Fall einen hübschen Eindruck, gefällt mir deutlich besser als meine simple Liste. Gut, ist nur Optik, aber ich stehe ja auf Optik :)
Das Problem mit den kleinen Feldern ließe sich ggf umgehen, wenn man die entsprechenden Zeilen höher macht und die Schrift vertikal ausrichtet...
 

Progof

-
Moderator
Posts mit Tags zu markieren haben wir auf der Agenda.
Wann wir dies einführen kann ich aber noch nicht sagen.
 

tiermutter

Well-known member
Ok, eilt ja nicht.
Wenn der Artikel bei den Erfahrungsberichten gut aufgehoben ist kann er sehr gerne dort hin, dann kann mein Tag-Ersatz auch entfallen. :)

Achja, einen Grund gab es doch für dies "Sonstige" Kategorie:
Hier war noch nichts drin und ich dachte hiermit könnte ich mal etwas Leben hier reinbringen :D
 

rednag

Well-known member
Das Problem mit den kleinen Feldern ließe sich ggf umgehen, wenn man die entsprechenden Zeilen höher macht und die Schrift vertikal ausrichtet...

Das ist eine gute Idee. Hab es mal testweise bei einem Gerät probiert. Sieht gewöhnungsbedürftig aus, der Text passt aber immerhin dann rein. :)
 

tiermutter

Well-known member
Alternativ könnte man auch mit Kommentaren arbeiten, die dann also onmouseover angezeigt werden, in der Zelle selbst könnte dann ggf. eine sehr kurze Abkürzung stehen... Glaube aber fast, dass das nicht mit 4 oder 5 möglichen Zeichen funktioniert...
 

rednag

Well-known member
Hab ich mir auch schon überlegt. Habe aber aus praktischen Gründen davon abgesehen.
Wenn man panisch die Doku braucht weil was nicht geht will ich nicht in der Hektik erst mühsam per Mouseover die Infos welche sich dahinrter verbergen zusammen suchen müssen.
 

tiermutter

Well-known member
Ach Quark... Meine Doku/ Verfahrensanweisung für die Backupwiederherstellung liegt auch auf dem NAS und für den Fall dass da nichts mehr geht habe ich ja ein Backup o_O
 

Zurzeit aktive Besucher

Keine Mitglieder online.

Letzte Anleitungen

Statistik des Forums

Themen
937
Beiträge
13.660
Mitglieder
466
Neuestes Mitglied
wischi83
Oben