Sổ tay VPN nhỏ cần trả lời gì khi gấp

Người trực nhận ca lúc 02:00 không thể nói dịch vụ có khỏe không, vì tài liệu giải thích thiết kế và không bao giờ nói phải chạy gì. Đưa tệp cho người khác rồi rời khỏi phòng là phép thử duy nhất có ý nghĩa. Phần lớn ghi chú VPN nhỏ đều trượt phép thử đó ngay ở trang thứ hai. Hình thức dưới đây chịu được phép thử ấy, và không phần nào của nó cần phải dài.

Bắt đầu bằng một bản đồ mà người mệt mỏi có thể quét mắt qua

Ghi lại những gì ai đó phải tra cứu gấp: tên mà máy khách kết nối tới, cổng mà daemon lắng nghe, các nhóm địa chỉ nó cấp, cách phân giải tên máy khách và những mạng nào sau đường hầm phải truy cập được. Thêm số bản dựng bạn thực sự chạy, và nêu tên thành phần sở hữu từng bộ phận chuyển động, vì tuyến, bộ lọc gói và hồ sơ máy khách thường được cấu hình ở ba nơi khác nhau. Cũng ghi lại các phụ thuộc bên ngoài: tài khoản lưu trữ, đường lên, nhà cung cấp danh tính và các mạng riêng ở đầu xa. Một bảng hoặc sơ đồ vẽ tay mang điều này tốt hơn đoạn văn, vì người đọc đang quét mắt chứ không đọc.

Sau đó nêu tên những người có thể cho phép thay đổi khẩn cấp, với một đường liên hệ không phụ thuộc vào việc đường hầm có hoạt động hay không. Một tuyến leo thang không có phương án dự phòng là ngõ cụt đúng trong sự cố cần đến nó. Hai cái tên và một số điện thoại là đủ; bản đồ không phải danh bạ nhân sự.

Mỗi kiểm tra cần câu trả lời được tính là khỏe

Với mỗi dịch vụ, đặt câu lệnh và dòng có nghĩa là nó đã thành công cạnh nhau, để người đọc không bao giờ phải suy ra cái này từ cái kia khi gấp. Trạng thái tiến trình và khả năng tiếp cận từ đầu đến cuối nằm ở các tầng khác nhau: một cái cho thấy daemon đã chấp nhận cấu hình, cái kia cho thấy máy khách dùng được điều đường hầm cung cấp. Viết cả hai dòng và nói mỗi dòng bắt được lỗi nào, vì một kiểm tra không nêu kết quả sẽ biến thành cuộc tranh luận xem đầu ra có trông ổn không.

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

Chạy cả hai, và coi chúng là bằng chứng riêng chứ không phải trình tự. Một unit xanh có thể nằm cạnh một đường hầm không ai dùng được, và điều ngược lại xảy ra khi một trình lắng nghe sống sót sau tuyến bị hỏng. Nêu tầng mà mỗi dòng quan sát, và người đọc sẽ biết tin cái nào khi chúng không khớp.

Ba lỗi bao phủ phần lớn các đêm

Không tới được điểm cuối, danh tính bị từ chối và kết nối mà không có lưu lượng hữu ích giải thích gần như mọi thứ đánh thức ai đó. Với mỗi trường hợp, liệt kê hai kiểm tra đầu tiên và người cần leo thang tới, để không ai phải nghĩ ra thứ tự chẩn đoán lúc 02:00. Không tới được thường chỉ vào đường đi hoặc trình lắng nghe, danh tính bị từ chối chỉ vào chứng chỉ, kho thông tin xác thực hoặc đồng hồ, và kết nối rỗng chỉ vào tuyến, chuyển tiếp hoặc phân giải tên. Ba nhánh đó đọc nhật ký khác nhau, vì vậy phải chọn nhánh trước khi mở nhật ký.

Liên kết tới tài liệu thượng nguồn thay vì dán những câu lệnh bạn chưa chạy trên máy này. Một câu lệnh chưa kiểm tra sao chép từ môi trường khác còn tệ hơn một chỉ dẫn, vì nó trông có thẩm quyền và thất bại âm thầm.

Viết thay đổi như một trình tự, không phải đoạn văn

Với mọi thay đổi, ghi lại điểm kiểm soát có thể quay về, kiểm tra xác nhận thành công và điều kiện kích hoạt việc hoàn tác, đúng theo thứ tự đó. Bao gồm một đường về không đi qua đường hầm, vì chính thay đổi bạn đang làm có thể đóng nó lại. Ghi lại cách khôi phục các thu hồi hiện tại thay vì một ảnh chụp cũ hơn, vì danh sách cũ sẽ âm thầm nhận lại thông tin xác thực đã bị thu hồi sáng hôm đó. Các bước mệnh lệnh được đánh số chịu được áp lực; văn xuôi biến thành diễn giải.

Tập luyện đường về đó trước khi cần đến, mỗi khi thay đổi đủ lớn để có ý nghĩa. Một lần hoàn tác viết từ trí nhớ là một phỏng đoán có dán ngày.

Thông tin xác thực sống ở nơi khác

Tham chiếu trình quản lý mật khẩu, két hoặc phong bì niêm phong, và nói ai được mở nó, thay vì trích dẫn bất kỳ tài liệu nào trong tệp. Khóa riêng, mã khôi phục dùng một lần và hồ sơ nhúng bí mật thuộc về kho lưu trữ được bảo vệ, và trang phải giải thích cách một người trực được ủy quyền tiếp cận chúng lúc 02:00. Đừng bao giờ dùng bí mật thật làm ví dụ, vì ví dụ bị dán vào phiếu và luồng trò chuyện. Một chỉ dẫn cộng với danh sách quyền là tất cả những gì tài liệu cần.

Xem lại tệp sau một thay đổi thật hoặc một buổi diễn tập khôi phục, xóa những đường không còn tồn tại và ghi lại quyết định bảo trì tiếp theo là việc của ai. Giữ ở cuối một nhật ký thay đổi ba cột: ngày, điều gì đã đổi, ai đã xác minh. Chính trang đó nói cho người đọc tiếp theo biết phần còn lại có cập nhật không, và tài liệu systemctl của systemd là một liên kết tốt hơn bản diễn giải các lệnh dịch vụ rồi sẽ lệch đi.