Betere infrastructuurdocumentatie maken

In de wereld van IT-systemen en infrastructuurdocumentatie worden vaak termen als 'single pane of glass', 'single source of truth', 'golden source' en 'zero touch documentation' gebruikt., schrijft David Cuthbertson in een artikel op LinkedIn. Cuthbertson is een specialist op het gebied van het documenteren en visualiseren van onder andere IT- en bekabelingsinfrastructuren.

Deze termen zijn onderdeel van marketingcampagnes die een oplossing beloven voor het veelvoorkomende probleem van slechte documentatie van IT-systemen en infrastructuur, stelt Cuthbertson. Er wordt vaak beweerd dat duplicatie van gegevens slecht is en de documentatie onbeheersbaar maakt. Een betrouwbare oplossing zou alleen geleverd kunnen worden door een geïntegreerd, geconsolideerd systeem met automatische updates.

Veel documentatieproject kosten veel geld en leveren relatief weinig op. De focus ligt veelal op technische gegevens, terwijl lastige gebieden zoals fysieke aspecten, bedrijfsvoering, teams, groepering, timing en presentatie vaak worden genegeerd. “Mijn vrijwilligerswerk met de TIA TR-60 ICT-levenscyclusbeheerstandaard is wat dat betreffend fascinerend”, schrijft Cuthbertson. Als voorzitter van de commissie die verantwoordelijk is voor de ontwikkeling van de infrastructuurdocumentatienorm TIA-5077.1, heeft hij door gesprekken met professionals een beter inzicht gekregen in de informatiebehoeften. "Hierdoor ben ik gaan begrijpen waarom duplicatie eigenlijk een goede, noodzakelijke en welkome zaak is – in tegenstelling tot wat soms wordt gezegd. Laten we beginnen met te kijken naar de infrastructuurinformatie die nodig is om taken te vereenvoudigen, risico's te verminderen, de werkdruk te verlagen, teamwerk te bevorderen en voorspelbare projectlevering mogelijk te maken.

“Zo'n 20 jaar geleden, bij de ontwikkeling van de eerste versies van onze AssetGen-software, realiseerde ik me dat IT-project- en operationele processen informatie vereisen in verschillende formaten, detailniveaus en presentatievormen.” Enkele voorbeelden van formaten waarin IT-infrastructuurcomponenten gedupliceerd worden zijn:

1. Documenten over beleid, configuraties, inkoop, kwaliteitsborging, testen, enz.
2. Ontwerpdocumenten over systemen en architecturen (HLD, LLD)
3. Lijsten van apparaten, configuraties, project BOM en ondersteuningsdetails
4. Diagrammen die locaties en afhankelijkheden tonen vanuit fysieke, systeem- en zakelijke perspectieven
5. Workflowprocessen die betrekking hebben op projecten, ITSM-beheer, compliance en beveiliging
6. Gestandaardiseerde procedures en controles die implementatiemethoden dekken
7. Monitorsystemen die capaciteit, status, beveiligingslogs en prestaties tonen

Het wordt problematisch als bijvoorbeeld een switch alleen in een activa-lijst verschijnt, maar niet in een netwerkdiagram, of de rack waarin het zich bevindt, of een lijst van apparaten die ermee verbonden zijn, of een lijst van diensten die worden beïnvloed door het herstarten ervan. Duplicatie is goed, maar moet wel beheerd worden, anders vertrouwt niemand de verstrekte informatie en gaat men handmatig de informatie die men nodig heeft voor een taak achterhalen – vaak door enquêtes, workshops en audits.

Maar hoe beheer je de noodzakelijke duplicatie?

Houd de zaken zo eenvoudig mogelijk en hergebruik gegevens om verschillende weergaven van elk component of systeem te tonen’, adviseert Cuthbertson. Een spreadsheet kan een goed begin zijn, maar voor schaalbaarheid, flexibiliteit en controle eindig je waarschijnlijk met het gebruik van een database. Het is een goed idee, vindt hij, om de huidige aanpak rond documenteren te beoordelen en te communiceren waar snelle winsten behaald kunnen worden. Het gebruik van dezelfde namen in verschillende informatiesets, het toewijzen van eigenaarschap, en het overeenkomen van een update-periode zijn slechts enkele basisbeginselen om mee te beginnen.

“Ook bestaan er methoden zoals die van Callum om de Visio-diagrammen die worden toegepast te bekijken en vervolgens kruisverwijzingen naar andere diagrammen met hetzelfde component of applicatie te rapporteren”, zegt Cuthbertson. “Dit is vergelijkbaar met inhoudscontrole, maar terwijl het eenvoudig is met Word en Excel, is dit niet het geval voor diagrammen. Zijn methode gaat verder door hyperlinks in te voegen die directe verwijzingen mogelijk maken van een vorm naar andere documenten en het diagram op de vorm te centreren. Zo kan een server in een rack snel worden gerefereerd in HLD's, LLD's, applicatiediagrammen en backup- en herstelplannen. Het beoordelen van de mate van duplicatie is snel en toont ook verschillen en inconsistenties die eenvoudig opgelost kunnen worden. Als servers niet verschijnen in racks of VM-omgevingen, maar cruciaal zijn voor een applicatie, dan is er iets mis. Als alleen de servers in andere documenten waren gedupliceerd, zouden we tenminste weten waar ze zijn.”