Конфигурация в окружении Platform V Frontend Std#

Общие настройки для сервисов DCGN#

Расположение на среде – репозиторий конфигурации компонента, файл conf/config/parameters/dcgn.all.conf

Наименование параметра в файле конфигурирования

Описание

Значение по умолчанию или глобальные параметры при установке Deploy tools

Версия ПО

dcgn.ose.poddisruptionbudget.apiVersion

Версия API в манифестах PodDisruptionBudget

policy/v1

1.4

dcgn.k8s.deploy.enabled

Параметр отвечающий за включение деплоя dcgn в k8s

true

1.4.1

dcgn.all.rn

Ресурс проекта (resourceName), из которого работает приложение

platformv:core:1

1.4.1

dcgn.ose.deployment.sidecar.istio.io.prestop.enabled

Включение задержки перед началом завершения Istio sidecar

true

2.1.4

Параметры определения BilledResourceName

dcgn.useBilledResourceNameOnlyFromRequest

Признак, указывающий на то, что в качестве значения billedResourceName использовать параметр из запроса (подробнее о billedResourceName читайте в разделе «Лейблы метрик» документа «Руководство по системному администрированию»)

false

1.4

dcgn.environment.partition

partition инсталляции, используется для формирования billedResourceName, когда dcgn.useBilledResourceNameOnlyFromRequest=false

sbrf

1.4

dcgn.environment.region

Регион или ЦОД установки сервиса; используется для формирования billedResourceName, когда dcgn.useBilledResourceNameOnlyFromRequest=false

1.4

dcgn.environment.account

account инсталляции, используется для формирования billedResourceName, когда dcgn.useBilledResourceNameOnlyFromRequest=false

1.4

При установке с помощью компонента Deploy Tools дополнительно с параметром dcgn.k8s.deploy.enabled необходимо проверить настройку overrides в файле multiCluster.json в common-репозитории.

Для установки в OpenShift:

"overrides": ["openshift"]

Для установки в k8s:

"overrides": []

Настройки для docgen-service#

Расположение на среде – репозиторий конфигурации компонента, файл conf/config/parameters/dcgn.docgen-service.conf

Наименование параметра в файле конфигурирования

Описание

Ограничения

Значение по умолчанию или глобальные параметры при установке Deploy tools

Версия ПО

dcgn.docgen-service.dcgn.health.status.refresh.fixed-delay.ms

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

1000

1.0

dcgn.docgen-service.dcgn.template-provider-url

URL до провайдера шаблонов

http://dcgn-svc-template-provider-:8080

1.0

dcgn.docgen-service.dcgn.template-provider-health-url

URL до healthcheck endpoint провайдера шаблонов

http://dcgn-svc-template-provider-:8081/actuator/health

1.0

dcgn.docgen-service.dcgn.cache.maxSize

Максимальный размер кеша (количество объектов)

100

1.0

dcgn.docgen-service.dcgn.cache.evictTimeoutSeconds

Период времени с момента получения шаблона из Реестра шаблонов, после которого шаблон вытесняется из кеша, в секундах

28800

1.0

dcgn.docgen-service.dcgn.cache.asyncInvalidationEnabled

Включение автоматической инвалидации шаблона в кэше при изменении шаблона в реестре

true

1.4

dcgn.docgen-service.dcgn.fillingTemplateTimeoutInMillis

Максимально допустимое время наполнения шаблона данными, в миллисекундах

60000

1.0

dcgn.docgen-service.rn

Ресурс проекта (resourceName), из которого работает приложение

1.0

dcgn.docgen-service.rn-in-header.enabled

Позволяет передавать ресурс проекта (resourceName) для HTTP-запросов через header параметр ufs-tenant (нужен для обратной совместимости в окружении FS)

false

1.4.1

dcgn.docgen-service.management.server.port

Порт для служебных запросов получения состояния работы приложения

8081

1.0

dcgn.docgen-service.jasperreport.locale.language

