runbook-generator

Narzędzie do szybkiego tworzenia szkieletów runbooków operacyjnych dla Twoich serwisów. Zamiast pisać od zera, generujesz strukturę z sekcjami start/stop/health/rollback, a następnie uzupełniasz szczegóły specyficzne dla Twojej usługi. Idealne dla zespołów DevOps, którym brakuje ustandaryzowanej dokumentacji operacyjnej lub chcą przyspieszyć onboarding pracowników na stanowisku on-call. Runbook zawiera placeholdery dla eskalacji, procedur incydentowych i wdrożeń.

1. Zainstaluj narzędzie, klonując repozytorium i upewniając się, że masz Python 3. Przejdź do katalogu projektu i sprawdź, że skrypt scripts/runbook_generator.py jest dostępny.

2. Wygeneruj szkielet runbooka, uruchamiając skrypt z nazwą Twojej usługi, na przykład python3 scripts/runbook_generator.py payments-api. Runbook wyświetli się w terminalu — przejrzyj strukturę sekcji start, stop, health check i rollback.

3. Zapisz runbook do pliku, dodając flagę --owner i --output, aby określić właściciela zespołu i ścieżkę docelową: python3 scripts/runbook_generator.py payments-api --owner platform --output docs/runbooks/payments-api.md.

4. Otwórz wygenerowany plik i uzupełnij sekcje specyficzne dla Twojej usługi: rzeczywiste komendy do startu i stopu, URL-e zdrowia serwisu, kroki rollbacku i kontakty eskalacyjne. Upewnij się, że każda komenda jest gotowa do skopiowania i wklejenia bezpośrednio w terminal.

5. Dodaj sprawdzenia zdrowia po każdym krytycznym kroku oraz zdefiniuj triggery rollbacku. Przetestuj runbook w środowisku staging, wykonując procedury opisane w dokumencie.

6. Zatwierdź runbook w kontroli wersji obok kodu serwisu. Zaplanuj przeglądy runbooka na stałe okresy i aktualizuj go po każdym incydencie lub postmortem.