Руководство по системному администрированию#

Сценарии администрирования#

Обновление#

Процесс по обновлению компонента Динамический контент (UFTM) продукта Platform V Content Management (SDC) (далее — компонент UFTM) описан в одноименном разделе документа «Руководство по установке».

Откат#

Процесс по откату компонента UFTM к предыдущей версии описан в одноименном разделе документа «Руководство по установке».

Управление ключами и сертификатами#

Управление ключами и сертификатами с помощью системы управления секретами#

Для использования системы управления секретами на этапе установки компонента необходимо:

  • включить интеграцию с системой управления секретами;

  • создать и настроить Secrets Engines;

  • настроить параметры интеграции с системой управления секретами.

Список параметров для интеграции с системой управления секретами перечислен в разделе «Параметры интеграции с системой управления секретами»

Хранение ключей и сертификатов#

  1. Ключи и сертификаты хранятся в репозитории с конфигурацией стенда (common-репозиторий) в виде JKS-хранилищ.

  2. Расположение хранилищ в common-репозитории указывается в следующих параметрах:

  3. ssl.ose.istio.keyStore.egress.KeyStoreFromFile — относительный путь до хранилища Egress.

  4. ufs-dynamic-content.k8s.istio.egress.secret.cms.kafka.certs.keystore.file-path — относительный путь до хранилища сертификатов Kafka внешней CMS.

  5. ufs-dynamic-content.k8s.istio.egress.secret.kafka.certs.keystore.file-path — относительный путь до хранилища сертификатов Kafka компонентов Журналирование (LOGA), Аудит (AUDT), Объединенный мониторинг Unimon (MONA).

  6. Для работы с ключами и сертификатами используется утилита keytool, которая входит в состав JDK.

Выпуск и импорт сертификатов в хранилище#

Выпуск и импорт сертификатов в хранилище осуществляется средствами компонента Deploy tools (CDJE) продукта Platform V DevOps Tools (DOT).

Для выпуска и добавления сертификатов выполнить следующие действия:

  1. Сгенерировать ключевую пару:

    keytool -genkey -keyalg EC -sigalg SHA256withECDSA -keystore ${keystore_file_path} -storetype JKS -keysize 256 -dname "CN=${certificate_alias}" -alias ${certificate_alias}

  2. Создать запрос на выпуск сертификата:

    keytool -certreq -keyalg EC -sigalg SHA256withECDSA -keystore ${keystore_file_path} -storetype JKS -alias ${certificate_alias} > ${certificate_alias}_cert_req.pem

  3. Отправить запрос на выпуск сертификата в удостоверяющий центр.

  4. Получить выпущенный сертификат и сертификат удостоверяющего центра.

  5. Импортировать сертификат удостоверяющего центра:

    keytool -import -keystore ${keystore_file_path} -storetype JKS -file ${ca_certificate_file_path} -alias ${ca_certificate_alias}

  6. Импортировать выпущенный сертификат:

    keytool -import -keystore ${keystore_file_path} -storetype JKS -file ${certificate_file_path} -alias ${certificate_alias}

, где:

  • ${keystore_file_path} - путь к хранилищу сертификатов;

  • ${ca_certificate_file_path} - путь к сертификату удостоверяющего центра;

  • ${ca_certificate_alias} - alias сертификата удостоверяющего центра;

  • ${certificate_file_path} - путь к выпущенному сертификату;

  • ${certificate_alias} - alias выпущенного сертификата.

Создание TrustStore Key-Value (KV) хранилища#

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

Для получения сертификатов проверьте наличие KV-хранилища. В случае отсутствия такого хранилища, создайте его и назовите TrustStore.

Путь к хранилищу может быть указан следующим образом: DEV/A/IFT/SK/DICT/UFTM/KV/truststore.

Когда хранилище будет создано, укажите в нем все необходимые поля, например:

  • truststore_cer;

  • truststore_jks;

  • truststore_jks_pass;

  • truststore_pem.

После создания полей заполните хранилище сертификатами соответствующих форматов:

  • для БД используется truststore_cer;

  • для компонентов MONA, LOGA внутри КМ ОТТS используются truststore_jks и truststore_jks_pass;

  • для Kafka используется truststore_pem.

Таким образом, сертификаты разных удостоверяющих центров могут быть заполнены в заданном формате, что позволяет UFTM работать с двумя и более удостоверяющими центрами.

Использование KV-механизма для наполнения TrustStore предоставляет эффективное и надежное управление сертификатами удостоверяющих центров. Это особенно полезно в случае, если администратор инсталляции продукта Platform V не контролирует удостоверяющие центры.

Общие рекомендации по работе с сертификатами#

  1. Сертификат должен быть подписан только удостоверяющим центром.

  2. Сертификат должен принадлежать конкретной функциональной подсистеме (нельзя использовать один и тот же сертификат для функционирования разных подсистем в рамках одной инсталляции Platform V).

  3. Сертификат должен быть действительным на текущую дату.

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

  5. Закрытый ключ не должен распространяться по каналам связи и должен иметь стойкий пароль.

Проверка подлинности сертификатов#

Для проверки подлинности сертификатов выполнить следующую команду:

keytool -v -list -keystore ${keystore_file_path} | awk '/Owner:|Issuer:|Valid from/'

, где ${keystore_file_path} - путь к хранилищу сертификатов.

Вывод содержит следующую информацию по сертификатам:

  • Owner: – владелец сертификата. CN должен соответствовать значению, указанному в запросе на выпуск сертификата.

  • Issuer: – удостоверяющий центр, выпустивший сертификат. CN должен соответствовать удостоверяющему центру.

  • Valid from: – период действия сертификата. Сертификат должен быть действительным на текущую дату.

Конфигурирование#

Параметры Istio#

Пути монтирования Secrets:

Название

Значение по умолчанию

Конфигурационный файл

ufs-dynamic-content.k8s.istio.egress.common.logger.kafka.certs.mount-path

/etc/istio/logger/ssl

ufsdyncontent.istio.all.conf

ufs-dynamic-content.k8s.istio.egress.common.monitoring.kafka.certs.mount-path

/etc/istio/monitoring/ssl

ufsdyncontent.istio.all.conf

ufs-dynamic-content.k8s.istio.egress.common.ufs-audit.kafka.certs.mount-path

/etc/istio/ufs-audit/ssl

ufsdyncontent.istio.all.conf

ufs-dynamic-content.k8s.istio.egress.common.union-audit.kafka.certs.mount-path

/etc/istio/union-audit/ssl

ufsdyncontent.istio.all.conf

ufs-dynamic-content.k8s.istio.egress.common.cms.kafka.certs.mount-path

/etc/istio/cms/ssl

ufsdyncontent.istio.all.conf

ufs-dynamic-content.k8s.istio.egress.common.egressgateway-certs.mount-path

/etc/istio/egressgateway-certs

ufsdyncontent.istio.all.conf

ufs-dynamic-content.k8s.istio.egress.common.egressgateway-certs.ca.file-name

root.crt

ufsdyncontent.istio.all.conf

ufs-dynamic-content.k8s.istio.egress.common.egressgateway-certs.certificate.file-name

tls.crt

ufsdyncontent.istio.all.conf

ufs-dynamic-content.k8s.istio.egress.common.egressgateway-certs.private-key.file-name

tls.key

ufsdyncontent.istio.all.conf

ufs-dynamic-content.k8s.istio.ingress.common.ingressgateway-certs.mount-path

/etc/istio/ingressgateway-certs

ufsdyncontent.istio.all.conf

ufs-dynamic-content.k8s.istio.ingress.common.ingressgateway-certs.ca.file-name

root.crt

ufsdyncontent.istio.all.conf

ufs-dynamic-content.k8s.istio.ingress.common.ingressgateway-certs.certificate.file-name

tls.crt

ufsdyncontent.istio.all.conf

ufs-dynamic-content.ose.istio.control-plane-project

${global.multiClusters.openshiftControlPlaneProject}

ufsdyncontent.istio.all.conf

ufs-dynamic-content.ose.istio.control-plane-istiod-service

${global.multiClusters.openshiftControlPlaneIstiodService}

ufsdyncontent.istio.all.conf

ufs-dynamic-content.ose.istio.control-plane-istiod-port

${global.multiClusters.openshiftControlPlaneIstiodPort}

ufsdyncontent.istio.all.conf

ufs-dynamic-content.ose.istio.control-plane-jaeger-service

${global.multiClusters.openshiftControlPlaneJaegerService}

ufsdyncontent.istio.all.conf

ufs-dynamic-content.ose.istio.control-plane-jaeger-port

${global.multiClusters.openshiftControlPlaneJaegerPort}

ufsdyncontent.istio.all.conf

ufs-dynamic-content.ose.istio.egress.deployment.spec.replicas

ufsdyncontent.istio.all.conf

ufs-dynamic-content.ose.istio.ingress.deployment.spec.replicas

1

ufsdyncontent.istio.all.conf

ufs-dynamic-content.ose.istio.egress.deployment.spec.template.spec.containers.istio-proxy.resources.limits.cpu

200m

ufsdyncontent.istio.all.conf

ufs-dynamic-content.ose.istio.egress.deployment.spec.template.spec.containers.istio-proxy.resources.limits.memory

512Mi

ufsdyncontent.istio.all.conf

ufs-dynamic-content.ose.istio.egress.deployment.spec.template.spec.containers.istio-proxy.resources.limits.ephemeral-storage

${global.ose.deployment.spec.template.spec.containers.resources.limits.ephemeral-storage2048Mi}

ufsdyncontent.istio.all.conf

ufs-dynamic-content.ose.istio.egress.deployment.spec.template.spec.containers.istio-proxy.resources.requests.cpu

100m

ufsdyncontent.istio.all.conf

ufs-dynamic-content.ose.istio.egress.deployment.spec.template.spec.containers.istio-proxy.resources.requests.memory

256Mi

ufsdyncontent.istio.all.conf

ufs-dynamic-content.ose.istio.ingress.deployment.spec.template.spec.containers.istio-proxy.resources.limits.cpu

450m

ufsdyncontent.istio.all.conf

ufs-dynamic-content.ose.istio.ingress.deployment.spec.template.spec.containers.istio-proxy.resources.limits.memory

800Mi

ufsdyncontent.istio.all.conf

ufs-dynamic-content.ose.istio.ingress.deployment.spec.template.spec.containers.istio-proxy.resources.limits.ephemeral-storage

