संहिता के रूप में परिचालन और → प्रबंधन प्रलेखन

कोड के रूप में लेनदेन प्रलेखन

1) दृष्टिकोण का सार

कोड के रूप में प्रलेखन एक अभ्यास है जिसमें परिचालन ज्ञान, निर्देश और प्रक्रियाओं को कोड के समान संग्रहीत, संपादित और मान्य किया जाता है: गिट के माध्यम से, पुल-अनुरोध, समीक्षा और सीआई सत्यापन।

एक परिचालन लूप में, यह विश्वसनीयता, पारदर्शिता और कमांड संगतता का आधार बनाता है।

• एक जीवित, प्रजनन योग्य और वर्गीकृत ज्ञान प्रणाली बनाएं, जहां प्रत्येक निर्देश बुनियादी ढांचे की एक कलाकृति है, न कि एक पुरानी पीडीएफ।

2) आपको इसकी आवश्यकता क्यों है

पारदर्शिता: आप देख सकते हैं कि प्रक्रिया कब, कब और क्यों बदल गई।

स्थिरता: सभी टीमें वर्तमान संस्करणों पर काम करती हैं।

सीआई/सीडी के साथ एकीकरण: निर्देशों का स्वचालित सत्यापन।

प्रतिकृति - बुनियादी ढांचे और प्रलेखन को तुल्यकालित किया जाता है।

सुरक्षा: गिट के माध्यम से पहुंच नियंत्रण और ऑडिटिंग।

ऑनबोर्डिंग त्वरण: नए ऑपरेटर सटीक कोड से संबंधित परिदृश्य देखते हैं।

3) मुख्य सुविधाएं

4) भंडार वास्तुकला

ops-docs/
├── README.md        # описание структуры
├── standards/
│  ├── sop-deploy.md
│  ├── sop-oncall.md
│  └── sop-release.md
├── runbooks/
│  ├── payments-latency.md
│  ├── games-cache.md
│  └── kyc-verification.md
├── playbooks/
│  ├── dr-failover.yaml
│  ├── psp-switch.yaml
│  └── safe-mode.yaml
├── postmortems/
│  └── 2025-03-17-bets-lag.md
├── policies/
│  ├── alerting.yaml
│  ├── communication.yaml
│  └── security.yaml
└── templates/
├── postmortem-template.md
├── sop-template.md
└── playbook-template.yaml

टिप: प्रत्येक फ़ोल्डर का अपना गिट भंडार या सबमॉड्यूल होता है ताकि विभिन्न टीमें स्वतंत्र रूप से सामग्री का प्रबंधन कर सकें।

5) प्रारूप और मानक

yaml id: sop-deploy owner: platform-team version: 3.2 last_review: 2025-10-15 tags: [deployment, ci-cd, rollback]
sla: review-180d

Цель
Контекст
Последовательность шагов
Проверка результата
Риски и откат
Контакты и каналы

yaml name: failover-psp triggers:
- alert: PSP downtime steps:
- action: check quota PSP-X
- action: switch PSP-Y
- action: verify payments latency < 200ms rollback:
- action: revert PSP-X

6) GitOps और परिवर्तन प्रक्रियाएं

पुल अनुरोध = RFC प्रलेखन परिवर्तन।

समीक्षा करें: डोमेन मालिक और ऑप्स के प्रमुख को मंजूरी देनी चाहिए।

सीआई सत्यापन: संरचना जाँच, अनिवार्य क्षेत्र, मार्कडाउन/YAML लिंटर।

स्वचालित प्रकाशन: HTML/wiki/dashboards के विलय के बाद।

लॉग बदलें: तारीखों और लेखकों के साथ परिवर्तनों का स्वतः इतिहास.

अलर्ट अनुस्मारक: दस्तावेज़ संशोधन हर N दिन (SLA द्वारा)।

7) सीआई/सीडी एकीकरण

लिंट चेक: मार्कडाउन सिंटैक्स, YAML वैधता, मालिक/संस्करण क्षेत्र।

लिंक-जाँच: URL और आंतरिक लिंक की जाँच कर रहा है.

डॉक्स-बिल्ड: HTML/Confluence/portal में परिवर्तित।

डिफ विश्लेषण: प्रलेखन की अंतिम रिलीज के बाद से क्या बदल गया है।

ऑटो-सिंक: डैशबोर्ड ग्राफाना, ऑप्स यूआई, स्लैक में लिंक अपडेट करना।

समीक्षा बॉट: पुराने वर्गों या लापता मालिकों के लिए सुझाव।

8) परिचालन उपकरणों के साथ एकीकरण

Grafana/Kibana: पैनल से सीधे संबंधित रनबुक के लिए एनोटेशन और लिंक।

हादसा प्रबंधक: टिकट बनाते समय "रनबुक खोलें" बटन।

ऑन-कॉल पोर्टल: घटना श्रेणी द्वारा वर्तमान एसओपी और प्लेबुक जारी करना।

एआई सहायक: भंडार खोज, टीएल पीढ़ी; डीआर और एक्शन टिप्स।

BCP पैनल - स्वचालित रूप से DR अनुदेशों को लोड करता है जब स्क्रिप्ट सक्रिय होती है।

9) दस्तावेज़ लाइफसाइकिल प्रबंधन

10) स्वचालन और तुल्यकालन

डॉक्स बॉट: जांच करता है कि कौन से दस्तावेज पुराने हैं।

संस्करण बिल्ला: '! [अंतिम समीक्षा: 2025-05] 'टोपी में सही।

रनबुक-खोजक: अलर्ट द्वारा टैग द्वारा वांछित दस्तावेज़ खोलता है.

