Що має швидко відповісти невеликий регламент VPN

Черговий, який прийняв зміну о 02:00, не зміг сказати, чи сервіс здоровий, бо документ пояснював устрій і жодного разу не казав, що запускати. Передати файл комусь іншому й вийти з кімнати — єдина перевірка, що має значення. Більшість невеликих нотаток про VPN провалюють її вже на другій сторінці. Форма нижче цю перевірку витримує, і ніщо в ній не має бути довгим.

Почніть з карти, яку втомлена людина може переглянути

Запишіть, що треба швидко знайти: імена, до яких підключаються клієнти, порти, на яких слухає демон, пули адрес, які він роздає, як розв'язуються імена клієнтів і які мережі за тунелем мають бути доступними. Додайте номер збірки, яку ви справді запускаєте, і назвіть компонент, якому належить кожна рухома частина, бо маршрути, пакетний фільтр і профілі клієнтів часто налаштовують у трьох різних місцях. Позначте й зовнішні залежності: хостинговий обліковий запис, висхідний канал, постачальника ідентичності та приватні мережі на далекому кінці. Таблиця або намальована від руки схема передають це краще за абзаци, бо читач переглядає, а не читає.

Потім назвіть людей, які можуть дозволити аварійну зміну, з каналом зв'язку, що не залежить від того, чи працює тунель. Лінія ескалації без запасного варіанта — глухий кут саме в тій події, якій вона потрібна. Двох імен і одного телефону достатньо; карта — не штатний список.

Кожна перевірка потребує відповіді, яка вважається здоровою

Для кожного сервісу поставте команду і рядок, що означає, що вона спрацювала, поруч, щоб читачеві ніколи не доводилося виводити одне з одного поспіхом. Стан процесу й наскрізна доступність лежать на різних рівнях: одне показує, що демон прийняв конфігурацію, інше — що клієнт може використати те, що пропонує тунель. Напишіть обидва рядки й скажіть, який збій ловить кожен із них, бо перевірка без зазначеного результату перетворюється на суперечку про те, чи вивід виглядає добре.

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

Виконайте обидві й ставтеся до них як до окремих доказів, а не як до послідовності. Зелений юніт може стояти поруч із тунелем, яким ніхто не може користуватися, і зворотне трапляється, коли слухач переживає зламаний маршрут. Зазначте рівень, який спостерігає кожен рядок, і читач знатиме, якому вірити, коли вони розходяться.

Три відмови покривають більшість ночей

Недоступна кінцева точка, відхилена ідентичність і з'єднання без корисного трафіку пояснюють майже все, що когось будить. Для кожного перелічіть перші дві перевірки й людину, до якої ескалювати, щоб нікому не доводилося о 02:00 вигадувати порядок діагностики. Недоступність зазвичай указує на шлях або слухача, відхилена ідентичність — на сертифікат, сховище облікових даних або годинник, а порожнє з'єднання — на маршрути, переспрямування чи розв'язання імен. Ці три гілки читають різні журнали, тому гілку треба вибрати до того, як відкрити журнал.

Ставте посилання на документацію вище замість того, щоб вставляти команди, які ви не запускали на цьому хості. Неперевірена команда, скопійована з іншого середовища, гірша за вказівку, бо вона виглядає авторитетно й тихо здається.

Записуйте зміну як послідовність, а не як абзац

Для будь-якої зміни запишіть контрольну точку, до якої можна повернутися, перевірку, що підтверджує успіх, і умову, що запускає відкат, саме в цьому порядку. Включіть шлях назад, який не йде через тунель, бо саме внесена зміна може його закрити. Зазначте, як буде відновлено поточні відкликання, а не старіший знімок, бо застарілий список мовчки знову приймає облікові дані, виведені того ранку. Нумеровані наказові кроки витримують тиск; проза перетворюється на тлумачення.

Тренуйте цей шлях назад до того, як він знадобиться, щоразу, коли зміна достатньо велика, щоб мати значення. Відкат, написаний з пам'яті, — це здогад із прикріпленою датою.

Облікові дані живуть в іншому місці

Посилайтеся на менеджер паролів, сховище або запечатаний конверт і кажіть, хто може його відкрити, замість того щоб цитувати матеріал у файлі. Приватні ключі, одноразові коди відновлення й профілі, що вбудовують секрет, належать захищеному сховищу, і сторінка має пояснювати, як уповноважений черговий дістається до них о 02:00. Ніколи не використовуйте живий секрет як приклад, бо приклади вставляють у тікети й чати. Вказівка та список дозволів — усе, що потрібно документу.

Перегляньте файл після реальної зміни або навчального відновлення, видаліть шляхи, яких більше немає, і зазначте, чиє завдання — наступне рішення про обслуговування. Наприкінці ведіть журнал змін із трьома стовпцями: дата, що змінилося, хто перевірив. Саме ця сторінка каже наступному читачеві, чи решта актуальна, а документація systemctl від systemd — краще посилання, ніж переказ службових команд, які з часом розійдуться.