Конфигурация в окружении продукта Platform V Backend#

Для окружения продукта Platform V Backend (#BD) поддерживается только целевой алгоритм определения billedResourceName из запроса (подробнее о billedResourceName читайте в разделе Метки метрик документа «Руководство по системному администрированию»).

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

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

Наименование параметра

Описание

Значение по умолчанию или глобальные параметры при установке посредством программного компонента Deploy Tools (CDJE) продукта Platform V DevOps Tools (DOT)

Версия ПО

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

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

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

"overrides": ["openshift"]

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

"overrides": []

Настройки для Docgen Service#

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

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

Описание

Ограничения

Значение по умолчанию или глобальные параметры при установке посредством программного компонента Deploy Tools (CDJE) продукта Platform V DevOps Tools (DOT)

Версия ПО

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

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

1000

1.0

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

Template Provider URL

http://dcgn-svc-template-provider-{{ lookup('custom_vars', 'distrib.release.version') }}:8080

1.0

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

Template Provider URL healthcheck endpoint

http://dcgn-svc-template-provider-{{ lookup('custom_vars', 'distrib.release.version') }}: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.cache.asyncAutoInvalidationScheduleSeconds

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

10

1.5

dcgn.docgen-service.dcgn.fillingTemplateTimeoutInMillis

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

60000

1.0

dcgn.docgen-service.rn

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

{{ lookup('custom_vars', 'dcgn.all.rn', default='platformv:core:1') }}

1.0

dcgn.docgen-service.jasperreport.locale.language

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

ru

1.4

dcgn.docgen-service.management.server.port

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

8081

1.0

dcgn.docgen-service.log.level

Уровень логирования сервиса

warn

1.4

dcgn.docgen-service.jasperreport.locale.region

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

RU

1.4

dcgn.docgen-service.dcgn.cache.reopeningTimeoutSeconds

Как часто идет проверка, что соединение по типу emitter открыто, в секундах

10

4.0.0

dcgn.docgen-service.root.log.level

Корневой уровень логирования

error

1.4

dcgn.docgen-service.dcgn.cache.listenerType

Тип соединение с провайдером, для обновления кеша

- emitter — обрабатывает сообщения об измененных шаблонах как только они поступают, при этом соединение держится открытым как можно дольше и по нему может приходить сколько угодно событий;
- poller — проверяет ответ каждые N секунд, и если есть ответ — соединение закрывается

emitter

4.0.0

dcgn.docgen-service.platform.http.timeout

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

10000

4.0.0

dcgn.docgen-service.platform.http.timeout.thread.count

Количество потоков для обработки тайм-аутов HTTP-запроса

3

4.0.0

dcgn.docgen-service.ose.deployment.spec.template.spec.priorityClassName

Имя класса приоритета

Пустое значение или имя объекта PriorityClass

{{ lookup('custom_vars', 'global.ose.deployment.spec.template.spec.priorityClassName', default='') }}

4.0.0

dcgn.docgen-service.dcgn.usingPrecompiledTemplate

Использовать прекомпилированные шаблоны при рендеринге

true, false

false

4.0.0

Параметр, добавляющий аргументы запуска приложения через 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 — терабайты

{{ lookup('custom_vars', 'global.server.max-http-header-size', default='32KB') }}

1.1

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

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

true, false

true

1.1

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

dcgn.docgen-service.dcgn.requestsQueue.enabled

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

true, false

false

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». Он будет использован, как точка отсчета

{{ lookup('custom_vars', 'dcgn.docgen-service.ingress.ose.vs.spec.http.retries.perTryTimeout') }}

1.4

dcgn.docgen-service.dcgn.requestsQueue.requestsCountLogging

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

true, false

false

1.4

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

dcgn.docgen-service.dcgn.customFonts.enabled

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

true, false

true

1.5

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

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

true, false

true

3.0.0.0

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

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

true, false

false

1.5

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

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

1.5

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

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

1.5

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

dcgn.docgen-service.dcgn.parametersValidationMode

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

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

STRICT

2.0.4

Настройки для Template Provider#

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

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

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

Ограничения

Значение по умолчанию или глобальные параметры при установке посредством программного компонента Deploy Tools (CDJE) продукта Platform V DevOps Tools (DOT)

Версия ПО

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), из которого работает приложение

