Skip to main content

Каталог ПО

Cервис-каталог — интерфейс с информацией о сервисах, библиотеках, контрактах API, связях с другими сервисами и инфраструктурой.

Компонент состоит из трёх сущностей:

  • Resource — инфраструктурный компонент — база данных, топик Kafka и прочее. Лежит на вкладке Зависимости.
  • Contract — контракт API, который предоставляет сервис. Он нужен для связи сервисов друг с другом. Лежит на вкладке Контракты API.
  • Service — сервис и его связи с инфраструктурными ресурсами или другими сервисами через его контракты. Лежит на вкладке Обзор.
  • Library — библиотеки для разработчиков. Лежит на вкладке Обзор.

Компонент-сервис сформируется из файла .YML, который вы добавите в ветку master кода проекта.

Версии​

Версии сервиса регистрируются автоматически, когда появляется тег с именем «release*». Они соответствуют релизным тегам в репозитории, где хранится манифест сервиса.

Пользователь с ролью Service catalog manager должен самостоятельно указать активные версии сервиса.

Поиск сервиса или библиотеки​

  1. Зайдите в Spirit.

  2. Нажмите Сервисы в левом меню.

  3. Используйте поиск с фильтрами, чтобы найти сервис.

  4. Нажмите на название сервиса, чтобы посмотреть информацию о нём.

Вкладки​

Обзор​

Также на страницу выводятся сообщения об ошибках валидации связей, если они есть. Чтобы посмотреть библиотеки, нажмите на вкладку Библиотеки.

В заголовке страницы выводится информация о сервисе с манифеста в ветке master соответствующего репозитория. Можно переключиться на представление о сервисе, привязанное к созданным релизным тегам.

Контракты API​

Контракт — описание того, какой API предоставляет сервис.

Чтобы посмотреть информацию об API:

  1. Перейдите на вкладку Контракты API.
  2. Нажмите на название контракта.

Если ваши контракт описан с помощью спецификации в формате OpenAPI, он визуализируются с помощью SwaggerUI. Статусы версий контракта и сервиса зависят друг от друга.

Зависимости​

Зависимости — связи сервиса в виде интерактивного графа:

  • предоставляемые контракты;
  • потребляемые контракты, которые предоставляют другие сервисы;
  • инфраструктурные зависимости.

Чтобы посмотреть граф:

  1. Перейдите на вкладку Зависимости.
  2. Нажмите Показать легенду, чтобы посмотреть условные обозначения.

Если нажать на элемент графа, откроется информация о нём со ссылками:

  • комментарии к связям потребляемых контрактов;
  • поставляемые и потребляемые контракты;
  • связанные сервисы-поставщики потребляемых контрактов.