Составление конфигурационного файла Агента ПОДД для поcтавщика

Скопировать прямую ссылку на статью

Конфигурационный файл Агента ПОДД представляет собой системный файл с набором параметров, необходимых для запуска и функционирования сервиса.

Для того, чтобы сформировать конфигурационный файл Агента ПОДД для поставщика, необходимо скачать Образцы файлов конфигурирования агента по пути: Документы СМЭВ 4 (ПОДД) -> раздел Для внедрения на портале ЕСКС. После загрузки архива, в соответствии с необходимой операционной системой сервера на котором развернуто ПО Агента ПОДД, перейдите в нужный каталог conf, скопируйте шаблон Поставщика исходя из следующих требований:

1) Шаблон конфигурационного файла Агента-Поставщика для тестовой среды СМЭВ 4:

· test-producer-application.yml.

2) Шаблон конфигурационного файла Агента-Поставщика для продуктивной среды СМЭВ 4 с одноцодной конфигурацией:

· prod- producer-application.yml.

3) Шаблон конфигурационного файла Агента-Поставщика для продуктивной среды СМЭВ 4 с мультицодной конфигурацией:

· prodMC- producer-application.yml.

Содержимое шаблона необходимо скопировать и поместить в рабочий каталог Агента ПОДД, по-умолчанию это: /distr/einfahrt, в файл с названием application.yml.

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

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

Более подробное описание настроек файла application.yml указаны в разделах ниже.

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

В данном блоке необходимо указать основные параметры Агента-Поставщика (Рисунок 1).

Конфиг Поставщика 1.jpg

Рисунок 1 – Блок «Общие настройки агента» конфигурационного файла application.yml».

Параметры agent, keys и trust-store являются обязательными для заполнения:

agent:

(настройка Агента)

· id – в идентификатор Агента необходимо вписать мнемонику ИС Агента из ЛК УВ;

· ogrn – в ОГРН Агента необходимо вписать ОГРН владельца этой ИС Агента из ЛК УВ;

· use-ca – параметр, который подключается если предполагается использование целевой архитектуры (ЦА) (по умолчанию значение false).

Примечание: если необходимые для заполнения конфигурационного файла application.yml данные мнемоники Агента и Витрины данных начинаются с 0, то такие названия необходимо обособить в одинарные кавычки ' '.

keys:

(настройка CryptoPro)

· alias – в идентификатор ключа CryptoPro необходимо вписать название контейнера ключей (полное название контейнера можно найти перейдя в контейнер ключей, в файл с названием name.key);

· password – в пароль ключа CryptoPro необходимо вписать пароль от контейнера ключей.

trust-store:

(настройка хранилища доверенных сертификатов)

· path – в путь к файлу cp_ca_store необходимо прописать путь до директории c файлом «cp_ca_store» из дистрибутивов (в стандартной конфигурации Агента путь по умолчанию: /distr/einfahrt/cp_ca_store, и /директория_с_ПО_Агента/certs/cp_ca_store, если Агент был развёрнут из doker);

· password – в пароль к файлу cp_ca_store необходимо вписать пароль от хранилища доверенных сертификатов.

Примечание: если название мнемоники Агента начинается с 0, то в application.yml такое названия необходимо обособить в одинарные кавычки ' '.

Общие настройки ядра

В следующем блоке прописаны общие настройки для ядра ПОДД и витрины (Рисунок 2). По умолчанию они заполнены и не требуют редактирования.

Конфиг Поставщика 2.jpg

Рисунок 2 – Блок «Общие настройки ядра» конфигурационного файла application.yml.

Общие настройки и регистрация витрины

Данные блоки также необходимо заполнить. Они содержат информацию о Витринах данных (ВД), и сервере, где данные витрины развёрнуты (Рисунок 3).

Конфиг Поставщика 3.jpg

Рисунок 3 – Блоки «Общие настройки витрины», «Настройки регистрации витрин».

kafka-bootstrap-servers – в адрес kafka необходимо вписать адрес сервера, где развернуто ПО витрины.

datamarts.id – в идентификатор витрины необходимо вписать мнемонику Витрины данных (ВД) из ЕИП НСУД (Важно! Обязательно в нижнем регистре).

Настройки подключения к ЦОД с установленным ПО ядра

