Hvad en lille VPN-driftshåndbog skal kunne svare på i en fart

Den driftsansvarlige, der overtog klokken 02:00, kunne ikke sige, om tjenesten var sund, fordi dokumentet forklarede designet og aldrig sagde, hvad der skulle køres. At give filen videre til en anden og derefter forlade lokalet er den eneste test, der betyder noget. De fleste små VPN-noter fejler den allerede på anden side. Formen nedenfor består testen, og intet af det behøver at være langt.

Start med et kort, som et træt menneske kan skimte

Skriv ned, hvad nogen skal slå op i en fart: navnene klienter forbinder til, portene dæmonen lytter på, adressepuljerne den uddeler, hvordan klientnavne opløses, og hvilke netværk bag tunnelen der skal kunne nås. Tilføj det buildnummer, du faktisk kører, og navngiv den komponent, der ejer hver bevægelig del, fordi ruter, pakkefilter og klientprofiler ofte konfigureres tre forskellige steder. Noter også de ydre afhængigheder: hostingkontoen, uplinket, identitetsudbyderen og de private netværk i den fjerne ende. En tabel eller et håndtegnet diagram bærer dette bedre end afsnit, fordi læseren skimmer frem for at læse.

Navngiv derefter de personer, der kan godkende en akut ændring, med en kontaktvej, der ikke afhænger af, at tunnelen er oppe. En eskaleringslinje uden reserve er en blindgyde i netop den hændelse, der har brug for den. To navne og ét telefonnummer er nok; kortet er ikke en personaleliste.

Hver kontrol har brug for det svar, der tæller som sundt

Sæt for hver tjeneste kommandoen og den linje, der betyder, at den lykkedes, ved siden af hinanden, så læseren aldrig skal udlede den ene af den anden i en fart. Processtatus og nåbarhed ende-til-ende ligger på forskellige lag: det ene viser, at dæmonen har accepteret sin konfiguration, det andet at en klient kan bruge det, tunnelen tilbyder. Skriv begge linjer, og sig hvilken fejl hver af dem fanger, fordi en kontrol uden oplyst resultat bliver en diskussion om, hvorvidt outputtet ser fint ud.

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

Kør begge, og behandl dem som separate beviser i stedet for en sekvens. En grøn unit kan stå ved siden af en tunnel, ingen kan bruge, og det modsatte sker, når en lytter overlever en brudt rute. Angiv det lag, hver linje observerer, og læseren ved, hvilken der skal troes, når de er uenige.

Tre fejl dækker de fleste nætter

Endepunkt utilgængeligt, identitet afvist og forbundet uden nyttig trafik forklarer næsten alt, hvad der vækker nogen. For hver af dem, list de to første kontroller og personen, der skal eskaleres til, så ingen skal opfinde en diagnostikrækkefølge klokken 02:00. Utilgængelighed peger som regel på stien eller lytteren, en afvist identitet på et certifikat, et credential-lager eller et ur, og en tom forbindelse på ruter, videresendelse eller navneopløsning. De tre grene læser forskellige logs, og derfor skal grenen vælges, før loggen åbnes.

Link til dokumentationen ovenfor i stedet for at indsætte kommandoer, du ikke har kørt på denne host. En utestet kommando kopieret fra et andet miljø er værre end en henvisning, fordi den ser autoritativ ud og fejler lydløst.

Skriv ændringen som en sekvens, ikke som et afsnit

For enhver ændring skal du notere det kontrolpunkt, du kan vende tilbage til, den kontrol, der bekræfter succes, og den betingelse, der udløser tilbagerulning, i den rækkefølge. Medtag en vej tilbage, der ikke går gennem tunnelen, fordi netop den ændring, du laver, kan lukke den. Noter, hvordan aktuelle tilbagekaldelser ville blive gendannet i stedet for et ældre snapshot, fordi en forældet liste lydløst optager legitimationsoplysninger igen, som blev pensioneret samme morgen. Nummererede bydende trin overlever pres; prosa bliver til fortolkning.

Øv den vej tilbage, før du får brug for den, hver gang ændringen er stor nok til at betyde noget. En tilbagerulning skrevet fra hukommelsen er et gæt med en dato på.

Legitimationsoplysninger bor et andet sted

Henvis til password-manageren, hvælvingen eller den forseglede konvolut, og sig, hvem der må åbne den, i stedet for at citere materiale i filen. Private nøgler, engangskoder til gendannelse og profiler, der indlejrer en hemmelighed, hører i beskyttet lager, og siden bør forklare, hvordan en autoriseret driftsansvarlig når dem klokken 02:00. Brug aldrig en levende hemmelighed som eksempel, fordi eksempler bliver indsat i tickets og chattråde. En henvisning plus en tilladelsesliste er alt, dokumentet har brug for.

Gennemgå filen efter en rigtig ændring eller en gendannelsesøvelse, slet stier, der ikke findes længere, og noter, hvis opgave den næste vedligeholdelsesbeslutning er. Hold en ændringslog med tre kolonner til sidst: dato, hvad der blev ændret, hvem der verificerede det. Det er den side, der fortæller den næste læser, om resten er aktuel, og systemctl-dokumentationen fra systemd er et bedre link end en parafrase af tjenestekommandoer, der vil drive.