Apa yang harus dijawab buku catatan VPN kecil dengan cepat

Pengelola yang mengambil alih pada 02:00 tidak bisa mengatakan apakah layanannya sehat, karena dokumen itu menjelaskan desain dan tidak pernah menyebut apa yang harus dijalankan. Menyerahkan berkas kepada orang lain lalu meninggalkan ruangan adalah satu-satunya uji yang penting. Sebagian besar catatan VPN kecil gagal pada uji itu di halaman kedua. Bentuk di bawah ini lolos uji tersebut, dan tidak ada bagiannya yang perlu panjang.

Mulailah dengan peta yang bisa dipindai orang lelah

Tuliskan apa yang harus dicari seseorang dengan cepat: nama yang dihubungi klien, porta tempat daemon mendengarkan, kumpulan alamat yang dibagikannya, bagaimana nama klien diselesaikan, dan jaringan mana di balik terowongan yang harus dapat dijangkau. Tambahkan nomor build yang benar-benar Anda jalankan, dan sebutkan komponen yang memiliki setiap bagian bergerak, karena rute, penyaring paket, dan profil klien sering dikonfigurasi di tiga tempat berbeda. Catat juga dependensi luar: akun hosting, tautan atas, penyedia identitas, dan jaringan privat di ujung jauh. Tabel atau diagram yang digambar tangan membawa ini lebih baik daripada paragraf, karena pembaca memindai bukan membaca.

Lalu sebutkan orang yang boleh mengesahkan perubahan darurat, dengan jalur kontak yang tidak bergantung pada terowongan menyala. Jalur eskalasi tanpa cadangan adalah jalan buntu tepat pada insiden yang membutuhkannya. Dua nama dan satu nomor telepon cukup; peta itu bukan daftar pegawai.

Setiap pemeriksaan membutuhkan jawaban yang dihitung sehat

Untuk setiap layanan, letakkan perintah dan baris yang berarti berhasil berdampingan, supaya pembaca tidak pernah harus menurunkan yang satu dari yang lain dengan cepat. Status proses dan keterjangkauan ujung-ke-ujung berada di lapisan berbeda: yang satu menunjukkan daemon menerima konfigurasinya, yang lain menunjukkan klien dapat memakai apa yang ditawarkan terowongan. Tulis kedua baris dan sebutkan kegagalan mana yang ditangkap masing-masing, karena pemeriksaan tanpa hasil yang dinyatakan berubah menjadi perdebatan apakah keluarannya terlihat baik.

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

Jalankan keduanya, dan perlakukan sebagai bukti terpisah alih-alih urutan. Unit hijau bisa berdampingan dengan terowongan yang tidak bisa dipakai siapa pun, dan sebaliknya terjadi ketika pendengar bertahan dari rute yang rusak. Nyatakan lapisan yang diamati setiap baris, dan pembaca akan tahu mana yang dipercaya ketika keduanya berselisih.

Tiga kegagalan menutupi sebagian besar malam

Titik akhir tak terjangkau, identitas ditolak, dan tersambung tanpa lalu lintas berguna menjelaskan hampir semua yang membangunkan orang. Untuk masing-masing, daftarkan dua pemeriksaan pertama dan orang yang harus dieskalasi, supaya tidak ada yang perlu mengarang urutan diagnosis pada 02:00. Tak terjangkau biasanya menunjuk ke jalur atau pendengar, identitas ditolak ke sertifikat, penyimpanan kredensial, atau jam, dan koneksi kosong ke rute, penerusan, atau penyelesaian nama. Ketiga cabang itu membaca log berbeda, karena itu cabang harus dipilih sebelum log dibuka.

Tautkan dokumentasi hulu alih-alih menempelkan perintah yang belum Anda jalankan di host ini. Perintah tak teruji yang disalin dari lingkungan lain lebih buruk daripada penunjuk, karena tampak berwibawa dan gagal tanpa suara.

Tulis perubahan sebagai urutan, bukan paragraf

Untuk setiap perubahan, catat titik periksa yang bisa Anda tuju kembali, pemeriksaan yang memastikan keberhasilan, dan syarat yang memicu pengembalian, dalam urutan itu. Sertakan jalan kembali yang tidak melewati terowongan, karena justru perubahan yang Anda lakukan bisa menutupnya. Catat bagaimana pencabutan saat ini akan dipulihkan alih-alih snapshot lama, karena daftar kedaluwarsa diam-diam menerima kembali kredensial yang sudah dipensiunkan pagi itu. Langkah imperatif bernomor bertahan di bawah tekanan; prosa berubah menjadi tafsir.

Latih jalan kembali itu sebelum Anda membutuhkannya, setiap kali perubahannya cukup besar untuk berarti. Pengembalian yang ditulis dari ingatan adalah dugaan dengan tanggal menempel.

Kredensial tinggal di tempat lain

Rujuk pengelola kata sandi, brankas, atau amplop tersegel, dan sebutkan siapa yang boleh membukanya, alih-alih mengutip bahan apa pun di berkas. Kunci privat, kode pemulihan sekali pakai, dan profil yang menyematkan rahasia termasuk penyimpanan terlindungi, dan halaman itu harus menjelaskan bagaimana pengelola berwenang mencapainya pada 02:00. Jangan pernah memakai rahasia hidup sebagai contoh, karena contoh ditempel ke tiket dan utas obrolan. Penunjuk plus daftar izin adalah semua yang dibutuhkan dokumen.

Tinjau berkas setelah perubahan nyata atau latihan pemulihan, hapus jalur yang tidak ada lagi, dan catat siapa yang bertugas atas keputusan pemeliharaan berikutnya. Simpan log perubahan tiga kolom di akhir: tanggal, apa yang berubah, siapa yang memverifikasi. Halaman itulah yang memberi tahu pembaca berikutnya apakah sisanya mutakhir, dan dokumentasi systemctl dari systemd adalah tautan yang lebih baik daripada parafrasa perintah layanan yang akan melenceng.