3. Описание конфигурационного файла Агента СМЭВ4
3.1. Состав и содержание файлов конфигурирования
Состав дистрибутива конфигурационных файлов Агента СМЭВ4 (/distr/einfahrt):
/distr/einfahrt/customLogLevels.xml– файл описания настроек логирования;/distr/einfahrt/postgresql.json– файл описания профиля Витрины;/distr/einfahrt/conf/*.yml– заготовки конфигурационных файлов для Потребителя и Поставщика, для тестовой и продуктивной среды.
В директории conf/ пакета находятся типовые заготовки конфигурационного файла.
Необходимо взять заготовку конфигурационного файла в соответствии с потребностями:
шаблоны конфигурационного файла Агента для продуктивной среды (ПОДД):
conf/prod-consumer-application.yml– для Потребителя.conf/prod-producer-application.yml– для Поставщика.
шаблоны конфигурационного файла Агента для тестовой среды (ТПОДД):
conf/test-consumer-application.yml– для Потребителя.conf/test-producer-application.yml– для Поставщика.
После распаковки дистрибутива необходимо скопировать выбранный файл в каталог /distr/einfahrt под именем application.yml.
В скопированном конфигурационном файле application.yml задать необходимые параметры
(в заготовке обозначены звездочками *). Более подробное описание необходимых настроек
файла application.yml приведено в разделах ниже.
3.2. Реестр изменений файлов конфигурирования
Таблица 3.1 содержит Реестр изменений. Фиксация изменений в данном документе ведётся с версии 3.8.1.
Версия |
Перечень изменений (относительно предыдущей версии) |
|---|---|
3.8.1 |
|
3.11.2 |
Добавлено описание параметров создания топиков kafka (см. Раздел 3.3.3.2) |
3.3. Формирование конфигурационного файла Агента СМЭВ4
3.3.1. Общие настройки Агента
Внимание
При использовании в качестве транспорта информационного обмена с Ядром ПОДД СМЭВ pulsar (параметр agent.use-ca в конфигурационном файле установлен в значение false) не поддерживается одновременная работа более одного экземпляра Агента с одним и тем же agent.id. Исключение – масштабируемый Агент-Потребитель (см. Раздел 3.3.11)
При необходимости настроить список активного функционала Агента СМЭВ4.
Предоставляемый шаблон конфигурационного файла имеет настройку по умолчанию для данного параметра. Применять изменения следует только в случае, если значения по умолчанию не подходят для данного Агента СМЭВ4.
Параметр необязательный и может отсутствовать в конфигурационном файле. По умолчанию (при отсутствии в конфигурационном файле данного параметра) активен весь функционал Агента СМЭВ4.
В предлагаемых шаблонах конфигурационных файлов указаны профайлы QueryConsumer, ApiGwConsumer, ApiGwProvider
только для файлов конфигурации prod/-consumer-.yml.
Для файлов -producer-.yml данный блок отсутствует.
# Общие настройки агента
# Оставить только нужные профили (т.е. только профили используемого функционала)
spring:
profiles:
active:
# потребитель SQL-запросов
- QueryConsumer
# поставщик ответов на SQL-запросы
- QueryProvider
# потребитель уведомлений
- ReplicationConsumer
# поставщик дельт по подпискам
- ReplicationProvider
# потребитель REST РЗ
- ApiGwConsumer
# поставщик ответов по REST РЗ
- ApiGwProvider
Пример: в случае использования Агента СМЭВ4 только как Инициатора (Потребителя), следует указать в данном списке в
конфигурационном файле только значения *Consumer.
Указать идентификатор Агента СМЭВ4 и задать настройки используемого транспорта (pulsar/rsocket):
agent:
# Идентификатор (мнемоника) агента
# При использовании id или ogrn состоящих только из цифр, их следует заключать в одинарные или двойные кавычки
id: '*** ИДЕНТИФИКАТОР (МНЕМОНИКА) АГЕНТА ***'
ogrn: '*** ОГРН АГЕНТА ***'
# использовать традиционный транспорт обмена с Ядром (pulsar, значение false)
# либо усовершенствованный вариант транспорта (rsocket, значение true)
use-ca: false
Получение информации о метаданных Витрин в Агенте СМЭВ4 (опционально)
Данная конфигурация не влияет на возможность исполнения информационного обмена и нужна только для получения
возможности просмотра метаданных Витрин при использовании JDBC-драйвера. Для включения необходимо переопределить
значение переменной в конфигурационном файле на true:
query:
metadata:
storeToDb: true
3.3.2. Настройка ключей CryptoPro CSP
Указать идентификатор контейнера контейнера ключа CryptoPro:
keys:
alias: '*** ИДЕНТИФИКАТОР КЛЮЧА CryptoPro ***'
В случае, если идентификатор ключа CryptoPro содержит пробелы, его следует заключить в одинарные кавычки.
Ключ с указанным алиасом должен быть в наличии на стороне компонента notarius, также необходимо его упоминание в списке ключей в конфигурационном файле компонента notarius, см. Раздел 4.3.
3.3.3. Настройка регистрации Витрин данных и подключения к kafka (только при использовании Витрин)
Внимание
указание адреса сервера(серверов) kafka (параметр datamart.kafka-bootstrap-servers) обязателен, если используется хотя бы один профайл из списка: QueryProvider, ReplicationConsumer, ReplicationProvider. Список включенных профайлов определяется параметром spring.profiles.active, см. описание выше.
3.3.3.1. Настройка создания топиков Агентом СМЭВ4
Далее приведено описание раздела конфигурации для настройки создания топиков Агентом СМЭВ4.
Доступна настройка взаимодействия нескольких схем Витрины данных через одну группу топиков.
Схемы Витрины могут общаться через одну группу топиков только в случае, если относятся к одному ПО «Витрина данных» и являются схемами одной (физической) Витрины.
Блок параметров datamarts.create-topics может отсутствовать в конфигурационном файле, в этом случае используются
значения по умолчанию: включено автоматическое создание топиков для всех видов информационного обмена
(Регламентированные SQL-запросы, Рассылки), отключено автоматическое создание топиков регистрации и настройки Витрин.
Таблица 3.2 содержит соответствие создаваемых топиков Apache Kafka параметрам конфигурационного файла.
№ |
Настройка |
Параметр |
Создаваемые топики [1] |
|---|---|---|---|
1 |
Топики для информационного обмена с использованием Регламентированных SQL-запросов |
query |
|
2 |
Топики для информационного обмена с использованием Рассылок |
Replication, ReplicationProvider |
|
Replication, ReplicationConsumer |
|
||
3 |
Топики регистрации и настройки Витрин |
config |
Топики регистрации и настройки Витрин |
Для настройки создания топиков для обмена по Рассылкам только для Поставщика или Потребителя необходимо
использовать настройки активного функционала Агента СМЭВ4 Replication, указанные в Раздел 3.3.1.
Если инициатором обмена по Рассылке является Витрина или ИС Потребителя для корректного осуществления обмена необходимо задать один из видов настроек:
при использовании режима COMPATIBLE прописать Витрину в блоке
datamarts:установить режим ENABLED для создания общей группы топиков при старте Агента.
В случае отсутствия Витрин у Агента СМЭВ4 есть возможность отключить функционал в соответствии с Раздел 3.3.1.
В этом случае раздел datamart-registration может полностью отсутствовать в конфигурационном файле.
# Общие настройки витрин
datamart:
# автоматическое создание топиков витрины
create-topics:
# регистрация и настройка витрины
config: false
# информационный обмен с использованием SQL
query: true
# репликация
replication: true
# подключение к Kafka для взаимодействия с витринами
kafka-bootstrap-servers: {{ kafka_link }}
# Настройки регистрации витрин.
# - Витрины могут регистрироваться в агенте двумя способами:
# - статически - витрина прописывается в конфиге агента (блок datamarts:), в этом случае используются
# прописанные для данной витрины настройки, топики витрины создаются и слушаются агентом при старте;
# - динамически - автоматическая регистрация, в этом случае используется общий набор настроек (блок dynamic:);
# - Если агенту приходит сообщение из ядра для незарегистрированной витрины, агент регистрирует её динамически.
# - Регистрация витрины также может быть инициирована со стороны витрины, через специальный топик, в
# этом случае витрина регистрируется динамически, если она не прописана статически. Это позволяет
# получать профиль запросом с витрины при динамической регистрации.
# - Через некоторый таймаут (inactive-cleanup-delay) если к витрине не приходят запросы, агент её
# деактивирует (выключаются потребители и удаляются топики) для экономии ресурсов;
# - Если агенту приходит сообщение из ядра для деактивированной витрины, агент её активирует обратно.
# - Профиль витрины отсылается в ядро каждый раз при старте агента для всех динамически и статически
# зарегистрированных витрин, а также во время динамической регистрации витрин;
datamart-registration:
# Список статически регистрируемых витрин.
# Можно задать пустой список [], параметры витрины:
# id - *** ИДЕНТИФИКАТОР ВИТРИНЫ (мнемоника витрины ПОДД в нижнем регистре) ***
# defined-profile - путь к файлу с предустановленным профилем витрины
# Например file:C:/profile.json, по умолчанию используется встроенный профиль datamart_profile/postgresql.json;
# inactive-cleanup-delay - задержка перед деактивацией витрины, 0 - никогда не деактивировать, по умолчанию 0;
# topic-name-prefix - *** ЛИБО ИДЕНТИФИКАТОР ВИТРИНЫ (если не указывать, то по умолчанию id витрины) / ЛИБО ИДЕНТИФИКАТОР ГРУППЫ ВИТРИН ***
datamarts:
- id: {{ vitrine_id1 }}
# Предустановленный профиль. В данном примере используется профиль витрины по умолчанию, находящийся внутри исполняемого пакета Агента
definedProfile: datamart_profile/postgresql.json
- id: {{ vitrine_id2 }}
# Профиль витрины. Используется конфигурируемый пользователем файл postgresql.json.
# В данном примере файл находится в корневом каталоге Агента (там же, где конфигурационный файл application.yml).
# Возможно расположение файла профиля витрины по любому пути с любым названием.
# В этом случае исползуется формат file:/путь/к/файлу/имя.файла
definedProfile: file:postgresql.json
# Настройки для динамически регистрируемых витрин
dynamic:
# Режим работы динамической регистрации:
# - ENABLED - динамическая регистрация включена, общие топики создаются и слушаются агентом при старте;
# - COMPATIBLE - режим по умолчанию, для обратной совместимости. Если список статических витрин пуст (datamarts: [])
# то работает аналогично как в режиме ENABLED. Если список статических витрин не пуст, то общие топики создаются
# при первой динамической регистрации витрины;
# - DISABLED - динамическая регистрация отключена;
mode: COMPATIBLE
# Путь к файлу с предустановленным профилем витрины. Например file:C:/profile.json
defined-profile: datamart_profile/postgresql.json
# Задержка перед деактивацией витрины, 0 - никогда не деактивировать
inactive-cleanup-delay: 0
# Префикс имен топиков, по умолчанию без префикса
topic-name-prefix: ''
Если схема Витрины не прописана в блоке datamart-registration.datamarts, то она будет подключена через группу топиков,
используемую по умолчанию.
Если прописать в конфиге несколько Витрин статически, а префикс оставить по умолчанию, то будет создана отдельная группа топиков для каждой из прописанных статически Витрин (с соответствующим префиксом).
Если прописать в конфиге несколько Витрин статически и задать префикс, то все Витрины, прописанные статически, будут общаться через общую группу с указанным префиксом.
Схемы Витрины, указанные в блоке datamart-registration.datamarts, могут быть сконфигурированы для общения через
отдельную группу топиков или через группу топиков по умолчанию.
Например:
datamart-registration:
datamarts:
# подключение через группу топиков со значением префикса по умолчанию
- id: {{ vitrine_id1 }}
topic-name-prefix: 'vitrine_id1'
# подключение нескольких схем Витрин через отдельную группу топиков
- id: {{ vitrine_id2 }}
topic-name-prefix: 'common'
- id: {{ vitrine_id3 }}
topic-name-prefix: 'common'
# подключение через группу топиков по умолчанию, в соответствии с настройками в блоке dynamic
- id: {{ vitrine_id4 }}
topic-name-prefix: ''
dynamic:
mode: COMPATIBLE
inactive-cleanup-delay: 0
topic-name-prefix: ''
3.3.3.2. Настройка параметров создаваемых топиков (опционально)
Для создаваемых топиков имеется возможность указывать их параметры: фактор репликации, количество партиций и т.п.
Параметры влияют на все топики, создаваемые агентом.
Пример:
kafka:
topic:
property:
num.partitions: 1 # дефолтное значение 1
replication.factor: 1 # дефолтное значение 1
Также можно задавать и другие параметры топиков, описание которых находится по адресу https://kafka.apache.org/documentation/#topicconfigs.
Пример:
kafka:
topic:
property:
cleanup.policy: delete
К ошибке при создании топика будет приводить использование параметров, не определенных в:
3.3.3.3. Настройка взаимодействия через пользовательские топики (опционально)
Для настройки взаимодействия с Витриной через пользовательские топики необходимо:
Отключить автосоздание топиков Apache Kafka Агентом, указав следующие значения параметров в конфигурационном файле Агента СМЭВ4:
datamart:
# автоматическое создание топиков витрины
create-topics:
# регистрация и настройка витрин
config: false
# информационный обмен с использованием SQL
query: false
# репликация
replication: false
Отключить возможность автосоздания топиков на стороне kafka. Для этого в конфигурации Apache Kafka указать параметр
auto.create.topics.enable=falseв соответствии с https://kafka.apache.org/documentation/.Создать в Apache Kafka необходимые топики вручную в соответствии с https://kafka.apache.org/documentation/#basic_ops_add_topic.
Если имена созданных топиков отличаются от имен по умолчанию, указать в конфигурационном файле Агента СМЭВ4 имена используемых топиков.
В примере указаны имена топиков, используемые по умолчанию:
replication:
subscription:
# Топик запросов на регистрацию подписки (Агент -> Витрина)
registration-request-topic: replication.rq
# Топик ответов с успешным результатом регистрации подписки (Витрина -> Агент)
registration-result-topic: replication.rs
# Топик ответов с ошибками регистрации подписки (Витрина -> Агент)
registration-error-topic: replication.err
# Топик запросов на отмену подписки у поставщика (Агент -> Витрина)
cancel-request-topic: replication.cancel.rq
# Топик ответов с результатом отмены подписки у поставщика (Витрина -> Агент)
cancel-result-topic: replication.cancel.rs
# Топик запросов на отмену подписки у потребителя (Агент -> Витрина)
cancel-consumer-request-topic: replication.cancel.in.rq
# Топик ответов с результатом отмены подписки у потребителя (Витрина -> Агент)
cancel-consumer-result-topic: replication.cancel.in.rs
# Топик команд по репликации посылаемых от витрины в сторону ядра (Витрина -> Агент)
command-topic: command.podd
# Параметры конфигурирования топиков для запросов/ответов на создание хранилищ реплик (Агент <-> Витрина)
storage:
# Топик запросов на создание структуры для хранения реплик (Агент -> Витрина)
request-topic: replication.in.rq
# Топик ответов с ошибками создания структуры хранения реплик (Витрина -> Агент)
error-topic: replication.in.err
# Топик ответов с успешным результатом создания структуры хранения реплик (Витрина -> Агент)
response-topic: replication.in.rs
# Параметры конфигурирования топиков работы с дельтами (Агент <-> Витрина)
delta:
# Топик запросов на получение дельт от поставщиков (Агент -> Витрина)
request-topic: delta.rq
# Топик запросов на получение дельт от поставщиков (Агент -> Витрина)
request-tp-topic: delta.tp
# Топик чанков с дельтами (Витрина -> Агент)
response-topic: delta.rs
# Топик ответов с ошибками для реплик (Витрина -> Агент)
error-topic: delta.err
# Топик чанков на применение дельты потребителем (Агент -> Витрина).
# По умолчанию топик настроен под старую реализацию витрины. Для новой реализации витрины
# которая поддерживает распределенные подписки, не важно, используете вы распределенные
# подписки или обычные, в настройках агента за которым стоит новая реализация витрины
# надо поменять имя топика на delta.in.tp:
apply-request-topic: delta.in.rq
# Топик чанков на применение дельты потребителем (Агент -> Витрина)
apply-request-tp-topic: delta.in.tp
# Топик ответов с ошибками применения дельты (Витрина -> Агент)
apply-error-topic: delta.in.err
# Топик ответов с успешным результатом применения дельты (Витрина -> Агент)
apply-response-topic: delta.in.rs
# Топик уведомлений о новых данных по подпискам от поставщика (Витрина -> Агент)
notification-topic: delta.notification
# Топик уведомлений потребителя о новых данных по подпискам (Агент -> Витрина)
notification-datamart-topic: delta.notification.in
# Настройки модуля обработки SQL подзапросов из ядра ПОДД к витрине данных
sub-query:
# Настройки получения SQL подзапроса из ядра и отправки его в витрину
request:
# Топик отправки подзапросов к витрине (Агент -> Витрина)
request-topic-name: query.rq
# Топик подзапросов для вызова регламентированного запроса (хранимой процедуры) (Агент -> Витрина)
regulated-query-request-topic-name: procedure.query.rq
# Топик для передачи чанков табличного параметра (Агент -> Витрина)
table-param-topic-name: query.tp
# Топик для передачи чанков табличного параметра, нарезанных бинарно (Агент -> Витрина)
binary-table-param-topic-name: query.tp.bin
result:
# Топик получения результатов исполнения SQL подзапросов от витрины (Витрина -> Агент)
result-topic-name: query.rs
# Топик получения ошибок исполнения SQL подзапросов от витрины (Витрина -> Агент)
error-topic-name: query.err
# Топик ответов с оценкой (статистикой) по исполнению подзапросов (Витрина -> Агент)
query-estimation-topic-name: query.estimation.rs
# Настройки модуля обработки SQL запросов отправляемых в ядро ПОДД
query:
# Обработчик отмены SQL запросов
cancel:
# Топик нотификаций витрины об отмене SQL запроса (Агент -> Витрина)
request-topic-name: cancel.rq
# Топик передачи результата об отмене SQL запроса (Витрина -> Агент)
result-topic-name: cancel.rs
# Топик передачи ошибок отмены SQL запроса (Витрина -> Агент)
error-topic-name: cancel.err
# Настройки получения BLOB по ссылке
load-reference-data:
# Топик запроса по BLOB ссылке (Агент -> Витрина)
request-topic-name: blob.rq
# Ответный топик с данными (чанки) по BLOB ссылке (Витрина -> Агент)
result-topic-name: blob.rs
# Ответный топик с ошибками обработки запроса по BLOB ссылке (Витрина -> Агент)
error-topic-name: blob.err
# Настройки модуля сбора Статистики
statistic:
# Топик с запросами на сбор статистики (Агент -> Витрина)
requestTopicName: statistic.rq
# Топик с результатами сбора статистики (Витрина -> Агент)
responseTopicName: statistic.rs
# Конфиг модуля регистрации профиля витрины в ядре
datamart-profile:
# Топик с запросами профиля у витрины (Агент -> Витрина)
datamartRequestTopic: profile.rq
# Топик ответов за запросы профиля у витрины (Витрина -> Агент)
datamartResponseTopic: profile.rs
# Топик с неуспешными ответами на запросы профиля у витрины (Витрина -> Агент)
datamartErrorTopic: profile.err
cls:
datamart-topic: scl.signal
Если имена созданных топиков отличаются от имён по умолчанию, указать использование пользовательских топиков на стороне Витрины в конфигурации ПОДД-Адаптера – Модуль исполнения запросов, согласно разделу «7.1.1 Спецификация модуля ПОДД-адаптера – Модуль исполнения запросов» Руководства администратора Типового ПО «Витрина данных».
3.3.4. Настройка подключения к Ядру ПОДД СМЭВ, в том числе для работы в гео-распределенной конфигурации
Предоставляемый шаблон конфигурационного файла имеет настройку по умолчанию для данного параметра. Применять изменения следует только в случае, если значения по умолчанию не подходят для данного Агента СМЭВ4.
Для настройки Агентов необходимо перечислить все Ядра ПОДД СМЭВ(nodes), к которым подключается Агент СМЭВ4, с указанием адресов брокеров, ссылки на Pulsar и сервис авторизации Ядра ПОДД СМЭВ.
Внимание
Масштабируемый Агент (Раздел 3.3.11) должен работать только с одним Ядром ПОДД СМЭВ при использовании транспорта Pulsar, при использовании транспорта RSocket данного ограничения нет. Не масштабированный может работать с двумя Ядрами ПОДД СМЭВ через любой из транспортов (Pulsar, RSocket).
Пример раздела конфигурации:
# Настройки подключения ко всем ЦОД с установленным ПО ядра
data-center:
…
nodes:
- node-id: {{ node1_name }}
# Адреса брокеров (транспорт rsocket)
broker-addresses:
- host: {{ broker1-host }}
port: {{ broker1-port }}
- host: {{ broker2-host }}
port: {{ broker2-host }}
# Настройки подключения к Pulsar (транспорт pulsar)
pulsar:
# есть возможность указания нескольких адресов pulsar, для этого необходимо в переменную "serviceUrl" через запятую прописать все адреса
# пример - serviceUrl: pulsar://{{ address1:port }}, pulsar://{{ address2:port }}
client:
serviceUrl: pulsar://{{ pulsar_kernel1_link }}
...
auth:
keycloak-oauth:
auth-server:
# список адресов серверов авторизации.
# Может быть указано несколько адресов списком.
- url: {{ keycloak_kernel1_link_1 }}
- url: {{ keycloak_kernel1_link_2 }}
- node-id: {{ node2_name }}
broker-addresses:
{...}
pulsar:
{...}
client:
serviceUrl: pulsar://{{ pulsar_kernel2_link }}
{...}
keycloak-oauth:
auth-server:
- url: {{ keycloak_kernel2_link }}
{...}
В блоке data-center.default-node описаны параметры, общие для подключения ко всем Ядрам ПОДД СМЭВ.
Как правило, их изменение не требуется относительно значений по умолчанию.
3.3.5. Настройка подключения к сервису подписания и верификации сообщений
Пример раздела конфигурации:
notarius:
target-host: *** IP АДРЕС СЕРВЕРА NOTARIUS ***
target-port: *** ПОРТ NOTARIUS ***
3.3.6. Настройка модуля подписания печатных форм
Для настройки модуля подписания печатных форм необходимо перечислить используемые сертификаты для данного модуля и данные о них.
При отсутствии используемых печатных форм необходимо указать пустой массив [].
Пример раздела конфигурации:
printable-form:
# Максимальный размер данных для подписания
max-content-length: 268435456
# Настройка каким сертификатом подписать результат какого запроса.
# Пары значений "название регламентированного запроса": "алиас сертификата"
forms:
{{ form1_name }}: {{ key1 }}
{{ form2_name }}: {{ key2 }}
{...}
signature:
# не изменять, всегда указывается пустой массив
printable-form-keys: []
3.3.7. Настройка использования S3 для передачи блобов (опционально)
3.3.7.1. Настройка автоматического скачивания БЛОБ по ссылке Агентом СМЭВ4
Раздел применим для Агента Потребителя. Предоставляемый шаблон конфигурационного файла имеет настройку по умолчанию для данного параметра. Применять изменения следует только в случае, если значения по умолчанию не подходят для данного Агента СМЭВ4.
По умолчанию ссылка на скачивание БЛОБ возвращается ИС Потребителя. При необходимости настроить автоматическую выгрузку Агентом Потребителя БЛОБ по ссылке, полученной в ответе на запрос через REST-интерфейс, следует указать параметр в конфигурационном файле:
# Настройки REST сервера исполнения SQL запросов
rest-query-endpoint:
# Агент автоматически запрашивает БЛОБ, при получении ссылки
blobAutoresolve: true
Примечание
Настройка может быть задана при использовании передачи данных через Pulsar (блок pulsar) и не распространяется на передачу данных с использованием транспорта RSocket (блок broker-addresses). Описание указанных разделов приведено в Раздел 3.3.4.
Примечание
Механизм автоматической выгрузки БЛОБ по ссылке Агентом Потребителя является устаревшим и поддерживается временно, может быть убран без предупреждения в последующих релизах
3.3.7.2. Настройка использования S3 для передачи БЛОБов (опционально)
Раздел применим только при использовании хранилища типа S3 (на стороне Поставщика). В случае если хранилище S3 не используется, данный раздел в конфигурационном файле может отсутствовать.
Для настройки использования S3 для передачи блобов следует указать адрес точки доступа и ссылку на файл с учётными данными для подключения к S3.
Bucket с соответствующим именем должен быть предварительно создан на стороне S3.
Также в файле s3_creds.properties необходимо прописать корректные значения логина и пароля для подключения
к хранилищу S3. Данный файл создается вручную, при наличии необходимости в нем.
Формат указания учетных данных в файле s3_creds.properties:
accessKey = '*** логин ***'
secretKey = '*** пароль ***'
В случае, если S3 не используется (т.е. параметр blob-source имеет значение «DATAMART»), адрес, bucket и путь могут быть указаны любые, либо отсутствовать.
Пример раздела конфигурации:
query:
# Настройки получения BLOB по ссылке
load-reference-data:
# Источник получения данных для BLOB ссылок,
# S3 - данные загружаются агентом из хранилища S3, DATAMART - запрос пересылается витрине
blob-source: DATAMART
# Настройки подключения к хранилищу S3
s3-storage:
endpoint: http://{{ s3_url }}/
# Имя бакета
bucket-name: {{ bucket name }}
# Путь к файлу с данными для авторизации
pathToCredentialFile: {{ /absolute/path/to/s3_creds.properties }}
3.3.8. Настройки разбиения получаемой информации на чанки (опционально)
Предоставляемый шаблон конфигурационного файла имеет настройку по умолчанию для данного параметра. Применять изменения следует только в случае, если значения по умолчанию не подходят для данного Агента ПОДД
Доступна возможность указать способ разбиения получаемой информации при выполнении Регламентированных SQL-запросов на чанки.
Для настройки разбиения получаемой информации на чанки при выполнении запроса через REST-интерфейс необходимо
в конфигурационном файле Агента ПОДД задать параметр tableParamChunkType, который может принимать значения:
EXACTLY_CUT – позволяет разбивать информацию на чанки исходя из размера чанка (размер чанка указывается параметром
tableParamChunkSize, значение по умолчанию 900 KB);EVEN_ROWS – запрещает разбиение информации между чанками (автономно десериализуемые чанки), не гарантируется соблюдение размера чанка.
Пример раздела конфигурации для настройки выполнения запросов через REST-интерфейс:
# Настройки REST сервера исполнения SQL запросов
rest-query-endpoint:
...
# Размер чанка пользовательского табличного параметра
tableParamChunkSize: 900KB
# Способ разбиения пользовательского табличного параметра на чанки
tableParamChunkType: EXACTLY_CUT
Для настройки разбиения получаемой информации на чанки для JDBC драйвера
необходимо добавить в свойства драйвера параметр tableParamChunkType, который может принимать значения:
EXACTLY_CUT – позволяет разбивать информацию на чанки исходя из размера чанка (размер чанка указывается дополнительным свойством в настройках драйвера
tableParamChunkSize, напримерtableParamChunkSize =100KB);EVEN_ROWS – запрещает разбиение информации между чанками (автономно десериализуемые чанки), не гарантируется соблюдение размера чанка.
3.3.9. Настройка организации информационного обмена через API Gateway (опционально)
Настройка информационного обмена через API Gateway для выполнения запросов к REST-сервису ИС Поставщика.
Внимание
Данная настройка опциональна, применяется только при использовании API Gateway; Некоторые шаги выполняются только при использовании https для коммуникации, подробнее см. в описании шагов
Если требуется настройка, то:
шаги 1-4 выполняются в рамках организации информационного обмена через API Gateway по HTTPS;
шаг 5 только для Агента Поставщика/ответчика;
шаг 6 только для Агента Потребителя/инициатора запроса.
Скопировать файл cacerts java в локальный каталог (java должна быть установлена, см. Раздел 5.2.2)
cp /usr/java/lib/security/cacerts /distr/einfahrt/certs/cacerts
Произвести импорт сертификата в java cacerts. Пример:
keytool -importcert -keystore /distr/einfahrt/certs/cacerts -storepass changeit -alias api-gateway -file cert.crt
changeit- пароль по умолчанию для cacerts;cert.crt– файл с сертификатом используемым на стороне https сервера.
В параметры запуска агента добавить ключи
-Djavax.net.ssl.keyStore=certs/cacertsи-Djavax.net.ssl.trustStore=certs/cacerts. При использовании systemd (Раздел 5.2.4) данные параметры добавить в строку описания переменных окружения:Environment="JDK_JAVA_OPTIONS=….Произвести настройку модуля для работы по HTTPS.
Пример раздела конфигурации:
# Настройка модуля API gateway
api-gateway:
# Параметры HTTP-клиента для отправки запросов на стороне поставщика
client:
impl: APACHE
options:
# указать адрес и порт http(s) сервера
default-host: *** адрес подключения к серверу ***
default-port: *** адрес подключения к серверу ***
ssl: true # false при использовании http
verifyHost: false
maxPoolSize: 100
При необходимости настройки таймаутов указать опциональные параметры (ниже приведены дефолтные значения, которые используются в случае, если параметры не указаны явно):
# Настройка модуля API gateway
api-gateway:
# Параметры HTTP-клиента для отправки запросов на стороне поставщика
client:
options:
connectTimeout: 10000 #таймаут подключения, мс
idleTimeout: 60000 #таймаут бездействия, мс
maxPoolSize: 100 #размер пула соединений
maxWaitQueueSize: 0 # 0 - не ждать, возвращает инициатору ошибку 503(service unavailable)
#для impl=VERTX - число ожидающих запросов при исчерпании
#пула соединений (-1 - неограниченная очередь),
#для impl=APACHE - таймаут ожидания соединения
#при исчерпании пула (-1 - неограниченное время
#ожидания), мс
При необходимости изменения порта, используемого ИС Потребителя при обращении к Агенту ПОДД по Регламентированным REST-запросам возможно указание значений следующих параметров:
при использовании транспорта pulsar (по умолчанию 8171):
# Настройка модуля API gateway
api-gateway:
# Параметры HTTP-сервера для приёма запросов на стороне потребителя (транспорт pulsar)
server:
port: 8171
при использовании транспорта rsocket (по умолчанию 8172).
Внимание
Версия Агента СМЭВ4 должна быть 3.8.0 или выше как у инициатора обмена, так и у ответчика
# Настройка модуля API gateway
api-gateway:
# Параметры HTTP-сервера для приёма запросов на стороне потребителя (транспорт rsocket)
target-arch:
server-port: 8172
3.3.10. Настройка параметров времени активации агента (опционально)
Данные параметры применяются для обеспечения обновления масштабированного Агента с нулевым временем простоя.
В примере ниже указаны значения по умолчанию.
agent-activation:
# Таймаут ожидания активации экземпляра Агента при получении запроса
component-activation-timeout: 1s
# Код ошибки HTTP при попытке выполнения SQL запроса на неактивированном экземпляре агента
inactive-query-http-error-code: 501
# Код ошибки HTTP при попытке выполнения APIGateway запроса на неактивированном экземпляре агента
inactive-api-gw-http-error-code: 501
При последовательном обновлении экземпляров масштабированного Агента до новой мажорной версии, экземпляр Агента с новой версией не будет активирован до момента завершения работы агентов более старой версии.
Выполнение запроса к не активированному экземпляру Агента приведет к сообщению об ошибке (коды ошибок в соответствии с примером конфигурации выше), в таком случае система - инициатор запроса должна перенаправить запрос на другой экземпляр Агента.
3.3.11. Настройка подключения к масштабированному Агенту СМЭВ4 (опционально)
Внимание
Масштабирование поддерживается для Агента Инициатора (Потребителя) при использовании любого из транспортов (Pulsar, RSocket). Для Агента Ответчика (Поставщика), т.е. в случае подключённой к Агенту Витрины, масштабирование Агента СМЭВ4 поддерживается только при использовании транспорта RSocket. В случае использования транспорта Pulsar, Агент на стороне Поставщика должен работать строго в одном экземпляре.
Указать URL подключения к агентам.
Для масштабированного агента-потребителя(поставщика), пример раздела конфигурации:
# Настройки REST сервера исполнения SQL запросов
rest-query-endpoint:
# URL подключения к агентам по JDBC (только для implementation = JDBC)
jdbc-url: jdbc:podd://<instance-1-ip-address>:${query-server.port},<instance-2-ip-address>:${query-server.port},<instance-N-ip-address>:${query-server.port}
где <instance-*-ip-address> - адреса всех экземпляров масштабированного агента.
Для не масштабированного Агента Потребителя, а также для Агента Поставщика, можно указать значение
jdbc:podd://localhost:${query-server.port}.
Указать идентификатор экземпляра Агента СМЭВ4. В случае использования масштабируемого Агента СМЭВ4, значение параметра должно быть уникальным для каждого экземпляра Агента СМЭВ4.
Пример раздела конфигурации:
# Настройки модуля "информация об агенте"
agent-info:
# идентификатор экземпляра агента
instanceId: ${HOSTNAME:instance-1}
3.3.12. Настройка подключения к NTP
Предоставляемый шаблон конфигурационного файла имеет настройку по умолчанию для данного параметра. Применять изменения следует только в случае, если значения по умолчанию не подходят для данного Агента СМЭВ4.
В данном разделе необходимо указать один или более IP адрес или HOSTNAME NTP сервера.
ntp:
- host: {{ IP адрес или HOSTNAME NTP }}
В случае, если используется поставляемый в комплекте с Агентом СМЭВ4 пакет chrony, в данном параметре конфигурационного файла Агента СМЭВ4 следует указать IP адрес, на котором работает chrony.
3.3.13. Настройка типа аутентификации агента в ядре
Для получения токена Агентом СМЭВ4, позволяющим взаимодействовать с Ядром ПОДД СМЭВ, необходимо произвести настройку, описанную ниже. В зависимости от использования либо неиспользования mTLS, должен быть выбран один из возможных способов аутентификации агента в ядре (mTLS, при его использовании, обеспечивается средствами инфраструктуры - (см Раздел 2.2.3))
pulsar:
auth:
keycloak-oauth:
# Способ аутентификации в Keycloak:
# - TLS_PUB_KEY - проверка агента на сервере аутентификации выполняется по открытому ключу получаемому
# из сертификата используемого агентом при Mutual-TLS
# - SIGNED_JWT - аутентификация через проверку подписи переданного агентом JWT, при данном способе
# использование Mutual-TLS опционально
auth-type: SIGNED_JWT
# Протокол подключения
# - GOST_TLS - Mutual-TLS по ГОСТ алгоритмам, с использованием ключа CryptoPro (только при использовании mTLS на основе stunnel из состава CryptoPro CSP 5.0 R2)
# - PLAIN_HTTP - обычный HTTP/HTTPS
auth-protocol: PLAIN_HTTP
Значения по умолчанию: SIGNED_JWT и PLAIN_HTTP
3.3.14. Настройка передачи информации в аудит Гостех (только при установке Агента на платформе Гостех)
Для передачи информации аудита, используются следующие параметры:
gostech:
audit:
host: *audit_server_host*
port: *audit_server_port*