Runbook
Tài liệu vận hành nội bộ cho BANA — dành cho đội ngũ phát triển, ops/SRE và hỗ trợ.
Chỉ sử dụng nội bộ
Runbook này chứa quy trình vận hành, playbook xử lý sự cố và quy trình hỗ trợ. Không chia sẻ ra ngoài đội NEXPANDO.
Các mục
| Mục | Mục đích | Đối tượng chính |
|---|---|---|
| Triển khai | Cách triển khai, rollback và quản lý môi trường | Dev, Ops |
| Vận hành | Kiểm tra hằng ngày: service, queue, DB, cache, log | Ops, On-call |
| Sự cố | Triage và playbook cho các cảnh báo/sự cố thường gặp | On-call, Ops |
| Hỗ trợ | Triage khách hàng và xử lý vấn đề thường gặp | Support |
Quy ước
- Mức độ nghiêm trọng — S0 (ngừng dịch vụ), S1 (suy giảm nghiêm trọng), S2 (nhẹ), S3 (vấn đề hình thức).
- On-call — lịch trực và quy trình escalation được tài liệu hóa theo từng mục.
- Lệnh (Commands) — mọi khối lệnh đều có thể copy-paste; placeholder dùng dạng
<angle-brackets>.
Cách đóng góp
Các trang runbook nằm trong docs/wiki/content/en/runbook/. Viết ngắn gọn, theo kiểu "công thức" (recipe), tập trung vào "phải làm gì ngay bây giờ" — liên kết tới tài liệu dành cho developer để xem chi tiết chuyên sâu.