Часто используемые страницы документации AIOps для быстрого доступа.
Для новых участников
- Что это за продукт — описание AIOps
- Как начать разработку — первые шаги
- Как найти нужный сервис — навигация по сервисам
- Кому писать — контакты команды
Сервисы
Каталоги
- Все сервисы — полная таблица с зависимостями
- Владельцы сервисов — кто отвечает за что
- Критичность сервисов — SLA и impact
Auth Platform
- Identity service — canonical identity registry
- Credential service — password storage
- Auth Service — authentication orchestrator
- Session Token service — OAuth2/OIDC
- Account service — user profiles
- Herald — notifications
- API Gateway — trust boundary
Архитектура
- System Overview — обзор системы
- Контекстная диаграмма (C4) — контекстная диаграмма
- Диаграмма контейнеров (C4) — диаграмма сервисов
- Event Flow — поток событий Kafka
- Security Architecture / Authentication — JWT auth
- Domain Boundaries — границы доменов
Домены
- Identity Domain — домен идентичности
- Identity / Owned Services — сервисы домена
- Identity / Related Features — связанные фичи
Продукт
- Product Mission — миссия продукта
- Authentication Feature — ключевая capability
- Authentication / Related Services — сервисы auth
- Functional Requirements — функциональные требования
Разработка
- Getting Started — как начать
- Local Setup — настройка окружения
- Git Workflow — работа с Git
- Code Review Guide — ревью кода
- Coding Standards — стандарты кода
- Repositories Map — где что лежит
- Developer FAQ — частые вопросы
Backend
- Backend Overview — обзор backend
- Service Patterns — паттерны сервисов
- Event-Driven Patterns — Transactional Outbox
- Database Access Patterns — Repository, UoW
- API Guidelines — стандарты API
- Backend Testing — тестирование
Данные
- Event Schema Catalog — схемы событий Kafka
- Data Contracts — контракты между сервисами
- Data Warehouse — аналитическое хранилище
- ETL/ELT Pipelines — пайплайны данных
Платформа
- Infrastructure Overview — инфраструктура
- Environments / Stage — окружение для интеграции
- Environments / Prod — production
- Kubernetes — оркестрация
- Observability / Logging — логирование
- Observability / Metrics — метрики
Операции
- Incident Management — управление инцидентами
- On-call — дежурства
- Runbooks — операционные процедуры
Governance
- Decisions (ADR) — Architecture Decision Records
- Security & Compliance — compliance
- Glossary — термины
- Service Owners — владельцы
Полезные внешние ссылки
- GitLab:
https://gitlab.com/ai-operations/ai-ops - Grafana Dashboards: (когда будет развернуто)
- Sentry: (когда будет развернуто)
Связанные страницы
- Документация главная — главная страница
- Как устроена документация — структура разделов