AI-Ops Documentation

Русский English
  • Главная
  • Карта документации
0. С чего начать
  • Что это за продукт
  • Для кого он
  • Как устроена документация
  • Быстрые ссылки
  • Как начать разработку
  • Как найти нужный сервис
  • К кому идти по вопросам
1. Продукт
Обзор продукта
  • Миссия продукта
  • Ценность для бизнеса
  • Основные сценарии
  • Границы системы
Пользователи и персоны
  • Сегменты пользователей
  • Роли пользователей
  • Основные потребности
Пользовательские сценарии
  • Регистрация / логин
  • Основной пользовательский сценарий
  • Оплата / заказ / действие
  • Поддержка и сценарий восстановления
Функции продукта
Фича: Аутентификация
  • Цель
  • Пользовательская история
  • Бизнес-правила
  • Ограничения
  • Метрики успеха
  • Связанные сервисы
  • Связанные события / данные
  • Фича: Профиль
  • Фича: Организации
  • Фича: Топология
  • Фича: Вычислительные ресурсы
  • Фича: Кластеры
  • Фича: Каталог сервисов
Требования
  • Функциональные требования
  • Нефункциональные требования
  • Требования к производительности
  • Требования к безопасности
  • Конфиденциальность и соответствие
  • Доступность
Метрики
  • Ключевая метрика (North Star)
  • Продуктовые KPI
  • Метрики воронки
  • Метрики качества
  • Метрики экспериментов
2. Домены
Домен: Identity
  • Назначение
  • Основные концепции
  • Сущности
  • Бизнес-правила
  • Сервисы домена
  • Данные домена
  • Связанные фичи
  • Домен: Профиль пользователя
  • Домен: Поиск
  • Домен: Заказы / транзакции
  • Домен: Уведомления
  • Домен: Аналитика
  • Домен: Рекомендации
3. Архитектура
Обзор системы
  • Что входит в систему
  • Что не входит
  • Высокоуровневая диаграмма
C4 Model
  • Контекстная диаграмма
  • Диаграмма контейнеров
  • Диаграмма компонентов
  • Диаграмма развёртывания
Интеграционная архитектура
  • Внешние системы
  • Интеграции API
  • Webhooks
  • Сторонние провайдеры
Потоки данных
  • Онлайн-поток данных
  • Пакетный поток данных
  • Поток событий
  • Владение данными
Архитектура безопасности
  • Аутентификация
  • Авторизация
  • Управление секретами
  • Шифрование
  • Аудит и логирование
Надежность и масштабируемость
  • SLA / SLO
  • Планирование мощностей
  • Отказоустойчивость
  • Обратное давление и повторы
  • Восстановление после сбоев
Архитектурные принципы
  • Границы доменов
  • Принципы проектирования API
  • Принципы проектирования событий
  • Принципы контрактов данных
  • Диаграмма: auth микросервисы
Control plane
  • Архитектура компонентов (control plane)
  • Доменная модель v0
  • Протокол v0 (control plane)
  • Примеры (control plane)
Сервисы (control plane)
Сервис control plane
  • API
  • Модель данных
  • События
  • Модули
  • Операции
Сервис execution plane
  • API
  • Модель данных
  • События
  • Модули
  • Операции
Сервис resource catalog
  • API
  • Модель данных
  • События
  • Модули
  • Операции
4. Инженерия
Сервисы
Каталог сервисов
  • Все сервисы списком
  • Владельцы
  • Критичность
  • Уровень / домен / статус
  • Сервис аутентификации
  • Сервис аккаунтов
  • Облачный сервис
  • Сервис учётных данных
  • Herald
  • Сервис идентификации
  • API Gateway
  • Сервис токенов
Фронтенд
  • Обзор фронтенда
  • Структура приложения
  • Routing (фронтенд)
  • State management (фронтенд)
  • Design system (фронтенд)
  • UI components (фронтенд)
  • API контракты фронтенда
  • Обработка ошибок (фронтенд)
  • Performance (фронтенд)
  • Feature flags (фронтенд)
  • Тестирование фронтенда
Бэкенд
  • Обзор бэкенда
  • Паттерны сервисов
  • Рекомендации по API
  • Событийные паттерны
  • Паттерны доступа к БД
  • Кэширование
  • Асинхронные задачи и воркеры
  • Идемпотентность
  • Обработка ошибок
  • Тестирование бэкенда
Данные
  • Обзор данных
  • Системы-источники
  • Контракты данных
  • Каталог схем событий
  • Хранилище данных
  • Витрины данных
  • ETL / ELT-пайплайны
  • Качество данных
  • Происхождение данных
  • Политики хранения
  • Политики доступа
ML / DS
  • Обзор ML/DS
  • Сценарии (ML)
  • Каталог моделей
  • Feature store
  • Training pipelines
  • Inference pipelines
  • Offline evaluation
  • Online evaluation / A-B
  • Мониторинг (ML)
  • ML runbooks
