Установка

Система Ordinaut предназначена для запуска в виде набора контейнерных сервисов с использованием Docker. Этот подход обеспечивает последовательную и воспроизводиемую среду как для разработки, так и для производственной эксплуатации.

🚀 Быстрая установка: Используйте наши готовые Docker-образы для мгновенного развертывания или соберите из исходного кода для разработки и настройки.

Предварительные требования

Перед началом убедитесь, что на вашей системе установлены следующие инструменты:

Docker Engine: Версия 24.0 или новее. Установить Docker
Docker Compose: Входит в состав Docker Desktop или как отдельный плагин. Установить Docker Compose
Git: Для клонирования репозитория. Установить Git
cURL: Инструмент командной строки для выполнения API-запросов, используется для проверки.

1. Клонируйте репозиторий

Сначала клонируйте репозиторий Ordinaut с GitHub на ваш локальный компьютер.

git clone https://github.com/yoda-digital/ordinaut.git
cd ordinaut

2. Запустите систему

Система предлагает два подхода к установке - выберите тот, который соответствует вашим потребностям:

🚀 Вариант A: Готовые образы (РЕКОМЕНДУЕТСЯ - Мгновенный запуск)

Используйте готовые к производству Docker-образы, публикуемые автоматически с каждым релизом:

cd ops/
./start.sh ghcr --logs

✅ Преимущества: - Запуск за 30 секунд по сравнению с 5-10 минутами сборки из исходного кода - Протестированные в производстве образы с аттестациями безопасности - Поддержка нескольких архитектур для Intel/AMD (linux/amd64) - Автоматические обновления с семантическим версионированием - Отсутствие зависимостей для сборки на вашей системе

📚 Доступные образы: - ghcr.io/yoda-digital/ordinaut-api:latest - Сервис REST API FastAPI - ghcr.io/yoda-digital/ordinaut-scheduler:latest - Сервис APScheduler - ghcr.io/yoda-digital/ordinaut-worker:latest - Сервис выполнения заданий

🛠️ Вариант B: Сборка из исходного кода (Разработка)

Для разработки, настройки или когда вам нужно изменить исходный код:

cd ops/
./start.sh dev --build --logs

Стек сервисов

При запуске стартового скрипта запускаются следующие сервисы:

postgres: База данных PostgreSQL.
redis: Сервер Redis.
api: Основной сервер FastAPI на порту 8080.
scheduler: Процесс APScheduler.
worker: Рабочий процесс, выполняющий задачи.

3. Проверьте установку

Проверьте статусы контейнеров и запросите эндпоинт состояния.

Проверьте состояние контейнеров

docker compose ps

Запросите API состояния

curl http://localhost:8080/health

Успешный ответ означает, что система работает корректно.

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

Ваш экземпляр Ordinaut теперь полностью работоспособен! 🎉