Пошаговая инструкция¶

Установка и всё дальнейшее обслуживание сервера выполняются одной утилитой orbita-ctl с рабочей машины администратора. Она подключается к серверам окружения по SSH и разворачивает все компоненты, включая среду контейнеризации.

Утилита работает в двух режимах:

Интерактивный режим: полноэкранное меню в терминале. Основной способ работы, его и описывает эта страница.
Неинтерактивный режим: запуск одной командой вида ./bin/orbita-ctl --env <окружение> --action <действие>. Удобен для автоматизации и регламентных заданий. Равнозначная команда приводится рядом с каждым действием.

Настройка уже работающей системы (доступ ролей, описания данных, отчёты) выполняется в веб-интерфейсе администратора и вынесена в раздел Администрирование системы.

Понятия¶

Окружение. Именованный набор параметров одной установки (например, production). В окружении хранятся адреса серверов, доменные имена, реквизиты реестра образов, пароли баз, параметры доступа к языковой модели и список пользователей. Утилита ведёт несколько окружений независимо, например промышленное и тестовое.
Хранилище секретов. Пароли и ключи не лежат в открытом виде рядом с утилитой. Они хранятся в защищённом хранилище: либо в корпоративном хранилище секретов, либо в локальном зашифрованном файле. Утилита читает их оттуда при каждом запуске.

Что потребуется¶

На рабочей машине администратора:

Python 3 и средство автоматизации развёртывания Ansible (устанавливается командой pip install ansible);
SSH-доступ к серверам окружения с правами администратора;
доступ к корпоративному хранилищу секретов либо решение хранить секреты в локальном зашифрованном файле.

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

Заранее подготовьте параметры окружения:

Параметр	Назначение
Адрес и учётная запись SSH	Подключение к серверам окружения
Доменные имена	Публикация системы и сервиса аутентификации по HTTPS
Реквизиты реестра образов	Загрузка контейнеров
Пароли баз данных	База метаданных, сервис аутентификации, аналитическое хранилище
Параметры аналитического хранилища	Локальный контейнер или подключение к существующему хранилищу организации
Параметры доступа к языковой модели	Тип, адрес, ключ, название модели
Учётные записи пользователей	Первые пользователи с ролями

Шаг 1. Подготовка серверов¶

На серверах окружения:

установлена поддерживаемая операционная система (см. Системные требования);
открыт доступ по SSH для учётной записи администратора;
разрешён исходящий доступ к реестру образов;
между серверами разрешено сетевое взаимодействие по портам компонентов.

Среда контейнеризации устанавливается утилитой, отдельно готовить её не нужно.

Шаг 2. Первый запуск утилиты¶

Распакуйте полученный архив на рабочей машине и запустите утилиту:

tar xzf orbita-ctl-<версия>-linux-amd64.tar.gz
cd orbita-ctl-<версия>
./bin/orbita-ctl

Архив самодостаточен: содержит саму утилиту и все сценарии установки. Доступ в интернет для её работы не требуется.

Откроется полноэкранное меню. Управление одинаково на всех экранах:

стрелки: перемещение по списку;
Enter: выбрать пункт;
Esc: вернуться на шаг назад;
Ctrl+C: выход.

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

Шаг 3. Хранилище секретов¶

Выбор хранилища задаётся файлом .vault рядом с утилитой. Если файла нет, при первом запуске утилита предложит выбрать вариант в меню. Поддерживаются два варианта.

Корпоративное хранилище секретовЛокальный зашифрованный файл

Создайте файл .vault с адресом корпоративного хранилища секретов:

VAULT_ADDR=https://vault.example.com
VAULT_TOKEN=<токен>

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

Укажите в файле .vault локальный режим:

BACKEND=local

Секреты будут храниться в зашифрованном файле рядом с утилитой. При первом запуске утилита предложит создать хранилище и задать пароль. Пароль нигде не сохраняется: без него секреты восстановить нельзя.

Шаг 4. Создание окружения¶

В списке окружений выберите пункт создания нового окружения. Откроется мастер из нескольких шагов; переходы между полями стрелками и Enter. Мастер запросит:

