Общие сведения

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

Информация о параметрах разделена соответственно сервисам, к которым эти параметры относятся.

Названия сервисов в заголовках указаны так, как они используются в приложении.

Для приложения, развернутого с использованием 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

База данных для работы с датасетами.

Предоставляемые базы:

  • clickhouse;
  • postgres
  • clickhouse;
  • postgres


postgres–
CACHE_DSNDSN базы данных для работы с датасетамиСтрокаpostgres://polymatica:polymatica-secret@postgresql/platform_manager_cache–
APPLICATION_MODE_BETAВключение бета-режимаБулево–false

Параметры аутентификации

EXPIRE_SESSION_EXPIRE_SECONDSСрок жизни токена аутентификации

Длительность в секундах

–1800
AUTH_DEFAULT_METHOD

Метод аутентификации по умолчанию. Указанный метод должен быть доступен (см. далее методы аутентификации)

Предоставляемые методы:

  • api – стандартная аутентификация (логин/пароль);
  • ldap – аутентификация с использованием службы каталогов;
  • openIDConnect – аутентификация с использованием OIDC;
  • custom_client_rec
  • api;
  • ldap;
  • openIDConnect;
  • custom_client_rec
–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

Строка––
POLYMATICA_CORE_OIDC_PROVIDER_CLAIMS_FIRST_NAME_KEY

Ключ claims, по которому будет определено значение "имя пользователя" в Polymatica

Строка––
POLYMATICA_CORE_OIDC_PROVIDER_CLAIMS_LAST_NAME_KEY

Ключ claims, по которому будет определено значение "фамилия пользователя" в Polymatica

Строка––
POLYMATICA_CORE_OIDC_PROVIDER_CLAIMS_MIDDLE_NAME_KEY

Ключ claims, по которому будет определено значение "отчество пользователя" в Polymatica

Строка––
POLYMATICA_CORE_OIDC_INSECURE_OVERRIDE_ISSUER

Не выполнять валидацию issuer_url

Булево–false

POLYMATICA_CORE_OIDC_PROVIDER_ACTUAL_ISSUER

Эндпоинт issuer_url для валидации id_token когда валидация issuer_url не выполняется

Строка––

POLYMATICA_CORE_OIDC_PROVIDER_AUTHORIZE_IAM_URL

Адрес эндпоинта /authorize ЕЦП "Гостех" для получения роли пользователя

Строка––

Метод Custom

INTEGRATION_AUTH_METHOD_CLIENT_REC_ACTIVE

Доступность метода

Булево–false
INTEGRATION_AUTH_CLIENT_REC_HEADER_KEY

Заголовок запроса, содержащий имя пользователя (username) должен приходить на POST-запрос "/auth/custom-client-rec/login"

Строка––

Параметры логирования

LOG_LVL

Уровень логирования действий сервиса.

Предоставляемые уровни:

  • 0 – Panic level
  • 1 – Fatal level
  • 2 – Error level
  • 3 – Warning level
  • 4 – Info level
  • 5 – Debug level
  • 6 – Trace level
  • 0;
  • 1;
  • 2;
  • 3;
  • 4;
  • 5;
  • 6
–4
LOG_WITH_RESPONSE

Запись в лог тела ответа

Булево–false

Параметр правила перехода в Polymatica Analytics

INTEGRATION_DETAILING_UNDER_ANONYMOUS

Метод аутентификации в Polymatica Analytics который будет запрашиваться для сквозной детализации из виджета.

Принимает значения:

  • true – аутентификация в Polymatica Analytics всегда выполняется под временным анонимным пользователем, права анонимного пользователя в Polymatica Analytics определяются группой пользователей shared_resources;

  • false – метод аутентификации в Polymatica Analytics выполняется в зависимости от использованного метода аутентификации в Polymatica Dashboards TN

Булево–false

Параметр установки по умолчанию глобального правила ограничения данных датасета

DATASETS_RIGHTS_TO_DATA_FOR_ALL_USERS

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

Принимает значения:

  • allow-all – по умолчанию устанавливается правило «Разрешить всем», аналогично отсутствию параметра;
  • restrict-all – (а также любое значение отличное от allow-all) по умолчанию устанавливается правило «Запретить всем»
Строка–allow-all

Сервис dashboard

Сервис обеспечивает работу модуля приложения Dashboard. Префикс параметров: POLYMATICA_DASHBOARD.

ПараметрНазначениеПринимаемое значениеЗначение при установкеЗначение по умолчанию

Параметры логирования

LOG_LVL

Уровень логирования действий сервиса.

Предоставляемые уровни:

  • 0 – Panic level
  • 1 – Fatal level
  • 2 – Error level
  • 3 – Warning level
  • 4 – Info level
  • 5 – Debug level
  • 6 – Trace level

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 – Panic level
  • 1 – Fatal level
  • 2 – Error level
  • 3 – Warning level
  • 4 – Info level
  • 5 – Debug level
  • 6 – Trace level

0–6

–

4

LOG_PATHФайл для записи логов сервисаСтрока–/tmp/platform/gateway.log

Сервис logstash

Сервис обеспечивает сбор, хранение и отправку по http логов событий приложения. Префикс параметров: POLYMATICA_LOGSTASH.

ПараметрНазначениеПринимаемое значениеЗначение при установкеЗначение по умолчанию

Параметры логирования

LOG_LVL

Уровень логирования действий сервиса.

Предоставляемые уровни:

  • 0 – Panic level
  • 1 – Fatal level
  • 2 – Error level
  • 3 – Warning level
  • 4 – Info level
  • 5 – Debug level
  • 6 – Trace level

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 – Panic level
  • 1 – Fatal level
  • 2 – Error level
  • 3 – Warning level
  • 4 – Info level
  • 5 – Debug level
  • 6 – Trace level

0–6

–

4

Сервис file-storage

Сервис обеспечивает для фронтенда хранение статических файлов (компоненты, изображения, видео). Префикс параметров: POLYMATICA_STORAGE.

ПараметрНазначениеПринимаемое значениеЗначение при установкеЗначение по умолчанию

Параметры логирования 

LOG_LVL

Уровень логирования действий сервиса.

Предоставляемые уровни:

  • 0 – Panic level
  • 1 – Fatal level
  • 2 – Error level
  • 3 – Warning level
  • 4 – Info level
  • 5 – Debug level
  • 6 – Trace level

0–6

–

4

Параметры сервиса

STORAGE_ASSETS_STATIC_PATHПуть до директории хранения статичных файловСтрока–/usr/share/polymatica/platform/file-storage/assets/

Сервис data-transformer

Сервис обеспечивает для фронтенда работу расчетных колонок датасета. Префикс параметров: POLYMATICA_DATA_TRANSFORMER.

ПараметрНазначениеПринимаемое значениеЗначение при установкеЗначение по умолчанию

Параметры логирования 

LOG_LVL

Уровень логирования действий сервиса.

Предоставляемые уровни:

  • 0 – Panic level
  • 1 – Fatal level
  • 2 – Error level
  • 3 – Warning level
  • 4 – Info level
  • 5 – Debug level
  • 6 – Trace level

0–6

–

4

Параметры Python-скрипта

PY_SCRIPT_PYTHON_PATHПуть до интерпретатора PythonСтрока–/usr/share/polymatica/platform/data-transformer/python/venv/bin/python

  • Нет меток