Общие сведения
Раздел предоставляет справочную информацию о настраиваемых параметрах приложения: их перечень, назначение и значения по умолчанию. Используя настраиваемые параметры вы можете конфигурировать приложение.
Информация о параметрах разделена соответственно сервисам, к которым эти параметры относятся.
Названия сервисов в заголовках указаны так, как они используются в приложении.
Для приложения, развернутого с использованием Docker, название каждого параметра включает в себя префикс, который соответствует использующему параметр сервису. Например, в названии параметра POLYMATICA_CORE_CACHE_TYPE префикс – POLYMATICA_CORE. Префикс указан для каждого сервиса в начале раздела. Префикс отделяется от остальной части названия параметра нижним подчеркиванием. Например, для сервиса указан префикс POLYMATICA_DASHBOARD, а параметр – LOG_LVL, тогда в конфигурации приложения следует использовать название POLYMATICA_DASHBOARD_LOG_LVL. Для приложения, развернутого с использованием пакетов, префиксы отсутствуют, а параметры могут быть составными, например, параметры LOG_LVL, LOG_PATH указываются как
"log": { "lvl": 4, "path": "/var/log/polymatica/platform/dashboards.log", }
Параметры указываются:
- для приложения, развернутого с использованием Docker, в соответствующем приложению файле docker-compose.yml, в соответствующих сервисам блоках;
- для приложения, развернутого с использованием пакетов, параметры указываются в файлах config.json, которые находятся в соответствующих сервисам директориях /etc/polymatica/platform/service/{название_сервиса}/. Для файлов config.json сервисов Manager и Dashboards выделены отдельные директории /etc/polymatica/platform/manager/ и /etc/polymatica/platform/dashboards/.
Пути размещения, используемые в параметрах, находятся:
- для приложения, развернутого с использованием Docker – внутри контейнеров соответствующих сервисов, например, параметр POLYMATICA_CORE_LICENSE_FILE_PATH = /etc/polymatica/platform/manager/license.key указывает путь внутри контейнера manager;
- для приложения, развернутого с использованием пакетов – в окружающей операционной системе.
После изменения значений параметров:
для приложения, развернутого с использованием Docker, выполните:
docker compose up -d || docker-compose up -d
для приложения, развернутого с использованием пакетов, выполните:
systemctl restart polymatica-platform-manager
Сервис manager
Сервис обеспечивает работу модуля приложения Manager. Префикс параметров: POLYMATICA_CORE.
Параметр | Назначение | Принимаемое значение | Значение при установке | Значение по умолчанию |
---|---|---|---|---|
Параметры сервиса | ||||
CACHE_TYPE | База данных для работы с датасетами. Предоставляемые базы:
|
| postgres | – |
CACHE_DSN | DSN базы данных для работы с датасетами | Строка | postgres://polymatica:polymatica-secret@postgresql/platform_manager_cache | – |
APPLICATION_MODE_BETA | Включение бета-режима | Булево | – | false |
Параметры аутентификации | ||||
EXPIRE_SESSION_EXPIRE_SECONDS | Срок жизни токена аутентификации | Длительность в секундах | – | 1800 |
AUTH_DEFAULT_METHOD | Метод аутентификации по умолчанию. Указанный метод должен быть доступен (см. далее методы аутентификации) Предоставляемые методы:
|
| – | api |
Метод аутентификации API (стандартная, логин/пароль) | ||||
AUTH_METHOD_API_ACTIVE | Доступность метода стандартной аутентификации. Если все прочие методы аутентификации недоступны, метод стандартной аутентификации доступен независимо от состояния этого параметра | Булево | – | true |
Метод аутентификация AD/LDAP | ||||
AUTH_METHOD_LDAP_ACTIVE | Доступность метода аутентификация с использованием службы каталогов | Булево | – | false |
AUTH_ACTIVE_DIRECTORY_SERVER | Адрес контроллера домена | Строка | – | – |
AUTH_ACTIVE_DIRECTORY_PORT | Порт контроллера домена | Строка | – | |
AUTH_ACTIVE_DIRECTORY_BASE_DN | Доменное имя, которое приложение будет использовать для привязки к домену | Строка | – | – |
Метод аутентификация OpenID Connect | ||||
OIDC_AUTH_METHOD_ACTIVE | Доступность метода аутентификация OIDC | Булево | – | false |
OIDC_PROVIDER_ISSUER | Провайдер-поставщик аутентификации | Значение ключа "issuer" в метаданных провайдера | – | – |
OIDC_PROVIDER_REDIRECT_URL | Адрес переадресации после аутентификации в провайдере | Строка | https://хост/auth/oidc-callback | – |
OIDC_PROVIDER_CLIENT_ID | Client ID, указываемый в провайдере для приложения | Строка | – | – |
OIDC_PROVIDER_CLIENT_SECRET | Client secret, выдаваемый провайдером | Строка | – | – |
CORE_OIDC_PROVIDER_SCOPE | Скоуп, запрашиваемый у провайдера | Строка | openid email profile | – |
OIDC_PROVIDER_NAME | Произвольное имя провайдера | Строка | – | – |
OIDC_PROVIDER_CLAIMS_PREFERRED_USERNAME_KEY | Ключ claims, по которому будет определен username пользователя в Polymatica | Строка | – | – |
OIDC_PROVIDER_CLAIMS_EMAIL_KEY | Ключ claims, по которому будет определен email пользователя в Polymatica | Строка | – | – |
Метод Custom | ||||
INTEGRATION_AUTH_METHOD_CLIENT_REC_ACTIVE | Доступность метода | Булево | – | false |
INTEGRATION_AUTH_CLIENT_REC_HEADER_KEY | Заголовок запроса, содержащий имя пользователя (username) должен приходить на POST-запрос "/auth/custom-client-rec/login" | Строка | – | – |
Параметры логирования | ||||
LOG_LVL | Уровень логирования действий сервиса. Предоставляемые уровни:
|
| – | 4 |
LOG_WITH_RESPONSE | Запись в лог тела ответа | Булево | – | false |
Параметр правила перехода в Polymatica Analytics | ||||
INTEGRATION_DETAILING_UNDER_ANONYMOUS | Метод аутентификации в Polymatica Analytics который будет запрашиваться для сквозной детализации из виджета. Принимает значения:
| Булево | – | false |
Сервис dashboard
Сервис обеспечивает работу модуля приложения Dashboard. Префикс параметров: POLYMATICA_DASHBOARD.
Параметр | Назначение | Принимаемое значение | Значение при установке | Значение по умолчанию |
---|---|---|---|---|
Параметры логирования | ||||
LOG_LVL | Уровень логирования действий сервиса. Предоставляемые уровни:
| 0–6 | – | 4 |
LOG_WITH_RESPONSE | Запись в лог тела ответа | Булево | – | false |
Параметры подключения к OSM-серверу | ||||
MAPS_TILE_SERVER_BASE_URL | Адрес OSM-сервера | Строка | – | – |
MAPS_TILE_SERVER_SKIP_INSECURE | Пропускать незащищенное http-соединение | Булево | – | false |
MAPS_TILE_SERVER_URL_POSTFIX | Формат тайлов | Строка | – | .png |
Сервис gateway
Сервис обеспечивает маршрутизацию запросов между фронтендом и остальными сервисами. Префикс параметров: POLYMATICA_GATEWAY.
Параметр | Назначение | Принимаемое значение | Значение при установке | Значение по умолчанию |
---|---|---|---|---|
Параметры логирования | ||||
LOG_LVL | Уровень логирования действий сервиса. Предоставляемые уровни:
| 0–6 | – | 4 |
LOG_PATH | Файл для записи логов сервиса | Строка | – | /tmp/platform/gateway.log |
Сервис logstash
Сервис обеспечивает сбор, хранение и отправку по http логов событий приложения. Префикс параметров: POLYMATICA_LOGSTASH.
Параметр | Назначение | Принимаемое значение | Значение при установке | Значение по умолчанию |
---|---|---|---|---|
Параметры логирования | ||||
LOG_LVL | Уровень логирования действий сервиса. Предоставляемые уровни:
| 0–6 | – | 4 |
Параметры сервиса | ||||
REPOSITORY_PATH | Путь до директории хранения логов | Строка | – | /usr/share/polymatica/platform/logstash/ |
PIPELINE_CONFIG_PATH | Путь до файла конфигурации | Строка | – | /etc/polymatica/platform/service/logstash/ |
Сервис renderer
Сервис обеспечивает для фронтенда экспорт в изображение. Префикс параметров: POLYMATICA_RENDERER.
Параметр | Назначение | Принимаемое значение | Значение при установке | Значение по умолчанию |
---|---|---|---|---|
Параметры логирования | ||||
LOG_CHROME_DRIVER_LOG_LVL | Уровень логирования действий сервиса | Строка | – | ALL |
LOG_CHROME_DRIVER_LOG_PATH | Файл для записи логов сервиса | Строка | – | /tmp/POLYMATICA_RENDERER_CHROMEDRIVER.log |
Параметры сервиса | ||||
DRIVER_WEB_DRIVER_POOL_WARM_START | Начальный размер активных соединений | Число | – | 10 |
DRIVER_WEB_DRIVER_POOL_MAX_IDLE_SIZE | Максимальный размер пула соединений | Число | – | 20 |
DRIVER_RENDER_TIMEOUT_SEC | Таймаут | Длительность в секундах | – | 300 |
Сервис notifications
Сервис обеспечивает для фронтенда работу функциональности «Уведомления». Префикс параметров: POLYMATICA_NOTIFICATIONS.
Параметр | Назначение | Принимаемое значение | Значение при установке | Значение по умолчанию |
---|---|---|---|---|
Параметры логирования | ||||
LOG_LVL | Уровень логирования действий сервиса. Предоставляемые уровни:
| 0–6 | – | 4 |
Сервис file-storage
Сервис обеспечивает для фронтенда хранение статических файлов (компоненты, изображения, видео). Префикс параметров: POLYMATICA_STORAGE.
Параметр | Назначение | Принимаемое значение | Значение при установке | Значение по умолчанию |
---|---|---|---|---|
Параметры логирования | ||||
LOG_LVL | Уровень логирования действий сервиса. Предоставляемые уровни:
| 0–6 | – | 4 |
Параметры сервиса | ||||
STORAGE_ASSETS_STATIC_PATH | Путь до директории хранения статичных файлов | Строка | – | /usr/share/polymatica/platform/file-storage/assets/ |
Сервис data-transformer
Сервис обеспечивает для фронтенда работу расчетных колонок датасета. Префикс параметров: POLYMATICA_DATA_TRANSFORMER.
Параметр | Назначение | Принимаемое значение | Значение при установке | Значение по умолчанию |
---|---|---|---|---|
Параметры логирования | ||||
LOG_LVL | Уровень логирования действий сервиса. Предоставляемые уровни:
| 0–6 | – | 4 |
Параметры Python-скрипта | ||||
PY_SCRIPT_PYTHON_PATH | Путь до интерпретатора Python | Строка | – | /usr/share/polymatica/platform/data-transformer/python/venv/bin/python |