Πράξεις και → τεκμηρίωση διαχείρισης των πράξεων ως κώδικας

Τεκμηρίωση συναλλαγής ως κωδικός

1) Η ουσία της προσέγγισης

Η τεκμηρίωση ως Κώδικας είναι μια πρακτική στην οποία οι επιχειρησιακές γνώσεις, οδηγίες και διαδικασίες αποθηκεύονται, επεξεργάζονται και επικυρώνονται με τον ίδιο τρόπο όπως ο κώδικας: μέσω Git, αιτημάτων έλξης, επανεξέτασης και επικύρωσης του CI.
Σε ένα λειτουργικό βρόχο, αυτό αποτελεί τη βάση για αξιοπιστία, διαφάνεια και συμβατότητα εντολών.

• Δημιουργήστε ένα ζωντανό, αναπαραγώγιμο και μεταφρασμένο σύστημα γνώσης, όπου κάθε οδηγία είναι ένα τεχνούργημα της υποδομής, και όχι ένα ξεπερασμένο PDF.

2) Γιατί το χρειάζεστε

Διαφάνεια: μπορείτε να δείτε ποιος, πότε και γιατί άλλαξε τη διαδικασία.
Συνέπεια: όλες οι ομάδες εργάζονται σε τρέχουσες εκδόσεις.
Ολοκλήρωση με CI/CD: αυτόματη επικύρωση οδηγιών.
Αναπαραγωγιμότητα - Συγχρονισμός υποδομής και τεκμηρίωσης.
Ασφάλεια: έλεγχος πρόσβασης και λογιστικός έλεγχος μέσω Git.
Επιτάχυνση της επιβίβασης: Οι νέοι φορείς εκμετάλλευσης βλέπουν ακριβή σενάρια που σχετίζονται με τον κώδικα.

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

Συμβουλή: κάθε φάκελος έχει το δικό του αποθετήριο Git ή υποενότητα έτσι ώστε διαφορετικές ομάδες να μπορούν να διαχειρίζονται το περιεχόμενο ανεξάρτητα.

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.
Αξιολόγηση: Ο ιδιοκτήτης τομέα και ο επικεφαλής των επιχειρήσεων πρέπει να εγκρίνουν.
Επικύρωση CI: έλεγχος δομής, υποχρεωτικά πεδία, επένδυση Markdown/YAML.
Αυτόματη έκδοση: μετά τη συγχώνευση - παραγωγή HTML/wiki/ταμπλό.
Αλλαγή καταγραφής: αυτόματη ιστορία αλλαγών με ημερομηνίες και συγγραφείς.
Υπενθυμίσεις καταχώρισης: αναθεώρηση εγγράφου κάθε N ημέρες (από την SLA).

7) Ολοκλήρωση CI/CD

Έλεγχοι lint: σύνταξη Markdown, ισχύς YAML, πεδία ιδιοκτήτη/έκδοσης.
Έλεγχος σύνδεσης: έλεγχος URL και εσωτερικών συνδέσμων.
Docs-build: μετατροπή σε HTML/Confluence/portal.
Ανάλυση Diff: τι έχει αλλάξει από την τελευταία δημοσίευση της τεκμηρίωσης.
Αυτόματος συγχρονισμός: ενημέρωση συνδέσμων σε ταμπλό Grafana, Ops UI, Slack.
Ανασκόπηση bots: συμβουλές για παρωχημένα τμήματα ή ιδιοκτήτες που λείπουν.

8) Ενσωμάτωση με επιχειρησιακά εργαλεία

Grafana/Kibana: σημειώσεις και σύνδεσμοι με το αντίστοιχο runbook απευθείας από το πάνελ.
Διαχειριστής συμβάντων: κουμπί «Open Runbook» κατά τη δημιουργία εισιτηρίου.
Δικτυακή πύλη εφημερίας: έκδοση τρεχουσών SOP και playbooks ανά κατηγορία συμβάντων.
βοηθοί AI: αναζήτηση αποθετηρίου, παραγωγή TL· Συμβουλές DR και δράσης.
Πίνακες BCP - Φορτώνει αυτόματα οδηγίες DR όταν ενεργοποιείται ένα σενάριο.

9) Διαχείριση του κύκλου ζωής των εγγράφων

10) Αυτοματοποίηση και συγχρονισμός

Docs bot: έλεγχοι των εγγράφων που είναι παρωχημένα.
Σήμα έκδοσης: '! [τελευταία επανεξέταση: 2025-05] "δεξιά στο ανώτατο όριο.
Το runbook-finder: με προειδοποίηση ανοίγει το επιθυμητό έγγραφο με ετικέτα.
Πρότυπο-γεννήτρια: δημιουργεί νέες SOP με πρότυπο ("make new-sop" Εγκατάσταση ").
Έλεγχος-συγχρονισμός: Συσχετίζει την έκδοση SOP με την έκδοση του συστήματος και δεσμεύει-ID.

11) Ασφάλεια και ιδιωτικότητα

