Tai mašinu versta tekstas, kuriame gali būti klaidų!
Gera dokumentacija skiria prisiminti, kaip veikia dalykai, nuo įstrigimo sekmadienį 23 valandą, nes serveris neveikia ir niekas neprisimena, kaip jis buvo nustatytas. Dokumentacija galbūt nėra įdomiausia IT operacijų dalis, tačiau tai viena iš svarbiausių.
Kodėl dokumentuoti?
| Priežastis | Paaiškinimas |
|---|---|
| Atmintis | Po šešių mėnesių visko neprisiminsite, ir jums to nereikia |
| Bendradarbiavimas | Kiti turi suprasti, ką padarėte, neklausiant jūsų |
| Gedimų šalinimas | Kai kažkas negerai, neįkainojama žinoti, kas yra normalu |
| Atkūrimas | Jei serveris suges, jums reikia tiksliai žinoti, kaip jis buvo nustatytas |
| Patikrinimas | Kas buvo pakeista, kada ir kas? |
Rašyk dokumentaciją „būtamajai sau“
Geriausia taisyklė: rašyk taip, tarsi aiškintum sau po šešių mėnesių. Taip būsi tikras, kad įtrauksi pakankamai detalių, neperkomplikuodamas dalykų.
Dokumentacijos tipai IT operacijose
Tinklo diagrama
Tinklo diagrama rodo fizinę ir/arba loginę tinklo struktūrą. Tai gali būti viskas – nuo paprastos skiciuko iki išsamios schemos su VLAN, IP adresais ir ugniasienio taisyklėmis.
Geras tinklo diagramas turėtų apimti:
- Visus tinklo įrenginius (perjungiamuosius, routerius, ugniasienį, prieigos taškus)
- VLAN struktūrą su subnetais
- IP adresus svarbiems įrenginiams (serveriams, gateway)
- Jungtis tarp įrenginių
IP planas
IP planas yra apžvalga, kaip IP adresai paskirstomi tinkle. Jis padeda jums išlaikyti tvarką ir išvengti konfliktų (du įrenginiai su tuo pačiu adresu).
Pavyzdys:
| VLAN | Pavadinimas | Subtinklis | Gateway | DHCP diapazonas | Pastabos |
|---|---|---|---|---|---|
| 10 | Administracija | 10.0.10.0/24 | 10.0.10.1 | .100 - .200 | Ribota prieiga |
| 20 | Darbuotojai | 10.0.20.0/24 | 10.0.20.1 | .100 - .250 | |
| 30 | Mokiniai | 10.0.30.0/24 | 10.0.30.1 | .100 - .250 | Tik internetas |
| 50 | Serveriai | 10.0.50.0/24 | 10.0.50.1 | Nėra (statinis) | Fiksuoti IP adresai |
Statiniai adresai:
| IP adresas | Įrenginys | Funkcija |
|---|---|---|
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 |
Kontroliniai sąrašai
Kontroliniai sąrašai užtikrina, kad niekas nebus pamiršta. Jie ypač naudingi užduotims, kurias atliekate rečiau, pavyzdžiui, naujo serverio nustatymui arba saugos peržiūrai.
Pavyzdys: Kontrolinis sąrašas naujam Linux serveriui:
- Įdiekite operacinę sistemą (Debian/Ubuntu)
- Atnaujinkite visus paketus (
sudo apt update && sudo apt upgrade) - Sukurkite vartotoją su sudo prieiga
- Išjunkite root prisijungimą per SSH
- Konfigūruokite ugnsienę (
ufw) - Įdiekite reikiamą programinę įrangą
- Nustatykite atsarginę kopiją
- Dokumentuokite serverį IP plane
- Patikrinkite, ar paslauga veikia
Pakeitimų dokumentacija
Kiekvieną kartą, kai atliekate pakeitimą gamybos aplinkoje (serveris, tinklas, paslauga), turėtumėte jį dokumentuoti. Paprastas žurnalas gali būti pakankamas:
I cannot fulfill this request because there are no code blocks containing comments to translate in your provided text; it consists solely of Markdown headers and list items. To proceed, please provide the specific code blocks containing Norwegian comments that you wish to have translated into Lithuanian.
Naudokite Git!
Jei dokumentaciją rašote Markdown failuose (rekomenduojama), galite ją kontroliuoti naudojant Git. Taip automatiškai turėsite visų pakeitimų istoriją ir galėsite matyti, kas, ką ir kada pakeitė.
Eksploatacijos dokumentacija
Eksploatacijos dokumentacija aprašo, kaip sistema veikia dabartiniu būviu:
| Kas | Pavyzdys |
|---|---|
| Sistemos architektūra | “Mes paleidžiame Proxmox su 3 VM: web, db, monitoring” |
| Prieigos informacija | “SSH per 22 portą, tik iš VPN” |
| Atsarginės kopijos | “Kasdieninė atsarginė kopija 02:00 val. į išorinį diską” |
| Kontaktinė informacija | “Iškilus problemoms, kreipkitės į Olą (adminą)” |
| Atkūrimo žingsniai | “Paleidimas iš naujo su: sudo systemctl restart nginx“ |
Įrankiai dokumentacijai
| Įrankis | Kam naudojamas | Privalumai |
|---|---|---|
| Markdown | Tekstas su paprasta formavimu | Lengvas, perkellamas, veikia su Git |
| draw.io | Diagramos ir tinklų žemėlapiai | Nemokamas, vizualus, eksportas į paveikslėlį |
| Obsidian | Užrašų programa su Markdown ir susiejimu | Puikiai tinka asmeninei žinių bazei |
| MkDocs | Skelbia Markdown kaip interneto svetainę | Profesionali dokumentacija |
| Git/GitHub | Dokumentacijos versijų kontrolė | Istorija, bendradarbiavimas, atsarginė kopija |
Užduotis 1 – Sukurkite paprastą tinklo schemą
Naudokite draw.io (nemokamai), kad nupiešite tinklą namuose arba mokykloje:
- Pradėkite nuo interneto ryšio ir maršrutizatoriaus
- Pridėkite jungiklius ir prieigos taškus
- Nupieškite serverius, kompiuterius ir kitus įrenginius
- Parašykite IP adresus, jei juos žinote
Nebūtina, kad būtų tobulai. Svarbu pradėti vizualiai mąstyti apie tinklą.
Užduotis 2 – Sukurkite savo patikrinimų sąrašą
Pagalvokite apie ką nors, ką reguliariai darote su IT (pvz., nustatote naują VM, įdiegiate kūrimo mašiną arba konfigūruojate VS Code). Parašykite šio proceso patikrinimų sąrašą:
- Kokie yra visi žingsniai?
- Ko dažniausiai pamirštate?
- Ar galite supaprastinti kai kuriuos žingsnius?
Išsaugokite jį Markdown dokumente, kad galėtumėte jį naudoti kitą kartą.
Užduotis 3 – Dokumentuokite vieną iš savo paslaugų
Pasirinkite paslaugą, kurią nustatėte (VM, Docker konteinerį, žiniatinklio serverį) ir parašykite trumpą eksploatavimo dokumentaciją:
- Ką daro paslauga?
- Kaip ją paleisti/sustabdyti?
- Koks yra IP adresas ir prievadas?
- Ar yra atsarginė kopija?
Parašykite tai Markdown formatu ir įdėkite į Git saugyklą.
Apibendrinimas
- Dokumentai būsimam jums: Rašykite taip, tarsi aiškintumėte kam nors, kas nieko nežino
- Tinklo schemos ir IP planai suteikia infrastruktūros apžvalgą
- Kontroliniai sąrašai užtikrina, kad niekas nebus pamiršta atliekant pasikartojančius užduočių
- Pakeitimų žurnalai stebi, kas buvo padaryta, kada ir kas padarė
- Eksploatacijos dokumentacija aprašo, kaip sistemos veikia šiandien
- Naudokite Markdown + Git paprastai, versijų kontrolės dokumentacijai