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

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

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

Предпосылки¶

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

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

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

Выберите окружение и откройте пункт меню «Спутники (установить, обновить, удалить)». На экране перечислены все пакеты из каталога satellites, для каждого видно, что он несёт и заданы ли его настройки.

Набор это полный желаемый состав: приложение приводит систему к нему. Чтобы добавить или обновить Спутник, отметьте нужное и повторите установку. Порядок в списке это порядок наложения слоёв. Выбранный набор закрепляется за окружением, поэтому в следующий раз он уже отмечен.

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

Установку можно повторять безопасно: с тем же набором ничего лишнего не меняется.

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

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

Настройки, у которых есть значение по умолчанию, заполнять не обязательно: оно и будет использовано. Остальные проверяются перед установкой.

Если настройка не заполнена, установка останавливается и приложение показывает, каких значений не хватает и у какого Спутника. На сервере при этом ничего не изменилось. Заполните значения клавишей s и повторите. Проверка нужна потому, что Спутник без ключа доступа установился бы благополучно и отказал при первом обращении к данным.

Несовпадение версии Спутника и установленной версии платформы показывается предупреждением и установку не останавливает.

Удаление¶

Клавиша d на выбранном Спутнике, с подтверждением.

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

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

Остальные Спутники набора при этом сохраняются: приложение снимает только выбранный и приводит систему к оставшемуся составу.

Установка из командной строки¶

Тот же жизненный цикл доступен без меню, для автоматизации. Желаемый набор задаётся переменной ORBITA_SATELLITES, удаляемый Спутник переменной ORBITA_SATELLITE_TARGET:

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 указывается желаемый набор после удаления.

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

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

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