RBAC ανά αποθετήριο: μόνο ιδιοκτήτες τομέα μπορούν να επεξεργαστούν.
Μυστικά και PII: Δεν είναι δυνατόν να φυλάσσονται σε ανοικτά έγγραφα. μόνο συνδέσεις με προστατευόμενα θησαυροφυλάκια.
Έλεγχος: καταγραφή όλων των αλλαγών, επανεξετάσεων και δημοσιεύσεων.
Επικαιροποίηση της πολιτικής: επανεξέταση των SOP κάθε 6 μήνες.
Αντίγραφα ασφαλείας: κανονικά στιγμιότυπα αποθετηρίου και κρύπτες πύλης στη ζώνη DR.

12) Μετρήσεις διάρκειας

13) Αντι-μοτίβα

Η τεκμηρίωση αποθηκεύεται στο Google Docs χωρίς εκδόσεις και ιδιοκτήτες.
Το Runbook δεν ενημερώνεται μετά τις κυκλοφορίες.
Το SOP αναφέρεται σε κληροδοτημένες εντολές/εργαλεία.
Καμία επικύρωση CI: Markdown με σφάλματα και σπασμένους συνδέσμους.
Επαναλάβετε τις ίδιες οδηγίες σε διαφορετικές τοποθεσίες.
Έλλειψη ιδιοκτητών και διαδικασία αναθεώρησης.

14) Κατάλογος ελέγχου εφαρμογής

• Ταυτοποίηση ιδιοκτητών τομέα και ιδιοκτητών εγγράφων.
• Δημιουργήστε το αποθετήριο Git 'ops-docs/' και SOP/runbook/playbook πρότυπα.
• Ρύθμιση ελέγχων CI και γραμμών (Markdown/YAML).

Ρυθμίστε το Auto-Publish στην πύλη ή το Wiki.

• Να ενσωματωθεί με Grafana/Manager περιστατικών.
• Προσθέστε ένα bot Ops για υπενθυμίσεις και αναθεωρήσεις SLA.
• Εντολές ροής αμαξοστοιχίας-as-code.

15) 30/60/90 - σχέδιο εφαρμογής

• Δημιουργία δομής αποθετηρίου, προτύπων, διεργασίας ανασκόπησης CI και PR.
• Να μεταναστεύσουν βασικές SOP και 5-10 βιβλία κρίσιμης σημασίας.
• Δημιουργία αυτόματης κατασκευής στην πύλη.

• Εφαρμογή ενοποιήσεων με διαχειριστή συμβάντων και Grafana.
• Σύνδεση Ops bot για ελέγχους και υποβολή εκθέσεων.
• Ενημέρωση του μεταθανάτιου προτύπου και σύνδεση με το περιστατικό του ταμπλό.

• Πλήρης κάλυψη του SOP/runbook (≥90%).
• Εισάγετε το KPI: Coverage, Review SLA, Usage.
• Ρετρό σχετικά με την ευκολία και την ποιότητα της διαδικασίας «docs-as-code».

16) Παράδειγμα υποδείγματος SOP (Markdown)

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) Ολοκλήρωση με άλλες διαδικασίες

Επιχειρησιακή ανάλυση: εκθέσεις ελέγχου κάλυψης και SLA.
Εκπαίδευση αερομεταφορέα: εκπαίδευση βασισμένη σε πραγματικά βιβλία δρομολογίων.
Μεταθανάτια: αυτόματη εισαγωγή συνδέσμων σε SOP και playbook.
Δεοντολογία διακυβέρνησης: διαφάνεια της αλλαγής και πατρότητα.
βοηθοί AI: αναζήτηση πλαισίου και TL· DR από το αποθετήριο.

18) ΣΥΧΝΈΣ ΕΡΩΤΉΣΕΙΣ

Ε: Γιατί Git αν υπάρχει Συρροή

A: Το Git δίνει εκδόσεις, αναθεώρηση, αυτοματοποίηση και αναπαραγωγιμότητα. Η συμβολή μπορεί να είναι η τελική βιτρίνα, αλλά όχι η πηγή της αλήθειας.

Το παρόν έγγραφο αποτελεί σύνοψη της Ευρωπαϊκής Δημόσιας Έκθεσης Αξιολόγησης (EPAR) του

A: SLA για αναθεώρηση (180 ημέρες) + Ops-remender bots + αυτόματο σήμα του τελευταίου ελέγχου.

Ε: Μπορεί ο ΚΚΠ να συνδεθεί με την τεκμηρίωση

A: Ναι. Η σύνταξη, τα απαιτούμενα πεδία και οι σπασμένες αναφορές ελέγχονται ως πρότυπος αγωγός, παρόμοιος με τις δοκιμές κώδικα.