Перейти к содержанию

Спутники: установка и управление

Спутник это готовое отраслевое решение, которое ставится поверх работающей Орбиты. Что такое Спутник и какие бывают, описано в разделе Спутники. Здесь порядок установки и управления для администратора.

Спутники ставятся тем же приложением orbita-ctl, что разворачивает платформу, но отдельным действием: базовая установка при этом не переразворачивается. У Спутника собственный жизненный цикл: установка, обновление и удаление независимо от платформы.

Предпосылки

  • Развёрнутая и работающая платформа Орбиты. См. Пошаговая инструкция.
  • Пакеты Спутников, распакованные на машине администратора рядом с менеджером orbita-ctl (в каталоге satellites).

Желаемый набор Спутников

Устанавливаемый набор задаётся списком в переменной ORBITA_SATELLITES. Порядок в списке это порядок наложения слоёв:

export ORBITA_SATELLITES="farmer@1.0.0"

Имя без версии означает новейшую распакованную версию этого Спутника. Список это полный желаемый набор: приложение приводит систему к нему. Чтобы добавить или обновить Спутник, измените список и повторите установку.

Набор можно закрепить за окружением, чтобы не задавать его каждый раз: в меню «Настройки» откройте «Параметры приложения», поле «Спутники». Если переменная ORBITA_SATELLITES не задана, берётся закреплённый за окружением набор.

Настройки Спутника

У Спутника могут быть собственные настройки, свои на каждую установку: ключ доступа к источнику, признак включения функции и подобное. Задайте их до установки:

  • в меню «Настройки» откройте «Настройки спутников» и выберите Спутник;
  • секретные значения маскируются, как и прочие секреты окружения.

Незаданные настройки берут значения по умолчанию из пакета Спутника.

Установка и обновление

export ORBITA_SATELLITES="farmer@1.0.0"
./bin/orbita-ctl --env production --action install-satellites

Приложение приводит систему к желаемому набору: подключает описания данных и отчёты Спутника, применяет его настройки, при необходимости загружает данные и настраивает единый вход, затем перезапускает сервер Орбиты.

Действие можно повторять безопасно: с тем же набором ничего лишнего не меняется, с изменённым набором Спутники добавляются или обновляются.

Удаление

export ORBITA_SATELLITE_TARGET=farmer
./bin/orbita-ctl --env production --action remove-satellite

При удалении снимаются описания данных и отчёты Спутника строго по его пакету. Созданное вручную в веб-интерфейсе администратора не затрагивается.

Важно: удаление Спутника не трогает загруженные данные. Витрины и данные в аналитическом хранилище остаются на месте.

Если на сервере оставались другие Спутники, укажите их в ORBITA_SATELLITES (желаемый набор после удаления), а удаляемый в ORBITA_SATELLITE_TARGET.

Проверка результата

  • В веб-интерфейсе администратора появились (или исчезли при удалении) описания данных и отчёты Спутника.
  • Отчёт Спутника доступен, если активны все его описания данных.
  • При несовпадении версии Спутника и установленной версии платформы приложение выводит предупреждение.

Разработка собственного Спутника описана в разделе Разработка спутника.