Ĉi tio estas maŝintradukita teksto kiu povas enhavi erarojn!
Bona dokumentado estas la diferenco inter memori kiel aferoj funkcias kaj resti blinde je la 23-a horo dimanĉe ĉar la servilo estas malsupre kaj neniu memoras kiel ĝi estis starigita. Dokumentado eble ne estas la plej ekscita parto de IT-operacioj, sed ĝi estas unu el la plej gravaj.
Kialo dokumenti?
| Grundo | Klarigo |
|---|---|
| Memoro | Vi ne memoros ĉion post ses monatoj, kaj vi ne bezonas tion |
| Kunlaboro | Aliaj devas kompreni kion vi faris sen demandi vin |
| Erarmalhelpado | Kiam io estas erara, estas neprezebla scii kio estas normala |
| Rekonstruo | Se servilo mortas, vi bezonas scii precize kiel ĝi estis agordita |
| Kontrolebleco | Kio estis ŝanĝita, kiam kaj de kiu? |
Skribu la dokumentadon por “viro estonta vi”
La plej bona regulo estas: skribu kiel se vi klarigus al vi mem post ses monatoj. Tiel vi certigos, ke vi inkluzivas sufiĉe da detaloj sen tro kompliki la aferojn.
Tipoj de dokumentado en IT-operacio
Dokumentasjon er kritisk for effektiv IT-drift. Uten god dokumentasjon blir det vanskelig å feilsøke problemer, implementere endringer og opprettholde systemene. Det finnes flere typer dokumentasjon som er relevant i IT-drift:
- Brukerdokumentasjon: Beskriver hvordan sluttbrukere skal bruke systemene.
- Systemdokumentasjon: Beskriver hvordan systemene er bygget opp og fungerer teknisk.
- Driftshåndbok: Inneholder instruksjoner for daglig drift og vedlikehold av systemene.
- Feilhåndtering: Dokumentasjon av kjente feil og løsninger.
- Konfigurasjonsdokumentasjon: Beskriver hvordan systemene er konfigurert.
God dokumentasjon bør være oppdatert, lett forståelig og tilgjengelig for de som trenger den. Regelmessig gjennomgang og oppdatering av dokumentasjonen er viktig for å sikre at den er korrekt og relevant.
Dokumentasjonen kan lagres i ulike formater, for eksempel tekstfiler, Word-dokumenter, wiki-sider eller spesialiserte dokumentasjonssystemer. Valg av format bør baseres på behovene til organisasjonen og hvilke verktøy som er tilgjengelige.
Retmapo
Retmapo montras la fizikan kaj/aŭ logikan strukturon de la reto. Ĝi povas esti ĉio de simpla skizo ĝis detala diagramo kun VLAN-oj, IP-adresoj kaj fajromuraj reguloj.
Bona retmapo devus enhavi:
- Ĉiujn retajn aparatojn (ŝaltilojn, ripetilojn, fajromurojn, alirpunktojn)
- VLAN-strukturon kun subreto
- IP-adresojn por gravaj aparatoj (serviloj, pordoj)
- Konektojn inter aparatoj
IP-plano
IP-plano estas superrigardo pri kiel IP-adresoj estas disdonitaj en la reto. Ĝi helpas vin konservi ordon kaj eviti konfliktojn (du aparatoj kun la sama adreso).
Ekzemplo:
| VLAN | Nomo | Subreto | Pordokontrolilo | DHCP-gamo | Notoj |
|---|---|---|---|---|---|
| 10 | Administrado | 10.0.10.0/24 | 10.0.10.1 | .100 - .200 | Limigita aliro |
| 20 | Dungitoj | 10.0.20.0/24 | 10.0.20.1 | .100 - .250 | |
| 30 | Studentoj | 10.0.30.0/24 | 10.0.30.1 | .100 - .250 | Nur interreto |
| 50 | Serviloj | 10.0.50.0/24 | 10.0.50.1 | Neniu (stata) | Fiksaj IP-adresoj |
Stataj adresoj:
| IP-adreso | Aparato | Rolo |
|---|---|---|
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 | Hipervizoro |
Kontrolllistoj
Kontrolllistoj certigas, ke nenio estas forgesita. Ili estas aparte utilaj por taskoj, kiujn vi faras malofte, kiel starigi novan servilon aŭ efektivigi sekurecan revizion.
Ekzemplo: Kontrolllisto por nova Linux-servilo:
- Instali operaciumon (Debian/Ubuntu)
- Ĝisdatigi ĉiujn pakojn (
sudo apt update && sudo apt upgrade) - Krei uzanton kun sudo-rajto
- Malaktivigi eniron de radiko per SSH
- Konfiguri fajromuro (
ufw) - Instali necesan programaron
- Starigi bakupan kopion
- Dokumenti la servilon en la IP-plano
- Testi, ke la servo funkcias
Ŝanĝodokumentado
Ĉiufoje kiam vi faras ŝanĝon en produktocirklo (servero, reto, servo), vi devus dokumenti ĝin. Simpla registro povas sufiĉi:
## Endringslogg
### 2026-04-14 - Oppgradert Nginx
- **Kio:** Ĝisdatigita Nginx de 1.24 al 1.26
- **Kial:** Sekureca ĝisdatigo (CVE-2025-XXXX)
- **Kiu:** Ola
- **Rezulto:** Bone, neniu interrompo
### 2026-04-10 - Nova VLAN por IoT
- **Kio:** Kreita VLAN 40 por IoT-aparatoj
- **Kial:** Izoli IoT de la resto de la reto
- **Kiu:** Kari
- **Rezulto:** Bone, ĉiuj presiloj transigitaj al VLAN 40
Uzante Git!
Se vi skribas la dokumentadon en Markdown-dosieroj (rekomendata), vi povas versikontroli ilin per Git. Tiam vi aŭtomate havas historion de ĉiuj ŝanĝoj, kaj vi povas vidi kiu ŝanĝis kion kaj kiam.
Operacia Dokumentaro
Operacia dokumentaro priskribas kiel sistemo funkcias en sia nuna stato:
| Kio | Ekzemplo |
|---|---|
| Sistema Arkitekturo | “Ni funkigas Proxmox kun 3 VM-oj: web, db, monitoring” |
| Aliro-Informoj | “SSH per pordo 22, nur de VPN” |
| Backup-Rutinoj | “Ĉiutaga backup je 02:00 al ekstera disko” |
| Kontakto-Informoj | “En kazo de problemoj, kontaktu Ola (admin)” |
| Reenŝargaj Paŝoj | “Restartu per: sudo systemctl restart nginx“ |
Iluzoj por dokumentado
| Iluzo | Kio ĝi uzas por | Avantaĝoj |
|---|---|---|
| Markdown | Teksto kun simpla formatado | Malpeza, portebla, funkcias kun Git |
| draw.io | Diagramoj kaj reto-mapoj | Senpaga, vida, eksportas al bildo |
| Obsidian | Notaplikaĵo kun Markdown kaj ligoj | Bona por personaj scibazoj |
| MkDocs | Eldonas Markdown kiel retejo | Profesia dokumentado |
| Git/GitHub | Versiokontrolo de dokumentado | Historio, kunlaboro, sekurkopio |
Tasko 1 - Kreu simplan retekdiagramon
Uzu draw.io (senpaga) por desegni la reton hejme aŭ en lernejo:
- Komencu per la interreta konekto kaj la ripetilo
- Aldonu ŝaltilojn kaj alirpunktojn
- Desegnu servilojn, komputilojn kaj aliajn aparatojn
- Skribu IP-adresojn tie, kie vi ilin konas
Ĝi ne bezonas esti perfekta. La celo estas komenci pensi vizuale pri la reto.
Tasko 2 - Kreu vian propran kontrol-liston
Pensu pri io, kion vi faras regule kun per IT (ekz. starigi novan VM, instali disvolvan maŝinon, aŭ konfiguri VS Code). Skribu kontrol-liston por la procezo:
- Kio estas ĉiuj paŝoj?
- Kion vi plej ofte forgesas?
- Ĉu vi povas simpligi iujn paŝojn?
Konservu ĝin en Markdown-dokumento por ke vi povu uzi ĝin la venontan fojon.
Tasko 3 - Dokumentu unu el viaj servoj
Elektu servon, kiun vi starigis (VM, Docker-ujon, retserveron) kaj skribu mallongan operacian dokumentaron:
- Kion faras la servo?
- Kiel vi startas/haltas ĝin?
- Kio estas la IP-adreso kaj la pordo?
- Ĉu ekzistas sekurkopio?
Skribu ĝin en Markdown kaj metu ĝin en Git-deponejojn.
Resumo
- Dokumentoj por via estonta vi: Skribu kiel se vi klarigus al iu, kiu nenion scias
- Retmapoj kaj IP-planoj donas superrigardon pri la infrastrukturo
- Kontrollistoj certigas, ke nenio forgesiĝas ĉe ripetaj taskoj
- Ŝanĝregistroj sekvas kion oni faris, kiam kaj de kiu
- Funkciigadodokumentado priskribas kiel la sistemoj funkcias hodiaŭ
- Uzu Markdown + Git por facila, versio-kontrolita dokumentado