Для настройки Агента необходимо перечислить не только все Ядра ПОДД, к которым подключается Агент ПОДД, но и указать ссылки на Pulsar и сервис авторизации Ядра ПОДД. Для этих параметров предусмотрена настройка подключения к центрам обработки данных (ЦОД).

Целевая архитектура (ЦА) предназначена для поддержки повышенного трафика в СМЭВ 4. Под целевую архитектуру (ЦА) задействованы порты с 6651 по 6680.

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

keycloak-oauth.auth-server-url – адрес сервиса авторизации, под который задействован порт 443. При использовании нескольких серверов авторизации, они могут быть перечислены через запятую.

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

Рассмотрим несколько вариантов конфигураций:

· Для тестовой среды:

В данной конфигурации реализуется подключение к тестовой среде ПОДД. Предполагается настройка для одной переменной окружения с подключением к адресам брокеров целевой архитектуры (ЦА) и пульсара (Рисунок 4).

Конфиг Поставщика 4.jpg

Рисунок 4 – Блок «Настройки подключения ко всем ЦОД с установленным ПО ядра» для тестовой среды.

Доменное имя podd.test.gosuslugi.ru используется для ip-адреса тестовой среды СМЭВ 4 - 109.207.9.87.

Примечание: если для подключения используется отличный, нестандартный адрес (например, серый), то его необходимо прописать соответствующему доменному имени в /etc/hosts. Если Агент был развернут из docker, то соответствующие изменения необходимо внести в run_agent.sh, так как docker не опрашивает hosts с хост-машины.

· Для продуктивной среды с 1 ЦОД:

В данной конфигурации реализуется подключение к продуктивной среде ПОДД. Предполагается настройка для одной переменной окружения с подключением к адресам брокеров целевой архитектуры (ЦА) и пульсара (Рисунок 5).

Конфиг Поставщика 5.jpg

Рисунок 5 – Блок «Настройки подключения ко всем ЦОД с установленным ПО ядра» для продуктивной среды с 1 ЦОД.

В отличие от тестовой среды для реализации подключения к продуктивной среде через брокеров ЦА и Pulsar прописывается адрес продуктивной среды. Конфигурация с одной переменной окружения (1 ЦОД) работает на адресах, начинающихся с 172.

В keycloak-oauth.auth-server-url прописывается доменное имя podd.gosuslugi.ru - 172.20.59.5, при одноцоцовой конфигурации.

· Для продуктивной среды с мультицодной конфигурацией (МС):

(рекомендуется)

В данной конфигурации реализуется подключение к продуктивной среде ПОДД. Предполагается настройка для нескольких переменных окружения с подключением к адресам брокеров целевой архитектуры (ЦА) и пульсара (Рисунок 6).

Конфиг Поставщика 6.jpg

Рисунок 6 – Блок «Настройки подключения ко всем ЦОД с установленным ПО ядра» для продуктивной среды с 2 ЦОД.

В мультицодной конфигурации с несколькими переменными окружения (2 ЦОД) задействованы адреса, начинающиеся на 109. Также в мультицодной конфигурации реализована возможность указания нескольких адресов pulsar, для этого необходимо в переменной serviceUrl через запятую прописаны все адреса.

В keycloak-oauth.auth-server-url прописаны следующие доменные имена:

109.207.15.26 podd1.gosuslugi.ru
109.207.15.58 podd2.gosuslugi.ru
109.207.15.154 podd3.gosuslugi.ru
109.207.15.186 podd4.gosuslugi.ru

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

В данном блоке описаны общие настройки для всех ядер. Его необходимо оставить без изменений (Рисунок 7).

Конфиг Поставщика 7.jpg

Рисунок 7 – Блок «Общий блок настроек для всех ядер».

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

Конфиг Поставщика 8.jpg

Рисунок 8 – Блок метаданных.

Настройки REST сервиса исполнения SQL запросов

Данный блок настроек также необходимо оставить без редактирования (Рисунок 9).

Конфиг Поставщика 9.jpg

Рисунок 9 – Блок «Настройки REST сервиса исполнения SQL запросов».

Настройка модуля API gateway

Модуль API gateway заполняется, если предполагается помимо обычных SQL-запросов взаимодействие с Витриной через REST-сервисы (например: OpenAPI) (Рисунок 10).

Конфиг Поставщика 10.jpg