Руководство по развертыванию¶

Добро пожаловать в руководство по развертыванию Р13.Орбита! Этот раздел содержит всю необходимую информацию для установки, настройки и эксплуатации системы.

Для кого это руководство¶

Это руководство предназначено для администраторов и DevOps-инженеров, которые:

• Устанавливают Р13.Орбита в организации
• Настраивают интеграцию с корпоративными системами
• Обеспечивают работоспособность системы
• Решают технические проблемы

Процесс развертывания¶

Развертывание Р13.Орбита состоит из пяти основных этапов:

graph LR
    A[1. Требования] --> B[2. Установка]
    B --> C[3. Конфигурация]
    C --> D[4. Инфраструктура]
    D --> E[5. Тестирование]

    style A fill:#ff9800
    style B fill:#4caf50
    style C fill:#2196f3
    style D fill:#9c27b0
    style E fill:#f44336

Шаг 1: Требования¶

Перед установкой убедитесь, что ваша система соответствует требованиям.

Что проверить:

• Версия Python (3.11+)
• Доступность ClickHouse
• Наличие LLM API (OpenAI, GigaChat, Ollama)
• Системные ресурсы (CPU, RAM, диск)

Время: 10-15 минут Перейти к требованиям →

Шаг 2: Установка¶

Установка базовых компонентов системы.

Что будет установлено:

• Python пакеты Р13.Орбита
• База данных метаданных (PostgreSQL/SQLite)
• Миграции схемы данных
• CLI и API сервер

Время: 20-30 минут Начать установку →

Шаг 3: Конфигурация¶

Настройка всех компонентов системы под вашу инфраструктуру.

Что настроить:

• Подключение к LLM провайдеру
• Подключение к ClickHouse
• База данных метаданных
• Аутентификация (Keycloak)
• Домены данных
• Безопасность (CORS, headers)

Время: 30-60 минут Настроить систему →

Шаг 4: Инфраструктура¶

Разворачивание полной инфраструктуры с мониторингом.

Что развернуть:

• Docker Compose для всех сервисов
• PostgreSQL, ClickHouse, Redis
• Keycloak (SSO)
• Jaeger, Prometheus, Grafana (мониторинг)
• Loki, Promtail (логирование)

Время: 20-30 минут Развернуть инфраструктуру →

Шаг 5: Решение проблем¶

Диагностика и решение типичных проблем.

Что найдете:

• Проблемы с окружением
• Проблемы с подключением к БД
• Проблемы с аутентификацией
• Проблемы с LLM провайдерами
• Как читать логи

Решить проблему →

Архитектура развертывания¶

Минимальная конфигурация¶

Для тестирования и разработки:

graph TB
    A["Р13.Орбита CLI/API"]
    B[("SQLite<br/>метаданные")]
    C[("ClickHouse<br/>данные")]
    D["LLM API<br/>(OpenAI, GigaChat)"]

    A --> B
    A --> C
    A --> D

    style A fill:#4051b5,color:#fff
    style B fill:#90caf9
    style C fill:#ff9800,color:#fff
    style D fill:#4caf50,color:#fff

Требования:

• Python 3.11+
• ClickHouse (локальный или удаленный)
• Доступ к LLM API
• SQLite (встроенная)

Продуктивная конфигурация¶

Для работы в организации:

graph TB
    subgraph "Клиенты"
        WEB[Web UI]
        CLI[CLI]
        SDK[SDK]
    end

    subgraph "Сервисы Р13.Орбита"
        API["API Server<br/>FastAPI"]
        CORE["Core Engine<br/>LangGraph"]
    end

    subgraph "Хранилища"
        PG[("PostgreSQL<br/>метаданные")]
        CH[("ClickHouse<br/>данные")]
        REDIS[("Redis<br/>кэш")]
    end

    subgraph "Инфраструктура"
        KC["Keycloak<br/>SSO"]
        JG["Jaeger<br/>трейсинг"]
        PR["Prometheus<br/>метрики"]
        GR["Grafana<br/>дашборды"]
    end

    WEB --> API
    CLI --> API
    SDK --> API
    API --> CORE
    CORE --> PG
    CORE --> CH
    CORE --> REDIS
    API --> KC
    CORE --> JG
    API --> PR
    PR --> GR

    style API fill:#4051b5,color:#fff
    style CORE fill:#4051b5,color:#fff
    style PG fill:#4caf50,color:#fff
    style CH fill:#ff9800,color:#fff
    style KC fill:#9c27b0,color:#fff

Требования:

• Кластер Kubernetes или Docker Swarm
• PostgreSQL кластер (HA)
• ClickHouse кластер
• Redis cluster
• Keycloak для SSO
• Мониторинг стек (Prometheus, Grafana, Jaeger)
• Balancer (Nginx/Traefik)

Режимы развертывания¶

Локальная разработка¶

Для разработчиков и тестирования.

# Запуск с SQLite и локальным LLM
python -m orbita_cli chat

Плюсы: Быстрый старт, не требует инфраструктуры Минусы: Ограниченные возможности, нет мониторинга

Docker Compose¶

Для команд и малого бизнеса.

cd docker_dev
docker-compose up -d

Плюсы: Полная инфраструктура, легко управлять Минусы: Ограниченная масштабируемость

Kubernetes¶

Для корпоративного использования.

kubectl apply -f k8s/

Плюсы: Высокая доступность, масштабируемость, мониторинг Минусы: Сложность настройки и эксплуатации

Чек-лист развертывания¶

Используйте этот чек-лист для контроля процесса:

Подготовка¶

• Проверены системные требования
• Выбран LLM провайдер
• Настроен доступ к ClickHouse
• Определены домены данных
• Определена стратегия бэкапов

Установка¶

• Установлен Python 3.11+
• Создано виртуальное окружение
• Установлены зависимости
• Применены миграции БД
• API сервер запускается

Конфигурация¶

• Настроен config.yaml
• Настроены переменные окружения
• Настроено подключение к LLM
• Настроено подключение к ClickHouse
• Настроена аутентификация
• Добавлены домены данных

Тестирование¶

• CLI запускается и работает
• API отвечает на запросы
• Выполняются простые запросы
• Сохраняются датасеты
• Создаются визуализации
• Работает аутентификация

Мониторинг¶

• Настроен Jaeger для трейсинга
• Настроен Prometheus для метрик
• Настроен Grafana для дашбордов
• Настроен Loki для логов
• Настроены алерты

Следующие шаги¶

После успешного развертывания:

1. Обучите пользователей - проведите тренинг с Руководством пользователя
2. Настройте домены - добавьте специфичные для вашей организации источники данных
3. Настройте мониторинг - создайте дашборды и алерты
4. Организуйте поддержку - определите процесс решения проблем

Дополнительные ресурсы¶

• FAQ - часто задаваемые вопросы администраторов
• Глоссарий - технические термины
• Примеры - готовые сценарии использования

Успешного развертывания! 🚀