Documentatie-voorbeelden

Hoi, heeft iemand voorbeelden van hoe ze VPN-informatie effectief documenteren in Hudu? Ik heb een hoop OpenVPN- en Wireguard-tunnels bij verschillende klanten om te documenteren en ik probeer uit te vinden wat de meest effectieve manier is om dat te doen.

Het hangt af van wat je gebruikt, maar…
Maak een asset-type genaamd “Remote access/VPN”
Binnen de asset-velden:
“VPN Type” dat een dropdown is “Wireguard” “NetExtender” “OpenVPN” “Other” etc.

IP/DNS voor netwerk

Assetlink zodat je het kunt verbinden met de firewall (je hebt toch firewalls gedocumenteerd, toch? :P)

Verband tussen asset en het wachtwoord voor authenticatie.

Dit is niet voor alles hetzelfde, maar is bedoeld om afgestemd en aangepast te worden. Probeer dingen niet dubbel te documenteren, maar gebruik links/relaties.

Afhankelijk van de schaalgrootte, moet je mogelijk linken naar een globale KB over hoe je de verschillende VPNs installeert/gebruikt. Als je bastion hosts/jump boxes hebt, kun je dat ook documenteren als een andere asset-link.

Ik heb de onderstaande assets gemaakt

  1. Ssl vpn configuratie

Hierin staan alle configuratiegegevens. Serveradressen. Links naar de router/ssl-apparaat. Mfa-bron azure/nps-server erc

  1. Ssl-gebruikers.

Dit is gewoon een lijst van alle gebruikers die geautoriseerd zijn voor SSL. Technici moeten hier het service ticketnummer invullen dat toont wanneer en wie deze toegang heeft geautoriseerd. Vervolgens delen we dit via het partnerportaal zodat de klant kan zien wie SSL-toegang heeft.

  1. Site-to-site tunnels.

Hier staan bron- en eind-IP’s. Wachtwoordzin. Encryptiemethoden en details met betrekking tot routering.

  1. Site-to-site VPN.

Vergelijkbaar met het bovenstaande, maar Sophos XGS-tunnels versus site-to-site VPN’s vereisen verschillende info.

We gebruiken Sophos XGs, dus velden die allemaal betrekking hebben op wat de XG nodig heeft.

Eerst had ik één asset-type voor alle VPNs, maar verschillende VPNs hebben verschillende info nodig, en technici documenteerden nooit correct met zoveel willekeurige velden die niet relevant waren voor de specifieke VPN die ze opzetten.

Ik stuur graag screenshots van mijn asset-indelingen als je geïnteresseerd bent, stuur me een bericht.

Thanks! Dit geeft me wat goede spullen om mee te werken. Ik twijfel of ik op sommige dingen te gedetailleerd moet zijn, omdat hercreatie soms makkelijker is door gewoon configuratiebestanden te herstellen, maar ik probeer geen aannames te doen. Goed punt over een KB-artikel link. En ja, ik heb firewalls gedocumenteerd!

Iets waar je voorzichtig mee moet zijn, is te veel documentatie. Meestal doe ik mijn best om dingen te documenteren die ik denk dat nodig zullen zijn met ofwel frequentie of met lange tussenpozen.

Als voorbeeld, hebben we een wisselrooster dat vereist dat je in een virtuele PBX inlogt en de gespreksroutering wijzigt. Ik hoef dit maar elke 5 weken te doen. Omdat ik het gedocumenteerd heb, hoef ik me geen zorgen te maken dat ik vergis waar de pagina is of dat ik moet zoeken naar de login.

Als voorbeeld van een langere interval, hebben we een aantal van deze virtuele PBX’s die opnieuw moeten worden ingezet om ze te updaten. Het proces is het opzetten van een OVA met een paar vooraf bepaalde waarden voordat de overstap plaatsvindt. Omdat we zoveel van hen hebben en dit proces slechts ~1 keer per jaar doen, maar het zeer impactvol is, is het superhandig om het op te schrijven.

Het vinden van de juiste balans tussen gestroomlijnde documentatie en te veel documenteren dat onhoudbaar wordt, is een heel fijne lijn.