Основное: имя окружения (латиница, цифры, дефисы) и описание.
Серверы: адрес, учётная запись и порт SSH. Ключ можно вставить или оставить пустым, тогда он будет создан при первом развёртывании; пароль нужен только для первичного подключения.
Домены: доменное имя системы и доменное имя сервиса аутентификации.
Реестр образов: адрес реестра, учётная запись, пароль, имя и тег образа.
Базы данных: пароли базы метаданных, сервиса аутентификации и аналитического хранилища; выбор локального или внешнего аналитического хранилища и его адрес.
Сервис аутентификации: пароль администратора и секрет приложения.
Языковая модель: тип, адрес, ключ доступа и название модели.
Параметры приложения: режим работы, уровень журналирования и, при необходимости, дополнительные переменные окружения.

В конце мастер попросит завести пользователей: для каждого логин, пароль, адрес почты и роль (администратор или аналитик). Нужен хотя бы один пользователь. Все значения сохраняются в хранилище секретов, окружение появляется в списке.

Шаг 5. Проверка и развёртывание¶

Выберите созданное окружение в списке: откроется меню действий. Разверните систему в три приёма.

Пункт «Deploy dry-run (проверка)» показывает, что изменится на серверах, ничего не меняя. Убедитесь, что нет ошибок доступа и опечаток в параметрах.
Пункт «Deploy (развернуть)» устанавливает среду контейнеризации, поднимает контейнеры, выполняет миграции базы метаданных, настраивает сервис аутентификации и заводит указанных пользователей. Ход работ виден на экране.
Пункт «Health check (диагностика)» показывает состояние контейнеров и доступность компонентов. Утилита предложит режим автообновления для наблюдения в реальном времени.

Те же три действия одной командой (для автоматизации):

./bin/orbita-ctl --env production --action deploy-check
./bin/orbita-ctl --env production --action deploy
./bin/orbita-ctl --env production --action health

Шаг 6. Проверка после установки¶

После развёртывания убедитесь вручную:

Главная страница системы открывается по HTTPS.
Вход с тестовой учётной записью выполняется.
Тестовый вопрос по данным возвращает результат.
Веб-интерфейс администратора открывается и показывает список пользователей.

Если какой-то пункт не выполняется, смотрите Диагностику.

Шаг 7. Установка плагина табличного редактора¶

Плагин устанавливается на рабочие места пользователей.

Получите архив плагина, собранный под адрес вашей установки.
Разместите его в каталоге плагинов редактора на рабочем месте либо распространите средствами централизованного управления.
Перезапустите редактор.
Убедитесь, что в меню Плагины появился пункт Р13.Орбита и выполняется вход.

Обслуживание после установки¶

После установки та же утилита обслуживает окружение. Выберите окружение в меню, доступны действия:

Пункт меню	Команда (`--action`)	Что делает
Deploy (развернуть)	`deploy`	Развернуть или обновить окружение целиком
Deploy dry-run (проверка)	`deploy-check`	Проверка без внесения изменений
Status (статус контейнеров)	`status`	Состояние контейнеров
Health check (диагностика)	`health`	Диагностика сервера и сервисов
Restart (перезапуск)	`restart`	Перезапустить сервисы
Pull & restart (обновить образы)	`pull`	Обновить образы и перезапустить
Update (быстрое обновление)	`update`	Быстрое обновление сервера Орбиты
Stop (остановить)	`stop`	Остановить сервисы
Up (запустить)	`up`	Запустить сервисы
SSH (подключиться)	`ssh`	Интерактивная SSH-сессия к серверу
Load test data (загрузить данные)	`load-test-data`	Загрузить демонстрационные данные
Настройки окружения	(только в меню)	Правка параметров окружения, настройки спутников, удаление окружения

Пункт «Настройки окружения» открывает правку любой группы параметров (серверы, домены, реестр образов, базы данных, сервис аутентификации, языковая модель, параметры приложения, мониторинг, пользователи), настройки спутников и удаление окружения.

Отдельно из командной строки доступны действия без пункта меню: logs (последние строки журналов), health-watch (диагностика с автообновлением), install-satellites и remove-satellite (управление Спутниками), delete-env (удаление окружения).

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

Что дальше¶

Установлена платформа Орбита без отраслевого наполнения: она умеет работать с данными, но пока не знает ни ваших данных, ни отраслевой специфики. Дальнейшие шаги зависят от способа внедрения:

описать данные организации самостоятельно: Настройка и Подключение данных;
установить готовое отраслевое решение поверх платформы: Спутники: установка и управление.