Язык, для которого осуществляется генерация документов с помощью движка шаблона JasperReports

ru

1.4

dcgn.docgen-service.jasperreport.locale.region

Регион, для которого осуществляется генерация документов с помощью движка шаблона JasperReports

RU

1.4

dcgn.docgen-service.dcgn.cache.asyncAutoInvalidationScheduleSeconds

Периодичность запросов на состояние шаблонов в реестре в секундах

10

1.5

Параметр, добавляющий аргументы запуска приложения через JVM-переменную JAVA_OPTS

dcgn.docgen-service.ose.configmap.javaArguments

Параметр, добавляющий аргументы запуска приложения через JVM-переменную JAVA_OPTS

-XX:+UseContainerSupport -XX:MaxRAMPercentage=50.0 -XX:InitialRAMPercentage=25.0 -XX:G1HeapRegionSize=4m

1.0

Параметры web

dcgn.docgen-service.server.tomcat.max-threads

Максимальное количество потоков приложения, выделенных для обработки входящих запросов

200

1.0

dcgn.docgen-service.server.tomcat.min-spare-threads

Минимальное количество потоков приложения, выделенных для обработки запросов

10

1.0

dcgn.docgen-service.server.graceful-shutdown-timeout

Максимальное время ожидания завершения входящих запросов при получении сигнала о завершении работы

Формат:
- h — часы;
- m — минуты;
- s — секунды;
- ms — миллисекунды

20s

1.0

dcgn.docgen-service.server.max-http-header-size

Максимально допустимая длина HTTP-заголовков

Тип org.springframework.util.unit.DataSize. Формат:
- B — байты;
- KB — килобайты;
- MB — мегабайты;
- GB — гигабайты;
- TB — терабайты

1.1

dcgn.docgen-service.server.tomcat.mbeanregistry.enabled

Флаг включения метрик Tomcat

true, false

true

1.1

Параметры фильтра очереди запросов

dcgn.docgen-service.dcgn.requestsQueue.enabled

Флаг включения фильтра очереди запросов

true, false

true

1.4

dcgn.docgen-service.dcgn.requestsQueue.maxProcessingRequestsCount

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

Положительное целое число

8

1.4

dcgn.docgen-service.dcgn.requestsQueue.requestTimeout

Таймаут запроса

Миллисекунды. Клиент (istio) опционально должен выставить заголовок вида «x-start-time: 2023-02-15T09:27:44.394Z». Он будет использован, как точка отсчета.

1.4

dcgn.docgen-service.dcgn.requestsQueue.requestsCountLogging

Логирование счетчика запросов (используется для отладки)

true, false

false

1.4

Параметры работы с PACMAN (CFGA) в окружении Platform V Frontend Std

dcgn.docgen-service.ufs.platform.config.enabled

Признак включения работы с конфигурацией PACMAN (CFGA)

true, false

1.4

dcgn.docgen-service.ufs.platform.config.agent.disabled

Признак выключения агента интеграции с компонентом Управление параметрами

true, false

1.4

Параметры для подключения дополнительных шрифтов

dcgn.docgen-service.dcgn.customFonts.enabled

Признак включения дополнительных шрифтов

true, false

true

1.4.5

dcgn.docgen-service.dcgn.customFonts.lookup.fonts.in.repo

Признак поиска дополнительных шрифтов в репозитории конфигурации компонента

true, false

true

1.4.5

dcgn.docgen-service.dcgn.customFonts.fineTune.enabled

Признак включения настройки дополнительных шрифтов

true, false

false

1.4.5

dcgn.docgen-service.dcgn.customFonts.fineTune.fontFamilies

Список дополнительных семейств шрифтов

1.4.5

dcgn.docgen-service.dcgn.customFonts.fineTune.fontFilesPaths

Список путей до файлов дополнительных шрифтов

1.4.5

Параметр подключения перемаршрутизации трафика LPTE

dcgn.docgen-service.iag.reroute.from.lpte

Признак включения перемаршрутизации трафика LPTE