${global.ose.deployment.spec.template.spec.containers.resources.limits.ephemeral-storage2048Mi}

ufsdyncontent.istio.all.conf

ufs-dynamic-content.ose.istio.ingress.deployment.spec.template.spec.containers.istio-proxy.resources.requests.cpu

350m

ufsdyncontent.istio.all.conf

ufs-dynamic-content.ose.istio.ingress.deployment.spec.template.spec.containers.istio-proxy.resources.requests.memory

600Mi

ufsdyncontent.istio.all.conf

ufs-dynamic-content.ose.istio.ingress.route.spec.host.https.appFQDN

ufs-dynamic-content-${global.multiClusters.openshiftNewRoute}

ufsdyncontent.istio.all.conf

ufs-dynamic-content.ose.istio.egress.common.internal-port

${global.ose.platform.egress.http.port}

ufsdyncontent.istio.all.conf

ufs-dynamic-content.ose.istio.egress.common.db.internal-port

7074

ufsdyncontent.istio.all.conf

ufs-dynamic-content.ose.istio.ingress.common.internal-port

11443

ufsdyncontent.istio.all.conf

ufs-dynamic-content.ose.istio.ingress.envoy_filter.regex_match.client.cn

${global.ufs.istio.ingress.envoy_filter.regex_match.client.cn}

ufsdyncontent.istio.all.conf

Параметры сервера приложений#

Параметры в репозитории с конфигурацией компонента:

Название

Описание

Значение по умолчанию

Конфигурационный файл

ufs-dynamic-content.server.max-http-header-size

Максимальный размер заголовка HTTP-запроса

ufsdyncontent.all.conf

Параметры интеграции с СУБД#

Параметры в репозитории с конфигурацией стенда (common-репозитории):

Название

Описание

Значение по умолчанию

Конфигурационный файл

jdbc.uftm_postgres.url

URL подключения к БД. URL должен содержать адрес одного сервера БД в формате "IP-адрес:порт"

_global.jdbc.conf

jdbc.liquibase_postgres.user

Имя пользователя БД для выполнения liquibase-скриптов

Имя пользователя БД, который обладает всем набором прав на изменение схемы БД

_passwords.conf

jdbc.liquibase_postgres.password

Пароль пользователя БД, имя которого указано в параметре jdbc.liquibase_postgres.user

Пароль пользователя БД, который обладает всем набором прав на изменение схемы БД

_passwords.conf

DB_SCHEMA_SUFFIX

Суффикс имени схемы БД

Суффикс имени схемы БД, например, имя блока или контура, на который устанавливается компонент

common.conf.yml

jdbc.uftm_postgres.user

Имя пользователя БД для взаимодействия со схемой БД из компонента

Имя пользователя БД, который обладает набором прав для взаимодействия со схемой БД

_passwords.conf

jdbc.uftm_postgres.password

Пароль пользователя БД, имя которого указано в параметре jdbc.uftm_postgres.user

Пароль пользователя БД, который обладает набором прав для взаимодействия со схемой БД

_passwords.conf

Параметры в репозитории с конфигурацией компонента:

Название

Описание

Значение по умолчанию

Конфигурационный файл

ufs-dynamic-content.postgresql.spring.datasource.hikari.jdbc-url

URL подключения к БД. URL должен содержать адрес одного сервера БД в формате «IP-адрес:порт»

${jdbc.uftm_postgres.url}

ufsdyncontent.all.conf

ufs-dynamic-content.postgresql.spring.datasource.enabled

Вкл./выкл. DataSource

true

ufsdyncontent.all.conf

ufs-dynamic-content.postgresql.spring.datasource.hikari.maximum-pool-size

Параметр для управления максимальным размером, который может достигать пул

${global.jdbc.spring.datasource.hikari.maximum-pool-size}

ufsdyncontent.all.conf

ufs-dynamic-content.postgresql.spring.datasource.hikari.minimum-idle

Параметр, контролирующий минимальное количество незанятых соединений, которое HikariCP пытается поддерживать в пуле

${global.jdbc.spring.datasource.hikari.minimum-idle}

ufsdyncontent.all.conf

ufs-dynamic-content.postgresql.spring.datasource.hikari.connection-timeout

Таймаут, в течение которого клиент будет ждать соединения из пула

${global.jdbc.spring.datasource.hikari.connection-timeout}

ufsdyncontent.all.conf

ufs-dynamic-content.postgresql.spring.datasource.hikari.validation-timeout

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

${global.jdbc.spring.datasource.hikari.validation-timeout}

ufsdyncontent.all.conf

ufs-dynamic-content.postgresql.spring.datasource.hikari.max-lifetime

Параметр, контролирующий максимальное время жизни соединения в пуле

${global.jdbc.spring.datasource.hikari.max-lifetime}

ufsdyncontent.all.conf

ufs-dynamic-content.postgresql.spring.datasource.hikari.idle-timeout

Параметр, определяющий максимальное количество времени (в миллисекундах), в течение которого соединение может простаивать в пуле

${global.jdbc.spring.datasource.hikari.idle-timeout}

ufsdyncontent.all.conf

ufs-dynamic-content.postgresql.spring.datasource.hikari.connection-test-query

SQL-запрос, который нужно выполнить, чтобы проверить правильность подключений

${global.jdbc.spring.datasource.hikari.connection-test-query}

ufsdyncontent.all.conf

ufs-dynamic-content.postgresql.spring.datasource.hikari.leak-detection-threshold

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

${global.jdbc.spring.datasource.hikari.leak-detection-threshold}

ufsdyncontent.all.conf

ufs-dynamic-content.postgresql.spring.datasource.hikari.initializationFailTimeout

Таймаут сбоя инициализации пула

${global.jdbc.spring.datasource.hikari.initializationFailTimeout}

ufsdyncontent.all.conf

ufs-dynamic-content.postgresql.spring.datasource.hikari.data-source-properties.socketTimeout

Время, в течение которого SQL-запрос пользователя должен выполниться

${global.jdbc.postgres.spring.datasource.hikari.data-source-properties.socketTimeout}

ufsdyncontent.all.conf

ufs-dynamic-content.postgresql.spring.datasource.hikari.connection-init-sql

SQL-выражение, которое будет выполняться для всех новых подключений при их создании, прежде чем они будут добавлены в пул

${global.jdbc.postgresql.spring.datasource.hikari.connection-init-sql}

ufsdyncontent.all.conf

ufs-dynamic-content.postgresql.spring.datasource.hikari.driver-class-name

Наименование класса драйверов

${global.jdbc.postgresql.spring.datasource.driver-class-name}

ufsdyncontent.all.conf

ufs-dynamic-content.postgresql.spring.datasource.hikari.schema

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

uftm{{ DB_SCHEMA_SUFFIX lower }}

ufsdyncontent.all.conf

ufs-dynamic-content.spring.datasources.hikari.housekeeping.periodMs

Интервал планирования задачи

${global.jdbc.hikari.housekeeping.periodMs}

ufsdyncontent.all.conf

ufs-dynamic-content.spring.datasources.hikari.aliveBypassWindowMs

Интервал проверки работоспособности соединения после помещения его в пул

${global.jdbc.hikari.aliveBypassWindowMs}

ufsdyncontent.all.conf

ufs-dynamic-content.db.data_tablespace

Название табличного пространства для хранения данных таблиц

uftm_ts_data

ufsdyncontent.all.conf

ufs-dynamic-content.db.index_tablespace

Название табличного пространства для хранения данных индексов

uftm_ts_idx

ufsdyncontent.all.conf

ufs-dynamic-content.jdbc.ssl.enabled

Флаг включения/отключения SSL-соединения с БД

{{ lookup('vars', 'global.jdbc_mtls') }}

ufsdyncontent.all.conf

ufs-dynamic-content.jdbc.ssl.mode

Режим проверки серверных сертификатов

{{ lookup('custom_vars', 'ufs-dynamic-content.jdbc.ssl.enabled') | bool | ternary(lookup('vars', 'global.jdbc.postgresql.sslmode', default='verify-full'), 'disable') }}

ufsdyncontent.all.conf

ufs-dynamic-content.jdbc.ssl.certs.path

Директория в pod прикладного сервиса с сертификатами БД

/etc/config/db/ssl

ufsdyncontent.all.conf

ufs-dynamic-content.jdbc.ssl.root-cert.file-name

Имя файла с корневыми сертификатами

root.crt

ufsdyncontent.all.conf

ufs-dynamic-content.jdbc.ssl.root-cert.file-path

Полный путь до файла с корневыми сертификатами в pod прикладного сервиса

{{ lookup('custom_vars', 'ufs-dynamic-content.jdbc.ssl.certs.path') + '/' + lookup('custom_vars', 'ufs-dynamic-content.jdbc.ssl.root-cert.file-name') }}

ufsdyncontent.all.conf

ufs-dynamic-content.jdbc.ssl.cert.file-name

Имя файла с клиентским сертификатом БД

`cert.pem

ufsdyncontent.all.conf

ufs-dynamic-content.jdbc.ssl.cert.file-path

Полный путь до файла с клиентским сертификатом БД в pod прикладного сервиса

{{ lookup('custom_vars', 'ufs-dynamic-content.jdbc.ssl.certs.path') + '/' + lookup('custom_vars', 'ufs-dynamic-content.jdbc.ssl.cert.file-name') }}

ufsdyncontent.all.conf

ufs-dynamic-content.jdbc.ssl.key.file-name

Имя файла с приватным ключом клиентского сертификата БД

`key.der

ufsdyncontent.all.conf

ufs-dynamic-content.jdbc.ssl.key.file-path

Полный путь до файла с приватным ключом клиентского сертификата БД в pod прикладного сервиса

{{ lookup('custom_vars', 'ufs-dynamic-content.jdbc.ssl.certs.path') + '/' + lookup('custom_vars', 'ufs-dynamic-content.jdbc.ssl.key.file-name') }}

ufsdyncontent.all.conf

ufs-dynamic-content.ose.secret.db.certs.keystore.file-path

Относительный путь до файла-хранилища сертификатов в common-репозитории

{{ lookup('vars', 'ssl.ose.keyStore.mq.keyStoreFromFile') }}

ufsdyncontent.all.conf

ufs-dynamic-content.ose.secret.db.certs.keystore.password-variable-name

Имя переменной с паролем от файла-хранилища сертификатов в common-репозитории

{{ lookup('vars', 'ssl.ose.keyStore.mq.password') }}

