Wat ’n klein VPN-handleiding vinnig moet kan antwoord

Die beheerder wat om 02:00 oorgeneem het, kon nie sê of die diens gesond was nie, want die dokument het die ontwerp verduidelik en nooit gesê wat om te hardloop nie. Om die lêer aan iemand anders te gee en dan die kamer te verlaat, is die enigste toets wat saak maak. Die meeste klein VPN-notas faal dit op die tweede bladsy. Die vorm hieronder oorleef daardie toets, en niks daarvan hoef lank te wees nie.

Begin met ’n kaart wat ’n moeë mens kan oorskan

Skryf neer wat iemand in ’n haas moet naslaan: die name waarmee kliënte verbind, die poorte waarop die daemon luister, die adrespoele wat hy uitdeel, hoe kliëntname opgelos word en watter netwerke agter die tonnel bereikbaar moet wees. Voeg die bou-nommer by wat jy werklik hardloop, en noem die komponent wat elke bewegende deel besit, want roetes, pakketfilter en kliëntprofiele word dikwels op drie verskillende plekke opgestel. Let ook op die buitenste afhanklikhede: die host-rekening, die opverbinding, die identiteitsverskaffer en die private netwerke aan die ander kant. ’n Tabel of ’n handgetekende diagram dra dit beter as paragrawe, want die leser oorskan eerder as om te lees.

Noem dan die mense wat ’n noodverandering kan goedkeur, met ’n kontakroete wat nie daarvan afhang dat die tonnel aan die gang is nie. ’n Eskalasie-lyn sonder ’n terugval is ’n doodloopstraat in juis die voorval wat dit nodig het. Twee name en een telefoonnommer is genoeg; die kaart is nie ’n personeellys nie.

Elke kontrole het die antwoord nodig wat as gesond geld

Plaas vir elke diens die opdrag en die reël wat beteken dit het gewerk langs mekaar, sodat die leser nooit die een uit die ander hoef af te lei nie. Prosesstatus en eind-tot-eind-bereikbaarheid lê op verskillende vlakke: een wys die daemon het sy opstelling aanvaar, die ander wys ’n kliënt kan gebruik wat die tonnel bied. Skryf albei reëls neer en sê watter fout elkeen vang, want ’n kontrole sonder ’n genoemde resultaat word ’n stryd oor of die uitset goed lyk.

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

Hardloop albei, en behandel hulle as aparte bewyse eerder as ’n reeks. ’n Groen eenheid kan langs ’n tonnel staan wat niemand kan gebruik nie, en die omgekeerde gebeur wanneer ’n luisteraar ’n gebreekte roete oorleef. Noem die vlak wat elke reël waarneem, en die leser sal weet watter een om te vertrou wanneer hulle verskil.

Drie foute dek die meeste nagte

Eindpunt onbereikbaar, identiteit verwerp en verbind sonder bruikbare verkeer verklaar byna alles wat iemand wakker maak. Lys vir elkeen die eerste twee kontroles en die persoon na wie geëskaleer word, sodat niemand om 02:00 ’n diagnosesorde hoef te bedink nie. Onbereikbaar dui gewoonlik op die pad of die luisteraar, ’n verwerpte identiteit op ’n sertifikaat, ’n geloofwaardigheidsbron of ’n klok, en ’n leë verbinding op roetes, deurgewing of naamoplossing. Daardie drie takke lees verskillende logs, daarom moet die tak gekies word voordat die log oopgemaak word.

Skakel na die opstroom-dokumentasie eerder as om opdragte te plak wat jy nie op hierdie gasheer uitgevoer het nie. ’n Ongetoetste opdrag wat uit ’n ander omgewing gekopieer is, is slegter as ’n verwysing, want dit lyk gesaghebbend en faal stilweg.

Skryf die verandering as ’n reeks, nie as ’n paragraaf nie

Teken vir elke verandering die kontrolepunt waarheen jy kan terugkeer, die kontrole wat sukses bevestig en die voorwaarde wat ’n terugrol veroorsaak, in daardie volgorde aan. Sluit ’n terugweg in wat nie deur die tonnel loop nie, want juis die verandering wat jy maak, kan dit sluit. Let op hoe huidige herroepings herstel sou word eerder as ’n ouer momentopname, want ’n verouderde lys laat stilweg geloofsbriewe weer toe wat daardie oggend afgetree is. Genommerde gebiedende stappe oorleef druk; prosa word vertolking.

Oefen daardie terugweg voordat jy dit nodig het, wanneer die verandering groot genoeg is om saak te maak. ’n Terugrol wat uit die geheue geskryf is, is ’n raaiskoot met ’n datum aan.

Geloofsbriewe woon elders

Verwys na die wagwoordbestuurder, die kluis of die verseëlde koevert, en sê wie dit mag oopmaak, eerder as om enige materiaal in die lêer aan te haal. Private sleutels, eenmalige herstelkodes en profiele wat ’n geheim insluit, hoort in beskermde berging, en die bladsy moet verduidelik hoe ’n gemagtigde beheerder hulle om 02:00 bereik. Gebruik nooit ’n lewende geheim as voorbeeld nie, want voorbeelde word in kaartjies en kletsdrade geplak. ’n Verwysing plus ’n toestemmingslys is alles wat die dokument nodig het.

Hersien die lêer ná ’n werklike verandering of ’n herstel-oefening, verwyder paaie wat nie meer bestaan nie, en let op wie se taak die volgende instandhoudingsbesluit is. Hou aan die einde ’n veranderingslog met drie kolomme: datum, wat verander het, wie dit geverifieer het. Daardie bladsy vertel die volgende leser of die res aktueel is, en die systemctl-dokumentasie van systemd is ’n beter skakel as ’n parafrase van diensopdragte wat sal afdryf.