true, false

true

1.4.5

Валидация параметров при рендеринге шаблонов

dcgn.docgen-service.dcgn.parametersValidationMode

Тип валидации при рендеринге шаблонов

STRICT (запрет рендеринга при ошибке), PERMISSIVE (разрешение рендеринга и запись в лог), NONE (без проверки)

STRICT

1.4.5

Настройки для template-provider#

Расположение на среде - репозиторий конфигурации компонента, файл conf/config/parameters/dcgn.template-provider.conf

Наименование параметра в файле конфигурирования

Описание параметра

Ограничения

Значение по умолчанию или глобальные параметры при установке Deploy tools

Версия ПО

dcgn.template-provider.management.server.port

Порт для служебных запросов получения состояния работы приложения

8081

1.0

dcgn.template-provider.dcgn.health.status.refresh.fixed-delay.ms

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

5000

1.0

dcgn.template-provider.rn

Ресурс проекта (resourceName), из которого работает приложение

1.0

dcgn.template-provider.dcgn.cache.updateRequestTimeoutMs

Максимально допустимое время жизни запроса в Template Provider о состоянии шаблонов для инвалидации шаблона в кэше

10000

1.5

dcgn.template-provider.dcgn.cache.asyncAutoInvalidationScheduleSeconds

Периодичность ответа на запрос о состоянии шаблонов в реестре в секундах

10

1.5

Параметр, добавляющий аргументы запуска приложения через JVM переменную JAVA_OPTS

dcgn.template-provider.ose.configmap.javaArguments

Параметр, добавляющий аргументы запуска приложения через JVM-переменную JAVA_OPTS

-XX:+UseContainerSupport -XX:MaxRAMPercentage=50.0 -XX:InitialRAMPercentage=25.0 -XX:G1HeapRegionSize=4m

1.0

web

dcgn.template-provider.server.tomcat.max-threads

Максимальное количество потоков приложения, выделенных для обработки входящих запросов

200

1.0

dcgn.template-provider.server.tomcat.min-spare-threads

Минимальное количество потоков приложения, выделенных для обработки запросов

10

1.0

dcgn.template-provider.server.graceful-shutdown-timeout

Максимальное время ожидания завершения входящих запросов при получении сигнала о завершении работы

Формат:
- h — часы;
- m — минуты;
- s — секунды;
- ms — миллисекунды

20s

1.0

dcgn.template-provider.server.max-http-header-size

Максимально допустимая длина HTTP-заголовков

Тип org.springframework.util.unit.DataSize. Формат:- B — байты;- KB — килобайты;- MB — мегабайты;- GB — гигабайты;- TB — терабайты

1.1

dcgn.template-provider.spring.datasource.hikari.maximum-pool-size

Максимальный размер pool (количество) соединений с БД

20

1.3

dcgn.template-provider.server.tomcat.mbeanregistry.enabled

Флаг включения метрик Tomcat

true, false

true

1.1

Параметры работы с PACMAN (CFGA) в окружении Platform V Frontend Std

dcgn.template-provider.ufs.platform.config.enabled

Признак включения работы с конфигурацией компонента PACMAN (CFGA)

true, false

1.4

dcgn.template-provider.ufs.platform.config.agent.disabled

Признак выключения агента интеграции с компонентом PACMAN (CFGA)

true, false

1.4

Настройки для template-registry#

Расположение на среде - репозиторий конфигурации компонента, файл conf/config/parameters/dcgn.template-registry.conf

Наименование параметра в файле конфигурирования

Описание параметра

Ограничения

Значение по умолчанию или глобальные параметры при установке Deploy tools

Версия ПО

dcgn.template-registry.spring.servlet.multipart.max-request-size

Максимальный размер, разрешенный для загружаемых файлов. Необязательная конфигурация. Если конфигурация не выставлена, будет использовано значение по умолчанию — 2GB

Тип org.springframework.util.unit.DataSize. Формат:
- B — байты;
- KB — килобайты;
- MB — мегабайты;
- GB — гигабайты;
- TB — терабайты