ufsdyncontent.all.conf

ufs-dynamic-content.ose.secret.db.root-cert.aliases

Список имен-заменителей (aliases) корневых сертификатов, разделенных запятой

{{ lookup('vars', 'ssl.ose.istio.keyStore.RootCertAlias') }}

ufsdyncontent.all.conf

ufs-dynamic-content.ose.secret.db.cert.alias

Имя-заменитель клиентского сертификата БД, разделенных запятой

uftm-db

ufsdyncontent.all.conf

Параметры интеграции с брокером Kafka#

Параметры в репозитории с конфигурацией компонента.

Параметры для маршрутизации трафика Kafka CMS через Egress

Название

Описание

Значение

Конфигурационный файл

ufs-dynamic-content.k8s.istio.egress.common.cms.kafka.servers

Параметры подключения к серверам Kafka для перенаправления трафика через Egress

Параметры подключения в формате "FQDN-адрес:IP-адрес:порт сервера Kafka:протокол исходящего трафика из Namespace:порт Egress Gateway:протокол обмена внутри Namespace", перечисленные через точку с запятой

ufsdyncontent.istio.all.conf

ufs-dynamic-content.k8s.istio.egress.common.cms.kafka.ssl.enabled

Флаг инициации mTLS соединения с серверам Kafka на Egress

true - mTLS включен

ufsdyncontent.istio.all.conf

Параметры для создания kind:Secret с сертификатами для Kafka CMS:

Название

Описание

Значение

Конфигурационный файл

ufs-dynamic-content.k8s.istio.egress.secret.cms.kafka.certs.keystore.file-path

Относительный путь до файла-хранилища сертификатов в common-репозитории

{{ lookup('vars', 'ssl.ose.istio.keyStore.egress.KeyStoreFromFile') }}

ufsdyncontent.istio.all.conf

ufs-dynamic-content.k8s.istio.egress.secret.cms.kafka.certs.keystore.password-variable-name

Имя переменной с паролем от файла-хранилища сертификатов в common-репозитории

ssl.ose.istio.keyStore.egress.password

ufsdyncontent.istio.all.conf

ufs-dynamic-content.k8s.istio.egress.secret.cms.kafka.root-cert.aliases

Список алиасов корневых сертификатов, разделенных запятой

root-UFSSBERCMS

ufsdyncontent.istio.all.conf

ufs-dynamic-content.k8s.istio.egress.secret.cms.kafka.cert.alias

Алиас клиентского сертификата Kafka

00CA0001CUFSSBERCMS

ufsdyncontent.istio.all.conf

Параметры Spring-Kafka:

Название

Описание

Значение

Конфигурационный файл

ufs-dynamic-content-upload-service.kafka.bootstrap.servers

Серверы Kafka для подключения

