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

Требования сгруппированы по доменам. Все сценарии предполагают аутентифицированного пользователя, где применимо; авторизация выполняется по токену, проверяемому на API Gateway (x-user-id).

Аутентификация

  • Система должна отказывать в регистрации, если пользователь уже авторизован.
  • Система должна отказывать в регистрации, если имя пользователя (логин) уже занято, и возвращать ошибку.
  • Система должна отказывать в регистрации, если пароль и подтверждение не совпадают.
  • При корректной регистрации: создавать пользователя в сервисе идентификации и хранить пароль только в сервисе учётных данных в виде хэша (Argon2id).
  • Система должна поддерживать вход по учётным данным: идентификатор (логин / email / телефон) и пароль.
  • Система должна отказывать в аутентификации, если идентификатора нет в базе, не раскрывая факт отсутствия пользователя.
  • Система должна отказывать в аутентификации при неверном пароле ответом, не раскрывающим, верен ли идентификатор или пароль.
  • При успешной аутентификации: создавать сессию и выдавать одноразовое подтверждение (assertion) для сервиса токенов.

Токены

  • После успешного входа система должна выдавать токен доступа в формате JWT, подписанный асимметричным ключом (RS256), и токен обновления в непрозрачном формате.
  • Для запросов, требующих токен доступа, система должна проверять JWT по JWKS, проверять срок действия и выставлять заголовок x-user-id (sub) для внутренних сервисов.
  • Система должна возвращать ошибку авторизации при невалидном или истёкшем токене доступа.
  • При предъявлении валидного токена обновления система должна выполнять ротацию (выдавать новую пару токенов) и хранить токены обновления только в виде хэша.

Профиль

  • Система должна возвращать профиль пользователя по аутентифицированному запросу (авторизация по x-user-id).
  • Система должна позволять обновлять профиль и хранить персональные данные только в сервисе профиля (account).

Организации

  • Система должна возвращать список организаций, связанных с пользователем; каждая — с названием, описанием, слагом, числом членов и датой создания.
  • Система должна позволять создавать организацию с названием, описанием и уникальным слагом и привязывать пользователя к ней.
  • Система должна возвращать одну организацию по идентификатору (название, id и т.д.).
  • Система должна возвращать список членов организации: имя, фамилия, юзернейм, дата присоединения.

Регионы

  • Система должна возвращать список регионов организации; каждый — с названием, описанием, слагом и датой создания.
  • Система должна фильтровать регионы по поисковому запросу и возвращать подходящие результаты.
  • Система должна позволять создавать регион с названием, описанием, слагом, привязанный к организации.
  • Система должна возвращать один регион с списком датацентров.

Датацентры

  • Система должна возвращать список датацентров организации; каждый — с названием, описанием, слагом, страной, городом, регионом и датой создания.
  • Система должна фильтровать датацентры по поисковому запросу и возвращать подходящие результаты.
  • Система должна позволять создавать датацентр с названием, описанием, слагом, страной, городом, регионом, привязанный к региону и организации.
  • Система должна возвращать один датацентр с списком вычислительных ресурсов.

Окружения

  • Система должна возвращать список окружений организации; каждое — с названием, описанием, слагом и датой создания.
  • Система должна фильтровать окружения по поисковому запросу и возвращать подходящие результаты.
  • Система должна позволять создавать окружение с названием, описанием, слагом, привязанное к организации.
  • Система должна возвращать одно окружение со списком окружений, имеющих доступ к нему.

Вычислительные ресурсы

  • Система должна возвращать список вычислительных ресурсов организации; каждый — с названием, описанием, типом (BARE_METAL, VIRTUAL_MACHINE, GPU), датацентром, IP, диском, CPU, памятью и датой создания.
  • Система должна фильтровать вычислительные ресурсы по поисковому запросу и возвращать подходящие результаты.
  • Система должна позволять создавать вычислительный ресурс с указанными атрибутами, привязанный к датацентру и организации.
  • Система должна возвращать один вычислительный ресурс по идентификатору.

Кластеры

  • Система должна возвращать список кластеров организации; каждый — с названием, описанием, слагом, правилами размещения, механизмом оркестрации и датой создания.
  • Система должна фильтровать кластеры по поисковому запросу и возвращать подходящие результаты.
  • Система должна позволять создавать кластер с названием, описанием, слагом, правилами размещения, оркестрацией, привязанный к организации.
  • Система должна возвращать один кластер по идентификатору.

Каталог сервисов

  • Система должна возвращать список сервисов организации; каждый — с названием, описанием, слагом, принадлежностью (внутренний/внешний), типом (платформенный/производственный) и датой создания.
  • Система должна фильтровать сервисы по поисковому запросу и возвращать подходящие результаты.
  • Система должна позволять создавать сервис с указанными атрибутами, привязанный к организации.
  • Система должна возвращать один сервис по идентификатору.

Где реализовано (маппинг на фичи и сервисы)

Домен требований Фича Сервисы
Аутентификация, Токены Аутентификация Auth Service, Identity, Credential, Token, API Gateway
Профиль Профиль Account service
Организации Организации Cloud service
Регионы, Датацентры, Окружения Топология Cloud service
Вычислительные ресурсы Compute Resources Cloud service
Кластеры Кластеры Cloud service
Каталог сервисов Каталог сервисов Cloud service

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

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

На странице

Аутентификация Токены Профиль Организации Регионы Датацентры Окружения Вычислительные ресурсы Кластеры Каталог сервисов Где реализовано (маппинг на фичи и сервисы) Связанные страницы