Руководство пользователя Реестра Сервисов

6.Администрирование.

6.11.Управление справочником «Реестр системных сервисов».

Справочник предназначен для централизованного хранения и управления внутренними, системными REST/SOAP-эндпоинтами, используемыми компонентами Реестра сервисов (например, Polus ESB, Менеджер сценариев и другими).

Каждая запись определяет единый источник правды для URL и метода вызова системного сервиса. Поля таблицы справочника и их назначение описаны в таблице 47.

Таблица 47Поля таблицы справочника и их назначение.
Поле Описание Заполнение Описание и ограничения
Наименование Текстовое поле Обязательное Уникальное понятное имя сервиса.
Максимальная длина поля: 200 символов (ограничение на сервере).
Fabio route Текстовое поле Обязательное поле. Максимальная длина поля: 255 символов.
Уникальный маршрут в маршрутизаторе запросов Fabio, управляемой Consul. Настраивает таблицу маршрутизации на основе данных, хранящихся в Consul.
Должен соответствовать правилам именования Fabio (обычно: service-name/version).
Цель Fabio route: распределять входящие запросы на сервисы, которые должны их обрабатывать. При этом используется функция обнаружения сервисов в Consul, чтобы находить сервисы, которые нужны для обслуживания запроса.
Метод Выпадающий список Обязательное поле. Выбор из стандартизированного набора HTTP-методов: GET, POST, PUT, DELETE, PATCH, HEAD, OPTIONS, TRACE.
Изменил Логин пользователя Автоматическое Заполняется автоматически при сохранении/изменении записи на основании данных входа в систему соответствующего пользователя.
Дата Дата и время Автоматическое Формат: ДД.ММ.ГГГГ ЧЧ:мм:сс.
Действия Кнопки управления «Сохранить», «Отмена», «Удалить» Автоматическое Появляются при редактировании имеющихся записей. При создании новой записи кнопка «Отмена» неактивна.

Область «Управление справочником «Реестр системных сервисов»» содержит все используемые в Реестре системные сервисы. Кнопка «Создать» создаёт новый системный сервис.

Рисунок 112Область «Управление справочником «Реестр системных сервисов»».
Область «Управление справочником «Реестр системных сервисов»».

После создания нового системного сервиса начинается его редактирование.

Рисунок 113Добавление в справочник «Реестр системных сервисов».
Добавление в справочник «Реестр системных сервисов».

После заполнения всех обязательных полей становится доступной кнопка «Сохранить».

Рисунок 114Готовые к сохранению данные.
Готовые к сохранению данные.

Редактирование имеющихся данных происходит аналогично.

Рисунок 115Редактирование имеющихся в справочнике «Реестр системных логинов» данных.
Редактирование имеющихся в справочнике «Реестр системных логинов» данных.

Кнопки редактирования появляются после нажатия на строку с данными.

Режимы работы.

Создание, редактирование и удаление записей аналогичны порядку работы с другими вышеперечисленными справочниками.

Валидация и ограничения.

Обязательные поля: не допускается сохранение параметров с незаполненными обязательными полями. Все три основных поля (Наименование, Fabio route, Метод) обязательны для заполнения.

Целостность данных: удаление записи, привязанной к сервисам, невозможно. Система выдаст ошибку выполнения.

Ошибки: в текущей версии вся валидация происходит на сервере. При нарушении правил заполнения полей пользователь получит техническую ошибку (например, size must be between… или ConstraintViolationException) при попытке сохранения данных.

Где используется системные сервисы?

Созданные записи о системных сервисах выбираются при настройке/редактировании сервиса:

Сервис ⇨ вкладка Реализация ⇨ вкладка Входной интерфейс ⇨ «Системный сервис» ⇨ выпадающий список со всеми доступными логинами — допускается выбор одной записи.

В поле «Системный сервис» отображается выпадающий список в формате «Наименование» - «Fabio route».

Выбранный сервис автоматически подставляет HTTP-метод в соответствующее недоступное для редактирования поле «Метод».

Рекомендации.

  • используйте осмысленные названия, отражающие функцию сервиса;
  • все Fabio route должны вводиться корректно (например: svcregistry/v1, polus-esb/check). При некорректном Fabio route вызовы к сервису завершатся ошибкой.