{{ lookup('custom_vars', 'ufs-dynamic-content.k8s.istio.egress.common.cms.kafka.servers').split(';') &#124; map('regex_search', '(?P<host>.+):(.+):(?P<port>.+):(.+):(.+):(.+)', '\\g<host>', '\\g<port>' ) &#124; map('join', ':') &#124; join(';') }}

ufsdyncontent-upload-service.conf

ufs-dynamic-content-upload-service.kafka.security.protocol

Протокол безопасности, который будет использоваться при подключении к Kafka

PLAINTEXT

ufsdyncontent-upload-service.conf

ufs-dynamic-content-upload-service.kafka.producer_factory.delivery.timeout.ms

Таймаут доставки сообщений в Kafka

${global.platform.kafka.producer.delivery.timeout.ms}

ufsdyncontent-upload-service.conf

ufs-dynamic-content-upload-service.kafka.producer_factory.batch.size

Размер пакета в Kafka (для продуктовых параметров)

${global.platform.kafka.producer.batch.size}

ufsdyncontent-upload-service.conf

ufs-dynamic-content-upload-service.kafka.producer_factory.linger.ms

Таймаут задержки в Kafka (для продуктовых параметров)

${global.platform.kafka.producer.linger.ms}

ufsdyncontent-upload-service.conf

ufs-dynamic-content-upload-service.kafka.producer_factory.buffer.memory

Общий объем памяти в байтах, которые можно использовать для буферизации записей, ожидающих отправки на сервер (для продуктовых параметров)

${global.platform.kafka.producer.buffer.memory}

ufsdyncontent-upload-service.conf

ufs-dynamic-content-upload-service.kafka.producer_factory.request.timeout.ms

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

${global.platform.kafka.producer.request.timeout.ms}

ufsdyncontent-upload-service.conf

ufs-dynamic-content-upload-service.kafka.producer_factory.send.buffer.bytes

Размер буфера отправки TCP, используемого при отправке данных (для продуктовых параметров)

${global.platform.kafka.producer.send.buffer.bytes}

ufsdyncontent-upload-service.conf

ufs-dynamic-content-upload-service.kafka.producer_factory.receive.buffer.bytes

Размер приемного буфера TCP, используемого при чтении данных (для продуктовых параметров)

${global.platform.kafka.producer.receive.buffer.bytes}

ufsdyncontent-upload-service.conf

ufs-dynamic-content-upload-service.kafka.producer_factory.max.request.size

Максимальный размер запроса в Kafka (для продуктовых параметров)

${global.platform.kafka.producer.max.request.size}

ufsdyncontent-upload-service.conf

ufs-dynamic-content-upload-service.kafka.producer_factory.metadata.max.age.ms

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

${global.platform.kafka.producer.metadata.max.age.ms}

ufsdyncontent-upload-service.conf

ufs-dynamic-content-upload-service.kafka.producer_factory.connections.max.idle.ms

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

${global.platform.kafka.producer.connections.max.idle.ms}

ufsdyncontent-upload-service.conf

ufs-dynamic-content-upload-service.kafka.producer_factory.max.block.ms

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

${global.platform.kafka.producer.max.block.ms}

ufsdyncontent-upload-service.conf

ufs-dynamic-content-upload-service.kafka.producer_factory.compression.type

Тип сжатия для всех данных (для продуктовых параметров)

${global.platform.kafka.producer.compression.type}

ufsdyncontent-upload-service.conf

ufs-dynamic-content-upload-service.kafka.consumer_factory.session.timeout.ms

Тайм-аут, используемый для обнаружения сбоев клиентов (параметры для потребителя)

${global.platform.kafka.consumer.session.timeout.ms}

ufsdyncontent-upload-service.conf

ufs-dynamic-content-upload-service.kafka.consumer_factory.fetch.max.bytes

Ограничение максимального количества байтов при получении сообщения (параметры для потребителя)

${global.platform.kafka.consumer.fetch.max.bytes}

ufsdyncontent-upload-service.conf

ufs-dynamic-content-upload-service.kafka.consumer_factory.fetch.max.wait.ms

Время максимального ожидания ответа (параметры для потребителя)

${global.platform.kafka.consumer.fetch.max.wait.ms}

ufsdyncontent-upload-service.conf

ufs-dynamic-content-upload-service.kafka.consumer_factory.fetch.min.bytes

Ограничение минимального количества байтов при получении сообщения (параметры для потребителя)

${global.platform.kafka.consumer.fetch.min.bytes}

ufsdyncontent-upload-service.conf

ufs-dynamic-content-upload-service.kafka.consumer_factory.max.poll.interval.ms

Время максимального интервала опроса (параметры для потребителя)

${global.platform.kafka.consumer.max.poll.interval.ms}

ufsdyncontent-upload-service.conf

ufs-dynamic-content-upload-service.kafka.consumer_factory.heartbeat.interval.ms

Интервал продления активного сеанса (параметры для потребителя)

${global.platform.kafka.consumer.heartbeat.interval.ms}

ufsdyncontent-upload-service.conf

ufs-dynamic-content-upload-service.kafka.consumer_factory.max.partition.fetch.bytes

Максимальный объем данных для каждого раздела, который вернет сервер (параметры для потребителя)

${global.platform.kafka.consumer.max.partition.fetch.bytes}

ufsdyncontent-upload-service.conf

ufs-dynamic-content-upload-service.kafka.consumer_factory.send.buffer.bytes

Размер буфера отправки TCP, используемого при отправке данных (параметры для потребителя)

${global.platform.kafka.consumer.send.buffer.bytes}

ufsdyncontent-upload-service.conf

ufs-dynamic-content-upload-service.kafka.consumer_factory.receive.buffer.bytes

Размер приемного буфера TCP, используемого при чтении данных (параметры для потребителя)

${global.platform.kafka.consumer.receive.buffer.bytes}

ufsdyncontent-upload-service.conf

ufs-dynamic-content-upload-service.kafka.consumer_factory.request.timeout.ms

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

${global.platform.kafka.consumer.request.timeout.ms}

ufsdyncontent-upload-service.conf

Параметры Kafka:

Название

Описание

Значение

Конфигурационный файл

ufs-dynamic-content-upload-service.kafka.upload-topic-name

Наименование топика, из которого приходят пакеты изменений

ufs-ul-sbercms-content-data

ufsdyncontent-upload-service.conf

ufs-dynamic-content-upload-service.kafka.notification-topic-name

Наименование топика, в который направляется сообщение о применении изменений

ufs-sbercms-content-acknowledgement

ufsdyncontent-upload-service.conf

ufs-dynamic-content-upload-service.kafka.consumer.retry.max-attempts

Количество попыток обработки пакета изменений в случае возникновения ошибки

10

ufsdyncontent-upload-service.conf

ufs-dynamic-content-upload-service.kafka.consumer.retry.interval

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

1000

ufsdyncontent-upload-service.conf

Параметры интеграции с компонентом Corax (KFKA) продукта Platform V Corax (KFK)#

Настройки идентичны настройкам интеграции с брокером Kafka, описанным выше в разделе «Параметры интеграции с брокером Kafka».

Параметры интеграции с компонентом Asynchronous Tasks (ASYT) продукта Platform V Frontend Std (#FS)#

Параметров со стороны компонента UFTM, используемых для интеграции с компонентом Asynchronous Tasks (ASYT) продукта Platform V Frontend Std (#FS), не предусмотрено.

Параметры интеграции с компонентом Журналирование (LOGA) продукта Platform V Monitor (OPM)#

Параметры в репозитории с конфигурацией компонента:

Название

Описание

Значение по умолчанию

Конфигурационный файл

ufs-logger.kafka.bootstrap.servers

Адреса серверов Kafka в формате "FQDN-адрес:порт", перечисленные через запятую

${global.platform.logger.kafka.bootstrap.servers}

ufsdyncontent.all.conf

ufs-logger.kafka.security.protocol

Протокол, используемый для связи с брокерами

PLAINTEXT

ufsdyncontent.all.conf

ufs-logger.kafka.topic

Топик Kafka

${global.platform.logger.kafka.topic}

ufsdyncontent.all.conf

ufs-logger.parameters.url

Адрес расположения параметров для журналирования

${global.ose.platform.ufs.baseurl.logger}/ufs-logger-parameters-ng/parameters

ufsdyncontent.all.conf

ufs-dynamic-content.k8s.istio.egress.common.logger.kafka.servers

Параметры подключения к серверам Kafka для перенаправления трафика через Egress

ufsdyncontent.istio.all.conf

ufs-dynamic-content.k8s.istio.egress.common.logger.kafka.ssl.enabled

Флаг инициации mTLS соединения с серверам Kafka на Egress

ufsdyncontent.istio.all.conf

ufs-dynamic-content.k8s.istio.egress.secret.kafka.certs.keystore.file-path

Относительный путь до файла-хранилища сертификатов в common-репозитории

ufsdyncontent.istio.all.conf

ufs-dynamic-content.k8s.istio.egress.secret.kafka.certs.keystore.password-variable-name

Имя переменной с паролем от файла-хранилища сертификатов в common-репозитории

ssl.ose.keyStore.mq.password

ufsdyncontent.istio.all.conf

ufs-dynamic-content.k8s.istio.egress.secret.kafka.root-cert.aliases

Список алиасов корневых сертификатов, разделенных запятой

ufsdyncontent.istio.all.conf

ufs-dynamic-content.k8s.istio.egress.secret.logger.kafka.cert.alias

Алиас клиентского сертификата Kafka

ufsdyncontent.istio.all.conf

Параметры интеграции с компонентом Объединенный мониторинг Unimon (MONA) продукта Platform V Monitor (OPM)#

Параметры в репозитории с конфигурацией компонента:

Название

Описание

Значение по умолчанию

Конфигурационный файл

ufs-monitoring.infra.metrics.period

Период сбора инфраструктурных метрик

20s

ufsdyncontent.all.conf

ufs-monitoring.jms.enabled

Отключить использование в передачи метрик JMS

false

ufsdyncontent.all.conf

ufs-monitoring.kafka.bootstrap.servers

Адреса серверов Kafka в формате "FQDN-адрес:порт", перечисленные через запятую

${global.kafka.monitoring.bootstrap.servers}

ufsdyncontent.all.conf

ufs-monitoring.kafka.topic.metrics

Метрики топика Kafka

${global.kafka.monitoring.metrics.topic}

ufsdyncontent.all.conf

ufs-monitoring.kafka.topic.settings

Настройки топика Kafka

${global.kafka.monitoring.settings.topic}

ufsdyncontent.all.conf

ufs-monitoring.kafka.topic.metadata

Метадата топика Kafka

${global.kafka.monitoring.metadata.topic}

ufsdyncontent.all.conf

ufs-monitoring.kafka.topic.filter

Фильтры для топика Kafka

${global.kafka.monitoring.filter.topic}

ufsdyncontent.all.conf

ufs-monitoring.kafka.security.protocol

Протокол, используемый для связи с брокерами

PLAINTEXT

ufsdyncontent.all.conf

ufs-monitoring.kafka.producer_factory.delivery.timeout.ms

Верхняя граница времени для сообщения об успешном или неудачном завершении вызова после send (для продуктовых параметров)

${global.platform.kafka.producer.delivery.timeout.ms}

ufsdyncontent.all.conf

ufs-monitoring.kafka.producer_factory.batch.size

Размер пакета в Kafka (для продуктовых параметров)

${global.platform.kafka.producer.batch.size}

ufsdyncontent.all.conf

ufs-monitoring.kafka.producer_factory.linger.ms

Таймаут задержки в Kafka (для продуктовых параметров)

${global.platform.kafka.producer.linger.ms}

ufsdyncontent.all.conf

ufs-monitoring.kafka.producer_factory.buffer.memory

Общий объем памяти в байтах, которые можно использовать для буферизации записей, ожидающих отправки на сервер (для продуктовых параметров)

${global.platform.kafka.producer.buffer.memory}

ufsdyncontent.all.conf

ufs-monitoring.kafka.producer_factory.request.timeout.ms

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

${global.platform.kafka.producer.request.timeout.ms}

ufsdyncontent.all.conf

ufs-monitoring.kafka.producer_factory.send.buffer.bytes

Размер буфера отправки TCP, используемого при отправке данных (для продуктовых параметров)

${global.platform.kafka.producer.send.buffer.bytes}

ufsdyncontent.all.conf

ufs-monitoring.kafka.producer_factory.receive.buffer.bytes

Размер приемного буфера TCP, используемого при чтении данных (для продуктовых параметров)

${global.platform.kafka.producer.receive.buffer.bytes}

ufsdyncontent.all.conf

ufs-monitoring.kafka.producer_factory.max.request.size

Максимальный размер запроса в Kafka (для продуктовых параметров)

${global.platform.kafka.producer.max.request.size}

ufsdyncontent.all.conf

ufs-monitoring.kafka.producer_factory.metadata.max.age.ms

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

${global.platform.kafka.producer.metadata.max.age.ms}

ufsdyncontent.all.conf

ufs-monitoring.kafka.producer_factory.connections.max.idle.ms

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

${global.platform.kafka.producer.connections.max.idle.ms}

ufsdyncontent.all.conf

ufs-monitoring.kafka.producer_factory.max.block.ms

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

${global.platform.kafka.producer.max.block.ms}

ufsdyncontent.all.conf

ufs-monitoring.kafka.producer_factory.compression.type

Тип сжатия для всех данных (для продуктовых параметров)

${global.platform.kafka.producer.compression.type}

ufsdyncontent.all.conf

ufs-monitoring.kafka.consumer_factory.session.timeout.ms

Тайм-аут, используемый для обнаружения сбоев клиентов (параметры для потребителя)

${global.platform.kafka.consumer.session.timeout.ms}

ufsdyncontent.all.conf

ufs-monitoring.kafka.consumer_factory.fetch.max.bytes

Ограничение максимального количества байтов при получении сообщения (параметры для потребителя)

${global.platform.kafka.consumer.fetch.max.bytes}

ufsdyncontent.all.conf

ufs-monitoring.kafka.consumer_factory.fetch.max.wait.ms

Время максимального ожидания ответа (параметры для потребителя)

${global.platform.kafka.consumer.fetch.max.wait.ms}

ufsdyncontent.all.conf

ufs-monitoring.kafka.consumer_factory.fetch.min.bytes

Ограничение минимального количества байтов при получении сообщения (параметры для потребителя)

${global.platform.kafka.consumer.fetch.min.bytes}

ufsdyncontent.all.conf

ufs-monitoring.kafka.consumer_factory.max.poll.interval.ms

Время максимального интервала опроса (параметры для потребителя)

${global.platform.kafka.consumer.max.poll.interval.ms}

ufsdyncontent.all.conf

ufs-monitoring.kafka.consumer_factory.heartbeat.interval.ms

Интервал продления активного сеанса (параметры для потребителя)

${global.platform.kafka.consumer.heartbeat.interval.ms}

ufsdyncontent.all.conf

ufs-monitoring.kafka.consumer_factory.max.partition.fetch.bytes

Максимальный объем данных для каждого раздела, который вернет сервер (параметры для потребителя)

${global.platform.kafka.consumer.max.partition.fetch.bytes}

ufsdyncontent.all.conf

ufs-monitoring.kafka.consumer_factory.send.buffer.bytes

Размер буфера отправки TCP, используемого при отправке данных (параметры для потребителя)

${global.platform.kafka.consumer.send.buffer.bytes}

ufsdyncontent.all.conf

ufs-monitoring.kafka.consumer_factory.receive.buffer.bytes

Размер приемного буфера TCP, используемого при чтении данных (параметры для потребителя)

${global.platform.kafka.consumer.receive.buffer.bytes}

ufsdyncontent.all.conf

ufs-monitoring.kafka.consumer_factory.request.timeout.ms

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

${global.platform.kafka.consumer.request.timeout.ms}

ufsdyncontent.all.conf

ufs-dynamic-content.k8s.istio.egress.common.monitoring.kafka.servers

Параметры подключения к серверам Kafka для перенаправления трафика через Egress

ufsdyncontent.istio.all.conf

ufs-dynamic-content.k8s.istio.egress.common.monitoring.kafka.ssl.enabled

Флаг инициации mTLS соединения с серверам Kafka на Egress

ufsdyncontent.istio.all.conf

ufs-dynamic-content.k8s.istio.egress.secret.kafka.certs.keystore.file-path

Относительный путь до файла-хранилища сертификатов в common-репозитории

ufsdyncontent.istio.all.conf

ufs-dynamic-content.k8s.istio.egress.secret.kafka.certs.keystore.password-variable-name

Имя переменной с паролем от файла-хранилища сертификатов в common-репозитории

ssl.ose.keyStore.mq.password

ufsdyncontent.istio.all.conf

ufs-dynamic-content.k8s.istio.egress.secret.kafka.root-cert.aliases

Список алиасов корневых сертификатов, разделенных запятой

ufsdyncontent.istio.all.conf

ufs-dynamic-content.k8s.istio.egress.secret.monitoring.kafka.cert.alias

Алиас клиентского сертификата Kafka

ufsdyncontent.istio.all.conf

Параметры интеграции с компонентом ЕФС.Stand In (STDE) продукта Platform V Frontend Std (#FS)#

Параметров со стороны Сервиса шаблонов форм UI, используемых для интеграции с компонентом ЕФС.Stand In (STDE) продукта Platform V Frontend Std (#FS), не предусмотрено.

Параметры интеграции с компонентом Защита от внутренних отказов ЕФС (FPRT) продукта Platform V Frontend Std (#FS)#

Параметров со стороны Сервиса шаблонов форм UI, используемых для интеграции с компонентом Защита от внутренних отказов ЕФС (FPRT) продукта Platform V Frontend Std (#FS), не предусмотрено.

Параметры интеграции с компонентом Аудит (AUDT) продукта Platform V Audit SE#

Параметры в репозитории с конфигурацией компонента:

Название

Описание

Значение по умолчанию

Конфигурационный файл

union-audit.useQuota

Квотирование в компоненте Аудит (AUDT) продукта Platform V Audit SE

false

ufsdyncontent-upload-service.conf

union-audit.circuit-breaker.mode

Режим работы главного балансировщика

ufsdyncontent-upload-service.conf

union-audit.kafka.$$$provider.name$$$.bootstrap.servers

Адреса серверов Kafka в формате "FQDN-адрес:порт", перечисленные через запятую

$$$provider.bootstrap$$$

ufsdyncontent-upload-service.conf

union-audit.kafka.$$$provider.name$$$.security.protocol

Протокол, используемый для связи с брокерами

PLAINTEXT

ufsdyncontent-upload-service.conf

union-audit.kafka.$$$provider.name$$$.delivery.timeout.ms

Верхняя граница времени для сообщения об успешном или неудачном завершении вызова

ufsdyncontent-upload-service.conf

union-audit.kafka.$$$provider.name$$$.batch.size

Размер пакета в Kafka

ufsdyncontent-upload-service.conf

union-audit.kafka.$$$provider.name$$$.linger.ms

Таймаут задержки в Kafka

ufsdyncontent-upload-service.conf

union-audit.kafka.$$$provider.name$$$.buffer.memory

Общий объем памяти в байтах, которые можно использовать для буферизации записей, ожидающих отправки на сервер

ufsdyncontent-upload-service.conf

union-audit.kafka.$$$provider.name$$$.request.timeout.ms

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

ufsdyncontent-upload-service.conf

union-audit.kafka.$$$provider.name$$$.send.buffer.bytes

Размер буфера отправки TCP, используемого при отправке данных

ufsdyncontent-upload-service.conf

union-audit.kafka.$$$provider.name$$$.receive.buffer.bytes

Размер приемного буфера TCP, используемого при чтении данных

ufsdyncontent-upload-service.conf

union-audit.kafka.$$$provider.name$$$.max.request.size

Максимальный размер запроса в Kafka

ufsdyncontent-upload-service.conf

union-audit.kafka.$$$provider.name$$$.metadata.max.age.ms

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

ufsdyncontent-upload-service.conf

union-audit.kafka.$$$provider.name$$$.connections.max.idle.ms

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

ufsdyncontent-upload-service.conf

union-audit.kafka.$$$provider.name$$$.max.block.ms

Максимальное время блокировки методов

ufsdyncontent-upload-service.conf

union-audit.kafka.$$$provider.name$$$.compression.type

Тип сжатия для всех данных

ufsdyncontent-upload-service.conf

ufs-dynamic-content.k8s.istio.egress.common.ufs-audit.kafka.servers

Параметры подключения к серверам Kafka компонента Аудит (AUDT) продукта Platform V Audit SE для перенаправления трафика через Egress

ufsdyncontent.istio.all.conf

ufs-dynamic-content.k8s.istio.egress.common.ufs-audit.kafka.ssl.enabled

Флаг инициации mTLS соединения с серверам Kafka на Egress

ufsdyncontent.istio.all.conf

ufs-dynamic-content.k8s.istio.egress.secret.kafka.certs.keystore.file-path

Относительный путь до файла-хранилища сертификатов в common-репозитории

ufsdyncontent.istio.all.conf

ufs-dynamic-content.k8s.istio.egress.secret.kafka.certs.keystore.password-variable-name

Имя переменной с паролем от файла-хранилища сертификатов в common-репозитории

ssl.ose.keyStore.mq.password

ufsdyncontent.istio.all.conf

ufs-dynamic-content.k8s.istio.egress.secret.kafka.root-cert.aliases

Список алиасов корневых сертификатов, разделенных запятой

ufsdyncontent.istio.all.conf

ufs-dynamic-content.k8s.istio.egress.secret.ufs-audit.kafka.cert.alias

Алиас клиентского сертификата Kafka

ufsdyncontent.istio.all.conf

ufs-dynamic-content.k8s.istio.egress.common.union-audit.kafka.servers

Параметры подключения к серверам Kafka компонента Аудит (AUDT) для перенаправления трафика через Egress

ufsdyncontent.istio.all.conf

ufs-dynamic-content.k8s.istio.egress.common.union-audit.kafka.ssl.enabled

Флаг инициации mTLS соединения с серверам Kafka на Egress

ufsdyncontent.istio.all.conf

ufs-dynamic-content.k8s.istio.egress.secret.kafka.certs.keystore.file-path

Относительный путь до файла-хранилища сертификатов в common-репозитории

ufsdyncontent.istio.all.conf

ufs-dynamic-content.k8s.istio.egress.secret.kafka.certs.keystore.password-variable-name

Имя переменной с паролем от файла-хранилища сертификатов в common-репозитории

ssl.ose.keyStore.mq.password

ufsdyncontent.istio.all.conf

ufs-dynamic-content.k8s.istio.egress.secret.kafka.root-cert.aliases

Список алиасов корневых сертификатов, разделенных запятой

ufsdyncontent.istio.all.conf

ufs-dynamic-content.k8s.istio.egress.secret.union-audit.kafka.cert.alias

Алиас клиентского сертификата Kafka

ufsdyncontent.istio.all.conf

Топики для провайдера $$$provider.name$$$.

  1. Для balance_group in balance_group_union_audit_list. Если provider.name in balance_group.providers и если balance_group.protocol == "UFS":

Название

Значение по умолчанию

Конфигурационный файл

union-audit.kafka.$$$provider.name$$$.topic.audit-events-crit-in

{{ lookup('vars', 'global.platform.union_audit.kafka.ufs.audit-events-crit-in') }}

ufsdyncontent-upload-service.conf

union-audit.kafka.$$$provider.name$$$.topic.audit-events-uncrit-in

{{ lookup('vars', 'global.platform.union_audit.kafka.ufs.audit-events-uncrit-in') }}

ufsdyncontent-upload-service.conf

union-audit.kafka.$$$provider.name$$$.topic.audit-metamodel-in

{{ lookup('vars', 'global.platform.union_audit.kafka.ufs.audit-metamodel-in') }}

ufsdyncontent-upload-service.conf

  1. Если balance_group.protocol == "AVRO":

Название

Значение по умолчанию

Конфигурационный файл

union-audit.kafka.$$$provider.name$$$.topic.audit-events-crit-in

{{ lookup('vars', 'global.platform.union_audit.kafka.pprb.audit-events-crit-in') }}

ufsdyncontent-upload-service.conf

union-audit.kafka.$$$provider.name$$$.topic.audit-events-uncrit-in

{{ lookup('vars', 'global.platform.union_audit.kafka.pprb.audit-events-uncrit-in') }}

ufsdyncontent-upload-service.conf

union-audit.kafka.$$$provider.name$$$.topic.audit-metamodel-in

{{ lookup('vars', 'global.platform.union_audit.kafka.pprb.audit-metamodel-in') }}

ufsdyncontent-upload-service.conf

  1. Если balance_group.protocol in ["UNION", "PRE_UNION"]:

Название

Значение по умолчанию

Конфигурационный файл

union-audit.kafka.$$$provider.name$$$.topic.audit-events-crit-in

{{ lookup('vars', 'global.platform.union_audit.kafka.union.audit-events-crit-in') }}

ufsdyncontent-upload-service.conf

union-audit.kafka.$$$provider.name$$$.topic.audit-events-uncrit-in

{{ lookup('vars', 'global.platform.union_audit.kafka.union.audit-events-uncrit-in') }}

ufsdyncontent-upload-service.conf

union-audit.kafka.$$$provider.name$$$.topic.audit-metamodel-in

{{ lookup('vars', 'global.platform.union_audit.kafka.union.audit-metamodel-in') }}

ufsdyncontent-upload-service.conf

Заполнение параметров группы балансировки Kafka

Для balance_group in balance_group_union_audit_list

Название

Значение по умолчанию

Конфигурационный файл

union-audit.balance_group.$$$balance_group.name$$$.main

$$$balance_group.main$$$

ufsdyncontent-upload-service.conf

union-audit.balance_group.$$$balance_group.name$$$.providerClass

$$$balance_group.provider_class$$$

ufsdyncontent-upload-service.conf

union-audit.balance_group.$$$balance_group.name$$$.priority

$$$loop.revindex * 11$$$

ufsdyncontent-upload-service.conf

union-audit.balance_group.$$$balance_group.name$$$.eventProtocol

$$$balance_group.protocol$$$

ufsdyncontent-upload-service.conf

union-audit.balance_group.$$$balance_group.name$$$.balanceMode

RR

ufsdyncontent-upload-service.conf

union-audit.balance_group.$$$balance_group.name$$$.circuit_breaker.recoveryTimeout

{{ lookup('vars', 'global.platform.union_audit.circuit_breaker.recoveryTimeout') }}

ufsdyncontent-upload-service.conf

union-audit.balance_group.$$$balance_group.name$$$.circuit_breaker.recoveryTimeout

120000

ufsdyncontent-upload-service.conf

union-audit.balance_group.$$$balance_group.name$$$.circuit_breaker.successThreshold

{{ lookup('vars', 'global.platform.union_audit.circuit_breaker.successThreshold') }}

ufsdyncontent-upload-service.conf

union-audit.balance_group.$$$balance_group.name$$$.circuit_breaker.mode

ERROR_WINDOW

ufsdyncontent-upload-service.conf

Только для ERROR_WINDOW:

Название

Значение по умолчанию

Конфигурационный файл

union-audit.balance_group.$$$balance_group.name$$$.circuit_breaker.failureThreshold

{{ lookup('vars', 'global.platform.union_audit.circuit_breaker.failureThreshold') }}

ufsdyncontent-upload-service.conf

Только для TIME_WINDOW (опционально):

Название

Значение по умолчанию

Конфигурационный файл

union-audit.balance_group.$$$balance_group.name$$$.circuit_breaker.failureRateThreshold

—

ufsdyncontent-upload-service.conf

union-audit.balance_group.$$$balance_group.name$$$.circuit_breaker.failureExecutionThreshold

—

ufsdyncontent-upload-service.conf

union-audit.balance_group.$$$balance_group.name$$$.circuit_breaker.failureThresholdingPeriod

—

ufsdyncontent-upload-service.conf

Параметры интеграции с компонентом PACMAN (CFGA) продукта Platform V Frontend Std (#FS)#

Параметры в репозитории с конфигурацией компонента:

Название

Описание

Значение по умолчанию

Конфигурационный файл

ufs-params.startup-config-directory

Корневой каталог для хранения начальных конфигурационных файлов компонента PACMAN (CFGA) продукта Platform V Frontend Std (#FS)

/tmp/ufsparams/config

ufsdyncontent.all.conf

ufs-params.working-config-directory

Корневой каталог для хранения рабочих конфигурационных файлов компонента PACMAN (CFGA) продукта Platform V Frontend Std (#FS)

/tmp/ufsparams-runtime/config

ufsdyncontent.all.conf

Параметры интеграции с системой управления секретами#

Параметры в репозитории с конфигурацией компонента

Общие параметры:

Название

Описание

Значение по умолчанию

Конфигурационный файл

ufs-dynamic-content.k8s.configmap.hashicorp.enabled

Включение интеграции с системой управления секретами (кроме OTT sidecar)

false - интеграция выключена

ufsdyncontent.secman.all.conf

ufs-dynamic-content.ott.k8s.configmap.hashicorp.enabled

Включение интеграции с системой управления секретами для OTT sidecar

false - интеграция выключена

ufsdyncontent.ott.all.conf

ufs-dynamic-content.k8s.deployment.spec.template.metadata.annotations.vault.hashicorp.com.role

AppRole - роль, полученная в системе управления секретами

{{ global.platform.annotations.hashicorp.role &#124; default() }}

ufsdyncontent.secman.all.conf

ufs-dynamic-content.k8s.deployment.spec.template.metadata.annotations.vault.hashicorp.com.namespace

Тенант в системе управления секретами

{{ global.platform.annotations.hashicorp.namespace &#124; default() }}

ufsdyncontent.secman.all.conf

ufs-dynamic-content.k8s.deployment.spec.template.metadata.annotations.vault.hashicorp.com.agent-limits-cpu

Лимит на количество ресурсов CPU для sidecar vault-agent

{{ lookup('vars', 'global.platform.hashicorp.agent-limits-cpu', default='51m') }}

ufsdyncontent.secman.all.conf

ufs-dynamic-content.k8s.deployment.spec.template.metadata.annotations.vault.hashicorp.com.agent-limits-mem

Лимит на количество ресурсов RAM для sidecar vault-agent

{{ lookup('vars', 'global.platform.hashicorp.agent-limits-mem', default='129Mi') }}

ufsdyncontent.secman.all.conf

ufs-dynamic-content.k8s.deployment.spec.template.metadata.annotations.vault.hashicorp.com.agent-requests-cpu

Запрашиваемое количество ресурсов CPU для sidecar vault-agent

{{ lookup('vars', 'global.platform.hashicorp.agent-requests-cpu', default='50m') }}

ufsdyncontent.secman.all.conf

ufs-dynamic-content.k8s.deployment.spec.template.metadata.annotations.vault.hashicorp.com.agent-requests-mem

Запрашиваемое количество ресурсов RAM для sidecar vault-agent

{{ lookup('vars', 'global.platform.hashicorp.agent-requests-mem', default='128Mi') }}

ufsdyncontent.secman.all.conf

ufs-dynamic-content.k8s.istio.egress.common.hashicorp.host

Хост системы управления секретами

{{ global.platform.hashicorp.host &#124; default() }}

ufsdyncontent.secman.istio.all.conf

ufs-dynamic-content.k8s.istio.egress.common.hashicorp.mesh.tls.port

Порт egress proxy для перенаправления трафика к системе управления секретами

{{ global.platform.egress.hashicorp.tls.port &#124; default('8550') }}

ufsdyncontent.secman.istio.all.conf

ufs-dynamic-content.k8s.istio.egress.common.hashicorp.tls.port

Порт системы управления секретами

{{ global.platform.hashicorp.port &#124; default('8443') }}

ufsdyncontent.secman.istio.all.conf

ufs-dynamic-content.k8s.configmap.file-watcher.poll-interval

Интервал между проверками изменений файлов с секретами. Значение не должно превышать время действия секрета, установленного в системы управления секретами. Настройка интеграции с системой управления секретами описана в разделе «Настройка интеграции с системой управления секретами (опционально)» документа «Руководство по установке».

30s

ufsdyncontent.secman.all.conf

ufs-dynamic-content.k8s.configmap.file-watcher.quiet-period

Задержка после обнаружения изменения файла с секретом, необходимая для ожидания завершения всех изменений

10s

ufsdyncontent.secman.all.conf

ufs-dynamic-content.k8s.configmap.hashicorp.pki.engine.enabled

Включение или отключение движка HashiCorp PKI

true

ufsdyncontent.secman.all.conf

ufs-dynamic-content.k8s.istio.egress.deployment.spec.template.metadata.annotations.vault.hashicorp.com.agent-inject-template-egress.certs.use-kv-engine

Флаг использования KV Engine для получения секретов для egress

false

ufsdyncontent.secman.istio.all.conf

ufs-dynamic-content.k8s.istio.ingress.deployment.spec.template.metadata.annotations.vault.hashicorp.com.agent-inject-template-ingress-certs.use-kv-engine

Флаг использования KV Engine для получения секретов для ingress

false

ufsdyncontent.secman.istio.all.conf

Параметры KV (2 УЦ):

Название

Значение по умолчанию

Конфигурационный файл

ufs-dynamic-content.k8s.deployment.spec.template.metadata.annotations.vault.hashicorp.com.agent-inject-template-truststore_pem.engineMountPath

{{ lookup('custom_vars', 'global.platform.annotations.hashicorp.rootCertsPath', default='') }}

ufsdyncontent.secman.all.conf

ufs-dynamic-content.k8s.root.secman.kv.truststore_pem

index .Data "truststore_pem"

ufsdyncontent.secman.all.conf

ufs-dynamic-content.k8s.deployment.spec.template.metadata.annotations.vault.hashicorp.com.agent-inject-template-truststore_cer.engineMountPath

{{ lookup('custom_vars', 'global.platform.annotations.hashicorp.rootCertsPath', default='') }}

ufsdyncontent.secman.all.conf

ufs-dynamic-content.k8s.db.secman.kv.truststore_cer

index .Data "truststore_cer"

ufsdyncontent.secman.all.conf

ufs-dynamic-content.k8s.deployment.spec.template.metadata.annotations.vault.hashicorp.com.agent-inject-template-truststore_jks.engineMountPath

{{ lookup('custom_vars', 'global.platform.annotations.hashicorp.rootCertsPath', default='') }}

ufsdyncontent.secman.all.conf

ufs-dynamic-content.k8s.jks.secman.kv.truststore_jks

base64Decode (index .Data "truststore_jks")

ufsdyncontent.secman.all.conf

ufs-dynamic-content.k8s.deployment.spec.template.metadata.annotations.vault.hashicorp.com.agent-inject-template-truststore_jks_pass.engineMountPath

{{ lookup('custom_vars', 'global.platform.annotations.hashicorp.rootCertsPath', default='') }}

ufsdyncontent.secman.all.conf

ufs-dynamic-content.k8s.jks_pass.secman.kv.truststore_jks_pass

base64Decode (index .Data "truststore_jks_pass")

ufsdyncontent.secman.all.conf

Параметры управления сертификатами для установки mTLS-соединения для HTTPS-взаимодействий, проходящих через ingress/egress proxy:

Название

Описание

Значение по умолчанию

Конфигурационный файл

ufs-dynamic-content.k8s.istio.egress.deployment.spec.template.metadata.annotations.vault.hashicorp.com.agent-inject-template-egress.certs.path

Путь, используемый для обращения к системе управления секретами для выпуска сертификатов egress proxy

ufsdyncontent.secman.istio.all.conf

ufs-dynamic-content.k8s.istio.egress.deployment.spec.template.metadata.annotations.vault.hashicorp.com.agent-inject-template-egress.certs.common-name

Common name выпускаемого сертификата egress proxy

ufsdyncontent.secman.istio.all.conf

ufs-dynamic-content.k8s.istio.ingress.deployment.spec.template.metadata.annotations.vault.hashicorp.com.agent-inject-template-ingress-certs.path

Путь, используемый для обращения к системе управления секретами для выпуска сертификатов ingress proxy

ufsdyncontent.secman.istio.all.conf

ufs-dynamic-content.k8s.istio.ingress.deployment.spec.template.metadata.annotations.vault.hashicorp.com.agent-inject-template-ingress-certs.common-name

Common name выпускаемого сертификата ingress proxy

ufsdyncontent.secman.istio.all.conf

Параметры управления сертификатами для установки mTLS-соединения для взаимодействий с Kafka компонента Журналирование (LOGA) продукта Platform V Monitor (OPM), проходящих через egress proxy:

Название

Описание

Значение по умолчанию

Конфигурационный файл

ufs-dynamic-content.k8s.istio.egress.deployment.spec.template.metadata.annotations.vault.hashicorp.com.agent-inject-template-logger.kafka.certs.use-kv-engine

Флаг использования KV Secrets Engine для управления сертификатами

false

ufsdyncontent.secman.istio.all.conf

ufs-dynamic-content.k8s.istio.egress.deployment.spec.template.metadata.annotations.vault.hashicorp.com.agent-inject-template-logger.kafka.certs.path

Путь, используемый для обращения к системе управления секретами для выпуска сертификатов Kafka

ufsdyncontent.secman.istio.all.conf

ufs-dynamic-content.k8s.istio.egress.deployment.spec.template.metadata.annotations.vault.hashicorp.com.agent-inject-template-logger.kafka.certs.common-name

Common name выпускаемого сертификата Kafka

ufsdyncontent.secman.istio.all.conf

Параметры управления сертификатами для установки mTLS-соединения для взаимодействий с Kafka компонента Объединенный мониторинг Unimon (MONA) продукта Platform V Monitor (OPM), проходящих через egress proxy:

Название

Описание

Значение по умолчанию

Конфигурационный файл

ufs-dynamic-content.k8s.istio.egress.deployment.spec.template.metadata.annotations.vault.hashicorp.com.agent-inject-template-monitoring.kafka.certs.use-kv-engine

Флаг использования KV Secrets Engine для управления сертификатами

false

ufsdyncontent.secman.istio.all.conf

ufs-dynamic-content.k8s.istio.egress.deployment.spec.template.metadata.annotations.vault.hashicorp.com.agent-inject-template-monitoring.kafka.certs.path

Путь, используемый для обращения к системе управления секретами для выпуска сертификатов Kafka

ufsdyncontent.secman.istio.all.conf

ufs-dynamic-content.k8s.istio.egress.deployment.spec.template.metadata.annotations.vault.hashicorp.com.agent-inject-template-monitoring.kafka.certs.common-name

Common name выпускаемого сертификата Kafka

ufsdyncontent.secman.istio.all.conf

Параметры управления сертификатами для установки mTLS-соединения для взаимодействий с Kafka компонента Аудит (AUDT), проходящих через egress proxy:

Название

Описание

Значение по умолчанию

Конфигурационный файл

ufs-dynamic-content.k8s.istio.egress.deployment.spec.template.metadata.annotations.vault.hashicorp.com.agent-inject-template-union-audit.kafka.certs.use-kv-engine

Флаг использования KV Secrets Engine для управления сертификатами

false

ufsdyncontent.secman.istio.all.conf

ufs-dynamic-content.k8s.istio.egress.deployment.spec.template.metadata.annotations.vault.hashicorp.com.agent-inject-template-union-audit.kafka.certs.path

Путь, используемый для обращения к системе управления секретами для выпуска сертификатов Kafka

ufsdyncontent.secman.istio.all.conf

ufs-dynamic-content.k8s.istio.egress.deployment.spec.template.metadata.annotations.vault.hashicorp.com.agent-inject-template-union-audit.kafka.certs.common-name

Common name выпускаемого сертификата Kafka

ufsdyncontent.secman.istio.all.conf

Параметры управления сертификатами для установки mTLS-соединения для взаимодействий с Kafka CMS, проходящих через egress proxy:

Название

Описание

Значение по умолчанию

Конфигурационный файл

ufs-dynamic-content.k8s.istio.egress.deployment.spec.template.metadata.annotations.vault.hashicorp.com.agent-inject-template-cms.kafka.certs.use-kv-engine

Флаг использования KV Secrets Engine для управления сертификатами

false

ufsdyncontent.secman.istio.all.conf

ufs-dynamic-content.k8s.istio.egress.deployment.spec.template.metadata.annotations.vault.hashicorp.com.agent-inject-template-cms.kafka.certs.path

Путь, используемый для обращения к системе управления секретами для выпуска сертификатов Kafka

ufsdyncontent.secman.istio.all.conf

ufs-dynamic-content.k8s.istio.egress.deployment.spec.template.metadata.annotations.vault.hashicorp.com.agent-inject-template-cms.kafka.certs.common-name

Common name выпускаемого сертификата Kafka

ufsdyncontent.secman.istio.all.conf

Параметры управления сертификатами для установки mTLS-соединения для взаимодействий с компонентом One-Time Password (OTP)/OTT (OTTS) из OTT sidecar:

В составе Egress:

Название

Описание

Значение по умолчанию

Конфигурационный файл

ott.ose.istio.egress.deployment.spec.template.metadata.annotations.vault.hashicorp.com.agent-inject-template-ott-certs.use-kv-engine

Флаг использования KV Secrets Engine для управления сертификатами

false

ufsdyncontent.ott.all.conf

ott.ose.istio.egress.deployment.spec.template.metadata.annotations.vault.hashicorp.com.agent-inject-template-ott-certs.path

Путь, используемый для обращения к системе управления секретами для выпуска клиентского сертификата OTT

ufsdyncontent.ott.all.conf

ott.ose.istio.egress.deployment.spec.template.metadata.annotations.vault.hashicorp.com.agent-inject-template-ott-certs.common-name

Common name выпускаемого сертификата Kafka

ufsdyncontent.ott.all.conf

В составе Ingress:

Название

Описание

Значение по умолчанию

Конфигурационный файл

ott.ose.istio.ingress.deployment.spec.template.metadata.annotations.vault.hashicorp.com.agent-inject-template-ott-certs.use-kv-engine

Флаг использования KV Secrets Engine для управления сертификатами

false

ufsdyncontent.ott.all.conf

ott.ose.istio.ingress.deployment.spec.template.metadata.annotations.vault.hashicorp.com.agent-inject-template-ott-certs.path

Путь, используемый для обращения к системе управления секретами для выпуска клиентского сертификата OTT

ufsdyncontent.ott.all.conf

ott.ose.istio.ingress.deployment.spec.template.metadata.annotations.vault.hashicorp.com.agent-inject-template-ott-certs.common-name

Common name выпускаемого сертификата Kafka

ufsdyncontent.ott.all.conf

Параметры управления сертификатами для установки mTLS-соединения для взаимодействий с Kafka компонентов Журналирование (LOGA), Объединенный мониторинг Unimon (MONA), Аудит (AUDT) из OTT sidecar:

Название

Описание

Значение по умолчанию

Конфигурационный файл

ott.ose.istio.deployment.spec.template.metadata.annotations.vault.hashicorp.com.agent-inject-template-mq-certs.use-kv-engine

Флаг использования KV Secrets Engine для управления сертификатами

false

ufsdyncontent.ott.all.conf

ott.ose.istio.deployment.spec.template.metadata.annotations.vault.hashicorp.com.agent-inject-template-mq-certs.path

Путь, используемый для обращения к системе управления секретами для выпуска сертификатов Kafka

ufsdyncontent.ott.all.conf

ott.ose.istio.deployment.spec.template.metadata.annotations.vault.hashicorp.com.agent-inject-template-mq-certs.common-name

Common name выпускаемого сертификата Kafka

ufsdyncontent.ott.all.conf

Параметры управления сертификатами для аутентификации в БД:

Название

Описание

Значение по умолчанию

Конфигурационный файл

ufs-dynamic-content.k8s.deployment.spec.template.metadata.annotations.vault.hashicorp.com.agent-inject-template-db-certs.use-kv-engine

Флаг использования KV Secrets Engine для управления сертификатами

false - для управления сертификатами используется PKI Secrets Engine

ufsdyncontent.secman.all.conf

ufs-dynamic-content.k8s.deployment.spec.template.metadata.annotations.vault.hashicorp.com.agent-inject-template-db-certs.path

Путь, используемый для обращения к системе управления секретами для выпуска сертификатов для аутентификации в БД

ufsdyncontent.secman.all.conf

ufs-dynamic-content.k8s.deployment.spec.template.metadata.annotations.vault.hashicorp.com.agent-inject-template-db-certs.common-name

Common name выпускаемого сертификата для аутентификации в БД. Значение common name должно совпадать с именем пользователя БД

ufsdyncontent.secman.all.conf

ufs-dynamic-content.k8s.deployment.db-creds.mount-path

Монтирование пути к файлам с учетными данными базы данных

/etc/config/db

ufsdyncontent.secman.all.conf

ufs-dynamic-content.k8s.deployment.db-creds.file-name

Указание имени файла, содержащего учетные данные для подключения к базе данных

db-creds.properties

ufsdyncontent.secman.all.conf

ufs-dynamic-content.k8s.deployment.db-creds.file-path

Путь к файлу, который содержит учетные данные, такие как пароли или ключи доступа к базе данных

{{ lookup('custom_vars', 'ufs-dynamic-content.k8s.deployment.db-creds.mount-path') + '/' + lookup('custom_vars', 'ufs-dynamic-content.k8s.deployment.db-creds.file-name') }}

ufsdyncontent.secman.all.conf

Параметры для управления именем пользователя и паролем для аутентификации в БД:

Название

Описание

Значение по умолчанию

Конфигурационный файл

ufs-dynamic-content.k8s.deployment.spec.template.metadata.annotations.vault.hashicorp.com.agent-inject-template-db-creds.path

Путь, используемый для обращения к системе управления секретами для получения имени пользователя и пароля для аутентификации в БД

ufsdyncontent.secman.all.conf

Параметры интеграции с компонентом Synapse Rate Limiter (SRLS) продукта Platform V Synapse Enterprise Integration (SEI)#

Параметры в репозитории с конфигурацией компонента:

Название

Описание

Значение по умолчанию

Конфигурационный файл

endpoints

Конфигурация квотирования

custom_property.conf.yml

Формат конфигурации квотирования описан в разделе «Развертывание компонентов SRLS по агентской схеме» документа «Руководство прикладного разработчика Synapse Rate Limiter».

Параметры интеграции с компонентом One-Time Password (OTP)/OTT (OTTS) продукта Platform V Frontend Std (#FS)#

Параметры в репозитории с конфигурацией компонента:

Название

Описание

Значение по умолчанию

Конфигурационный файл

ufs-dynamic-content.ott.store.type

Тип хранилища сертификатов (PEM, JKS)

{{ lookup('vars', 'global.ott.store.type') }}

ufsdyncontent.ott.all.conf

Параметры интеграции с компонентом IAGW#

В дистрибутиве компонента UFTM расположены файлы: nginx-iag-nodes.json.j2, nginx-iag-routing.json.j2, nginx-iag-services.json.j2, в которых указываются параметры настройки с компонентом IAGW.

Параметры настройки логирования#

Параметры в АРМ компонента Журналирование (LOGA) продукта Platform V Monitor (OPM):

Название

Описание

Значение по умолчанию

logger.local.enabled

Включение записи логов в локальный канал (stdout)

true

logger.local.level

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

ERROR

logger.local.stdout.appender.enabled

Включение записи логов в stdout

false

logger.remote.level

Уровень логирования для удаленного канала

ERROR

logger.name.level

Уровень логирования для конкретного пакета или класса

ru.sbrf.ufs.content.dynamic:ERROR,ru.sbrf.ufs.content.dynamic.common.filewatch:INFO,ru.sbrf.ufs.scheduler.server.impl.TaskNotificationJob:INFO,ru.sbrf.ufs.scheduler.standin.StandInModeChangeListener:INFO

Параметры настройки загрузки пакетов изменений шаблонов#

Параметры в АРМ компонента PACMAN (CFGA) продукта Platform V Frontend Std (#FS):

Название

Описание

Тип

Значение по умолчанию

Списочный параметр

dynamic-content.scheduled.change-packages-processing

Расписание запуска задачи обработки полностью принятых и зависших пакетов изменений шаблонов в компоненте Asynchronous Tasks (ASYT) продукта Platform V Frontend Std (#FS), в сек.

STRING

300

Нет

task_scheduler.standin.modes.dynamic-content.scheduled.change-packages-processing

Список режимов блока, в которых компонент Asynchronous Tasks (ASYT) продукта Platform V Frontend Std (#FS) выполняет запуск задачи применения пакетов изменений шаблонов

STRING

["NORMAL", "INERT", "ACTIVE_STANDIN", "PASSIVE_STANDIN", "PASSIVE_INERT", "INERT_PERCENT"]

Да

dynamic.content.change-package.last.chunk.expiration.timeout

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

LONG

172800

Нет

dynamic.content.change-package.processing.expiration.timeout

Время, на которое задача обработки пакетов изменений может взять блокировку, в секундах; используется для блокировки одновременного запуска задач на нескольких узлах

LONG

180

Нет

ufs.standin.node.path

Путь к узлу Stand-In

STRING

Нет

Сценарии отказа#

Сценарии отказа описаны в одноименном разделе документа «Детальная архитектура».

Архивирование и восстановление данных#

Архивирование и восстановление из архивной копии производится средствами инфраструктуры, в которой разворачивается компонент UFTM.

Просмотр системного журнала и метрик мониторинга#

Действие

Описание

Просмотр событий системного журнала

Для просмотра системного журнала необходимо воспользоваться АРМ компонента Журналирование (LOGA) продукта Platform V Monitor (OPM). Перечень событий перечислен далее по документу

Просмотр метрик мониторинга

Для просмотра метрик мониторинга необходимо воспользоваться АРМ компонента Объединенный мониторинг Unimon (MONA) продукта Platform V Monitor (OPM). Перечень метрик перечислен далее по документу

События системного журнала#

Логирование событий компонента UFTM осуществляется через общее платформенное решение компонент Журналирование (LOGA) продукта Platform V Monitor (OPM). При этом место хранения логов событий (локальное хранилище, удаленное хранилище или оба одновременно) определяются администратором стенда. События сервиса идентифицируются по коду подсистемы UFTM. Компонент UFTM использует настройки журналирования по умолчанию, определяемые компонентом Журналирование (LOGA) продукта Platform V Monitor (OPM), и переопределяет следующие настройки:

logger.local.enabled=true
logger.local.level=ERROR
logger.local.stdout.appender.enabled=false
logger.remote.level=ERROR
logger.name.level=ru.sbrf.ufs.content.dynamic:ERROR,ru.sbrf.ufs.content.dynamic.common.filewatch:INFO,ru.sbrf.ufs.scheduler.server.impl.TaskNotificationJob:INFO,ru.sbrf.ufs.scheduler.standin.StandInModeChangeListener:INFO

Изменение настроек журналирования осуществляется в АРМ компонента Журналирование (LOGA) продукта Platform V Monitor (OPM). Перечень доступных настроек перечислен в разделе «Параметры для интеграции с Компонентом Журналирование», документа «Руководство по установке».

Список событий логирования Сервиса шаблонов форм UI#

Сервис загрузки пакетов изменений шаблонов#

Описание

Текст лога

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

Ошибка при выполнении задачи по обработке пакета изменений

"Processing packages task finished with error"

ERROR

Наличие задачи, которая обрабатывает пакеты изменений

"Other task already processing existed packages"

DEBUG

Во время обработки пакета произошло исключение

"Exception was thrown during processing package with id ${it.packageId}"

ERROR

Пакеты изменений уже обрабатываются другим процессом

"Change packages are already being processed by another process"

DEBUG

Предупреждение о принятии пакета не было доставлено в Kafka

"Apply notification for package ${templateChangePackage.packageId} to kafka was not delivered."

WARNING

Предупреждение об отклонении пакета не было доставлено в Kafka

"Reject notification for package ${templateChangePackage.packageId} to kafka was not delivered."

WARNING

Получено сообщение о создании пакета изменений

"Message received: $data"

DEBUG

Ошибка при синтаксическом анализе в чанке

"Error occurred during parsing packageCreationDate in chunk ${chunk.currentChunkNumber} of package ${chunk.packageId}"

ERROR

Смена режима Stand-In

"Текущий Stand-In режим работы блока установлен в {}"

INFO

Запрет на обработку чанков пакета изменений из временной таблицы

"В текущем Stand-In режиме работы блока запрещена обработка заданий для типа {}"

INFO

Запуск задачи обработки чанков пакета изменений из временной таблицы

"Старт задания. Контекст выполнения: {}"

INFO

Завершение задачи обработки чанков пакета изменений из временной таблицы

"Задание выполнено. Результат: {}. Контекст выполнения: {}"

INFO

Сервис выдачи шаблонов#

Описание

Текст лога

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

Запрос шаблонов по коду продукта и атрибутам

"Template controller received request: {}"

DEBUG

Запрос шаблонов по коду кортежа и атрибутам

"Template controller received request: {}"

DEBUG

Запрос шаблонов по идентификаторам шаблонов в CMS

"Template controller received request: {}"

DEBUG

Предупреждение о наличии в запросе повторяющиеся идентификаторы CMS

"Request contains duplicated CMS IDs: ${duplicates.keys}"

WARNING

КМ для сервиса выдачи шаблонов#

Описание

Текст лога

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

Сервер возвращает ответ с ошибкой

"Server returns error response {}"

ERROR

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

"Response contains only part of the requested data. Templates with ids $notFoundIds were not found"

WARNING

Ошибка при предоставлении значения для внешнего источника

"Caught an exception during an attempt to provide value for {} from external source". Details:

ERROR

Постраничный запрос пакета изменений

"Change packages on page ${request.page} with page limit ${request.pageSize} are requested"

DEBUG

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

"More than one template found for '$id', the first one will be returned"

WARNING

Ошибка о невозможности сопоставить тело шаблона с объектом класса $templateBodyClass

"Cannot map template body (cmsTemplateId=${template.cmsTemplateId}) to object of $templateBodyClass"

ERROR

Шаблоны $templates были получены из локального файла

"Templates $templates were retrieved from local file"

INFO

Во время обработки запроса возникла исключительная ситуация

"An exception has occurred during the request processing: {}"

ERROR

События логирования при интеграции с системой управления секретами#

Описание

Текст лога

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

Соединения с БД были помечены как исключенные в пуле соединений после изменения сертификатов

"Connections were marked as evicted in database connection pool because of certificates change"

INFO

Соединения с БД были помечены как исключенные в пуле соединений после изменения имени пользователя и пароля

"Connections were marked as evicted in database connection pool because of credentials change"

INFO

Обработка измененного файла с секретом завершилась ошибкой

"Processing of the file {} failed with error"

ERROR

Примечание: уровни логирования DEBUG и TRACE не рекомендуется включать при установке на промышленные стенды.

Описание процесса выдачи шаблонов#

Описание процесса выдачи шаблонов приведено в разделах «Варианты использования» и «Сценарии использования» документа «Детальная архитектура»

Описание атрибутного состава шаблона приведено в документе «Детальная архитектура», при описании ответов на запросы в разделе «Интерфейсы».

События мониторинга#

Мониторинг событий Сервиса шаблонов форм UI осуществляется через общее платформенное решение компонент Объединенный мониторинг Unimon (MONA) продукта Platform V Monitor (OPM).

Сервис загрузки пакетов изменений шаблонов#

Имя метрики

Тип метрики

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

Примечание

UFTM_FAILED_APPLYING_OF_TEMPLATE_CHANGE_PACKAGE

Количество

Неуспешное применение пакета изменений

Неуспешное применение по причине возникновения непредвиденной ошибки во время обработки

UFTM_SUCCESSFUL_APPLYING_OF_TEMPLATE_CHANGE_PACKAGE

Количество

Успешное применение пакета изменений шаблонов

UFTM_SUCCESSFUL_REJECTION_OF_TEMPLATE_CHANGE_PACKAGE

Количество

Успешное отклонение пакета изменений шаблонов

Отклонение пакета изменений шаблонов по причине некорректного формата пакета изменений

UFTM_FAILED_REJECTION_OF_TEMPLATE_CHANGE_PACKAGE

Количество

Неуспешное отклонение пакета изменений шаблонов

Неуспешное отклонение пакета изменений шаблонов по причине возникновения непредвиденной ошибки во время обработки

Сервис выдачи шаблонов#

Имя метрики

Тип метрики

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

Примечание

UFTM_SUCCESSFUL_TEMPLATES_SEARCH_BY_ID_LIST

Количество и длительность

Успешный запрос шаблонов по списку идентификаторов шаблонов

UFTM_FAILED_TEMPLATES_SEARCH_BY_ID_LIST

Количество и длительность

Неуспешный запрос шаблонов по списку идентификаторов шаблонов

UFTM_SUCCESSFUL_TEMPLATES_SEARCH_BY_CORTEGE

Количество и длительность

Успешный запрос шаблонов по коду кортежа и атрибутам шаблона

UFTM_FAILED_TEMPLATES_SEARCH_BY_CORTEGE

Количество и длительность

Неуспешный запрос шаблонов по коду кортежа и атрибутам шаблона

UFTM_SUCCESSFUL_TEMPLATES_SEARCH_BY_PRODUCT

Количество и длительность

Успешный запрос шаблонов по коду продукта и атрибутам шаблона

UFTM_FAILED_TEMPLATES_SEARCH_BY_PRODUCT

Количество и длительность

Неуспешный запрос шаблонов по коду продукта и атрибутам шаблона

get_templates_api_call_counter_total

Количество

Запрос шаблонов

Может использоваться для учета потребления сервиса

События мониторинга при интеграции с системой управления секретами#

Имя метрики

Тип метрики

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

Примечание

UFTM_DB_CONNECTIONS_MARKED_AS_EVICTED

Количество

Соединения с БД помечены как устаревшие после обновления секрета

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

UFTM_FAILED_SECRETS_UPDATE

Количество

Неуспешное обновление секрета в памяти приложения

Возникновение непредвиденной ошибки во время чтения файла с секретом или при обновлении SSL-контекста

События мониторинга ingress/egress при интеграции с системой управления секретами#

Имя метрики

Тип метрики

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

ssl_context_update_by_sds

Количество

Обновление SSL-контекста при ротации секрета

Часто встречающиеся проблемы и пути их устранения#

Ошибка применения сертификатов, выпущенных системой управления секретами#

  1. Пример текста ошибки в логе:

    HikariPool-1 - Cannot acquire connection from data source 
org.postgresql.util.PSQLException: SSL error: Received fatal alert: bad_certificate

  2. Возможные причины:

  3. Выпущенный сертификат начинает действовать позже, чем текущее время на сервере БД.

  4. Варианты исправления:

  5. Синхронизировать время сервера БД с временем на узле, где развернуто приложение.