Разделы документации

Продукты

Что такое продукт в каталоге, как его создать и заполнить карточку и кто видит продукт.

Что это

Продукт — главная единица каталога. К нему привязываются команды, репозитории и компоненты, по нему считаются метрики, уязвимости и деплои. У каждого продукта есть ID вида PRD-12: он стоит в адресе карточки и не меняется при переименовании.

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

Создание продукта

Создать продукт может администратор или роль с правом на редактирование продуктов.

  • Нажмите Создать продукт и укажите Название и, по желанию, Краткое описание.
  • Откроются Настройки продукта с разделами Основное, Классификация, Доступ, Брендинг, Интеграции и Связи. Здесь задаются профиль, владельцы, изображение, команды и репозитории.
  • Изменения применяются только после кнопки Сохранить.

Пока у продукта нет репозиториев, на обзоре висит подсказка Продукт создан с кнопками Привязать репозитории и Заполнить сведения.

Карточка продукта

ВкладкаЧто на ней
ОбзорОписание, Общие сведения и виджет Покрытие SSDLC
АктивностьКоммиты, авторы и релизы за 30 и 90 дней, DORA-метрики при деплоях в production
ОкруженияЧто где развёрнуто и история деплоев компонентов продукта
АрхитектураГраф связей продукта; при включённом обнаружении архитектуры — ещё и Взаимодействия
ЭпикиЗадачи выбранного эпика из Jira; вкладки нет, если Jira не подключена
Требования КБПрофили требований кибербезопасности, назначенные продукту
АнкетыАнкеты по продукту, если модуль анкет включён

Набор и порядок виджетов на Обзоре меняются кнопкой Настроить обзор.

Общие сведения

Это паспорт продукта. Каждую строку можно править на месте, если у вас есть права на редактирование. Значок «?» у строки объясняет, что в ней и откуда берётся значение.

СтрокаЧто значит
ID продуктаНомер продукта, выдаётся автоматически
ЗаполненностьУровень от TIER I до TIER IV, см. ниже
Product OwnerВладелец продукта, получает права на правку карточки и состава
КомандыКоманды, которые разрабатывают и сопровождают продукт
КомпонентыСервисы, сайты и библиотеки внутри продукта
РепозиторииКод продукта: по нему считаются стек, авторы, покрытие сканерами и активность
ПрофильШаблон карточки: какие классификаторы и поля показываются
СредыОкружения, в которых работает продукт
Канал уведомленийМессенджер для уведомлений; строки нет, если мессенджеры не подключены
ЭпикиЭпики Jira с назначением Безопасность, Техдолг или Прочее

Кнопки «+» в строках Команды, Репозитории и Компоненты привязывают команду, репозиторий или создают компонент. Счётчик рядом со списком открывает соответствующий раздел, уже отфильтрованный по продукту.

Эпик добавляется поиском по Jira или вручную — ссылкой или ключом вида SEC-123. Вкладка Эпики по умолчанию открывает первый эпик с назначением Безопасность.

Заполненность считается по семи пунктам: название, описание, изображение, классификация, команда, репозиторий и владелец. TIER I — заполнено всё, TIER II — от 70%, TIER III — от 40%, TIER IV — меньше.

Классификаторы и поля

Справочники для продуктов ведёт администратор в Настройки → Справочники:

  • Классификаторы — измерения организации: оргструктура, бизнес-домен, стадия ЖЦ, критичность и любые другие. Значения могут быть деревом из нескольких уровней.
  • Поля продукта — дополнительные поля видов Человек, Ссылки, Команда, Текст, Число, Дата и Да/Нет. У поля «Да/Нет» есть ещё ответы Не определено и Н/П.
  • Профили продуктов — какие классификаторы и поля показываются в карточке. У продукта один профиль.

Стадия ЖЦ

Стадия ЖЦ — обычный классификатор. Если его нет, создайте его в «Классификаторах» из шаблона «Стадия ЖЦ». Шаблон заводит значения Идея, Разработка, Пилот, Эксплуатация, Выводится и Выведен из эксплуатации и добавляет классификатор в профиль по умолчанию. В остальные профили его добавляет администратор.

Метрики считают продукты на любой стадии. Цифры по одной стадии покажет фильтр «Классификатор» в «Метриках».

Уязвимости

Отдельной вкладки уязвимостей в карточке нет. Продукт связывается с источником уязвимостей (Hexway ASOC, DefectDojo) в Настройках продукта → Интеграции → Источник уязвимостей (ASOC). Привязку задаёт администратор. Находки из источника попадают в техдолг и в раздел Метрики по этому продукту.

Компоненты

Компонент — часть продукта, которую учитывают как целое: Сервис, Сайт / веб-приложение, Мобильное приложение, Библиотека, Плагин / расширение, Обработка данных, Утилита или Другое. Тип только описывает компонент: стенды, деплои и другие разделы от него не зависят. Код компонента может лежать в нескольких репозиториях, а один монорепозиторий можно привязать к нескольким компонентам с разными путями. События деплоя привязываются к компоненту, поэтому без компонентов вкладка Окружения остаётся пустой.

Компонент создаётся кнопкой «+» в строке Компоненты или в разделе Компоненты: Действия → Создать из репозитория. Репозитории компонента выбираются из репозиториев продукта, у каждого есть роль: Основной код, Деплой и инфраструктура, Контракты или Прочее. Для монорепозитория можно указать путь к папке компонента. Вкладки Активность и Стек компонента считаются только по репозиториям с ролью Основной код.

Кто видит продукт

Продукт виден, если у вас есть право на просмотр каталога и вы участвуете в продукте одним из способов:

  • вы его Product Owner или участник продукта;
  • вы состоите в команде, привязанной к продукту, или владеете такой командой.

Администратор видит все продукты. Участия в организации продукта для доступа мало. Те же правила действуют для компонентов продукта.

Править карточку могут администратор и Product Owner.

См. также: Команды, Репозитории, Анализ кода и стек.