Skip to main content
Docker Compose запускает по одному контейнеру-песочнице на каждого активного пользователя Craft. Используйте этот вариант для небольшого развёртывания Yahont на одном хосте, которому вы доверяете и которым управляете.
Если Craft будут использовать больше нескольких человек, особенно одновременно, лучше развернуть Craft в Kubernetes.
Craft даёт API-серверу и фоновому контейнеру доступ на чтение и запись к сокету Docker. Такой доступ фактически равен доступу root к хосту. Прокси песочниц получает доступ к сокету только на чтение.

Требования

  • Полное развёртывание Yahont в Docker Compose
  • Docker Engine с Compose
  • Хост с ёмкостью для стека Yahont и активных контейнеров-песочниц
  • URL Yahont, доступный через прокси песочниц
Craft не работает с оверлеем Yahont Lite для Compose.

Новое развёртывание

Запустите установщик Yahont CLI с оверлеем Craft:
Установщик загружает docker-compose.craft.yml, включает Craft, выбирает бэкенд песочниц Docker, создаёт мостовую сеть песочниц и том CA прокси и запускает развёртывание.
В примерах ниже используется каталог развёртывания CLI по умолчанию. Для развёртывания, созданного старой версией скрипта install.sh, замените ~/.config/onyx каталогом onyx_data (например, onyx_data/deployment/.env).
Откройте ~/.config/onyx/deployment/.env и задайте URL Yahont:
Затем пересоздайте затронутые сервисы с обоими файлами Compose:

Существующее развёртывание

Задайте ONYX_SERVER_URL в .env существующего развёртывания, затем снова запустите установщик:
Установщик добавляет оверлей Craft и обновляет существующий .env:
Одного ENABLE_CRAFT=true без оверлея недостаточно. Оверлей монтирует сокет Docker, запускает прокси песочниц и подключает API-сервер и фоновый рабочий процесс к сети песочниц.

Задайте URL Yahont

Для продакшена используйте публичный HTTPS-URL, по которому пользователи открывают Yahont:
Для локального Docker Desktop в macOS или Windows используйте порт хоста, выбранный установщиком:
В Linux используйте имя хоста или адрес хоста, доступный из контейнеров Docker. Имена сервисов Compose, такие как api_server и nginx, не разрешаются из изолированного моста песочниц.

Планирование ёмкости хоста

По умолчанию песочницы Docker получают по одному CPU и 2 ГБ памяти:
Закладывайте базовые сервисы Yahont плюс число пользователей, которые могут одновременно запускать Craft. Простаивающая песочница по умолчанию сохраняется в снимок и останавливается через 3600 секунд; измените это с помощью SANDBOX_IDLE_TIMEOUT_SECONDS, если нужна более быстрая очистка или более долгоживущие песочницы. Образ песочницы следует за IMAGE_TAG. Держите бэкенд Yahont и песочницу на одном релизе. В обычных развёртываниях не следует задавать SANDBOX_CONTAINER_IMAGE отдельно.

Сборка Craft из исходного кода

docker compose up --build собирает сервисы Yahont, объявленные в файлах Compose. Он не собирает образ песочницы Craft, потому что песочницы создаются API-сервером динамически, а не запускаются как сервис Compose. Из корня исходного репозитория Yahont отдельно соберите образ песочницы с локальным неизменяемым тегом:
Задайте образ в .env, используемом вашим исходным репозиторием:
Затем соберите и пересоздайте сервисы Yahont с оверлеем Craft:
Не используйте latest, edge или beta для локально собранного образа песочницы. API-сервер считает эти теги изменяемыми и пытается обновить их из реестра перед подготовкой. Используйте тег вроде local-source.
Задание IMAGE_TAG не собирает соответствующий образ onyxdotapp/sandbox:${IMAGE_TAG}. Либо соберите этот тег песочницы отдельно, либо задайте SANDBOX_CONTAINER_IMAGE явно. Пересоздайте api_server и background после изменения настройки. Существующие контейнеры sandbox-* продолжают использовать образ, с которым были созданы, и для использования нового образа их нужно завершить и подготовить заново. Если вы запускаете из подготовленного каталога, например onyx_data/deployment, скопируйте настройку в .env этого каталога. В подготовленных каталогах развёртывания нет исходного репозитория, которого ожидают контексты сборки Compose, поэтому используйте уже собранные или опубликованные образы с --no-build.

Проверка развёртывания

Убедитесь, что основные сервисы и прокси работают:
После настройки модели и доступа пользователей отправьте запрос в Craft. Должен появиться контейнер-песочница:
Сервис background включает рабочий процесс запланированных задач; отдельный сервис Compose не нужен.

Сеть и безопасность хоста

Контейнеры-песочницы подключаются только к внешнему мосту onyx_craft_sandbox. Они не могут разрешать PostgreSQL, Redis, объектное хранилище или API-сервер по имени сервиса Compose. Их исходящий трафик HTTP и HTTPS проходит через sandbox-proxy, который применяет политики приложений и подставляет учётные данные после одобрения запроса.
В облачных виртуальных машинах блокируйте доступ песочниц к сервису метаданных инстанса на уровне хоста или платформы. В EC2 требуйте IMDSv2 с HttpTokens=required и примените правило брандмауэра хоста, блокирующее трафик моста Docker к 169.254.169.254.
Полную модель доверия и сети см. в разделе Архитектура Craft.

Устранение неполадок

Убедитесь, что заданы ENABLE_CRAFT=true и SANDBOX_BACKEND=docker, затем пересоздайте API-сервер и веб-приложение. Включите в команду Compose оба файла: docker-compose.yml и docker-compose.craft.yml.
Задайте значение в .env каталога развёртывания и пересоздайте API-сервер, фоновый рабочий процесс и прокси песочниц с оверлеем Craft.
Замените api_server, nginx или другое имя хоста, существующее только в Compose, публичным URL Yahont или адресом хоста, доступным из контейнеров Docker.
Выполните docker compose -f docker-compose.yml -f docker-compose.craft.yml logs sandbox-proxy. Проверьте ONYX_SERVER_URL, доступность PostgreSQL и Redis, том sandbox_proxy_ca и доступ к сокету Docker.
Повторно выполните onyx-cli deploy install --include-craft. Если автоматическое создание не удалось, создайте ресурсы и перезапустите развёртывание:
Проверьте журналы контейнера песочницы и нагрузку на память хоста. Увеличивайте SANDBOX_DOCKER_MEMORY_LIMIT или SANDBOX_DOCKER_CPU_LIMIT только когда у хоста достаточно ёмкости для каждой одновременной песочницы.

Обзор развёртывания Craft

Сравните варианты Docker Compose и Kubernetes.

Управление Craft

Настройте модели и доступ пользователей после развёртывания.