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 обновлений документации
Безопасность и соответствие
  • Модель угроз
  • Безопасная разработка
  • Управление доступом
  • Конфиденциальность
  • Реагирование на инциденты
Ответственность и владельцы
  • Команды
  • Зоны ответственности команд
  • Владельцы сервисов
  • Владельцы доменов
  • Контакты
Глоссарий
  • Бизнес-термины
  • Продуктовые термины
  • Технические термины
  • Сокращения

Главная

Next

Добро пожаловать в документацию платформы AIOps — системы управления IT-инфраструктурой.

AIOps — это control plane над облачными провайдерами и оркестраторами. Платформа хранит метаданные и контекст, задает доверенную модель доступа, описывает топологию и сервисы и предоставляет единые API для автоматизации и AI-агентов.

Статус контента

  • Статус: Stable
  • Проверено: 2026-03-12
  • Источник версий runtimes: services/*/pyproject.toml, services/*/go.mod

Быстрый старт

Для новых участников проекта

  1. С чего начать — что такое AIOps
  2. Для кого этот продукт — целевая аудитория
  3. Как организована документация — навигация
  4. Как начать разработку — первые шаги

Для разработчиков

  • Разработка / Быстрый старт — настройка окружения
  • Разработка / Локальная настройка — локальная разработка
  • Инженерия / Сервисы — каталог сервисов

Для архитекторов

  • Архитектура / Обзор системы — обзор системы
  • Высокоуровневая диаграмма — схема сервисов и потоков
  • Архитектура / Control Plane — концепция управления инфраструктурой через capabilities, DAG и operations
  • Архитектура / Модель C4 — архитектурные диаграммы
  • Домены — доменная модель

По задаче (куда смотреть)

Задача Документы
Понять аутентификацию Фича: Аутентификация → Identity → Сервисы Auth Platform
Найти реализацию требования Функциональные требования (в конце — маппинг на фичи и сервисы)
Развернуть локально Локальная настройка → Карта репозиториев
Разобраться в потоках данных Поток данных в реальном времени, Поток событий
Понять будущий control plane Архитектура / Control Plane
Посмотреть список сервисов платформы Каталог сервисов (Инженерия)

Основные разделы

Раздел Описание Кому интересно
С чего начать Вводная информация о продукте и документации Всем новым участникам
Продукт Продуктовое видение, фичи, требования, метрики PM, PO, стейкхолдеры
Домены Доменная модель системы (DDD) Архитекторы, разработчики бэкенда
Архитектура Системная архитектура, паттерны, принципы Архитекторы, техлиды
Инженерия Сервисы, бэкенд, фронтенд, данные, ML/DS, QA Инженеры всех направлений
Платформа Инфраструктура, окружения, CI/CD, observability Инженеры платформы, DevOps/SRE
Разработка Рабочий процесс Git, ревью кода, стандарты, релиз Все разработчики
Эксплуатация Дежурство, управление инцидентами, runbooks SRE, дежурные инженеры
Аналитика Метрики, дашборды, эксперименты Аналитики данных, продуктовая аналитика
Управление ADR, безопасность и соответствие, владение, глоссарий Техлиды, Compliance, Security

Текущее ядро платформы

AIOps строится вокруг auth-platform и cloud-сервисов:

Auth Platform

  • API Gateway — граница доверия
  • Auth Service — оркестратор аутентификации
  • Session Token service — платформа OAuth2 / OIDC
  • Identity service — канонический реестр идентичностей
  • Credential service — хранилище учётных данных
  • Account service — учётные записи пользователей
  • Herald — уведомления

Infrastructure Services

  • Cloud service — облачные и инфраструктурные сущности

Ключевые концепции

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

  • Микросервисы — каждый сервис владеет своими данными
  • Событийная архитектура — асинхронная коммуникация через Kafka
  • Clean Architecture — разделение на слои (Core, Use Case, Infrastructure, API)
  • Transactional Outbox — надёжная доставка событий

Технологический стек

  • Бэкенд: Python 3.12+, Go (см. services/*/go.mod)
  • API: gRPC (внутренние), REST (публичные)
  • Хранилища данных: PostgreSQL, Redis, Kafka
  • Инфраструктура: Kubernetes, Helm, GitOps
  • Наблюдаемость: Prometheus, Loki, Tempo, Grafana

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

Быстрые ссылки

  • Карта репозиториев — где что лежит
  • Каталог сервисов — полный список сервисов
  • Кому писать — контакты команды
  • FAQ для разработчиков — частые вопросы

Ключевые документы

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

На странице

Статус контента Быстрый старт Для новых участников проекта Для разработчиков Для архитекторов По задаче (куда смотреть) Основные разделы Текущее ядро платформы Auth Platform Infrastructure Services Ключевые концепции Архитектурные паттерны Технологический стек Связанные страницы Быстрые ссылки Ключевые документы