Dette er ein maskinomsett tekst som kann innehalda feil!
God dokumentasjon er skilnaden mellom å minnast korleis ting fungerer og å stå fast klokka 23 på ein sundag fordi tenaren er nede og ingen minnast korleis han vart sett opp. Dokumentasjon er kanskje ikkje den mest spennande delen av IT-drift, men det er ein av dei viktigaste.
Kvifor dokumentera?
| Grunn | Forklaring |
|---|---|
| Minne | Du hugsar ikkje alt om seks månadar, og det treng du heller ikkje |
| Samarbeid | Andre må kunne forstå kva du har gjort utan å spørja deg |
| Feilsøking | Når noko er gale, er det uvurderleg å vita kva som er normalt |
| Gjenoppbygging | Ifrå ein server døyr, treng du å vita nøyaktig korleis han var sett opp |
| Etterprøvbarheit | Kva vart endra, når og av kven? |
Skriv dokumentasjonen for «futur deg»
Den beste regelen er: skriv som om du forklarar til deg sjølv om seks månadar. Då er du garantert at du inkluderer nok detaljar utan å gjera tinga for kompliserte.
Typar dokumentasjon i IT-drift
Nettverkskart
Eit nettverkskart syner den fysiske og/eller logiske strukturen i nettverket. Det kann vera alt frå ei enkel skisse til eit detaljert diagram med VLAN, IP-adresser og brannmurreglar.
Eit godt nettverkskart bør innehalda:
- Alle nettverkseiningar (brytarar, rutere, brannmur, tilgangspunkt)
- VLAN-struktur med subnet
- IP-adresser for viktige einingar (tenarar, port)
- Tilkoplingar mellom einingar
IP-plan
Ein IP-plan er ei oversikt over korleis IP-adresser er fordelt i nettverket. Han hjelper deg med å halda orden og unngå konflikt (to einingar med same adresse).
Døme:
| VLAN | Namn | Subnet | Gateway | DHCP-rekkevidd | Notatar |
|---|---|---|---|---|---|
| 10 | Administrasjon | 10.0.10.0/24 | 10.0.10.1 | .100 - .200 | Begrensa tilgang |
| 20 | Tilsette | 10.0.20.0/24 | 10.0.20.1 | .100 - .250 | |
| 30 | Elevar | 10.0.30.0/24 | 10.0.30.1 | .100 - .250 | Berre internett |
| 50 | Tenarar | 10.0.50.0/24 | 10.0.50.1 | Ingen (statisk) | Faste IP-adresser |
Statisk adresser:
| IP-adresse | Eining | 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 tryggar at ingenting vert gløymt. Dei er særleg nyttige for oppgåver du gjer sjeldnare, som å setja opp ein ny tenar eller gjennomføra ein tryggleiksgjennomgang.
Døme: Sjekkliste for ny Linux-tenar:
- Installer operativsystem (Debian/Ubuntu)
- Oppdater alle pakkar (
sudo apt update && sudo apt upgrade) - Skap brukar med sudo-tilgang
- Deaktiver rot-innlogging via SSH
- Konfigurer brannmur (
ufw) - Installer naudsynt programvare
- Sett opp attskriv
- Dokumenter tenaren i IP-planen
- Test at tenesta fungerer
Endringsdokumentasjon
Kvar gong du gjer ei endring i eit produksjonsmiljø (server, nettverk, teneste), bør du dokumentera det. Ein enkel logg kann vera nok:
## Endringslogg
### 2026-04-14 - Oppgradert Nginx
- **Hva:** Oppdatert Nginx frå 1.24 til 1.26
- **Hvorfor:** Tryggleiksoppdatering (CVE-2025-XXXX)
- **Hvem:** Ola
- **Resultat:** OK, ingen nedetid
### 2026-04-10 - Nytt VLAN for IoT
- **Hva:** Oppretta VLAN 40 for IoT-einingar
- **Hvorfor:** Isolera IoT frå resten av nettverket
- **Hvem:** Kari
- **Resultat:** OK, alle skrivarar flytta til VLAN 40
Bruk Git!
Ynskjer du å skriva dokumentasjonen i Markdown-filer (tilrådd), kan du versjonskontrollera dei med Git. Då hev du automatisk historikk over alle endringar, og du kan sjå kven som endra kva og når.
Driftsdokumentasjon
Driftsdokumentasjon skildrar korleis eit system verkar i sin noverande tilstand:
| Kva | Døme |
|---|---|
| Systemarkitektur | «Me køyrer Proxmox med 3 VM-ar: web, db, overvåking» |
| Tilgangsinfo | «SSH via port 22, berre frå VPN» |
| Backup-rutinar | «Dagleg backup kl 02:00 til ytre disk» |
| Kontaktinformasjon | «Ved problem, kontakt Ola (admin)» |
| Gjenopprettingssteg | «Restart med: sudo systemctl restart nginx» |
Verktyg for dokumentasjon
| Verktyg | Kva det vert brukt til | Fordelar |
|---|---|---|
| Markdown | Tekst med enkel formatering | Lett, portabelt, fungerer med Git |
| draw.io | Diagram og nettverkskart | Gratis, visuelt, eksporter til bilete |
| Obsidian | Notatapp med Markdown og lenking | Bra for personleg kunnskapsbase |
| MkDocs | Publiser Markdown som nettstad | Profesjonell dokumentasjon |
| Git/GitHub | Versjonskontroll av dokumentasjon | Historikk, samarbeid, backup |
Oppgåve 1 – Lag eit enkelt nettverkskart
Bruk draw.io (gratis) til å teikne nettverket heime eller på skulen:
- Byrj med internett-sambandingi og rutaren
- Legg til brytarar og tilgangspunkt
- Teikn inn tenarar, PC-ar og andre einingar
- Skriv på IP-adresser der du veit dei
Det treng ikkje å vera perfekt. Poenget er å byrja å tenkje visuelt om nettverket.
Oppgåve 2 – Lag di eiga sjekkliste
Tenk på noko du gjer regelbunden med IT (t.d. setja opp ein ny VM, installera ei utviklingsmaskin, eller konfigurera VS Code). Skriv ei sjekkliste for prosessen:
- Kva er alle stega?
- Kva gløymer du oftast?
- Kan du forenkla nokre steg?
Lagre den i eit Markdown-dokument slik at du kan bruka den neste gong.
Oppgåve 3 – Dokumenter ei av tenestene dine
Vel ei teneste du har sett opp (ein VM, ein Docker-container, ein webserver) og skriv ein kort driftsdokumentasjon:
- Kva gjer tenesta?
- Korleis startar/stoppar du ho?
- Kva er IP-adressen og porta?
- Finst det backup?
Skriv det i Markdown og legg det i eit Git-repository.
Oppsummering
- Dokument for di framtidige deg: Skriv som um du forklarar til nokon som ikkje veit noko
- Nettverkskart og IP-planar gjev oversyn over infrastrukturen
- Sjekklister sikrar at ingenting vert gløymt ved gjentatte oppgåver
- Endringslogger sporer kva som vart gjort, når og av kven
- Driftsdokumentasjon beskriv korleis systema fungerer i dag
- Bruk Markdown + Git for enkel, versjonskontrollert dokumentasjon