{{ lookup('custom_vars', 'dcgn.all.rn', default='platformv:core:1') }}

1.0

dcgn.template-provider.log.level

Уровень логирования сервиса

warn

1.4

dcgn.template-provider.root.log.level

Уровень логирования для всех логов сервиса

error

1.4

dcgn.template-provider.dcgn.cache.updateRequestTimeoutMs

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

10000

1.5

dcgn.template-provider.dcgn.cache.asyncAutoInvalidationScheduleSeconds

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

10

1.5

dcgn.template-provider.dcgn.cache.invalidationThreshold

После скольки измененных шаблонов за период должно быть событие полной очистки кеша

Работает для dcgn.docgen-service.dcgn.cache.listenerType=emitter

50

4.0.0

dcgn.template-provider.platform.http.timeout

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

10000

4.0.0

dcgn.template-provider.platform.http.timeout.thread.count

Количество потоков для обработки тайм-аутов HTTP-запроса

3

4.0.0

dcgn.template-provider.ose.deployment.spec.template.spec.priorityClassName

Имя класса приоритета

Пустое значение или имя объекта PriorityClass

{{ lookup('custom_vars', 'global.ose.deployment.spec.template.spec.priorityClassName', default='') }}

4.0.0

Параметр, добавляющий аргументы запуска приложения через 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 — терабайты

{{ lookup('custom_vars', 'global.server.max-http-header-size', default='32KB') }}

1.1

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

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

true, false

true

1.1

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

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

20

1.3

Настройки для Template Registry#

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

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

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

Ограничения

Значение по умолчанию или глобальные параметры при установке посредством программного компонента Deploy Tools (CDJE) продукта Platform V DevOps Tools (DOT)

Версия ПО

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

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

\^\[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-сертификата

{{ lookup('custom_vars', 'dcgn.template-registry.rn') }}

1.0

dcgn.template-registry.dcgn.ui.standalone

Флаг размещения UI в автономном режиме

Для окружения продукта Platform V Backend (#BD) должен быть true

true

1.0.1

dcgn.template-registry.dcgn.ui.logoutUrl

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

{{ lookup('custom_vars', 'global.ufs.logout.url', default='/openid-connect-auth/logout') }}

1.0.1

dcgn.template-registry.log.level

Уровень логирования сервиса

warn

1.4

dcgn.template-registry.root.log.level

Корневой уровень логирования

error

1.4

dcgn.template-registry.platform.http.timeout

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

10000

4.0.0

dcgn.template-registry.platform.http.timeout.thread.count

Количество потоков для обработки таймаутов HTTP-запроса

3

4.0.0

dcgn.template-registry.ose.deployment.spec.template.spec.priorityClassName

Имя класса приоритета

Пустое значение или имя объекта PriorityClass

{{ lookup('custom_vars', 'global.ose.deployment.spec.template.spec.priorityClassName', default='') }}

4.0.0

dcgn.template-registry.dcgn.template.compilation.enabled

Компилировать шаблоны при импорте

- true — при импорте шаблонов выполняется компиляция шаблонов, при этом во время миграции шаблонов из LPTE в DCGN компиляция не выполняется;
- false — при импорте шаблонов компилиция шаблонов не выполняется

false

4.0.0

dcgn.template-registry.dcgn.template.compilation.jobEnabled

Фоновая компиляция шаблонов

- true — выполняется фоновая компиляция шаблонов;
- false — фоновая компиляция шаблонов не выполняется

false

4.0.0

dcgn.template-registry.dcgn.template.compilation.jobPeriod

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

10m

4.0.0

Параметр, добавляющий аргументы запуска приложения через 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.0

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 — терабайты

{{ lookup('custom_vars', 'global.server.max-http-header-size', default='32KB') }}

1.1

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

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

20

1.3