Установка Glarus BI в Docker Compose¶

В данном подразделе описаны шаги для получения экземпляра Glarus BI в среде Docker Compose.

Процесс установки показан в нашем обучающем ролике на Rutube.

Поддерживаемые операционные системы¶

Glarus BI создаётся и упаковывается в контейнере Docker. Поэтому для запуска системы требуется актуальная (ещё поддерживаемая) Unix-совместимая операционная система с поддержкой Docker.

Перечень операционных систем для Docker можно получить на docs.docker.com.

Если операционная система отсутствует в данном списке, но поддержка Docker заявлена разработчиком операционной системы, запуск возможен.

Также Glarus BI совместима с:

Astra Linux Special Edition РУСБ.10015-01 (очередное обновление 1.7). Сертификат соответствия от 08.09.2023 №13977/2023;
ОС РЕД ОС. Сертификат совместимости от 15.01.2024.

Предварительные условия¶

Для запуска стека Glarus BI используется среда Docker Compose.
Для запуска нужен сервер или рабочая станция с установленными пакетами Docker актуальной на момент установки версии.
Служба docker должна быть запущена.
Для развёртывания нужно получить в службе технической поддержки архив с настройками среды Docker Compose для Glarus BI.
Вам понадобится команда с логином и паролем для доступа к репозиторию Glarus Digital. Команда находится в текстовом файле инструкции README.md внутри архива для установки.

Требования к каналу связи¶

Значения приведены для холодной первой загрузки и фильтрации синтетического дашборда из шести карточек. HAR холодной загрузки с переходом в режим редактирования содержал 37 ответов общим объёмом 5,89 МБ; Performance API браузера зафиксировал 4,85 МБ ресурсов до перехода в режим редактирования. В дальнейшем браузер использует кэш статических файлов. Ответ API на запрос фильтрации одной карточки размером 14,8 КБ пришёл за 0,16 с; это время ответа на запрос, а не универсальная длительность вычисления. Для диагностики конкретного подключения снимите HAR при первой загрузке и при открытии или фильтрации дашборда: Создание HAR-файла для диагностики.

Соединение	Минимум	Рекомендуется	Основание измерения
Рабочая станция ↔ сервер Glarus BI, на одного одновременно работающего пользователя	10 Мбит/с входящая и 10 Мбит/с исходящая	20 Мбит/с входящая и 20 Мбит/с исходящая	Холодная загрузка передала 4,85 МБ ресурсов: 5,9 с при 10 Мбит/с и 4,0 с при 20 Мбит/с. При 2 Мбит/с она заняла 22,5 с. Допустимая задержка для первого открытия — до 6 с на минимуме и до 5 с на рекомендуемом канале.
Все рабочие станции ↔ сервер Glarus BI, 50 одновременно работающих пользователей	500 Мбит/с входящая и исходящая суммарно	1 Гбит/с входящая и исходящая суммарно	Расчёт: значение на одного пользователя умножено на 50 при одновременной холодной загрузке. После кэширования статических файлов фактический трафик ниже.
Сервер Glarus BI ↔ PostgreSQL приложения, на установку	250 Мбит/с в каждом направлении	500 Мбит/с в каждом направлении	В локальном синтетическом прогоне Glarus BI v57.1.17517 50 параллельных запросов заняли 0,82 с и передали через PostgreSQL приложения 0,76 МБ от BI и 1,82 МБ к BI. Экстраполяция на 50 пользователей и шесть карточек при той же длительности запроса даёт примерно 45 Мбит/с от BI и 107 Мбит/с к BI; значения умножены на число карточек и округлены с запасом.
Сервер Glarus BI ↔ источник PostgreSQL, ClickHouse или другой источник данных, на установку	10 Мбит/с в каждом направлении для измеренного профиля	20 Мбит/с в каждом направлении для измеренного профиля	В том же локальном прогоне PostgreSQL-источник принял 79 КБ от BI и отправил 65 КБ к BI за 0,82 с; для 50 пользователей с шестью карточками это около 4,7 Мбит/с от BI и 3,8 Мбит/с к BI. Измерение сделано на синтетическом PostgreSQL-источнике; для ClickHouse и других источников проверьте реальные запросы и объём результатов отдельно. Оценка 100 Мбит/с из обзора служит только ориентиром.

Счётчики PostgreSQL сняты для синтетической таблицы с 50 000 строками. Прогон содержал 50 параллельных запросов к одной карточке; расчёт для шести карточек выше — экстраполяция, а не отдельный тест 300 запросов. Снимите трафик приложения PostgreSQL и каждого источника отдельно при реальных запросах; объём ответа, кэширование и расписание могут изменить нагрузку.

