Сценарии настройки межсервисного взаимодействия

Вы выполняете эти сценарии, если вы разработали новый сервис или изменили существующий сервис, и этот сервис должен взаимодействовать с другими сервисами Платформы и/или другие сервисы должны взаимодействовать с этим сервисом.

Предварительные требования

Вы вошли в AdminTools.

Этапы

Если вы разработали новый сервис, настройка межсервисного взаимодействия включает следующие этапы:

1. Создание API-ресурса сервиса

   Для нового сервиса вы создаете API-ресурс.

2. Создание области разрешений доступа к API-ресурсу нового сервиса

   Для методов нового сервиса, к которым будут обращаться другие сервисы, вы настраиваете области разрешений доступа клиента к API-ресурсу.

3. Создание клиента для нового сервиса

   Для обращения нового сервиса к другим сервисам Платформы вы настраиваете клиента для этого сервиса.

4. Настройка доступа к новому сервису со стороны других сервисов

   Вы добавляете области разрешений доступа к API-ресурсу нового сервиса клиентам тех сервисов, которые будут обращаться к этому новому сервису.

Если вы изменили существующий сервис, добавив новые методы, настройка межсервисного взаимодействия включает следующие этапы:

1. Создание нового API-ресурса сервиса

   Этот этап не является обязательным. Если вы считаете целесообразным изолировать новые методы в отдельный API-ресурс, вы создаете новый API-ресурс.

2. Создание области разрешений доступа к API-ресурсу

   Этот этап не является обязательным. Если новые методы сервиса требуют отдельной области разрешений доступа, вы добавляете области разрешений доступа.

3. Настройка доступа к новым методам сервиса со стороны других сервисов

   Этот этап не является обязательным. Вы добавляете области разрешений доступа к API-ресурсу для новых методов сервиса клиентам тех сервисов, которые будут обращаться к этому новому сервису.

Если вы изменили существующий сервис, изменив или удалив методы, настройка межсервисного взаимодействия включает следующие этапы:

1. Ревизия API-ресурса сервиса

   Если в результате изменения набора методов сервиса какие-либо API-ресурсы более не нужны, вы можете удалить их.

2. Ревизия областей разрешений доступа к API-ресурсу

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

3. Ревизия настроек доступа к методам сервиса со стороны других сервисов

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

Если вы являетесь разработчиком инфраструктурных сервисов Платформы, после описанных выше этапов вы выполняете следующие дополнительные этапы:

1. Добавление в дистрибутив сервиса учетных данных клиента сервиса

   Вы обращаетесь к DevOps-инженеру с просьбой добавить в дистрибутив учетные данные клиента сервиса — идентификатор и секрет клиента — для созданного на предыдущих этапах клиента.

2. Размещение файла с описанием параметров межсервисного взаимодействия в папке дистрибутива сервиса

   После того, как взаимодействие настроено, в списке ресурсов (API Resources) напротив измененного ресурса вы устаналиваете флажок и нажимаете Export. Файл IdentityResources.json формируется и скачивается на ваш локальный диск в папку загрузки, которая настроена по умолчанию в вашем браузере. Вы размещаете этот файл в папке сервиса <имя сервиса>\Distrib\Identity, для которого вы настраивали API-ресурс и области разрешений доступа.

Результаты

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