Mida peab väike VPN-i käsiraamat kiirustades vastama

Hooldaja, kes võttis vahetuse üle kell 02:00, ei osanud öelda, kas teenus on terve, sest dokument selgitas disaini ega öelnud kordagi, mida käivitada. Faili teisele inimesele üleandmine ja seejärel ruumist lahkumine on ainus test, millel on tähtsust. Enamik väikeseid VPN-i märkmeid kukub selle läbi juba teisel lehel. Allpool olev vorm peab sellele testile vastu ja miski selles ei pea olema pikk.

Alusta kaardiga, mille väsinud inimene suudab üle vaadata

Kirjuta üles, mida keegi peab kiirustades vaatama: nimed, millega kliendid ühenduvad, pordid, millel deemon kuulab, aadressibasseinid, mida see jagab, kuidas kliendinimesid lahendatakse ja millised võrgud tunnelist tagapool peavad olema kättesaadavad. Lisa build'i number, mida sa tegelikult jooksutad, ja nimeta komponent, kellele iga liikuv osa kuulub, sest marsruudid, paketifilter ja kliendiprofiilid seadistatakse sageli kolmes eri kohas. Märgi ka välised sõltuvused: hostimiskonto, üleslink, identiteedipakkuja ja privaatvõrgud kaugemas otsas. Tabel või käsitsi joonistatud skeem kannab seda paremini kui lõigud, sest lugeja sirvib, mitte ei loe.

Seejärel nimeta inimesed, kes võivad hädaolukorra muudatust lubada, kontaktteega, mis ei sõltu sellest, kas tunnel töötab. Eskaleerimisliin ilma varuvariandita on tupik just selles intsidendis, mis seda vajab. Kaks nime ja üks telefoninumber on piisavad; kaart ei ole personalinimekiri.

Iga kontroll vajab vastust, mis loetakse terveks

Aseta iga teenuse puhul käsk ja rida, mis tähendab, et see õnnestus, kõrvuti, et lugeja ei peaks kunagi üht teisest kiirustades tuletama. Protsessi olek ja otsast-otsani kättesaadavus asuvad eri kihtidel: üks näitab, et deemon võttis oma konfiguratsiooni vastu, teine, et klient saab kasutada seda, mida tunnel pakub. Kirjuta mõlemad read ja ütle, millise rikke kumbki tabab, sest deklareeritud tulemuseta kontroll muutub vaidluseks selle üle, kas väljund näeb kena välja.

systemctl status openvpn-server@lab
ss -lntu | grep 1194

Käivita mõlemad ja kohtle neid eraldi tõenditena, mitte järjestusena. Roheline üksus võib seista tunneli kõrval, mida keegi kasutada ei saa, ja vastupidine juhtub siis, kui kuulaja jääb katkise marsruudi järel ellu. Märgi kiht, mida kumbki rida jälgib, ja lugeja teab, kummat usaldada, kui need lahknevad.

Kolm riket katavad enamiku öödest

Kättesaamatu lõpp-punkt, tagasi lükatud identiteet ja ühendus ilma kasuliku liikluseta selgitavad peaaegu kõike, mis kellegi üles äratab. Igaühe jaoks loetle kaks esimest kontrolli ja inimene, kelle poole eskaleerida, et keegi ei peaks kell 02:00 diagnostikajärjekorda leiutama. Kättesaamatus osutab tavaliselt teele või kuulajale, tagasi lükatud identiteet sertifikaadile, volituste hoidlale või kellale ning tühi ühendus marsruutidele, edastamisele või nimede lahendamisele. Need kolm haru loevad erinevaid logisid, seepärast tuleb haru valida enne, kui logi avatakse.

Linki ülesvoolu dokumentatsioonile, selle asemel et kleepida käske, mida sa sellel hostil ei käivitanud. Teisest keskkonnast kopeeritud testimata käsk on hullem kui osuti, sest see näeb välja autoriteetne ja ebaõnnestub vaikselt.

Kirjuta muudatus järjestusena, mitte lõiguna

Iga muudatuse puhul märgi kontrollpunkt, kuhu saad tagasi pöörduda, kontroll, mis kinnitab edu, ja tingimus, mis käivitab tagasipööramise, just selles järjekorras. Lisa tagasitee, mis ei kulge läbi tunneli, sest just sinu tehtav muudatus võib selle sulgeda. Märgi, kuidas praegused tühistamised taastataks, mitte vanem hetktõmmis, sest aegunud nimekiri võtab vaikselt uuesti vastu volitused, mis sellel hommikul pensionile saadeti. Nummerdatud imperatiivsed sammud peavad survele vastu; proosa muutub tõlgenduseks.

Harjuta seda tagasiteed enne, kui seda vaja läheb, alati kui muudatus on piisavalt suur, et omada tähtsust. Mälu järgi kirjutatud tagasipööramine on oletus, millele on kuupäev juurde pandud.

Volitused elavad mujal

Viita paroolihaldurile, hoidlale või pitseeritud ümbrikule ja ütle, kes tohib selle avada, selle asemel et failis mis tahes materjali tsiteerida. Privaatvõtmed, ühekordsed taastekoodid ja profiilid, mis sisaldavad saladust, kuuluvad kaitstud hoiukohta, ja leht peaks selgitama, kuidas volitatud hooldaja neid kell 02:00 kätte saab. Ära kunagi kasuta elavat saladust näitena, sest näited kleebitakse piletitesse ja vestluslõimedesse. Osuti pluss õiguste loend on kõik, mida dokument vajab.

Vaata fail üle pärast tõelist muudatust või taasteharjutust, kustuta teed, mida enam ei ole, ja märgi, kelle töö on järgmine hooldusotsus. Hoia lõpus kolmeveerulist muudatuste logi: kuupäev, mis muutus, kes selle kinnitas. Just see leht ütleb järgmisele lugejale, kas ülejäänu on ajakohane, ja systemd systemctl dokumentatsioon on parem link kui teenusekäskude ümbersõnastus, mis aja jooksul triivib.