1️⃣ [템플릿] SOP (Standard Operating Procedure)
h1. 📘 SOP: ${Title}
----
|| Field || Value ||
| Document Owner | |
| Backup Owner | |
| Version | v1.0 |
| Status | Draft / Review / Approved |
| Created Date | |
| Last Updated | |
| Next Review Date | |
| Risk Level | Low / Medium / High |
| Tags | sop |
----
h2. 1. Purpose
(이 문서의 목적을 명확히 기술)
----
h2. 2. Scope
(적용 범위 – Cluster, System, Environment 명시)
----
h2. 3. Related Systems
* Kubernetes Cluster
* Cilium (ClusterMesh / BGP / ECMP)
* AIStor (MinIO)
* Keycloak / AD
* Jenkins / ArgoCD
----
h2. 4. Roles & Responsibilities
|| Role || Name || Responsibility ||
| Primary | | |
| Secondary | | |
| Approver | | |
----
h2. 5. Pre-Check Checklist
* [ ] Cluster Health OK
* [ ] Monitoring 정상
* [ ] Alert Silence 예약
* [ ] Backup 완료 확인
* [ ] Rollback Plan 준비
----
h2. 6. Procedure
h3. Step 1:
{code}
명령어 또는 작업 내용
{code}
h3. Step 2:
(설명)
----
h2. 7. Validation Criteria
|| Metric || Expected Result ||
| Error Rate | 0% |
| Latency | SLA 이하 |
| Node Status | Ready |
----
h2. 8. Rollback Plan
(롤백 절차 상세 작성)
----
h2. 9. Risks & Notes
(주의사항 기재)
----
h2. 10. Change History
|| Version || Date || Author || Description ||
| v1.0 | | | Initial Draft |
2️⃣ [템플릿] Runbook (장애 대응)
h1. 🚨 Runbook: ${Incident Title}
----
|| Field || Value ||
| Severity | P1 / P2 / P3 / P4 |
| Detection | Alertmanager / User Report |
| Owner | |
| Tags | runbook, incident |
----
h2. 1. Symptoms
(발생 증상 상세 기술)
----
h2. 2. Immediate Actions (5분 이내)
* [ ] Alert Acknowledge
* [ ] Slack 공지 (Investigating)
* [ ] Primary 담당자 확인
----
h2. 3. Diagnosis Steps
h3. Check Logs
{code}
kubectl logs xxx
{code}
h3. Check Metrics
(확인해야 할 PromQL 명시)
----
h2. 4. Temporary Mitigation
(임시 대응 방법)
----
h2. 5. Permanent Fix
(근본 해결 방법)
----
h2. 6. Escalation
|| Level || Condition || Contact ||
| L1 | | |
| L2 | | |
| L3 | | |
----
h2. 7. Related SOP
* [SOP 링크 삽입]
----
h2. 8. FAQ / Known Pattern
(자주 반복되는 원인 정리)
3️⃣ [템플릿] Incident Report (사후 분석)
h1. 📌 Incident Report: ${Title}
----
|| Field || Value ||
| Severity | P1 / P2 |
| Start Time | |
| End Time | |
| Impact | |
| Owner | |
| Status | Closed |
----
h2. 1. Summary
(한 줄 요약)
----
h2. 2. Timeline
|| Time || Event ||
| | |
| | |
----
h2. 3. Root Cause
(기술적 원인 상세 작성)
----
h2. 4. Resolution
(어떻게 해결했는지)
----
h2. 5. Preventive Actions
* [ ] Monitoring 추가
* [ ] Alert Threshold 조정
* [ ] SOP 수정
----
h2. 6. Lessons Learned
(재발 방지 교훈)
----
h2. 7. Related Documents
* Runbook 링크
* 관련 Jira Ticket
4️⃣ [템플릿] Monitoring & Alert Document
h1. 📊 Monitoring Guide: ${System Name}
----
|| Field || Value ||
| Owner | |
| System | |
| Criticality | High / Medium / Low |
| Tags | monitoring |
----
h2. 1. Critical Metrics
|| Metric || Meaning || Threshold ||
| | | |
----
h2. 2. Alert Rules
{code}
PromQL Rule 작성
{code}
----
h2. 3. Alert Response
(해당 알람 발생 시 Runbook 링크)
----
h2. 4. Dashboard Link
(Grafana 링크 삽입)
----
h2. 5. Known Issues
(메트릭 오탐 등 기록)
5️⃣ [템플릿] Project Execution Document
h1. 🏗 Project: ${Project Name}
----
|| Field || Value ||
| Project Owner | |
| Tech Lead | |
| Start Date | |
| Target Completion | |
| Status | Planning / Design / Implement / Test / Done |
| Tags | project |
----
h2. 1. Objective
(목표 명확히 정의)
----
h2. 2. Feasibility Review
* Capacity Check
* Network Impact
* Storage Requirement
* Risk Assessment
----
h2. 3. Architecture Design
(다이어그램 첨부)
----
h2. 4. Implementation Plan
|| Phase || Description || Owner ||
| | | |
----
h2. 5. Test Plan
* Performance Test
* Failover Test
* Recovery Simulation
----
h2. 6. Go-Live Checklist
* [ ] Peer Review 완료
* [ ] Monitoring 구성
* [ ] Rollback Plan 확보
----
h2. 7. Post-Implementation Review
(결과 및 개선사항)
추가: Change Management 템플릿
h1. 🔄 Change Request
----
|| Field || Value ||
| Change Type | Standard / Normal / Emergency |
| Risk Level | Low / Medium / High |
| Affected System | |
| Planned Date | |
| Owner | |
----
h2. Change Description
----
h2. Impact Analysis
----
h2. Rollback Plan
----
h2. Approval
|| Role || Name || Date ||
| Reviewer | | |
| Approver | | |