QA / Качество
  • Стратегия качества
  • Пирамида тестов
  • Тестовые окружения
  • Тестовые данные
  • Ручное тестирование
  • Автоматизированное тестирование
  • Нагрузочное тестирование
  • Тестирование безопасности
  • Критерии приёмки релиза
  • Процесс разбора багов
5. Платформа
Инфраструктура
  • Ansible
  • WireGuard
  • Kubernetes
  • Longhorn
  • Ingress
  • PostgreSQL Cluster
  • Redis
  • Kafka
  • Vault
  • MinIO
  • Authentik
  • Monitoring
  • Logging
  • Tracing
  • Nexus
  • SonarQube
  • GlitchTip
  • GitLab Runner
  • Kubernetes Dashboard
  • OLM
  • Deploy
  • Internal DNS
  • Обзор (инфраструктура)
  • Config generator
  • Пример (инфраструктура)
  • Скрипты (инфраструктура)
Окружения
  • Локальное
  • Stage
  • Pre
  • Продакшен (prod)
  • Tech
  • Облако
  • Объектное хранилище
  • CI/CD
  • Секреты и сертификаты
Наблюдаемость
  • Логирование
  • Метрики
  • Трейсинг
  • Алертинг
  • Резервное копирование и восстановление
6. Разработка
  • Быстрый старт
  • Локальная настройка
  • Карта репозиториев
  • Стандарты кода
  • Git-процесс
  • Стратегия ветвления
  • Руководство по код-ревью
  • Критерии готовности
  • Процесс релиза
  • Флаги фич
  • FAQ разработчика
  • Миграция secure auth
7. Эксплуатация
  • Дежурство
  • Управление инцидентами
  • Уровни критичности
  • Политика эскалации
  • Постмортемы
  • Ранбуки
  • Управление изменениями
  • Непрерывность бизнеса
8. Аналитика
  • План трекинга событий
  • Определения KPI
  • Каталог дашбордов
  • Словарь метрик
  • Эксперименты
  • Стандарты отчётности
9. Управление
  • Решения (ADR)
  • Политика статуса контента
  • Changelog обновлений документации
Безопасность и соответствие
  • Модель угроз
  • Безопасная разработка
  • Управление доступом
  • Конфиденциальность
  • Реагирование на инциденты
Ответственность и владельцы
  • Команды
  • Зоны ответственности команд
  • Владельцы сервисов
  • Владельцы доменов
  • Контакты
Глоссарий
  • Бизнес-термины
  • Продуктовые термины
  • Технические термины
  • Сокращения

Что входит в систему

Previous Next

Этот документ определяет границы системы AIOps — какие компоненты, функции и ответственности включены в scope проекта.

Микросервисы

Auth Platform

Identity Service

✅ Входит в scope: - Управление жизненным циклом пользователей (создание, отключение, удаление) - Управление идентификаторами (email, phone) - Верификация контактов через OTP - Хранение статусов пользователей (active, disabled, deleted) - Публикация событий о пользователях и идентификаторах - gRPC API для internal communication

Ответственность: Source of truth для пользователей и их верифицированных контактов.

Credential Service

✅ Входит в scope: - Хранение паролей (Argon2id хеширование) - Валидация сложности паролей (zxcvbn) - Верификация паролей (constant-time) - Ротация паролей - Защита от timing attacks - Rate limiting хеширования (защита от DDoS) - Публикация событий о паролях

Ответственность: Безопасное хранение и верификация учетных данных.

Auth Service

✅ Входит в scope: - Создание и управление сессиями пользователей - Выдача access и refresh токенов - Logout и отзыв токенов - Хранение активных сессий в Redis - Публикация событий о сессиях

Ответственность: Управление жизненным циклом аутентификации.

Session Token service

✅ Входит в scope: - Генерация JWT токенов - Валидация и парсинг JWT - Управление ключами подписи (rotation) - Token introspection - Claims management

Ответственность: Генерация и валидация токенов доступа.

Core Services

Account Service

✅ Входит в scope: - Управление аккаунтами организаций - Team management (роли, права) - Биллинг и подписки - Subscription lifecycle - Usage tracking

Ответственность: Управление организационными структурами.

Herald Service

✅ Входит в scope: - Отправка Email через внешние провайдеры - Отправка SMS через внешние провайдеры - Push-уведомления - Управление шаблонами сообщений - Delivery tracking и retry logic - Обработка событий из Kafka

Ответственность: Единая точка для отправки всех уведомлений.

Cloud Service

✅ Входит в scope: - Управление облачными ресурсами - Провижионинг инфраструктуры - Мониторинг состояния ресурсов - Cost tracking - Resource tagging

Ответственность: Управление облачной инфраструктурой.