2GB

1.0.1

dcgn.template-registry.spring.servlet.multipart.max-file-size

Максимальный размер, разрешенный для запроса данных из нескольких частей/форм. Необязательная конфигурация. Если конфигурация не выставлена, будет использовано значение по умолчанию — 2GB

Тип org.springframework.util.unit.DataSize. Формат:
- B — байты;
- KB — килобайты;
- MB — мегабайты;
- GB — гигабайты;
- TB — терабайты

2GB

1.0.1

dcgn.template-registry.management.server.port

Порт для служебных запросов получения состояния работы приложения

8081

1.0

dcgn.template-registry.dcgn.health.status.refresh.fixed-delay.ms

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

5000

1.0

dcgn.template-registry.dcgn.template.size.calculate.fixed-delay.sec

Периодичность расчета общего объема шаблона с ресурсами в секундах. Используется для метрики билинга dcgn_template_registry_templates_size_bytes. Расписание расчета задается администратором сервиса согласно требованиям заказчика к биллингу

Значение указывается в секундх. Чтобы отключить расчет необходимо указать 0.

21600

1.3

dcgn.template-registry.dcgn.validation.templateCodeRegexp

Регулярное выражение для валидации переданных идентификаторов (templateCode) при импорте

^[a-zA-Z0-9_-]+$

1.0

dcgn.template-registry.dcgn.validation.versionCodeRegexp

Регулярное выражение для валидации переданных идентификаторов (versionCode) при импорте

^[a-zA-Z0-9_-]+$

1.0

dcgn.template-registry.dcgn.validation.resourceNameRegexp

Регулярное выражение для валидации переданного RN при импорте

^[a-zA-Z0-9_:-]+$

1.0

dcgn.template-registry.dcgn.validation.basisToImportRegexp

Регулярное выражение для валидации основания импорта архива

^.+$

1.0

dcgn.template-registry.rn

Ресурс проекта (resourceName, тенант), из которого работает приложение

platformv:admin:1

1.0

dcgn.template-registry.subject

CN (common name) SSL-сертификата

1.0

dcgn.template-registry.dcgn.ui.standalone

