Een netwerk van meerdere locaties documenteren

Een netwerk met één router documenteer je op een A4. Een netwerk met zes locaties, twintig apparaten en vier tunnels documenteer je in een map, of je documenteert het niet. De tool doet een flink deel van dat werk, en het is de moeite waard om precies te weten welk deel.

Wat de tool je geeft

• Een overdrachtsblad per apparaat. Naam, model, rol, tijdzone, beheeradres, welke diensten open staan en vanaf welke adressen, de VLAN-tabel met subnet, router-adres, DHCP, internet en isolatie per VLAN, en een poortentabel met per poort het gebruik, de VLAN en de opmerking. Wachtwoorden staan er standaard niet op; er is een vinkje om ze wel af te drukken.
• Een voorblad voor de hele site. De naam van de site, de tijdzone, een lijst van alle apparaten met model, rol en beheeradres, een bekabelingstabel van poort naar poort, de VLAN-tabel en de SSIDs.
• Lege regels om in te vullen. Op elk apparaatblad staan regels voor het serienummer en de fysieke locatie, en onderaan voor wie het heeft geïnstalleerd, op welke datum en voor welke klant. Die zijn expres leeg: de tool weet dat niet.
• Poortopmerkingen in het script zelf. Elke bekabelde poort krijgt een opmerking als to sw-01 ether24 of internet, en bij meerdere lijnen de naam van de verbinding met (backup) erachter. Die staan op het apparaat, dus ook als de map kwijt is.
• Een rollback-script per apparaat, dat verwijdert wat het eerste script heeft toegevoegd, plus een lijst van de dingen die het niet ongedaan kan maken omdat het wijzigingen van bestaande waarden zijn.
• De configuratie zelf, op te slaan en te delen. Zie Bewaren en delen. De tool bewaart niets op een server: wat je niet opslaat, is weg.

Wat er niet op staat

Dit is het deel dat je zelf moet toevoegen, en het is precies het deel dat een opvolger nodig heeft.

• De locaties en hun adresreeksen. Het voorblad noemt de apparaten en de kabels, maar niet de rechthoeken van het bord en de reeks die je elke locatie gaf. Schrijf die tabel er met de hand bij.
• De tunnels tussen locaties. Per apparaat staan de WireGuard-interfaces en hun peers op het blad, maar er is geen overzicht dat zegt: dit zijn de vier tunnels, dit zijn de tunneladressen, en dit is wat er over elke tunnel gaat.
• Alles wat je met de hand hebt toegevoegd. Een route naar een tweede filiaal, een bond die je alsnog een trunk hebt gemaakt, een route-afstand die je hebt aangepast: dat staat niet in het gegenereerde script en verdwijnt als iemand opnieuw genereert en plakt.
• De fysieke wereld. Rack, hoogte-unit, patchkastnummer, welk vezelpaar, waar de UPS staat, welke stopcontactgroep.
• De provider. Klantnummer, lijnnummer, contactgegevens, opzegtermijn, en het nummer waar je 's nachts terechtkomt.
• Waar de wachtwoorden staan, niet de wachtwoorden zelf. Een verwijzing naar de wachtwoordkluis is documentatie; een wachtwoord in een gedeelde map is een incident.

Eén document dat boven alles staat

Begin de map niet met apparaten maar met een half A4 dat de vragen beantwoordt die iemand om drie uur 's nachts stelt: waar komt het internet binnen, welke locatie hangt aan welke, wat gebeurt er als het hoofdkantoor uitvalt, en wie bel je. De rest van de map is naslag; dit ene blad is het begrip.

Zet daar in elk geval op: een schets van de locaties met hun adresreeksen, welke tunnel waar naartoe gaat, welke diensten centraal staan en welke lokaal, en wat er lokaal doorwerkt als de tunnel wegvalt. Dat laatste is vaak het enige wat mensen echt willen weten.

Per apparaat vastleggen

Per locatie vastleggen

Praktische gewoontes

• Namen die systematisch zijn. De identity moet uniek zijn, de tool meldt dubbele namen als fout, en een naam als zwl-sw-01 vertelt meteen waar het ding staat. Zie Namen kiezen.
• Bewaar het bord, niet alleen de scripts. De tekening met de locaties, de kabels en de tunnels is het document dat een opvolger als eerste opent. Sla de configuratie op zodra hij klopt, en opnieuw na elke wijziging.
• Print het voorblad en de apparaatbladen één keer, zonder wachtwoorden, en leg ze in de meterkast van de locatie zelf. De map op kantoor helpt niet als je in Breda voor een dode switch staat.
• Noteer wat er níet is ingesteld. Geen monitoring, geen backupschema, geen centrale logging: dat is informatie, geen schaamte. Zie Weten dat er iets stuk is voordat de klant belt.
• Loop de controles langs en schrijf op wat je bewust hebt laten staan. Een waarschuwing die je met reden negeert, is over een jaar een raadsel als er niets bij staat.

Verder lezen: Documenteren en overdragen, Bewaren en delen en Twintig filialen uitrollen.