4. Описание конфигурационного файла Агента СМЭВ4

4.1. Состав и содержание файлов конфигурирования

Состав дистрибутива Агента СМЭВ4 в архиве с конфигурационными файлами (/distr/einfahrt):

  • /distr/einfahrt/customLogLevels.xml – файл описания настроек логирования;

  • /distr/einfahrt/conf/*.yml – заготовки конфигурационных файлов для Потребителя и Поставщика, для тестовой и продуктивной среды.

В директории /distr/einfahrt/conf/ пакета находятся типовые заготовки конфигурационного файла.

Необходимо взять заготовку конфигурационного файла в соответствии с потребностями:

  • шаблоны конфигурационного файла Агента для продуктивной среды:

    • conf/prod-consumer-application.yml – для Потребителя.

    • conf/prod-producer-application.yml – для Поставщика.

  • шаблоны конфигурационного файла Агента для продуктивной среды (Подключение только к одному ЦОД):

    • conf/prod-singleDC-consumer-application.yml – для Потребителя.

    • conf/prod-singleDC-producer-application.yml – для Поставщика.

  • шаблоны конфигурационного файла Агента для тестовой среды:

    • conf/test-consumer-application.yml – для Потребителя.

    • conf/test-producer-application.yml – для Поставщика.

После распаковки дистрибутива необходимо скопировать выбранный файл в каталог /distr/einfahrt под именем application.yml.

В скопированном конфигурационном файле application.yml задать необходимые параметры (в заготовке обозначены звездочками *). Более подробное описание необходимых настроек файла application.yml приведено в разделах ниже.

4.2. Реестр изменений файлов конфигурирования

Таблица 4.1 содержит Реестр изменений.

Таблица 4.1 Реестр изменений файлов конфигурирования

Версия

Перечень изменений (относительно предыдущей версии)

2.11.0

Для экземпляров Агента СМЭВ4, использующих «печатные формы», добавлен параметр printable-form.max-content-length (Максимальный размер данных для подписания).

2.12.0

Добавлены опциональные параметры настроек таймаута запросов через API GW (см. Раздел 4.3.9).

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

2.12.1

Изменений нет

2.13.0

Значительные изменения конфигурационного файла, для упрощения настроек пользователем:

  • для ряда параметров изменилось их расположение, вынесены на верхние уровни;

  • параметры, значения которых не предназначены для изменения пользователем без значимых причин, убраны из конфигурационного файла.

Используйте поставляемые образцы файлов для внесения Ваших параметров подключения и применения полученного файла с Агентом СМЭВ4.

2.14.0

Изменений нет

2.15.0

  • Добавлен параметр «data-center.signature.keystore-type» с значением «JNI_CSP»;

  • Изменен формат описания печатных форм (только при их использовании).

3.0.0

  • Добавлены параметры подключения к Ядру data-center.nodes.node*.broker-addresses;

  • Версия java обновлена до 17.0.5.

3.1.0

  • В Агент добавлена дополнительная точка подключения API gateway - порт 8172 (см. Раздел 2.3);

  • Указана возможность изменения портов для обращения ИС Инициатора к Агенту при обмене через API Gateway (см. Раздел 4.3.9);

  • В файл конфигурации добавлен параметр podd-client.pool.size;

  • Добавлены разделы по настройке и разворачиванию NTP сервиса:

    • Настройка подключения к NTP;

    • Настройка и запуск NTP сервиса БЕЗ использования Docker;

    • Настройка и запуск NTP сервиса с использованием Docker.

3.2.0

  • Добавлен раздел «podd-client.routes» в конфигурационные файлы для подключения к одному ЦОД;

  • Исключены параметры:

    • datamart-registration.datamarts.registrationFlow;

    • data-center.default-node.pulsar.auth.keycloak-connection.tls-verify- host-name;

    • data-center.signature.additional-properties;

    • allowance.enabled;

  • Добавлен конфигурационный файл postgresql.json;

  • Добавлен раздел по заданию настроек в файле postgresql.json:

    • Настройка предустановленного профиля Витрины в Агенте СМЭВ4.

3.2.1

Изменений нет

3.3.0

  • Исключены параметры:

    • api-gateway.client.options.pipelining;

    • api-gateway.client.options.pipeliningLimit;

  • С данного релиза возможно использование ключей CryptoPro, содержащих пробелы в алиасе;

  • Изменён systemd unit для запуска агента, (см. Раздел 3.2.3)

3.4.0

Изменений нет

3.5.0

  • Добавлен раздел «spring.profiles.active» для настройки активного функционала Агента СМЭВ4;

  • Добавлены параметры управления созданием топиков Apache Kafka:

    • datamart.create-topics.config;

    • datamart.create-topics.query;

    • datamart.create-topics.replication;

    • datamart-registration.create-topics;

    • replication.create-topics;

    • query.create-topics;

  • Исключены параметры:

    • datamart.enabled (начиная с данной версии отключение производится с помощью выбора необходимого функционала параметром spring.profiles.active);

  • Версия JDK обновлена до 17.0.6. При варианте установки без использования Docker требуется обновление jdk на сервере, на котором устанавливается Агент.

3.6.0

Изменений нет

3.7.0

  • Версия JDK обновлена до 17.0.7. При варианте установки без использования Docker требуется обновление jdk на сервере, на котором устанавливается Агент;

  • Изменен формат указания подключения к keycloak: nodes.ID.pulsar.auth.keycloak-oauth.auth-server-url изменен на список адресов url в параметре nodes.ID.pulsar.auth.keycloak-oauth.auth-server;

  • Добавлены параметры времени активации Агента (см. Раздел 4.3.10);

  • Добавлен параметр управления используемым транспортом (pulsar/rsocket): agent.use-ca (см. Раздел 4.3.1);

  • Удален параметр настройки передачи событий Витрины в СЦЛ через rsocket cls.datamart.use-ca, транспорт определяется общим параметром agent.use-ca (см. Раздел 4.3.1);

  • Добавлено ограничение на использование транспорта rsocket при обмене по Регламентированным REST-запросам (см. Раздел 2.3):

    • значение параметра agent.use-ca должно быть true как на стороне Потребителя, так и на стороне Поставщика (см. Раздел 4.3.1);

    • версия Агента Потребителя и Поставщика должна быть не ниже 3.8.0;

    • Потребитель и Поставщик должны использовать единый транспорт (rsocket/pulsar).

3.8.0

  • Добавлен параметр для управления возможностью получения метаданных Витрин при использовании JDBC-драйвера: query.metadata.storeToDb.

3.9.0

Изменений нет

3.9.1

Изменений нет

3.10.0

Добавлено описание параметров создания топиков kafka (см. Раздел 4.3.5.1)

3.11.0

Изменений нет

3.12.0

Исключен параметр:

  • query.metadata.storeToDb

3.13.0

Исключены параметры:

  • datamart-registration.datamarts.registrationFlow

  • datamart-registration.datamarts.definedProfile

Исключен файл postgresql.json

3.14.0

Исключены параметры:

  • trust-store.path

  • trust-store.password

  • data-center.default-node.pulsar.auth.keycloak-oauth.auth-type

  • data-center.default-node.pulsar.auth.keycloak-oauth.auth-protocol

  • data-center.signature.keystoreType

3.15.0

Добавлены параметры:

  • datamart.integration.blobAdapter.host;

  • datamart.integration.blobAdapter.port;

  • datamart.integration.prostore.host;

  • datamart.integration.prostore.port;

  • datamart.integration.type;

Параметр datamart.kafka-bootstrap-servers изменен на datamart.integration.kafka.kafka-bootstrap-servers.

3.16.0

Добавлены опциональные параметры:

  • notarius.target-host;

  • notarius.target-port;

3.17.0

Изменений нет

3.18.0

Исключены параметры:

  • agent.use-ca;

  • nodes.*node*.pulsar.*;

  • rest-query-endpoint.blobAutoresolve;

  • rest-query-endpoint.jdbc-url;

Добавлен параметр:

  • nodes.*node*.auth.*

3.19.0

Изменений нет

3.20.1

Исключен параметр datamart.zero-base-chunk-num

Значение параметра query.default-query-timeout по умолчанию установлено в 20 секунд

Изменены способ включения и настройки логирования для платформы Гостех (см. Раздел 3.3)

Добавлена возможность сохранения тел запросов во внешнюю систему (clickhouse) (см. Раздел 3.4)

3.21.0

Исключены параметры

  • core.mnemonic

  • core.broadcast-tenant

3.22.0

Изменений нет

4.3. Формирование конфигурационного файла Агента СМЭВ4

4.3.1. Общие настройки Агента

  1. При необходимости настроить список активного функционала Агента СМЭВ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.

  1. Указать идентификатор Агента СМЭВ4:

  • идентификатор агента (мнемоника соответствующей ИС из ЛК УВ);

  • ОГРН Агента (ОГРН организации владельца ИС из ЛК УВ)

agent:
  # Идентификатор (мнемоника) агента
  # При использовании id или ogrn состоящих только из цифр, их следует заключать в одинарные или двойные кавычки
  id: '*** ИДЕНТИФИКАТОР (МНЕМОНИКА) АГЕНТА ***'
  ogrn: '*** ОГРН АГЕНТА ***'

4.3.2. Настройка ключей CryptoPro

Указать идентификатор и пароль контейнера ключа CryptoPro:

Подробнее об идентификаторе ключа и о том, как получить контейнер закрытого ключа электронной подписи на портале ЕСКС.

keys:
  alias: '*** ИДЕНТИФИКАТОР КЛЮЧА CryptoPro ***'
  password: '*** ПАРОЛЬ КЛЮЧА CryptoPro ***'

Внимание

Нельзя использовать кириллицу в имени alias!

Примечание

Указывать параметр password не требуется, если используется сервис подписания и верификации сообщений (см. Раздел 4.3.12.1)

В случае, если идентификатор ключа CryptoPro содержит пробелы, его следует заключить в одинарные кавычки.

4.3.3. Настройка регистрации Витрин данных и подключения к Apache Kafka (только при использовании Витрин)

Внимание

указание адреса сервера(серверов) Apache Kafka (параметр datamart.integration.kafka.kafka-bootstrap-servers) обязателен, если используется хотя бы один профайл из списка: QueryProvider, ReplicationConsumer, ReplicationProvider. Список включенных профайлов определяется параметром spring.profiles.active, см. описание выше.

4.3.3.1. Настройка создания топиков Агентом СМЭВ4

Далее приведено описание раздела конфигурации для настройки создания топиков Агентом СМЭВ4.

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

Схемы Витрины могут общаться через одну группу топиков только в случае, если относятся к одному ПО «Витрина данных» и являются схемами одной (физической) Витрины.

Блок параметров datamarts.create-topics может отсутствовать в конфигурационном файле, в этом случае используются значения по умолчанию: включено автоматическое создание топиков для всех видов информационного обмена (Регламентированные SQL-запросы, Рассылки), отключено автоматическое создание топиков регистрации и настройки Витрин.

Таблица 4.2 содержит соответствие создаваемых топиков Apache Kafka параметрам конфигурационного файла.

Таблица 4.2 Соответствие параметров конфигурационного файла и создаваемых топиков

№

Настройка

Параметр

Создаваемые топики [3]

1

Топики для информационного обмена с использованием Регламентированных SQL-запросов

query

  • Топики для обеспечения информационного обмена с использованием SQL-запросов;

  • Топики для получения статистики по Витринам;

  • Топики для получения событий Витрины.

2

Топики для информационного обмена с использованием Рассылок

Replication,

ReplicationProvider

  • Топики для обеспечения информационного обмена с использованием подписок (для Поставщика);

  • Топики для получения событий Витрины.

Replication, ReplicationConsumer

  • Топики для обеспечения информационного обмена с использованием подписок (для Потребителя);

  • Топики для получения событий Витрины

3

Топики регистрации и настройки Витрин

config

  • Топики регистрации и настройки Витрин

Для настройки создания топиков для обмена по Рассылкам только для Поставщика или Потребителя необходимо использовать настройки активного функционала Агента СМЭВ4 Replication, указанные в Раздел 4.3.1.

Если инициатором обмена по Рассылке является Витрина или ИС Потребителя для корректного осуществления обмена необходимо задать один из видов настроек:

  • при использовании режима COMPATIBLE прописать Витрину в блоке datamarts:

  • установить режим ENABLED для создания общей группы топиков при старте Агента.

В случае отсутствия Витрин у Агента СМЭВ4 есть возможность отключить функционал в соответствии с Раздел 4.3.1. В этом случае раздел datamart-registration может полностью отсутствовать в конфигурационном файле.

# Общие настройки витрин
datamart:
  integration:
    # подключение к Kafka для взаимодействия с витринами
    kafka:
      kafka-bootstrap-servers: {{ kafka_link }}
      # автоматическое создание топиков витрины
      create-topics:
        # регистрация и настройка витрины
        config: false
        # информационный обмен с использованием SQL
        query: true
        # репликация
        replication: true

# Настройки регистрации витрин.
#   - Витрины могут регистрироваться в агенте двумя способами:
#       - статически - витрина прописывается в конфиге агента (блок datamarts:), в этом случае используются
#         прописанные для данной витрины настройки, топики витрины создаются и слушаются агентом при старте;
#       - динамически - автоматическая регистрация, в этом случае используется общий набор настроек (блок dynamic:);
#   - Если агенту приходит сообщение из ядра для незарегистрированной витрины, агент регистрирует её динамически.
#   - Регистрация витрины также может быть инициирована со стороны витрины, через специальный топик, в
#     этом случае витрина регистрируется динамически, если она не прописана статически. Это позволяет
#     получать профиль запросом с витрины при динамической регистрации.
#   - Через некоторый таймаут (inactive-cleanup-delay) если к витрине не приходят запросы, агент её
#     деактивирует (выключаются потребители и удаляются топики) для экономии ресурсов;
#   - Если агенту приходит сообщение из ядра для деактивированной витрины, агент её активирует обратно.
#   - Профиль витрины отсылается в ядро каждый раз при старте агента для всех динамически и статически
#     зарегистрированных витрин, а также во время динамической регистрации витрин;

datamart-registration:
  # Список статически регистрируемых витрин.
  # Можно задать пустой список [], параметры витрины:
  #    id - *** ИДЕНТИФИКАТОР ВИТРИНЫ (мнемоника витрины в нижнем регистре) ***
  #    inactive-cleanup-delay - задержка перед деактивацией витрины, 0 - никогда не деактивировать, по умолчанию 0;
  #    topic-name-prefix - *** ЛИБО ИДЕНТИФИКАТОР ВИТРИНЫ (если не указывать, то по умолчанию id витрины) / ЛИБО ИДЕНТИФИКАТОР ГРУППЫ ВИТРИН ***
  datamarts:
    - id: {{ vitrine_id1 }}
    - id: {{ vitrine_id2 }}

  # Настройки для динамически регистрируемых витрин
  dynamic:
    # Режим работы динамической регистрации:
    #   - ENABLED - динамическая регистрация включена, общие топики создаются и слушаются агентом при старте;
    #   - COMPATIBLE - режим по умолчанию, для обратной совместимости. Если список статических витрин пуст (datamarts: [])
    #     то работает аналогично как в режиме ENABLED. Если список статических витрин не пуст, то общие топики создаются
    #     при первой динамической регистрации витрины;
    #   - DISABLED - динамическая регистрация отключена;
    mode: COMPATIBLE
    # Задержка перед деактивацией витрины, 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: ''

4.3.4. Настройка возможности выполнения SQL-РЗ при взаимодействии Агента СМЭВ4 с Витриной по HTTP (опционально)

Для обеспечения прямого взаимодействия Агента СМЭВ4 с Prostore на стороне Витрины, необходимо скопировать данный блок в файл application.yml и заполнить параметры datamart.integration.prostore.* актуальными данными:

datamart:
  integration:
    type: HTTP
    prostore:
      host: '*** prostore_host ***'
      port: '*** prostore_port ***'

Примечание

Данная настройка применима только при использовании Компонента «Витрина данных» версии 2.0.0 и выше.

4.3.5. Настройка организации информационного обмена с blob adapter (требуется только при включенном профайле QueryProvider)

Для обеспечения прямого взаимодействия Агента СМЭВ4 с blob-адаптером на стороне Витрины, необходимо скопировать данный блок в файл application.yml и заполнить параметры datamart.integration.blobAdapter.* актуальными данными:

Примечание

Указание данного параметра требуется только при включенном профайле QueryProvder, см. Раздел 4.3.1

datamart:
  integration:
    blobAdapter:
      host: '*** blob_adapter_host ***'
      port: '*** blob_adapter_port ***'

4.3.5.1. Настройка параметров создаваемых топиков (опционально)

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

Параметры влияют на все топики, создаваемые агентом.

Пример:

kafka:
  topic:
    property:
      num.partitions: 1        # дефолтное значение 1
      replication.factor: 1    # дефолтное значение 1

Также можно задавать и другие параметры топиков, описание которых находится по адресу https://kafka.apache.org/documentation/#topicconfigs

Пример:

kafka:
  topic:
    property:
      cleanup.policy: delete

Использование параметров не определенных в https://kafka.apache.org/documentation/#topicconfigs или num.partitions / replication.factor будет приводить к ошибке при создании топика.

4.3.5.2. Настройка взаимодействия через пользовательские топики (опционально)

Для настройки взаимодействия с Витриной через пользовательские топики необходимо:

  1. Отключить автосоздание топиков Apache Kafka Агентом, указав следующие значения параметров в конфигурационном файле Агента СМЭВ4:

datamart:
  # автоматическое создание топиков витрины
  create-topics:
    # регистрация и настройка витрин
    config: false
    # информационный обмен с использованием SQL
    query: false
    # репликация
    replication: false

  1. Отключить возможность автосоздания топиков на стороне Apache Kafka. Для этого в конфигурации Apache Kafka указать параметр auto.create.topics.enable=false в соответствии с https://kafka.apache.org/documentation/.

  2. Создать в Apache Kafka необходимые топики вручную в соответствии с https://kafka.apache.org/documentation/#basic_ops_add_topic.

  3. Если имена созданных топиков отличаются от имен по умолчанию, указать в конфигурационном файле Агента СМЭВ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 подзапросов из ядра СМЭВ4 к витрине данных
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 запросов отправляемых в ядро СМЭВ4
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

  1. Если имена созданных топиков отличаются от имён по умолчанию, указать использование пользовательских топиков на стороне Витрины в конфигурации СМЭВ4-Адаптера – Модуль исполнения запросов, согласно разделу «7.1.1 Спецификация модуля СМЭВ4-адаптера – Модуль исполнения запросов» Руководства администратора Типового ПО «Витрина данных».

4.3.6. Настройка подключения к Ядру СМЭВ4, в том числе для работы в гео-распределенной конфигурации

Предоставляемый шаблон конфигурационного файла имеет настройку по умолчанию для данного параметра. Применять изменения следует только в случае, если значения по умолчанию не подходят для данного Агента СМЭВ4.

Для настройки Агентов необходимо перечислить все Ядра СМЭВ4 (nodes), к которым подключается Агент СМЭВ4, с указанием адресов брокеров и сервиса авторизации Ядра СМЭВ4.

Пример раздела конфигурации:

# Настройки подключения ко всем ЦОД с установленным ПО Ядра СМЭВ4
data-center:
…
nodes:
    - node-id: {{ node1_name }}
      # Адреса брокеров
      broker-addresses:
        - host: {{ broker1-host }}
          port: {{ broker1-port }}
        - host: {{ broker2-host }}
          port: {{ broker2-host }}
      auth:
        oauth:
          auth-server:
            # список адресов серверов авторизации.
            # Может быть указано несколько адресов списком.
            - url: {{ authentication_kernel1_address_1 }}
            - url: {{ authentication_kernel1_address_2 }}
    - node-id: {{ node2_name }}
      broker-addresses:
      {...}
      auth:
        oauth:
          auth-server:
            # Может быть указано несколько адресов списком.
            - url: {{ authentication_kernel2_address_1 }}
            - url: {{ authentication_kernel2_address_2 }}
      {...}

В блоке data-center.default-node описаны параметры, общие для подключения ко всем Ядрам СМЭВ4. Как правило, их изменение не требуется относительно значений по умолчанию.

4.3.7. Настройка модуля подписания печатных форм

Для настройки модуля подписания печатных форм необходимо перечислить используемые сертификаты для данного модуля и данные о них.

При отсутствии используемых печатных форм, данный раздел в конфигурации должен отсутствовать.

Пример раздела конфигурации:

printable-form:
  # Максимальный размер данных для подписания
  max-content-length: 268435456
  # Настройка каким сертификатом подписать результат какого запроса.
  # Пары значений "название регламентированного запроса": "алиас сертификата"
  forms:
    {{ form1_name }}: {{ key1 }}
    {{ form2_name }}: {{ key2 }}
        {...}
  signature:
    printable-form-keys:
      -
        certificateAlias: {{ key1 }}
        privateKeyAlias: {{ key1 }}
        privateKeyPass: {{ key1_password }}

      -
        certificateAlias: {{ key2 }}
        privateKeyAlias: {{ key2 }}
        privateKeyPass: {{ key2_password }}
        {...}

4.3.7.1. Настройка использования 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 }}

4.3.8. Настройки разбиения получаемой информации на чанки (опционально)

Предоставляемый шаблон конфигурационного файла имеет настройку по умолчанию для данного параметра. Применять изменения следует только в случае, если значения по умолчанию не подходят для данного Агента СМЭВ4.

Доступна возможность указать способ разбиения получаемой информации при выполнении Регламентированных SQL-запросов на чанки.

Для настройки разбиения получаемой информации на чанки при выполнении запроса через REST-интерфейс необходимо в конфигурационном файле Агента СМЭВ4 задать параметр rest-query-endpoint.tableParamChunkType, который может принимать значения:

  • EXACTLY_CUT – позволяет разбивать информацию на чанки исходя из размера чанка (размер чанка указывается параметром rest-query-endpoint.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 – запрещает разбиение информации между чанками (автономно десериализуемые чанки), не гарантируется соблюдение размера чанка.

4.3.9. Настройка организации информационного обмена через API Gateway (опционально)

Настройка информационного обмена через API Gateway для выполнения запросов к REST-сервису ИС Поставщика.

Внимание

Данная настройка опциональна, применяется только при использовании API Gateway; Некоторые шаги выполняются только при использовании HTTPS для коммуникации, подробнее см. в описании шагов

Если требуется настройка, то:

  • шаги 1-4 выполняются в рамках организации информационного обмена через API Gateway по HTTPS;

  • шаг 5 только для Агента Поставщика/ответчика;

  • шаг 6 только для Агента Потребителя/инициатора запроса.

  1. Скопировать файл cacerts java в локальный каталог (Java должна быть установлена, см. Раздел 3.2.2)

cp  /usr/lib/jvm/axiomjdk-java17.x86_64/lib/security/cacerts /distr/einfahrt/certs/cacerts

  1. Произвести импорт сертификата в java cacerts. Пример раздела конфигурации:

keytool -importcert -keystore /distr/einfahrt/certs/cacerts -storepass changeit -alias api-gateway -file cert.crt

  • changeit - пароль по умолчанию для cacerts;

  • cert.crt – файл с сертификатом используемым на стороне HTTPS сервера поставщика данных.

  1. В параметры запуска агента добавить ключи -Djavax.net.ssl.keyStore=certs/cacerts и -Djavax.net.ssl.trustStore=certs/cacerts. При использовании systemd (Раздел 3.2.3) данные параметры добавить в строку описания переменных окружения: Environment="JDK_JAVA_OPTIONS=….

  2. Произвести настройку модуля для работы по HTTPS. Пример раздела конфигурации:

# Настройка модуля API gateway
api-gateway:
  # Параметры HTTP-клиента для отправки запросов на стороне поставщика
  client:
    impl: APACHE
    options:
      # указать адрес и порт http(s) сервера
      default-host: '*** адрес подключения к серверу ***'
      default-port: '*** адрес подключения к серверу ***'
      ssl: true          # false при использовании http
      verifyHost: false
      maxPoolSize: 100

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

# Настройка модуля 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 - неограниченное время
                          #ожидания), мс

  1. При необходимости изменения порта, используемого ИС Потребителя при обращении к Агенту СМЭВ4 по Регламентированным REST-запросам требуется указать значения следующих параметров:

  • при использовании протокола 1 (по умолчанию 8171):

# Настройка модуля API gateway
api-gateway:
  # Параметры HTTP-сервера для приёма запросов на стороне потребителя
  server:
    port: 8171

  • при использовании протокола 2 (по умолчанию 8172).

Внимание

Версия Агента СМЭВ4 должна быть 3.8.0 или выше как у инициатора обмена, так и у ответчика.

# Настройка модуля API gateway
api-gateway:
  # Параметры HTTP-сервера для приёма запросов на стороне потребителя
  target-arch:
    server-port: 8172

4.3.10. Настройка параметров времени активации Агента СМЭВ4 (опционально)

Данные параметры применяются для обеспечения обновления масштабированного Агента СМЭВ4 с нулевым временем простоя.

В примере ниже указаны значения по умолчанию.

agent-activation:
  # Таймаут ожидания активации экземпляра Агента при получении запроса
  component-activation-timeout: 1s
  # Код ошибки HTTP при попытке выполнения SQL запроса на неактивированном экземпляре агента
  inactive-query-http-error-code: 501
  # Код ошибки HTTP при попытке выполнения APIGateway запроса на неактивированном экземпляре агента
  inactive-api-gw-http-error-code: 501

При последовательном обновлении экземпляров масштабированного Агента СМЭВ4 до новой мажорной версии, экземпляр Агента СМЭВ4 с новой версией не будет активирован до момента обновления других экземпляров.

Выполнение запроса к не активированному экземпляру Агента СМЭВ4 приведет к ошибке (коды ошибок в соответствии с примером конфигурации выше), в таком случае система - инициатор запроса должна перенаправить запрос на другой экземпляр Агента СМЭВ4.

4.3.11. Настройка Агента СМЭВ4 для работы в масштабированном варианте (опционально)

  1. Указать идентификатор экземпляра Агента СМЭВ4. В случае использования масштабируемого Агента СМЭВ4, значение параметра должно быть уникальным для каждого экземпляра Агента СМЭВ4.

Пример раздела конфигурации:

# Настройки модуля "информация об агенте"
agent-info:
  # идентификатор экземпляра агента (HOSTNAME используется только при запуске под kubernetes, в остальных случаях следует использовать уникальные идентификаторы)
  instanceId: ${HOSTNAME:instance-1}

  1. При создании отказоустойчивого кластера каждый экземпляр КриптоПро CSP 5 R3 должен работать под лицензией и не нарушать лицензионных условий производителя (Раздел 2.2.3).

4.3.12. Настройка подключения к NTP

Предоставляемый шаблон конфигурационного файла имеет настройку по умолчанию для данного параметра. Применять изменения следует только в случае, если значения по умолчанию не подходят для данного Агента СМЭВ4.

В данном разделе необходимо указать один или более IP адрес или HOSTNAME NTP сервера.

ntp:
- host: {{ IP адрес или HOSTNAME NTP }}

В случае, если используется поставляемый в комплекте с Агентом СМЭВ4 пакет chrony, в данном параметре конфигурационного файла Агента СМЭВ4 следует указать IP-адрес, на котором работает chrony.

4.3.12.1. Настройка подключения к сервису криптографии (опционально)

Агент СМЭВ4 может работать как использовать встроенные средства криптографии, так и предоставляемые опциональным компонентом Notarius. В случае использования Notarius для средств криптографии, необходимо добавить блок notarius в файл application.yml и заполнить параметр notarius.target-host.

Пример раздела конфигурации (номер порта должен соответствовать указанному в конфигурационном файле Notarius, см. Раздел 9.2.4):

notarius:
  enabled: true
  endpoints:
    - target-host: '*** IP АДРЕС ПЕРВОГО СЕРВЕРА ПОДПИСАНИЯ И ВЕРИФИКАЦИИ СООБЩЕНИЙ СМЭВ4 ***'
      target-port: 8696
    - target-host: '*** IP АДРЕС ВТОРОГО СЕРВЕРА ПОДПИСАНИЯ И ВЕРИФИКАЦИИ СООБЩЕНИЙ СМЭВ4 (при наличии) ***'
      target-port: 8696
    {...}

Внимание

При использовании более одного экземпляра сервера подписания и верификации сообщений (notarius), каждый экземпляр должен быть указан в вышеуказанном списке явным образом. НЕ ДОПУСКАЕТСЯ использование любого вида прокси и балансировщиков между Агентом СМЭВ4 и Сервером подписания и верификации сообщений СМЭВ4 (notarius)

При указании данного параметра внутренние криптографические функции в Агенте СМЭВ4 не задействуются.

4.3.13. Настройка передачи информации аудита в ГосТех (опционально)

Для активации передачи информации аудита при работе Агента СМЭВ4 на платформе ГосТех, необходимо скопировать данный блок в файл application.yml и заполнить параметры gostech.audit.* актуальными данными:

gostech:
  enabled: true
  audit:
    host: '*** audit_server_host ***'
    port: '*** audit_server_port ***'

4.3.14. Настройка параметров Сервиса проверки полномочий (опционально)

Для активации работы функций Сервиса проверки полномочий (Раздел 8), необходимо скопировать данный блок в файл application.yml и заполнить параметры allowance.prohibitor-client.* актуальными данными:

allowance:
  enabled-sql: true
  enabled-api-gateway: true
  prohibitor-client:
    default-host: '*** prohibitor_server_host ***'
    default-port: '*** prohibitor_server_port ***'

4.3.15. Настройка таймаутов исполнения запросов по умолчанию (опционально)

Для изменения таймаутов по умолчанию (применяются при отсутствии таймаута в запросе) требуется добавить в конфигурацию агента дополнительные параметры. (Примеры значений: 15s, 5m, 1h). При отсутствии параметра в конфигурации применяется значение по молчанию, указанное ниже.

query:
  ...
  # Таймаут для SQL-запросов, включая запросы блобов через JDBC
  default-query-timeout: 20s
  # Таймаут для запросов блобов по ссылке через REST
  default-blob-query-timeout: 20s

api-gateway:
  ...
  # Таймаут для API Gateway запросов
  default-apigw-query-timeout: 20s

4.4. Настройка сбора метрик Агента СМЭВ4 (опционально)

4.4.1. Настройка Агента СМЭВ4 для передачи метрик в Prometheus

Агент поддерживает возможность передачи метрик работы во внешнюю систему сбора метрик Prometheus.

Для включения возможности передачи необходимо добавить в конфигурационный файл следующие параметры:

metrics:
  implementation: PROMETHEUS
  # порт, при обращении к которому Агент отдаёт значения метрик
  endpointPort: 8381

Prometheus следует настроить на опрос адреса, на котором запущен Агент СМЭВ4, по указанному порту.

При запуске Агента под Docker также необходимо добавить указанный порт в список expose ports в скрипте запуска Агента.

Список используемых метрик приведен в Раздел 7.

4.5. Переопределение значений портов REST и JDBC интерфейсов Агента СМЭВ4 (опционально, в случае необходимости)

Порты REST и JDBC интерфейсов при необходимости можно изменить указанием следующих параметров в конфигурационном файле.

Для REST интерфейса (по умолчанию 8192):

rest-query-endpoint:
  port: 8192

Для JDBC интерфейса (по умолчанию 8183):

query-server:
  port: 8183

В случае запуска Агента СМЭВ4 под Docker, необходимо также изменить значения портов в скрипте run_agent.sh (см. Раздел 3.5.5)