टेम्पलेट्स-जनरेटर: टेम्पलेट द्वारा नए एसओपी बनाता है ('नया-सोप "तैनाती")।

ऑडिट-सिंक: सिस्टम रिलीज और कमिट-आईडी के साथ एसओपी संस्करण को जोड़ ता है।

11) सुरक्षा और गोपनीयता

RBAC प्रति भंडार: केवल डोमेन मालिक संपादित कर सकते हैं।

रहस्य और PII: खुले दस्तावेजों में नहीं रखा जा सकता है; केवल संरक्षित वाल्टों के लिए लिंक।

ऑडिट: सभी परिवर्तनों, समीक्षाओं और प्रकाशनों का लॉग।

अद्यतन नीति: हर 6 महीने में एसओपी की समीक्षा।

बैकअप: डीआर ज़ोन में नियमित रिपॉजिटरी स्नैपशॉट और पोर्टल कैश।

12) परिपक्वता मैट्रिक्स

13) एंटी-पैटर्न

संस्करणों और मालिकों के बिना Google डॉक्स में प्रलेखन संग्रहीत किया जाता है।

रिलीज के बाद रनबुक अद्यतन नहीं किया जाता है।

एसओपी विरासत कमांड/टूल्स को संदर्भित करता है।

कोई सीआई सत्यापन नहीं: त्रुटियों और टूटे हुए लिंक के साथ मार्कडाउन।

विभिन्न स्थानों पर समान निर्देशों की नकल करें।

मालिकों की कमी और समीक्षा प्रक्रिया।

14) कार्यान्वयन चेकलिस्ट

• डोमेन मालिकों और दस्तावेज़ मालिकों की पहचान करें।
• Git भंडार 'ops-docs/' और SOP/runbook/playbook templates बनाएँ.
• सीआई जांच और लिंटर कॉन्फ़िगर करें (मार्कडाउन/YAML)।
• पोर्टल या विकी में ऑटो-प्रकाशन कॉन्फ़िगर करें।
• ग्राफाना/हादसा प्रबंधक के साथ एकीकृत करें।
• अनुस्मारक और एसएलए संशोधन के लिए एक ऑप्स बॉट जोड़ें।
• ट्रेन डॉक्स-ए-कोड वर्कफ़्लो कमांड।

15) 30/60/90 - कार्यान्वयन योजना

• भंडार संरचना, टेम्प्लेट, सीआई लिंटर और पीआर समीक्षा प्रक्रिया बनाएँ।
• कुंजी SOPs और 5-10 महत्वपूर्ण रनबुक को माइग्रेट करें।
• पोर्टल में ऑटो-बिल्ड सेट करें।

• हादसा प्रबंधक और ग्राफाना के साथ एकीकरण लागू करें।
• ऑडिट और रिपोर्टिंग के लिए ऑप्स बॉट कनेक्ट करें।
• पोस्टमॉर्टम टेम्पलेट अद्यतन करें और डैशबोर्ड घटना के लिए लिंक करें।

• SOP/runbook (≥90%) का पूर्ण कवरेज।
• केपीआई दर्ज करें: कवरेज, समीक्षा एसएलए, उपयोग।
• "डॉक्स-ए-कोड" प्रक्रिया की सुविधा और गुणवत्ता पर रेट्रो।

16) एसओपी टेम्पलेट का उदाहरण (मार्कडाउन)

SOP: Deployment через ArgoCD id: sop-deploy owner: platform-team last_review: 2025-10-15 tags: [deployment, rollback, argo]

Цель
Обеспечить безопасное и управляемое развертывание сервисов через ArgoCD.

Контекст
Используется для всех микросервисов с шаблоном Helm v2+.
Требует активного GitOps-контура и включенных health-checks.

Последовательность шагов
1. Проверить статус `argocd app list`
2. Выполнить `argocd app sync payments-api`
3. Убедиться, что `status: Healthy`
4. В случае проблем — `argocd app rollback payments-api --to-rev <rev>`

Проверка результата
SLO API доступность ≥ 99.95%, алертов нет.

Риски и откат
- Ошибка синхронизации — rollback.
- При повторных ошибках — эскалация Head of Ops.

Контакты
@platform-team / #ops-deploy

17) अन्य प्रक्रियाओं के साथ एकीकरण

ऑपरेशनल एनालिटिक्स: कवरेज और एसएलए ऑडिट रिपोर्ट।

ऑपरेटर प्रशिक्षण: असली रनबुक के आधार पर प्रशिक्षण।

पोस्टमॉर्टम: एसओपी और प्लेबुक के लिंक का स्वचालित सम्मिलन।

शासन की नैतिकता: परिवर्तन और लेखक की पारदर्शिता।

एआई सहायक: संदर्भ खोज और टीएल; भंडार से डीआर।

18) एफएक्यू

प्रश्न: अगर संगम है तो गिट क्यों?

A: Git संस्करण, समीक्षा, स्वचालन और प्रजनन क्षमता देता है। संगम अंतिम शोकेस हो सकता है, लेकिन सच्चाई का स्रोत नहीं।

प्रश्न: पुराने निर्देशों से कैसे बचें?

A: संशोधन के लिए SLA (180 दिन) + Ops-remender बॉट्स + अंतिम चेक का स्वचालित बैज।

प्रश्नः क्या सीआई प्रलेखन से जुड़ा हो सकता है?

A: हाँ। सिंटैक्स, आवश्यक क्षेत्रों और टूटे हुए संदर्भों को कोड परीक्षणों के समान मानक पाइपलाइन के रूप में जांचा जाता है।