Флаг размещения UI в автономном режиме (без интеграции с компонентом Self-service Portal (SSPL) продукта Platform V Self-service Portal (SSP) или компонентом Стартовый менеджер (SMGX) продукта Platform V Starting Manage (SMG):
- false — размещение во вложенном фрейме. В таком режиме не будут отображены некоторые элементы (в текущей версии ПО — это кнопка Выход из системы), т. к. эти элементы уже есть в компоненте SSPL и SMGX;
- true — автономное размещение, в таком режиме будут доступна кнопка Выход из системы

Возможные значения: true, false

true

1.0.1

dcgn.template-registry.dcgn.ui.logoutUrl

Cсылка на выход из системы. Нужно указывать полный путь от корня пути. Используется на UI для формирования кнопки Выход из системы (протокол://хост:порт/параметр).

1.0.1

Параметр, добавляющий аргументы запуска приложения через JVM переменную JAVA_OPTS

dcgn.template-registry.ose.configmap.javaArguments

Параметр, добавляющий аргументы запуска приложения через JVM-переменную JAVA_OPTS

-XX:+UseContainerSupport -XX:MaxRAMPercentage=50.0 -XX:InitialRAMPercentage=25.0 -XX:G1HeapRegionSize=4m

1.0

web

dcgn.template-registry.server.tomcat.max-threads

Максимальное количество потоков приложения, выделенных для обработки входящих запросов

200

1.0

dcgn.template-registry.server.tomcat.min-spare-threads

Минимальное количество потоков приложения, выделенных для обработки запросов

10

1.0

dcgn.template-registry.server.tomcat.mbeanregistry.enabled

Включить метрики Tomcat из JMX

true

1.4.1

dcgn.template-registry.server.graceful-shutdown-timeout

Максимальное время ожидания завершения входящих запросов при получении сигнала о завершении работы

Формат:
- h — часы;
- m — минуты;
- s — секунды;
- ms — миллисекунды

20s

1.0

dcgn.template-registry.server.max-http-header-size

Максимально допустимая длина HTTP-заголовков

Тип org.springframework.util.unit.DataSize. Формат:- B — байты;- KB — килобайты;- MB — мегабайты;- GB — гигабайты;- TB — терабайты

1.1

dcgn.template-registry.spring.datasource.hikari.maximum-pool-size

Максимальный размер pool (количество) соединений с БД

20

1.3

Подтверждение операций *

dcgn.template-registry.kvr.enabled

Признак активности функционала подтверждения операций

false

1.4

dcgn.template-registry.kvr.baseUrl

Базовый URL компонента AUTZ

/autz-policy-manager/autz

1.4

dcgn.template-registry.kvr.resource

Ресурс в ОСА

RN:SBRF:DCGN::::

1.4

dcgn.template-registry.kvr.taskTimeoutHours

Таймаут ожидания подтверждения задачи.

Значение указывается в часах

36

1.4

dcgn.template-registry.kvr.tasksSyncRate

Период запуска опроса состояния задач подтверждения из компонента AUTZ в Реестр шаблонов DCGN

Формат: миллисекунды без постфикса или секунды, минуты, часы с постфиксом s, m, h

30s

1.4

Параметры работы с PACMAN в окружении Platform V Frontend Std

dcgn.template-registry.ufs.platform.config.enabled

Признак включения работы с конфигурацией компонента PACMAN (CFGA)

true, false

1.4

dcgn.template-registry.ufs.platform.config.agent.disabled

Признак выключения агента интеграции с компонентом PACMAN (CFGA)

true, false

1.4

Режим stand-in в окружении Platform V Frontend Std

dcgn.template-registry.ufs.standin.enabled

Признак включения синхронизации статуса stand-in

true, false

true

1.4.2

dcgn.template-registry.ufs.standin.syncPeriod

Периодичность синхронизации статуса stand-in

Формат: миллисекунды без постфикса или секунды, минуты, часы с постфиксом s, m, h

30s

1.4.2

Настройки для ufs-adapter#

Наименование параметра в файле конфигурирования

Описание параметра

Ограничения

Значение по умолчанию или глобальные параметры при установке Deploy tools

Версия ПО

dcgn.ufs-adapter.rn

Ресурс проекта (resourceName), из которого работает приложение

1.4

dcgn.ufs-adapter.management.server.port

Порт для служебных запросов получения состояния работы приложения

8081

1.4

Параметр, добавляющий аргументы запуска приложения через JVM переменную JAVA_OPTS

dcgn.ufs-adapter.ose.configmap.javaArguments

-XX:+UseContainerSupport -XX:MaxRAMPercentage=50.0 -XX:InitialRAMPercentage=25.0 -XX:G1HeapRegionSize

4m

1.4

web

dcgn.ufs-adapter.server.tomcat.max-threads

Максимальное количество потоков приложения, выделенных для обработки входящих запросов

200

1.4

dcgn.ufs-adapter.server.tomcat.min-spare-threads

Минимальное количество потоков приложения, выделенных для обработки запросов

10

1.4

dcgn.ufs-adapter.server.graceful-shutdown-timeout

Максимальное время ожидания завершения входящих запросов при получении сигнала о завершении работы

20s

1.4

dcgn.ufs-adapter.server.max-http-header-size

Максимально допустимая длина HTTP-заголовков

1.4

dcgn.ufs-adapter.server.tomcat.mbeanregistry.enabled

true

1.4

UNIMON

dcgn.ufs-adapter.unimonId

Идентификатор подключения к Объединенному мониторингу Unimon. Можно получить при создании подключения к Объединенному мониторингу Unimon. Подробнее смотрите документацию «Platform V Monitor»

Не установлен (пусто)

1.4