Mihin pienen VPN-käsikirjan on vastattava kiireessä

Kello 02:00 tehtävän vastaanottanut ylläpitäjä ei osannut sanoa, oliko palvelu terve, koska asiakirja selitti suunnittelun eikä koskaan sanonut, mitä pitää ajaa. Tiedoston antaminen toiselle ja huoneesta poistuminen on ainoa testi, jolla on merkitystä. Useimmat pienet VPN-muistiinpanot reputtavat sen jo toisella sivulla. Alla oleva muoto kestää tuon testin, eikä mikään siinä tarvitse olla pitkää.

Aloita kartasta, jonka väsynyt ihminen voi silmäillä

Kirjoita ylös, mitä jonkun on kiireessä tarkistettava: nimet, joihin asiakkaat yhdistävät, portit, joilla taustaprosessi kuuntelee, osoitepoolit, joita se jakaa, miten asiakasnimet ratkaistaan ja mitkä tunnelin takaiset verkot on tarkoitettu tavoitettaviksi. Lisää build-numero, jota todella ajat, ja nimeä komponentti, jolle kukin liikkuva osa kuuluu, koska reitit, pakettisuodatin ja asiakasprofiilit määritetään usein kolmessa eri paikassa. Kirjaa myös ulkoiset riippuvuudet: hosting-tili, ylälinkki, identiteetintarjoaja ja kauimpana olevat yksityisverkot. Taulukko tai käsin piirretty kaavio kantaa tämän paremmin kuin kappaleet, koska lukija silmäilee sen sijaan että lukisi.

Nimeä sitten henkilöt, jotka voivat hyväksyä hätämuutoksen, ja yhteystie, joka ei riipu siitä, onko tunneli pystyssä. Eskalointilinja ilman varavaihtoehtoa on umpikuja juuri siinä tapauksessa, joka sitä tarvitsee. Kaksi nimeä ja yksi puhelinnumero riittävät; kartta ei ole henkilöstöluettelo.

Jokainen tarkistus tarvitsee vastauksen, joka lasketaan terveeksi

Laita jokaisen palvelun kohdalla komento ja se rivi, joka tarkoittaa että se onnistui, vierekkäin, jotta lukijan ei koskaan tarvitse johtaa toista toisesta kiireessä. Prosessin tila ja päästä päähän -tavoitettavuus ovat eri kerroksissa: toinen näyttää, että taustaprosessi hyväksyi asetuksensa, toinen, että asiakas voi käyttää sitä, mitä tunneli tarjoaa. Kirjoita molemmat rivit ja kerro, minkä vian kumpikin nappaa, koska tarkistus ilman ilmoitettua tulosta muuttuu väittelyksi siitä, näyttääkö tuloste hyvältä.

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

Aja molemmat ja käsittele niitä erillisinä todisteina eikä järjestyksenä. Vihreä yksikkö voi seisoa tunnelin vieressä, jota kukaan ei voi käyttää, ja päinvastoin käy, kun kuuntelija selviää rikkinäisestä reitistä. Kerro, mitä kerrosta kukin rivi tarkkailee, ja lukija tietää, kumpaan luottaa, kun ne ovat eri mieltä.

Kolme vikaa kattaa useimmat yöt

Tavoittamaton päätepiste, hylätty identiteetti ja yhteys ilman hyödyllistä liikennettä selittävät lähes kaiken, mikä herättää jonkun. Luettele jokaiselle kaksi ensimmäistä tarkistusta ja henkilö, jolle eskaloidaan, jotta kenenkään ei tarvitse keksiä diagnostiikkajärjestystä kello 02:00. Tavoittamattomuus viittaa yleensä reittiin tai kuuntelijaan, hylätty identiteetti sertifikaattiin, tunnistetietovarastoon tai kelloon ja tyhjä yhteys reitteihin, edelleenlähetykseen tai nimien ratkaisuun. Nuo kolme haaraa lukevat eri lokeja, siksi haara on valittava ennen kuin loki avataan.

Linkitä ylävirran dokumentaatio sen sijaan, että liittäisit komentoja, joita et ole ajanut tällä koneella. Toisesta ympäristöstä kopioitu testaamaton komento on huonompi kuin osoitin, koska se näyttää arvovaltaiselta ja epäonnistuu hiljaa.

Kirjoita muutos järjestyksenä, ei kappaleena

Kirjaa jokaisesta muutoksesta tarkistuspiste, johon voit palata, onnistumisen vahvistava tarkistus ja ehto, joka laukaisee palautuksen, juuri tässä järjestyksessä. Sisällytä paluutie, joka ei kulje tunnelin läpi, koska juuri tekemäsi muutos voi sulkea sen. Kirjaa, miten nykyiset peruutukset palautettaisiin eikä vanhempaa tilannekuvaa, koska vanhentunut luettelo hyväksyy hiljaa uudelleen tunnistetiedot, jotka poistettiin sinä aamuna. Numeroidut imperatiiviset askeleet kestävät painetta; proosa muuttuu tulkinnaksi.

Harjoittele tuota paluutietä ennen kuin tarvitset sitä, aina kun muutos on tarpeeksi suuri ollakseen merkityksellinen. Muistista kirjoitettu palautus on arvaus, johon on liitetty päivämäärä.

Tunnistetiedot asuvat muualla

Viittaa salasanahallintaan, holviin tai sinetöityyn kirjekuoreen ja kerro, kuka saa avata sen, sen sijaan että lainaisit mitään aineistoa tiedostossa. Yksityiset avaimet, kertakäyttöiset palautuskoodit ja profiilit, joihin on upotettu salaisuus, kuuluvat suojattuun säilöön, ja sivun pitäisi selittää, miten valtuutettu ylläpitäjä pääsee niihin kello 02:00. Älä koskaan käytä elävää salaisuutta esimerkkinä, koska esimerkit liitetään tiketteihin ja keskusteluketjuihin. Osoitin ja käyttöoikeusluettelo ovat kaikki, mitä asiakirja tarvitsee.

Käy tiedosto läpi todellisen muutoksen tai palautusharjoituksen jälkeen, poista polut, joita ei enää ole, ja kirjaa, kenen työ seuraava ylläpitopäätös on. Pidä lopussa kolmisarakkeista muutoslokia: päivämäärä, mikä muuttui, kuka sen vahvisti. Juuri se sivu kertoo seuraavalle lukijalle, onko muu ajan tasalla, ja systemdin systemctl-dokumentaatio on parempi linkki kuin palvelukomentojen mukaelma, joka ajautuu.