God dokumentasjon er forskjellen mellom å huske hvordan ting fungerer og å stå fast klokken 23 på en søndag fordi serveren er nede og ingen husker hvordan den ble satt opp. Dokumentasjon er kanskje ikke den mest spennende delen av IT-drift, men det er en av de viktigste.
Hvorfor dokumentere?
| Grunn | Forklaring |
|---|---|
| Hukommelse | Du husker ikke alt om seks måneder, og det trenger du heller ikke |
| Samarbeid | Andre må kunne forstå hva du har gjort uten å spørre deg |
| Feilsøking | Når noe er galt, er det uvurderlig å vite hva som er normalt |
| Gjenoppbygging | Hvis en server dør, trenger du å vite nøyaktig hvordan den var satt opp |
| Etterprøvbarhet | Hva ble endret, når og av hvem? |
Skriv dokumentasjonen for “fremtidig deg”
Den beste tommelfingerregelen: skriv som om du forklarer til deg selv om seks måneder. Da er du garantert at du inkluderer nok detaljer uten å overkomplisere ting.
Typer dokumentasjon i IT-drift
Nettverkskart
Et nettverkskart viser den fysiske og/eller logiske strukturen i nettverket. Det kan være alt fra en enkel skisse til et detaljert diagram med VLAN, IP-adresser og brannmurregler.
Et godt nettverkskart bør inneholde:
- Alle nettverksenheter (switcher, rutere, brannmur, aksesspunkter)
- VLAN-struktur med subnet
- IP-adresser for viktige enheter (servere, gateway)
- Tilkoblinger mellom enheter
IP-plan
En IP-plan er en oversikt over hvordan IP-adresser er fordelt i nettverket. Den hjelper deg med å holde orden og unngå konflikter (to enheter med samme adresse).
Eksempel:
| VLAN | Navn | Subnet | Gateway | DHCP-range | Notater |
|---|---|---|---|---|---|
| 10 | Administrasjon | 10.0.10.0/24 | 10.0.10.1 | .100 - .200 | Begrenset tilgang |
| 20 | Ansatte | 10.0.20.0/24 | 10.0.20.1 | .100 - .250 | |
| 30 | Elever | 10.0.30.0/24 | 10.0.30.1 | .100 - .250 | Kun internett |
| 50 | Servere | 10.0.50.0/24 | 10.0.50.1 | Ingen (statisk) | Faste IP-adresser |
Statiske adresser:
| IP-adresse | Enhet | Rolle |
|---|---|---|
10.0.50.10 | web-01 | Nginx |
10.0.50.11 | db-01 | PostgreSQL |
10.0.50.12 | monitoring-01 | Grafana + Loki |
10.0.50.20 | proxmox | Hypervisor |
Sjekklister
Sjekklister sikrer at ingenting blir glemt. De er spesielt nyttige for oppgaver du gjør sjeldnere, som å sette opp en ny server eller gjennomføre en sikkerhetsgjennomgang.
Eksempel: Sjekkliste for ny Linux-server:
- Installer operativsystem (Debian/Ubuntu)
- Oppdater alle pakker (
sudo apt update && sudo apt upgrade) - Opprett bruker med sudo-tilgang
- Deaktiver root-innlogging via SSH
- Konfigurer brannmur (
ufw) - Installer nødvendig programvare
- Sett opp backup
- Dokumenter serveren i IP-planen
- Test at tjenesten fungerer
Endringsdokumentasjon
Hver gang du gjør en endring i et produksjonsmiljø (server, nettverk, tjeneste), bør du dokumentere det. En enkel logg kan være nok:
## Endringslogg
### 2026-04-14 - Oppgradert Nginx
- **Hva:** Oppdatert Nginx fra 1.24 til 1.26
- **Hvorfor:** Sikkerhetsoppdatering (CVE-2025-XXXX)
- **Hvem:** Ola
- **Resultat:** OK, ingen nedetid
### 2026-04-10 - Nytt VLAN for IoT
- **Hva:** Opprettet VLAN 40 for IoT-enheter
- **Hvorfor:** Isolere IoT fra resten av nettverket
- **Hvem:** Kari
- **Resultat:** OK, alle printere flyttet til VLAN 40
Bruk Git!
Hvis du skriver dokumentasjonen i Markdown-filer (anbefalt), kan du versjonskontrollere dem med Git. Da har du automatisk historikk over alle endringer, og du kan se hvem som endret hva og når.
Driftsdokumentasjon
Driftsdokumentasjon beskriver hvordan et system fungerer i sin nåværende tilstand:
| Hva | Eksempel |
|---|---|
| Systemarkitektur | “Vi kjører Proxmox med 3 VMer: web, db, monitoring” |
| Tilgangsinfo | “SSH via port 22, kun fra VPN” |
| Backup-rutiner | “Daglig backup kl 02:00 til ekstern disk” |
| Kontaktinformasjon | “Ved problemer, kontakt Ola (admin)” |
| Gjenopprettingssteg | “Restart med: sudo systemctl restart nginx“ |
Verktøy for dokumentasjon
| Verktøy | Hva det brukes til | Fordeler |
|---|---|---|
| Markdown | Tekst med enkel formatering | Lett, portabelt, fungerer med Git |
| draw.io | Diagrammer og nettverkskart | Gratis, visuelt, eksporter til bilde |
| Obsidian | Notatapp med Markdown og lenking | Bra for personlig kunnskapsbase |
| MkDocs | Publiser Markdown som nettside | Profesjonell dokumentasjon |
| Git/GitHub | Versjonskontroll av dokumentasjon | Historikk, samarbeid, backup |
Oppgave 1 - Lag et enkelt nettverkskart
Bruk draw.io (gratis) til å tegne nettverket hjemme eller på skolen:
- Start med internettforbindelsen og ruteren
- Legg til switcher og aksesspunkter
- Tegn inn servere, PCer og andre enheter
- Skriv på IP-adresser der du vet dem
Det trenger ikke å være perfekt. Poenget er å begynne å tenke visuelt om nettverket.
Oppgave 2 - Lag din egen sjekkliste
Tenk på noe du gjør regelmessig med IT (f.eks. sette opp en ny VM, installere en utviklingsmaskin, eller konfigurere VS Code). Skriv en sjekkliste for prosessen:
- Hva er alle stegene?
- Hva glemmer du oftest?
- Kan du forenkle noen steg?
Lagre den i et Markdown-dokument slik at du kan bruke den neste gang.
Oppgave 3 - Dokumenter en av tjenestene dine
Velg en tjeneste du har satt opp (en VM, en Docker-container, en webserver) og skriv en kort driftsdokumentasjon:
- Hva gjør tjenesten?
- Hvordan starter/stopper du den?
- Hva er IP-adressen og porten?
- Finnes det backup?
Skriv det i Markdown og legg det i et Git-repository.
Oppsummering
- Dokumenter for fremtidig deg: Skriv som om du forklarer til noen som ikke vet noe
- Nettverkskart og IP-planer gir oversikt over infrastrukturen
- Sjekklister sikrer at ingenting glemmes ved gjentatte oppgaver
- Endringslogger sporer hva som ble gjort, når og av hvem
- Driftsdokumentasjon beskriver hvordan systemene fungerer i dag
- Bruk Markdown + Git for enkel, versjonskontrollert dokumentasjon