9. Конфигурация Proxy API
При установке Datamart Platform Studio, по умолчанию происходит также установка и запуск системного экземпляра модуля Proxy API (настройка PROXYAPI_STUDIO_ENABLE=true, в конфигурационном файле). Управление системным модулем происходит через настройки конфигурационного файла.При необходимости, в Datamart Platform Studio можно добаавить дополнительные экземпляры модуля Proxy API, используя системный бандл модуля.
Помимо этого, возможна конфигурация модулей Proxy API с отключением системного модуля (PROXYAPI_STUDIO_ENABLE=false), в этом случае системный модуль, после перезапуска Datamart Platform Studio с указанной настройкой, будет выключен. В данной конфигурации возможно развертывание отдельных модулей Proxy API для каждой из услуг Datamart Platform Studio.
Примечание
Системный модуль Proxy API всегда сконфигурирован для работы со всеми услугами, входящими в экземпляр Datamart Platform Studio и не может быть сконфигурирован под конкретную услугу.
В интерфейсе Datamart Platform Studio реализована возможность горизонтального масштабирования числа модулей Proxy API из системного бандла как на уровне Datamart Platform Studio, так и на уровне услуг студии. Предлагается конфигурировать работу proxy api несколькими способовами:
При конфигурации с включенным системным модулем, горизонтальное масштабирование модулей Proxy API осуществляется также на уровне Datamart Platform Studio;
При конфигурации с выключенным системным модулем, горизонтальное масштабирование модулей Proxy API осуществляется на уровне услуг студии.
Примечание
При любой конфигурации ограничений на количество выделенных модулей нет.
9.1. Общие положения
Управление дополнительными модулями Proxy API осуществляется из раздела «ProxyAPI» рабочего пространства «Администрирование»(см. „proxy_api_1“) и в одноименном разделе любой из Услуг (см. „proxy_api_2“).
Управление выделенным модулем осуществляется в таблице по кнопке «Управление». Набор действий в меню «Управление» зависит от статуса модуля и аналогичен меню «Управление» инсталляциями Услуг.
9.2. Настройка системного модуля Proxy API
Настройка системного модуля осуществляется в .env файле (см. разделы: Раздел 10.3 Настройка параметров в файле конфигурации) в разделе «Настройки модуля proxy api». По умолчанию модуль устанавливается на тот же сервер что и Datamart Platform Studio и включается после установки. Для применения измененных настроек системного модуля необходимо внести изменения в конфигурационный файл Datamart Platform Studio и перезапустить ее.
9.3. Настройка дополнительных модулей Proxy API
Настройка выделенных proxy API осуществляется из раздела «ProxyAPI» рабочего пространства «Администрирование» и карточки услуги.
Рисунок 9.1 Раздел ProxyAPI в рабочем пространстве Администрирование
Рисунок 9.2 Раздел ProxyAPI в карточке услуги
Для добавления модуля в разделе «ProxyAPI» необходимо выбрать действие «Добавить модуль». Модальное окно добавления содержит следующие поля:
Версия компонента
Сервер
Услуга
Наименование
Рисунок 9.3 Добавление модуля Proxy API
Поле «Версия компонента» всегда заполнено совместимой с текущей версией Datamart Platform Studio версией модуля. При выборе сервера доступен множественный выбор для установки сразу нескольких модулей Proxy API на разные сервера. При выборе услуги из выпадающего списка можно выбрать услугу или значение «Все услуги». При выборе значения «Все услуги» модуль Proxy API будет сконфигурирован для работы со всеми услугами Datamart Platform Studio. При выборе конкретной услуги, модуль Proxy API будет взаимодействовать только с указанной услугой, при попытке выполнить запрос к любой другой услуге Datamart Platform Studio с использованием этого экземпляра модуля, он вернет ошибку.
При добавлении модуля из карточки услуги поле «Услуга» будет предзаполнено соответствующей услугой. То есть добавить выделенный модуль можно только для услуги.
Рисунок 9.4 Добавление модуля из карточки услуги
Меню «Управление» модулем Proxy API аналогично меню «Управление» инсталляциями услуг. Для неустановленного на сервер компонента, доступны действия:
Установить
Редактировать
Удалить
Для установленного на сервер компонента, доступны действия:
Переустановить
Деинсталлировать
Показать изменения
Действия (список доступных модулю плейбуков)
Обновить приложение
Редактировать
Рисунок 9.5 Управление модуля
Для установленного модуля в модальном окне редактирования доступно только изменение наименования модуля