API Gateway

Control Plane (Go)

✅ Входит в scope: - Конфигурация Envoy через xDS protocol - Динамическая маршрутизация - Hot-reload конфигурации - Healthchecks и readiness probes - Metrics и observability

Envoy Proxy

✅ Входит в scope: - HTTP/gRPC routing - JWT authentication (через ext_authz filter) - Rate limiting - Request/response трансформация - TLS termination - Load balancing - Circuit breaking - Retry policies

Ответственность: Единая точка входа для всех внешних запросов.

Infrastructure Components

Event Bus (Kafka)

✅ Входит в scope: - Публикация и потребление событий - Topic management - Partitioning и ordering гарантии - Retention policies - Consumer groups - Schema evolution (через TopicConfig)

Databases (PostgreSQL)

✅ Входит в scope: - Отдельная БД для каждого сервиса - Партиционирование таблиц (по дате) - Transactional Outbox таблицы - Миграции (Alembic) - Backup и restore procedures - Connection pooling (через PgBouncer)

Caching (Redis)

✅ Входит в scope: - Кеширование данных сервисов - Session storage для Auth Service - Distributed locks - Rate limiting counters - TTL management

Observability

Logging

✅ Входит в scope: - Structured logging (JSON) - Log aggregation (Loki) - PII masking - Request tracing - Error tracking

Monitoring

✅ Входит в scope: - Metrics collection (Prometheus) - Alerting rules - Dashboards (Grafana) - SLI/SLO tracking - Resource utilization

Tracing

✅ Входит в scope: - Distributed tracing (Tempo) - OpenTelemetry instrumentation - Trace sampling - Performance analysis

Архитектурные паттерны

✅ Входит в scope: - Clean Architecture (Core → Use Case → Infrastructure → API) - Repository Pattern - Unit of Work Pattern - Transactional Outbox Pattern - Domain-Driven Design - Event-Driven Architecture - API Gateway Pattern - Database per Service - Saga Pattern для распределенных транзакций

Security & Compliance

✅ Входит в scope: - JWT-based authentication - Argon2id password hashing - Constant-time verification - Rate limiting (DDoS protection) - TLS encryption в transit - Encryption at rest (PostgreSQL) - Secrets management (Vault) - Audit logging - PII protection

Development & Operations

✅ Входит в scope: - CI/CD pipelines (GitLab CI) - Automated testing (unit, integration, e2e) - Code quality gates (ruff, mypy) - Pre-commit hooks - Trunk-based development - Conventional commits - Infrastructure as Code (Kubernetes manifests) - GitOps deployment

Shared Libraries

✅ Входит в scope: - omni-box — Transactional Outbox/Inbox реализация - unit-of-work-kit — базовые UoW классы - sqlalchemy-postgres-kit — базовые модели и сессии - dishka-providers — общие DI провайдеры - kafka-publisher-kit — Kafka publisher - grpc-service-runtime — gRPC сервер runtime - grpc-interceptor-kit — стандартные interceptors - redis-client-kit — Redis клиент - service-observability — observability utilities

Связанные страницы

  • What is Out of Scope — что НЕ входит в систему
  • Высокоуровневая диаграмма — общая схема
  • Service Catalog — полный список сервисов
Обзор системы Что не входит
Меню
Главная Карта документации
0. С чего начать
С чего начать Что это за продукт Для кого он Как устроена документация Быстрые ссылки Как начать разработку Как найти нужный сервис К кому идти по вопросам
1. Продукт
Продукт
2. Домены
Домены Домен: Профиль пользователя Домен: Поиск Домен: Заказы / транзакции Домен: Уведомления Домен: Аналитика Домен: Рекомендации
3. Архитектура
Архитектура Диаграмма: auth микросервисы
4. Инженерия
Инженерия
5. Платформа
Платформа Облако Объектное хранилище CI/CD Секреты и сертификаты Резервное копирование и восстановление
6. Разработка
Разработка Быстрый старт Локальная настройка Карта репозиториев Стандарты кода Git-процесс Стратегия ветвления Руководство по код-ревью Критерии готовности Процесс релиза Флаги фич FAQ разработчика Миграция secure auth
7. Эксплуатация
Эксплуатация Дежурство Управление инцидентами Уровни критичности Политика эскалации Постмортемы Ранбуки Управление изменениями Непрерывность бизнеса
8. Аналитика
Аналитика План трекинга событий Определения KPI Каталог дашбордов Словарь метрик Эксперименты Стандарты отчётности
9. Управление
Управление Решения (ADR) Политика статуса контента Changelog обновлений документации

На странице

Микросервисы Auth Platform Core Services API Gateway Infrastructure Components Event Bus (Kafka) Databases (PostgreSQL) Caching (Redis) Observability Архитектурные паттерны Security & Compliance Development & Operations Shared Libraries Связанные страницы