Запросы обрабатывает сервер Glarus BI и источник данных, а браузер получает результаты. Поэтому сетевой канал между BI и PostgreSQL приложения, ClickHouse и другими источниками рассчитывают по нагрузке серверной части, а не по числу рабочих станций. Протокол и показатели сервиса описаны в разделе «Сетевые требования и SLA».

Распаковка настроек¶

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

mkdir glarus_bi
unzip docker_config-main.zip -d glarus_bi/ && cd glarus_bi/docker_config-main

Создание паролей для баз данных¶

Система поставляется с колоночной СУБД ClickHouse и реляционной СУБД Postgres. Для работы с данными будет создан отдельный пользователь glarusbi с расширенными правами.

Для предустановки паролей используется скрытый файл .env. Используйте консольные инструменты для редактирования файла или включите отображение скрытых файлов, чтобы найти его в списке графического менеджера файлов.

Придумайте пароли для каждой СУБД и в файле .env замените фразу <YOUR_PASSWORD> на придуманные вами пароли:

PG_PASSWORD;
CLICK_PASSWORD.

Не забудьте сохранить файл при выходе.

Авторизация в репозитории Glarus Digital¶

Откройте файл README.md, найдите строку для доступа к репозиторию Glarus Digital, она содержит логин и пароль. Скопируйте её целиком (из вашего файла) и выполните в консоли. Ниже приведён пример подобной строки.

docker login registry.glarus-digital.ru -u <логин> -p <пароль>

Получение образа и запуск контейнеров¶

Всё готово к началу установки. Запустите процесс в консоли, выполнив команду:

docker compose up -d

Примечание

Команда docker compose может выполняться как docker-compose (написание через дефис) — это зависит от версии ОС и пакетов.

Дождитесь завершения процесса. Веб-интерфейс системы будет запущен на порту 3000.

Проверка доступа к веб-интерфейсу¶

Откройте браузер и составьте ссылку из адреса вашего сервера и порта 3000. Например:

https://localhost:3000

Система должна отобразить форму с кодом запроса лицензии. Серверу приложений может понадобиться какое-то время на запуск, но не более 3 минут. Если формы с кодом лицензии нет, установка выполнена с ошибками. В этом случае воспользуйтесь журналами контейнеров, попытайтесь переустановить Glarus BI или обратитесь в нашу техническую поддержку.

Ввод кода подтверждения лицензии¶

Если вы определились с размещением системы (ключ "привязывается" к серверу), сообщите в нашу техподдержку код запроса лицензии и другие данные для выпуска ключа (см. подраздел "Работа с лицензионным ключом Glarus BI").

После проверки мы выпустим лицензию и вышлем код подтверждения.

Введите код подтверждения в соответствующую форму в веб-интерфейсе системы.

Предупреждение

После активации лицензии не откладывайте предварительную настройку системы. Система сейчас разблокирована, и создать первую учётную запись администратора может любой пользователь, имеющий доступ к вашему серверу по http или https.

Начало работы с системой¶

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

Рекомендуем обзорный ролик "Весь Glarus BI для разработчика дашбордов за 15 минут!".

Известные проблемы и решения¶

Не работает команда `docker compose`¶

Выполните установку Docker согласно официальной документации Docker. Вам нужен пакет docker-compose-plugin. Если он не может установиться, и ОС поддерживается Docker, то скорее всего вы пытаетесь установить Docker из репозитория ОС, а не из репозитория Docker.

Docker сообщает о проблемах доступа к docker.sock¶

Добавьте пользователя в группу docker и примените изменения (ссылка на stackoverflow, англ.).

Не удаётся авторизоваться в registry.glarus-digital.ru. Docker не принимает пароль в текстовом виде¶

Если команда не может выполниться из-за повышенных требований к безопасности Docker, сохраните пароль в отдельный файл password.txt, расположите его в каталоге, куда распакован архив, и повторите попытку с изменённой командой:

cat password.txt | docker login registry.glarus-digital.ru -u <логин> --password-stdin

В архиве нет файла .env¶

Файл есть, но он скрытый. Включите отображение скрытых файлов в утилите, которую используете для работы с файлами. Например, в консоли команду ls -a вместо ls.
Такое может быть, если вы получали архив для установки до ноября 2025. Запросите в нашей техподдержке актуальный архив.

Glarus BI не запускается после установки¶

Более подробную информацию вы можете получить командами docker compose logs, docker logs <контейнер>, а список контейнеров — с помощью docker ps.