AI-чат
Виджет «AI-чат» позволяет отправлять запросы к языковой модели через выбранный AI-провайдер: задаются общие инструкции («Глобальный промпт») и набор кнопок быстрых вопросов («Быстрые вопросы»).
Конфигурация
| Название | Обязательность | Описание |
|---|---|---|
| Глобальный промпт | Нет | Общие инструкции к каждому запросу; при отправке объединяются с промптом выбранной кнопки быстрого вопроса |
| Быстрые вопросы | Да | Набор кнопок с подписью и текстом промпта (до 20 штук); для корректной работы виджета необходимо добавить хотя бы один вопрос |
Для каждого быстрого вопроса задаются поля:
| Название | Обязательность | Описание |
|---|---|---|
| Название вопроса | Да | Короткая подпись, отображается на нижней панели виджета и в чате |
| Промпт | Да | Инструкция для модели при нажатии на эту кнопку; допускается использование Go-шаблонизации |
При заполнении промпта рекомендуется в явном виде указывать названия MCP-инструментов, которые должна вызвать модель при подготовке ответа.
Пример промпта для быстрого вопроса:
1. Вызови MCP tool get_external_data для внешнего сервиса «Deckhouse Code» и получи пайплайны для проекта с ID {{ .entity.properties.deckhouse_code_id }}.
2. Выведи таблицу с последними 10 пайплайнами.Использование виджета
Для использования виджета у пользователя должен быть добавлен как минимум один AI-провайдер.
У чата не предусмотрена история:
- Выводится только один ответ на последний заданный вопрос.
- Ответ не сохраняется при переходе на другую страницу или при обновлении страницы.
Перед отправкой вопроса пользователь может кастомизировать промпт, кликнув на пункт «Отправить с изменением промпта» в выпадающем меню кнопки вопроса.
API
Виджет позволяет вывести спецификацию API из файла в репозитории GitLab или по ссылке в формате OpenAPI (Swagger) или Protobuf. При выводе спецификации OpenAPI из файла в формате YAML или JSON виджет отображает интерфейс Swagger. Во всех остальных случаях виджет отображает спецификацию в виде текста.
Общая конфигурация
| Название | Обязательность | Описание | Возможные значения | Значение по умолчанию |
|---|---|---|---|---|
| Тип спецификации | Да | Тип спецификации | OpenAPI (Swagger), Protocol Buffers | - |
| Тип источника | Да | Тип источника, из которого будет загружаться файл со спецификацией | URL, GitLab | - |
Конфигурация типа источника: URL
| Название | Обязательность | Описание | Значение по умолчанию |
|---|---|---|---|
| URL | Да | Ссылка на файл со спецификацией | - |
| Заголовки | Нет | Заголовки для доступа к файлу со спецификацией | - |
Конфигурация типа источника: GitLab
| Название | Обязательность | Описание | Значение по умолчанию |
|---|---|---|---|
| GitLab URL | Да | URL GitLab | - |
| ID проекта | Да | Идентификатор проекта, из которого будет браться файл со спецификацией | - |
| Ветка | Да | Ветка, из которой будет браться файл со спецификацией | - |
| Путь к файлу | Да | Путь к файлу со спецификацией относительно корня репозитория | - |
Авторизация
Конфигурация авторизации описана в разделе «Внешние сервисы».
Bitbucket. Pull Requests
Виджет позволяет отображать данные о Pull Requests (PR) в Bitbucket и выполнять действия с ними.
Авторизация
Конфигурация авторизации описана в разделе «Внешние сервисы».
Конфигурация
| Название | Обязательность | Описание | Пример |
|---|---|---|---|
| Ключ проекта | Да | Часть URL репозитория, которая идёт сразу после /projects/ | Для репозитория .../projects/MYTEAM/repos/backend укажите MYTEAM |
| Идентификатор репозитория | Да | Часть URL репозитория, которая идёт сразу после /repos/ | Для репозитория .../projects/MYTEAM/repos/backend укажите backend |
Фильтрация по статусу
Виджет позволяет фильтровать отображаемые Pull Requests по статусу. В настройках запроса виджета можно выбрать один из следующих статусов:
- «Открыт» — показывает только открытые PR.
- «Слит» — показывает только слитые PR.
- «Отклонён» — показывает только отклонённые PR.
- «Все» — показывает PR в любом статусе.
По умолчанию отображаются только открытые PR.
Дополнительные возможности виджета
При активированной функции действий в настройках виджет позволяет выполнять следующие действия с Pull Requests:
- «Слить» — слияние открытого запроса на слияние (доступно только для открытых PR).
- «Закрыть» — отклонение (decline) запроса на слияние.
- «Просмотр изменений» — просмотр диффа (изменений) в запросе на слияние.
- «Комментарии» — просмотр и добавление комментариев к PR.
- «Создать PR» — создание нового Pull Request с указанием исходной и целевой ветки, ревьюеров, названия и описания.
Для выполнения действий с PR требуются соответствующие права доступа в репозитории Bitbucket.
GitHub. Pull Requests
Виджет отображает Pull Requests (PR) репозитория на GitHub и позволяет просматривать изменения, создавать, сливать и закрывать PR.
Авторизация
Конфигурация авторизации описана в разделе «Внешние сервисы».
В настройках внешнего сервиса или в конфигурации виджета в поле «URL» необходимо указать https://api.github.com.
Учётная запись и автор действий
Запросы к GitHub выполняются с токеном из учётных данных того пользователя платформы, от имени которого вызывается действие. Если в настройках виджета включено «Выбрать учётную запись для виджета», используются учётные данные выбранного пользователя платформы, а не текущего.
При создании, слиянии и закрытии Pull Request в GitHub автором PR и исполнителем действий считается учётная запись GitHub, которой принадлежит этот токен. Логин и имя в интерфейсе GitHub могут не совпадать с именем в профиле Deckhouse Development Platform (DDP).
Конфигурация
| Название | Обязательность | Описание | Пример |
|---|---|---|---|
| Владелец репозитория | Да | Владелец репозитория (организация или пользователь) | Для https://github.com/example/my-repo укажите example |
| Репозиторий | Да | Название репозитория без .git | Для https://github.com/example/my-repo укажите my-repo |
Статус
В настройках запроса виджета можно фильтровать PR по статусу:
- «Открыт» — только открытые PR (не черновики).
- «Черновик» — только черновики.
- «Закрыт» — только закрытые PR.
- «Все» — любые PR.
По умолчанию отображаются открытые PR. В таблице отображаются: номер, название, описание, статус, метки, автор, дата создания, дата обновления; для каждого PR доступны действия через меню.
Действия
- «Изменения» — просмотр списка изменённых файлов и диффа по каждому файлу.
- «Слить» — слияние открытого PR (доступно только для открытых PR, не черновиков).
- «Закрыть» — закрытие PR без слияния.
- «Создать PR» — создание нового Pull Request. В диалоге указываются название, исходная ветка, целевая ветка и описание.
Для выполнения действий с PR требуются соответствующие права доступа в репозитории GitHub.
GitHub. Actions
Виджет показывает запуски GitHub Actions в репозитории и позволяет просматривать jobs, артефакты, а также производить действия над ними.
Авторизация
Конфигурация авторизации описана в разделе «Внешние сервисы».
В настройках внешнего сервиса в поле «URL» необходимо указать https://api.github.com.
Учётная запись и автор действий
Запросы к GitHub выполняются с токеном из учётных данных того пользователя платформы, от имени которого вызывается действие. Если в настройках виджета включено «Выбрать учётную запись для виджета», используются учётные данные выбранного пользователя платформы, а не текущего.
При запуске, отмене запуска и перезапуске workflow, работе с артефактами и логами в GitHub инициатором считается учётная запись GitHub, которой принадлежит токен. Логин в интерфейсе GitHub может не совпадать с именем в профиле DDP.
Конфигурация
| Название | Обязательность | Описание | Пример |
|---|---|---|---|
| Владелец репозитория | Да | Владелец репозитория (организация или пользователь) | Для https://github.com/example/my-repo укажите example |
| Репозиторий | Да | Название репозитория без .git | Для https://github.com/example/my-repo укажите my-repo |
Параметры запроса
В настройках запроса виджета можно задать фильтры:
- «Ветка» — только запуски с указанной head-веткой.
- «Событие» — только запуски с выбранным типом события.
- «Статус» — только запуски в выбранном статусе или с выбранным итогом (conclusion).
- «Workflow» — только запуски для выбранного файла workflow.
- «Кто запустил» — только запуски, начатые указанным пользователем GitHub.
- «Фильтр по дате создания» — интервал дат создания запуска (дата начала и дата окончания).
Действия
В виджете доступны следующие действия:
- «Запустить workflow» — ручной запуск workflow с триггером
workflow_dispatch: выбираются «Workflow» и «Ветка или тег»; при объявленных во входном YAML параметрах отображаются «Входные параметры». - «Перезапустить workflow», «Перезапустить упавшие jobs», «Отменить workflow» — для выбранного запуска.
- «Перезапустить job» — для job в статусе «завершён» с итогом failure или cancelled.
- Просмотр логов job, скачивание артефактов, открытие запуска на GitHub, дерево jobs и шагов.
Для действий с workflow и артефактами нужны соответствующие права в репозитории GitHub.
CodeScoring. Зависимости
Виджет позволяет вывести таблицу с зависимостями продукта на основе данных из CodeScoring с указанием названия зависимости, версии, лицензии, количества уязвимостей и другой информации для каждой зависимости.
Авторизация
Конфигурация авторизации описана в разделе «Внешние сервисы».
Конфигурация
| Название | Обязательность | Описание | Значение по умолчанию |
|---|---|---|---|
| URL | Да | URL CodeScoring | - |
| ID проекта | Да | Идентификатор проекта в CodeScoring | - |
CodeScoring. Уязвимости
Виджет позволяет вывести таблицу с уязвимостями продукта на основе информации из CodeScoring с указанием кода уязвимости, уровня критичности, наличия эксплойта, исправленной версии для каждой уязвимости.
Авторизация
Конфигурация авторизации описана в разделе «Внешние сервисы».
Конфигурация
| Название | Обязательность | Описание | Значение по умолчанию |
|---|---|---|---|
| URL | Да | URL CodeScoring | - |
| ID проекта | Да | Идентификатор проекта в CodeScoring | - |
CodeScoring. Секреты
Виджет позволяет вывести таблицу найденных секретов проекта из CodeScoring. Поддерживаются запуск либо отмена сканирования секретов по выбранной ветке или тегу.
Авторизация
Конфигурация авторизации описана в разделе «Внешние сервисы».
Конфигурация
| Название | Обязательность | Описание | Значение по умолчанию |
|---|---|---|---|
| URL | Да | URL CodeScoring | - |
| ID проекта | Да | Идентификатор проекта в CodeScoring | - |
DefectDojo. Уязвимости в продукте (детали)
Виджет позволяет вывести таблицу с уязвимостями продукта на основе информации из DefectDojo с указанием уровня критичности, описания и даты обнаружения для каждой уязвимости.
Авторизация
Конфигурация авторизации описана в разделе «Внешние сервисы».
Конфигурация
| Название | Обязательность | Описание | Значение по умолчанию |
|---|---|---|---|
| URL | Да | URL DefectDojo. Указывается без пути к API (/api/v2) | - |
| Название продукта | Да | Название продукта в DefectDojo | - |
Дополнительные возможности виджета
При просмотре виджета доступна настройка следующих параметров:
- «Активные уязвимости» — если включено, то загружаются уязвимости продукта с флагом ‘Active’ = true. Если отключено, то загружаются уязвимости продукта с флагом ‘Active’ = false. Включено по умолчанию.
- «Дублирующиеся уязвимости» — если включено, то загружаются уязвимости продукта с флагом ‘Duplicate’ = true. Если отключено, то загружаются уязвимости продукта с флагом ‘Duplicate’ = false. Отключено по умолчанию.
DefectDojo. Уязвимости в продукте (общая статистика)
Виджет позволяет вывести график с общим количеством уязвимостей продукта на основе информации из DefectDojo с разбивкой по уровням критичности.
Авторизация
Конфигурация авторизации описана в разделе «Внешние сервисы».
Конфигурация
| Название | Обязательность | Описание | Значение по умолчанию |
|---|---|---|---|
| URL | Да | URL DefectDojo. Указывается без пути к API (/api/v2) | - |
| Название продукта | Да | Название продукта в DefectDojo | - |
Дополнительные возможности виджета
При просмотре виджета доступна настройка следующих параметров:
- «Активные уязвимости» — если включено, то загружаются уязвимости продукта с флагом ‘Active’ = true. Если отключено, то загружаются уязвимости продукта с флагом ‘Active’ = false. Включено по умолчанию.
- «Дублирующиеся уязвимости» — если включено, то загружаются уязвимости продукта с флагом ‘Duplicate’ = true. Если отключено, то загружаются уязвимости продукта с флагом ‘Duplicate’ = false. Отключено по умолчанию.
Docker образы
Виджет позволяет отображать данные о доступных образах в docker registry. На виджет выводятся все доступные теги и команда docker pull. Поддерживается поиск.
Авторизация
Конфигурация авторизации описана в разделе «Внешние сервисы».
Конфигурация
| Название | Обязательность | Описание | Значение по умолчанию |
|---|---|---|---|
| URL | Да | URL Docker Registry. Используется для получения данных о доступных образах | - |
| Название | Нет | Название репозитория, из которого будут загружаться данные в виджет. Пример: repo. Без указания названия, будут получены все доступные образы | - |
GitLab. Запросы слияния
Виджет позволяет отображать данные о Merge Requests (MR) в платформе GitLab и выполнять действия с ними.
Авторизация
Конфигурация авторизации описана в разделе «Внешние сервисы».
Конфигурация
| Название | Обязательность | Описание | Значение по умолчанию |
|---|---|---|---|
| URL | Да | URL GitLab API. Используется для получения данных из GitLab | - |
| ID проекта | Да | ID проекта, из которого будут загружаться данные в виджет. Пример: 12345 | - |
Фильтрация по статусу
Виджет позволяет фильтровать отображаемые Merge Requests по статусу. В настройках запроса виджета можно выбрать один из следующих статусов:
- «Открытые» — показывает только открытые MR.
- «Закрытые» — показывает только закрытые MR.
- «Слитые» — показывает только слитые MR.
- «Заблокированные» — показывает только заблокированные MR.
По умолчанию отображаются только открытые MR.
Дополнительные возможности виджета
При активированной функции действий в настройках виджет позволяет выполнять следующие действия с Merge Requests:
- «Слить» — слияние открытого запроса на слияние (доступно только для открытых MR).
- «Закрыть» — закрытие запроса на слияние.
- «Отметить как черновик/готово» — изменение статуса черновика запроса на слияние.
- «Просмотр изменений» — просмотр диффа (изменений) в запросе на слияние.
Для выполнения действий с MR требуются соответствующие права доступа в репозитории GitLab.
GitLab. Пайплайны
Виджет позволяет отображать данные о пайплайнах в платформе GitLab.
Авторизация
Конфигурация авторизации описана в разделе «Внешние сервисы».
Конфигурация
| Название | Обязательность | Описание | Значение по умолчанию |
|---|---|---|---|
| URL | Да | URL GitLab API. Используется для получения данных из GitLab | - |
| ID проекта | Да | ID проекта, из которого будут загружаться данные в виджет. Пример: 12345 | - |
Дополнительные возможности виджета
Запуск пайплайнов
Виджет позволяет запускать пайплайны в GitLab напрямую из DDP.
Конфигурация
| Название | Обязательность | Описание | Значение по умолчанию |
|---|---|---|---|
| Ref | Да | Целевая ветка или тег для запуска пайплайна | - |
| Переменные | Нет | Переменные в формате ключ-значение, которые будут переданы в запускаемый пайплайн | - |
GitLab. Редактор пайплайна
Виджет позволяет редактировать конфигурацию пайплайна GitLab CI/CD (файл .gitlab-ci.yml) и создавать запросы на слияние с изменениями.
Авторизация
Конфигурация авторизации описана в разделе «Внешние сервисы».
Конфигурация
| Название | Обязательность | Описание | Значение по умолчанию |
|---|---|---|---|
| URL | Да | URL GitLab API. Используется для получения данных из GitLab | - |
| ID проекта | Да | ID проекта, из которого будут загружаться данные в виджет. Пример: 12345 | - |
Отображаемые данные
Виджет отображает:
- «Редактор кода» — Monaco Editor для редактирования файла
.gitlab-ci.yml. - «Дифф-просмотр» — отображение изменений между оригинальной и редактируемой версией конфигурации.
Дополнительные возможности виджета
Создание запроса на слияние
Виджет позволяет создавать запросы на слияние с изменениями конфигурации пайплайна.
Параметры запроса на слияние
| Название | Обязательность | Описание | Значение по умолчанию |
|---|---|---|---|
| Заголовок MR | Да | Краткий заголовок, описывающий цель запроса на слияние | - |
| Описание MR | Нет | Подробное описание запроса на слияние и изменений | - |
| Название новой ветки | Да | Название новой ветки, которая будет содержать ваши изменения | - |
| Целевая ветка | Да | Ветка, в которую будет выполнен запрос на слияние | main |
| Сообщение коммита | Да | Описание изменений, внесенных в конфигурацию пайплайна | - |
Ограничения
- Виджет работает только с файлом
.gitlab-ci.ymlв корне проекта. - Для создания запроса на слияние требуются права на запись в репозиторий.
- Максимальный размер файла конфигурации ограничен возможностями GitLab API.
GitLab. Статистика пайплайнов
Виджет позволяет отображать статистику пайплайнов в платформе GitLab, включая общую статистику, распределение по статусам, источникам, участникам и веткам.
Авторизация
Конфигурация авторизации описана в разделе «Внешние сервисы».
Конфигурация
| Название | Обязательность | Описание | Значение по умолчанию |
|---|---|---|---|
| URL | Да | URL GitLab API. Используется для получения данных из GitLab | - |
| ID проекта | Да | ID проекта, из которого будут загружаться данные в виджет. Пример: 12345 | - |
Отображаемые данные
Виджет отображает следующую статистику:
Основные метрики
- «Общее количество пайплайнов» — общее число пайплайнов за выбранный период.
- «Процент успеха» — процент успешно выполненных пайплайнов.
- «Процент неудач» — процент неудачно выполненных пайплайнов.
- «Средняя длительность» — среднее время выполнения пайплайнов.
Распределение по статусам
- Успешные пайплайны.
- Неудачные пайплайны.
- Отмененные пайплайны.
- Пропущенные пайплайны.
- Ручные пайплайны.
Распределение по источникам
- Push (коммиты).
- Merge requests (запросы слияния).
- Schedule (по расписанию).
- Web (через веб-интерфейс).
Топ участников
- Список участников с наибольшим количеством запущенных пайплайнов.
- Аватары участников (при наличии).
- Количество пайплайнов для каждого участника.
Активность веток
- Список веток с наибольшим количеством пайплайнов.
- Количество пайплайнов для каждой ветки.
Параметры запроса
| Название | Обязательность | Описание | Значение по умолчанию |
|---|---|---|---|
| Начальная дата | Да | Начальная дата для анализа пайплайнов в формате ISO 8601. Пример: 2024-01-01T00:00:00Z | - |
| Конечная дата | Да | Конечная дата для анализа пайплайнов в формате ISO 8601. Пример: 2024-01-31T23:59:59Z | - |
| Ветка | Нет | Фильтр по конкретной ветке. Если не указана, анализируются все ветки | - |
Ограничения
- Виджет анализирует максимум 100 пайплайнов за один запрос для оптимизации производительности.
- Статистика рассчитывается только для пайплайнов с валидными данными (имеющими статус и время выполнения).
- Данные обновляются при каждом обновлении виджета.
GitLab. Теги
Виджет позволяет отображать данные о тегах проекта в платформе GitLab.
Авторизация
Конфигурация авторизации описана в разделе «Внешние сервисы».
Конфигурация
| Название | Обязательность | Описание | Значение по умолчанию |
|---|---|---|---|
| URL | Да | URL GitLab API. Используется для получения данных из GitLab | - |
| ID проекта | Да | ID проекта, из которого будут загружаться данные в виджет. Пример: 12345 | - |
Дополнительные возможности виджета
Создание тегов
Виджет позволяет создать теги в GitLab напрямую из DDP.
Конфигурация
| Название | Обязательность | Описание | Значение по умолчанию |
|---|---|---|---|
| Название | Да | Название создаваемого тега | - |
| Создать из | Да | Ветка или существующий тег, от которого создаётся новый тег | - |
| Описание | Нет | Описание создаваемого тега | - |
Bitbucket. Теги
Виджет позволяет отображать данные о тегах репозитория в Bitbucket.
Авторизация
Конфигурация авторизации описана в разделе «Внешние сервисы».
Конфигурация
| Название | Обязательность | Описание | Пример |
|---|---|---|---|
| Ключ проекта | Да | Часть URL репозитория, которая идёт сразу после /projects/ | Для репозитория .../projects/MYTEAM/repos/backend укажите MYTEAM |
| Репозиторий | Да | Часть URL репозитория, которая идёт сразу после /repos/ | Для репозитория .../projects/MYTEAM/repos/backend укажите backend |
Отображаемые данные
Виджет отображает список тегов репозитория с информацией о каждом теге:
- «Название тега» — название тега.
- «Коммит» — хеш коммита, сообщение коммита, автор, дата создания, ссылка на коммит в Bitbucket.
Дополнительные возможности виджета
Создание тегов
Виджет позволяет создавать теги в Bitbucket напрямую из DDP.
Конфигурация
| Название | Обязательность | Описание |
|---|---|---|
| Название | Да | Название создаваемого тега |
| Создать из | Да | Ветка или существующий тег, от которого создаётся новый тег (выбирается из списка) |
| Описание | Нет | Описание создаваемого тега |
GitHub. Теги
Виджет отображает теги репозитория GitHub с информацией о коммите (автор, дата, описание) и позволяет создавать новые теги.
Авторизация
Конфигурация авторизации описана в разделе «Внешние сервисы».
В настройках внешнего сервиса в поле «URL» необходимо указать https://api.github.com.
Учётная запись и автор действий
Запросы к GitHub выполняются с токеном из учётных данных того пользователя платформы, от имени которого вызывается действие. Если в настройках виджета включено «Выбрать учётную запись для виджета», используются учётные данные выбранного пользователя платформы, а не текущего.
«Аннотированный тег» (поле «Описание» заполнено): в метаданных git-тега поля автора аннотации (tagger) заполняются из имени и email пользователя платформы, выполнившего действие (как в профиле в DDP). Если имя не задано, может подставляться email.
«Лёгкий тег» (без описания): отдельный автор тега в git не задаётся; создаётся ссылка на коммит.
Создание тега через API выполняется от учётной записи GitHub по токену; данные tagger при этом берутся из профиля DDP и могут не совпадать с логином GitHub.
Конфигурация
| Название | Обязательность | Описание | Пример |
|---|---|---|---|
| Владелец репозитория | Да | Владелец репозитория (организация или пользователь) | Для https://github.com/example/my-repo укажите example |
| Репозиторий | Да | Название репозитория без .git | Для https://github.com/example/my-repo укажите my-repo |
Отображаемые данные
В таблице отображаются колонки: тег, описание, автор коммита, ссылка на коммит, дата создания коммита; для каждого тега доступно действие «Просмотр» (просмотр описания коммита).
Дополнительные возможности виджета
Создание тега
Виджет позволяет создавать теги в GitHub. В диалоге «Создать тег» указываются:
| Название | Обязательность | Описание | Значение по умолчанию |
|---|---|---|---|
| Название тега | Да | Уникальное название тега, например v1.0.0 или release-2024-01 | — |
| Создать из | Да | Ветка или существующий тег, от которого создаётся новый тег | — |
| Описание | Нет | Аннотация к тегу (например, описание релиза). Если указано, создаётся аннотированный тег | — |
Для создания тегов требуются права на запись в репозиторий GitHub.
GitLab. Релизы
Виджет отображает список релизов GitLab-проекта, подсвечивает последний релиз и показывает связанную информацию: тег, ссылку на коммит, автора, дату публикации и описание (поддерживает Markdown).
Авторизация
Конфигурация авторизации описана в разделе «Внешние сервисы».
Конфигурация
| Название | Обязательность | Описание | Значение по умолчанию |
|---|---|---|---|
| ID проекта | Да | ID проекта, из которого будут загружаться данные в виджет. Пример: 12345 | - |
Дополнительные возможности виджета
Создание релиза
Виджет позволяет создать релиз в GitLab напрямую из DDP:
| Название | Обязательность | Описание | Значение по умолчанию |
|---|---|---|---|
| Название релиза | Да | Название релиза, отображаемое в списке | - |
| Тег | Да | Существующий тег, на основе которого будет сформирован релиз (выбирается из списка тегов проекта) | - |
| Описание | Нет | Описание релиза в формате Markdown | - |
Созданный релиз автоматически появляется в списке, а последний релиз подсвечивается.
GitLab. Участники
Виджет позволяет отображать данные об участниках проекта в GitLab. Подробнее об участниках.
Авторизация
Конфигурация авторизации описана в разделе «Внешние сервисы».
Конфигурация
| Название | Обязательность | Описание | Значение по умолчанию |
|---|---|---|---|
| ID проекта | Да | ID проекта, из которого будут загружаться данные в виджет. Пример: 12345 | - |
Просмотр репозитория
Виджет позволяет просматривать структуру и содержимое файлов в репозитории. Поддерживаются репозитории GitLab, Bitbucket и GitHub.
Авторизация
Конфигурация авторизации описана в разделе «Внешние сервисы».
Конфигурация
| Название | Обязательность | Описание | Значение по умолчанию |
|---|---|---|---|
| Провайдер | Да | Сервис, в котором размещён репозиторий (GitLab, GitHub, Bitbucket) | - |
| Ветка / Тег | Нет | Название ветки, тег или SHA коммита (по умолчанию: main) | main |
| Путь | Нет | Путь к директории в репозитории (оставьте пустым для корня) | - |
| Рекурсивно | Нет | Получать файлы рекурсивно из поддиректорий | false |
Конфигурация для GitLab
| Название | Обязательность | Описание | Значение по умолчанию |
|---|---|---|---|
| ID проекта | Да | ID проекта в GitLab (например, 12345) | - |
Конфигурация для Bitbucket
| Название | Обязательность | Описание | Пример | Значение по умолчанию |
|---|---|---|---|---|
| Ключ проекта | Да | Ключ проекта в Bitbucket (например, MYPROJ) | MYPROJ | - |
| Идентификатор репозитория | Да | Идентификатор репозитория в Bitbucket (например, my-repo) | my-repo | - |
Конфигурация для GitHub
| Название | Обязательность | Описание | Значение по умолчанию |
|---|---|---|---|
| Владелец репозитория | Да | Владелец репозитория (организация или пользователь). Пример: для https://github.com/example/my-repo укажите «example» | - |
| Репозиторий | Да | Название репозитория без .git. Пример: для https://github.com/example/my-repo укажите «my-repo» | - |
Jenkins. Пайплайны
Виджет отображает данные о пайплайнах в Jenkins и позволяет управлять сборками.
Авторизация
Конфигурация авторизации описана в разделе «Внешние сервисы».
Конфигурация
| Название | Обязательность | Описание | Значение по умолчанию |
|---|---|---|---|
| URL | Да | URL Jenkins. Используется для получения данных из Jenkins | - |
| Название | Да | Название пайплайна в Jenkins. Поддерживается вложенность: folder1/folder2/jobName | - |
Отображаемые данные
Виджет автоматически определяет тип пайплайна и отображает соответствующее представление.
Обычные пайплайны
Для обычных пайплайнов виджет отображает:
- «Список сборок» — таблица со всеми сборками пайплайна с информацией о номере, статусе, длительности, времени выполнения и пользователе.
- «Последняя сборка» — информация о последней выполненной сборке.
- «Последняя успешная сборка» — информация о последней успешной сборке.
- «Последняя неудачная сборка» — информация о последней неудачной сборке.
Multibranch пайплайны
Для multibranch пайплайнов виджет отображает:
- «Список веток» — таблица со всеми ветками с информацией о статусе, количестве сборок и последней сборке для каждой ветки.
- Всю информацию, описанную в разделе «обычные пайплайны», в разрезе каждой ветки.
Дополнительные возможности виджета
Виджет позволяет выполнять следующие действия:
Для обычных пайплайнов
- «Запустить сборку» — запуск новой сборки. Если у сборки есть параметры, отображается диалог для их ввода:
- Строковые параметры;
- Пароли;
- Выбор из списка;
- Булевые значения.
- «Отменить сборку» — отмена выполняющейся сборки.
- «Повторить сборку» — повторный запуск последней сборки.
- «Просмотр логов» — просмотр логов выполнения сборки.
Для multibranch пайплайнов
- «Запустить сборку ветки» — запуск новой сборки для конкретной ветки. Если у сборки есть параметры, отображается диалог для их ввода.
- «Получить сборки ветки» — загрузка списка сборок для конкретной ветки.
- «Сканировать multibranch» — запуск сканирования multibranch пайплайна для обнаружения новых веток.
- «Просмотр логов» — просмотр логов выполнения сборки.
Jira. Задачи
Виджет позволяет отображать задачи из Jira на основе JQL-запроса.
Авторизация
Конфигурация авторизации описана в разделе «Внешние сервисы».
Конфигурация
| Название | Обязательность | Описание | Значение по умолчанию |
|---|---|---|---|
| URL | Да | URL Jira. Используется для получения данных из Jira | - |
| JQL | Да | JQL-запрос для фильтрации задач. Пример: project = PROJ AND status = Open | - |
Параметры запроса
| Название | Обязательность | Описание | Значение по умолчанию |
|---|---|---|---|
| JQL | Нет | JQL-запрос для фильтрации задач. Если не указан, используется JQL из конфигурации | Из конфигурации |
| Максимум результатов | Нет | Максимальное количество задач для отображения (от 1 до 1000) | 50 |
Дополнительные возможности виджета
- «Просмотр описания» — при клике на кнопку «Просмотр описания» открывается диалоговое окно с полным описанием задачи.
- «Переход в Jira» — клик по ключу задачи открывает задачу в Jira в новой вкладке.
- «Динамическая фильтрация» — возможность изменить JQL-запрос и максимальное количество результатов прямо в виджете без изменения конфигурации.
Helm. Релизы
Виджет позволяет отображать данные о Helm-релизах в Kubernetes и производить rollback на предыдущие версии.
Данные, отображаемые на виджете:
- «Список релизов Helm» — информация о текущих релизах, созданных с помощью Helm в указанном неймспейсе Kubernetes.
- «Манифесты релизов» — манифесты, связанные с Helm-релизами в указанном неймспейсе Kubernetes. Это включает в себя файлы YAML, которые определяют конфигурацию и состояние ресурсов.
- «Values» — переменные, которые использовались для развёртывания Helm-релизов.
Авторизация
Конфигурация авторизации описана в разделе «Внешние сервисы».
Конфигурация
| Название | Обязательность | Описание | Значение по умолчанию |
|---|---|---|---|
| Namespace | Нет | Неймспейс, из которого будут загружаться данные в виджет. Пример: default | - |
| Релиз | Нет | Название релиза, из которого будут загружаться данные в виджет. Пример: my-release | - |
Iframe
Виджет Iframe работает только при включённой опции allowIframe: true в конфигурации заголовков безопасности (security.headers.csp.allowIframe). По умолчанию эта опция отключена, поэтому виджет не будет отображать контент до изменения конфигурации.
Виджет позволяет отображать данные из внешнего источника.
Конфигурация
| Название | Обязательность | Описание | Значение по умолчанию |
|---|---|---|---|
| URL | Да | URL внешнего источника. Используется для отображения данных в виджете | - |
Kafka. ACLs
Виджет позволяет отображать список ACLs кластера Kafka.
Для каждого ACL отображается следующая информация:
- Субъект.
- Тип ресурса.
- Шаблон.
- Тип шаблона.
- Хост.
- Операция.
- Тип разрешения.
Аутентификация
Для работы с виджетом требуется учётная запись пользователя. Система поддерживает следующие методы аутентификации:
- PLAINTEXT.
- SCRAM-SHA-256.
- SCRAM-SHA-512.
Конфигурация
| Название | Обязательность | Описание | Значение по умолчанию |
|---|---|---|---|
| URL | Да | URL Kafka-кластера | - |
| Протокол аутентификации | Да | Протокол для подключения к Kafka. Список протоколов в документации Kafka | - |
| Механизм SASL | Нет | Механизм аутентификации, который будет использовать SASL. Обязателен при использовании протокола SASL_PLAINTEXT или SASL_SSL. Список механизмов SASL в документации Kafka | - |
| Пользователь Kafka | Да | Username учётной записи для взаимодействия с Kafka | - |
| Пароль | Да | Пароль учётной записи для взаимодействия с Kafka | - |
| Типы ресурсов | Нет | Фильтр по типам ресурсов | - |
| Типы шаблонов | Нет | Фильтр по типам шаблонов | - |
| Операции | Нет | Фильтр по операциям | - |
| Типы разрешений | Нет | Фильтр по типам разрешений | - |
| Субъекты | Нет | Фильтр по субъектам. Поддерживается шаблонизация и регулярные выражения | - |
| Хосты | Нет | Фильтр по хостам. Поддерживается шаблонизация и регулярные выражения | - |
Дополнительные возможности виджета
При активированной функции действий в настройках виджет позволяет:
- Создавать новые правила ACL.
- Удалять существующие правила ACL.
Kafka. Топики
Виджет позволяет отображать различные данные о Kafka топиках.
Для каждого топика доступно:
- Общая информация о топике: основные параметры, конфигурация и статус.
- Информация о партициях: лидер и оффсеты, количество реплик и т. д.
- Информация о консьюмерах: список активных потребителей, их группы, текущие оффсеты и лаги.
- Сообщения: просмотр содержимого сообщений топиков.
- Поиск сообщений: фильтрация сообщений по timestamp и offset.
- Настройки топика: просмотр конфигурации топика в виде таблицы ключ-значение.
Аутентификация
Для работы с виджетом требуется учётная запись пользователя. Система поддерживает следующие методы аутентификации:
- PLAINTEXT.
- SCRAM-SHA-256.
- SCRAM-SHA-512.
Доступность информации в виджете определяется уровнем прав подключённой учётной записи.
Конфигурация
| Название | Обязательность | Описание | Значение по умолчанию |
|---|---|---|---|
| URL | Да | URL Kafka-кластера | - |
| Протокол аутентификации | Да | Протокол для подключения к Kafka. Список протоколов в документации Kafka | - |
| Механизм SASL | Нет | Механизм аутентификации, который будет использовать SASL. Обязателен при использовании протокола SASL_PLAINTEXT или SASL_SSL. Список механизмов SASL в документации Kafka | - |
| Пользователь Kafka | Да | Username учётной записи для взаимодействия с Kafka | - |
| Пароль | Да | Пароль учётной записи для взаимодействия с Kafka | - |
| Топики Kafka | Нет | Название топика или регулярное выражение для фильтрации отображаемых топиков в виджете; при пустом значении отображаются все доступные пользователю топики | - |
Дополнительные возможности виджета
При активированной функции действий в настройках виджет позволяет:
- Создавать новые топики;
- Удалять существующие топики;
- Отправлять сообщение в топик;
- Очищать топик от сообщений.
Kubernetes deployments
Виджет Kubernetes deployments позволяет выводить основную информацию обо всех deployments в кластере Kubernetes. Доступна фильтрация по неймспейсу и/или по label selector.
Для каждого ресурса Deployment доступны:
- «Просмотр спецификации и статуса Deployment».
- «Масштабирование количества реплик Deployment». Для применения изменений после выбора требуемого количества реплик необходимо нажать кнопку «Сохранить» с иконкой дискеты.
- «Просмотр информации о подах», управляемых Deployment, и контейнерах этих подов, включая просмотр логов каждого контейнера.
- «Просмотр и редактирование ресурсов контейнеров». Виджет отображает все настроенные ресурсы контейнеров, включая CPU, Memory, ephemeral-storage и другие типы ресурсов. Редактирование доступно только для CPU и Memory в секциях
requestsиlimits. Изменения применяются на уровне Deployment и распространяются на все поды, управляемые данным Deployment. При очистке значений CPU или Memory соответствующие ресурсы удаляются из конфигурации контейнера. Остальные ресурсы (например,ephemeral-storage) отображаются, но не могут быть отредактированы через виджет.
Авторизация
Конфигурация авторизации описана в разделе «Внешние сервисы».
Конфигурация
| Название | Обязательность | Описание | Значение по умолчанию |
|---|---|---|---|
| Kubernetes API | Да | URL API сервера Kubernetes. Используется для получения данных из Kubernetes | - |
| Namespace | Нет | Неймспейс Kubernetes, из которого будут загружаться deployment. Если неймспейс не указан, виджет будет пытаться загрузить все deployment кластера. Пример: default | - |
| Label selector | Нет | Селекторы для фильтрации получаемых deployment. Перечисляются через запятую. Пример: app.kubernetes.io/name=example | - |
Kubernetes ingresses
Виджет позволяет отображать данные об Ingress в кластере Kubernetes.
Для каждого Ingress доступны:
- Просмотр спецификации Ingress в виде YAML-конфигурации.
- Правила Ingress.
- Настройки TLS.
Авторизация
Конфигурация авторизации описана в разделе «Внешние сервисы».
Конфигурация
| Название | Обязательность | Описание | Значение по умолчанию |
|---|---|---|---|
| URL | Да | URL API сервера Kubernetes. Используется для получения данных из Kubernetes | - |
| Namespace | Нет | Неймспейс Kubernetes, из которого будут загружаться ingresses. Если неймспейс не указан, виджет будет пытаться загрузить все ingress кластера. Пример: default | - |
| Label selector | Нет | Селекторы для фильтрации получаемых ingress. Перечисляются через запятую. Пример: app.kubernetes.io/name=example | - |
Kubernetes pods
Виджет позволяет отображать данные о подах в кластере Kubernetes.
Для каждого pod доступны:
- Просмотр спецификации пода в виде YAML-конфигурации.
- Логи контейнеров.
- Различная информация о состоянии пода: статус, количество перезапусков и др.
Авторизация
Конфигурация авторизации описана в разделе «Внешние сервисы».
Конфигурация
| Название | Обязательность | Описание | Значение по умолчанию |
|---|---|---|---|
| URL | Да | URL API сервера Kubernetes. Используется для получения данных из Kubernetes | - |
| Namespace | Нет | Неймспейс, из которого будут загружаться данные в виджет. Пример: default | - |
| Label selector | Нет | Селекторы для фильтрации получаемых подов. Перечисляются через запятую. Пример: app.kubernetes.io/name=example | - |
Markdown
Виджет обеспечивает отображение текста, написанного в формате Markdown.
Конфигурация
| Название | Обязательность | Описание | Значение по умолчанию |
|---|---|---|---|
| Markdown | Да | Текст в формате Markdown. Отображается в виджете в отформатированном виде | - |
Nexus artifacts
Виджет позволяет выводить список артефактов в репозитории Nexus.
Авторизация
Конфигурация авторизации описана в разделе «Внешние сервисы».
Конфигурация
| Название | Обязательность | Описание | Значение по умолчанию |
|---|---|---|---|
| URL | Да | URL Nexus API. Используется для получения данных из Nexus | - |
| Repository | Да | Название репозитория, данные из которого будут отображаться в виджете. Пример: my-repo | - |
| Name | Нет | Название артефакта, данные о котором будут отображаться в виджете | - |
Opensearch index
Виджет Opensearch index позволяет отобразить данные из определённого index или index pattern в платформе. Данные по умолчанию сортируются от более новых к более старым. Доступен полнотекстовый поиск для фильтрации отображаемых данных. Для каждой записи (строки таблицы) доступно отображение в формате «ключ-значение», либо в JSON. При указании index pattern в виджете будет выводиться ссылка на страницу Discover в OpenSearch Dashboards.
Авторизация
Конфигурация авторизации описана в разделе «Внешние сервисы».
Конфигурация
| Название | Обязательность | Описание | Значение по умолчанию |
|---|---|---|---|
| API URL | Да | URL Opensearch API. Используется для получения данных из Opensearch | - |
| Dashboards URL | Да | URL Opensearch Dashboards. Используется при генерации ссылки для перехода в Opensearch и просмотра данных непосредственно в системе | - |
| Index pattern | Да | Название index pattern, из которого будут загружаться данные в виджет. Может содержать символ «*». Примеры: security-auditlog, security-auditlog-* | - |
| Timestamp field | Нет | Название поля с timestamp. Значение поля выводится в таблице с данными в отдельной колонке | @timestamp |
Prometheus metrics (range)
Виджет позволяет построить график из диапазона значений на основе метрики из Prometheus, задать для него единицу измерения и выбрать пороговое значение. Запрос (query), указанный в виджете, должен возвращать тип Scalar или тип Vector с одним значением.
Пример корректного запроса для виджета:
rate(nginx_ingress_controller_nginx_process_connections[5m])Конфигурация
| Название | Обязательность | Описание | Значение по умолчанию |
|---|---|---|---|
| URL | Да | URL Prometheus | - |
| Query | Да | Запрос метрики из Prometheus в формате PromQL | - |
| Шаг разрешения (сек) | Да | Интервал между отсчётами на горизонтальной оси (в секундах) | 60 |
| Метка | Да | Метка в результатах запроса, чьё уникальное значение присваивается в качестве названий соответствующих линий на графике визуализации | - |
| Порог | Нет | Порог, отображаемый в виде горизонтальной красной полосы на графике | - |
| Минимальное значение | Нет | Начальная точка отсчёта для вертикальной линии на графике | - |
| Максимальное значение | Нет | Предельная точка отсчёта для вертикальной линии на графике | - |
| InsecureSkipVerify | Нет | Отключение проверки подлинности TLS/SSL-сертификата Prometheus | false |
Авторизация
Конфигурация авторизации описана в разделе «Внешние сервисы».
Дополнительные возможности виджета
При просмотре виджета возможно настроить диапазон отображаемых значений. Доступные параметры отображения диапазона:
- Интервал.
- Минимальное значение (начальная точка отсчёта для вертикальной линии на графике).
- Максимальное значение (предельная точка отсчёта для вертикальной линии на графике).
Prometheus metrics (single)
Виджет позволяет вывести одно число на основе метрики из Prometheus, задать для него единицу измерения и выбрать пороговое значение. Query, указанная в виджете, должна возвращать тип Scalar или тип Vector с одним значением.
Пример корректной query для виджета:
sum(ingress_nginx_detail_requests_total)Конфигурация
| Название | Обязательность | Описание | Значение по умолчанию |
|---|---|---|---|
| URL | Да | URL Prometheus | - |
| Query | Да | Query для запроса метрики из Prometheus в формате PromQL | - |
| Количество цифр после запятой | Нет | Точность, с которой будет выводиться полученное значение | - |
| Единица измерения | Нет | Постфикс, с которым будет выводиться полученное значение | - |
| Отображать пороговое значение | Нет | Отображать пороговое значение в формате <значение метрики> / <пороговое значение> | false |
| Пороговое значение | Нет | Пороговое значение | - |
| Меньшее значение считается лучше | Нет | Метрика считается «хорошей», когда её значение ниже заданного порогового значения | false |
| Порог предупреждения (%) | Нет | Граница между красным и оранжевым цветами. Если значение метрики превышает этот процент от порога, оно получит оранжевый цвет | 60 |
| Порог успеха (%) | Нет | Граница между оранжевым и зелёным цветами. Если значение метрики превышает этот процент от порога, оно получит зелёный цвет | 90 |
| InsecureSkipVerify | Нет | Отключение проверки подлинности TLS/SSL-сертификата Prometheus | false |
Авторизация
Конфигурация авторизации описана в разделе «Внешние сервисы».
SonarQube
Виджет позволяет отображать данные о метриках в платформе SonarQube.
Авторизация
Конфигурация авторизации описана в разделе «Внешние сервисы».
Конфигурация
| Название | Обязательность | Описание | Значение по умолчанию |
|---|---|---|---|
| URL | Да | Адрес SonarQube, например, https://sonarqube.example.com | - |
| Ключ проекта | Да | Идентификатор проекта в SonarQube | - |
| Ветка | Нет | Ветка проекта, для которой будут браться метрики | Согласно настройкам проекта в Sonarqube |
| Метрики | Да | Метрики проекта, которые будут выводиться в виджете. В конфигурации указывается Metric key |
Список возможных метрик для текущей версии SonarQube.
Дополнительные возможности виджета
Виджет позволяет просматривать данные не только для ветки по умолчанию, но и для любой другой ветки.
S3 bucket
Виджет позволяет просматривать содержимое S3-совместимых хранилищ объектов, таких как Amazon S3, Yandex Object Storage, MinIO и другие.
Для каждого объекта доступно:
- Просмотр списка объектов в контейнере (bucket) с информацией о размере, дате изменения и классе хранения.
- Поиск объектов по префиксу (пути).
- Загрузка файлов из bucket.
- Просмотр детальной метаинформации объектов (размер, тип контента, метаданные, настройки кеширования и т. д.).
- Навигация по папкам bucket.
Аутентификация
Для работы с виджетом требуется учётная запись с правами доступа к S3 Bucket. Система поддерживает следующие методы аутентификации:
- Access Key ID и Secret Access Key.
- Поддержка различных S3-совместимых провайдеров через настройку эндпоинта.
В отличие от других виджетов, S3 Bucket виджет не поддерживает использование внешних сервисов для передачи учётных данных. Все параметры аутентификации указываются непосредственно в конфигурации виджета.
Использование шаблонов для учётных данных
Для повышения безопасности можно использовать механизм шаблонизации с учётными данными:
{{ .credentials.accessKeyId }}— подставить Access Key ID из учётных данных.{{ .credentials.secretAccessKey }}— подставить Secret Access Key из учётных данных.
Доступность информации в виджете определяется уровнем прав подключённой учётной записи.
Конфигурация
| Название | Обязательность | Описание | Значение по умолчанию |
|---|---|---|---|
| Название bucket | Да | Название S3 Bucket для просмотра | - |
| Endpoint | Да | Эндпоинт URL S3-совместимого хранилища (например, https://storage.yandexcloud.net) | - |
| Регион | Да | Регион, в котором находится Bucket | - |
| Access Key ID | Да | Идентификатор ключа доступа для аутентификации | - |
| Secret Access Key | Да | Секретный ключ доступа для аутентификации | - |
| Префикс | Нет | Префикс (путь) для фильтрации объектов при первоначальной загрузке | - |
| Максимум объектов | Нет | Максимальное количество объектов для отображения за один запрос (по умолчанию 100) | 100 |
Дополнительные возможности виджета
Поиск объектов
Виджет позволяет искать объекты по префиксу (пути). При поиске список объектов обновляется в соответствии с заданным префиксом.
Поиск работает только при вводе символов с начала названия объекта. Поиск по символам из середины названия не поддерживается.
Если в конфигурации виджета задан начальный префикс, поиск в виджете ограничивается этим префиксом. Загрузка и отображение файлов с другим префиксом недоступны.
Загрузка файлов
Виджет позволяет загружать файлы из bucket напрямую в браузер. Для каждого файла доступна кнопка загрузки.
Детальная информация об объектах
При клике на иконку документа для каждого объекта отображается детальная информация:
- Основные параметры: ключ, размер, дата изменения, класс хранения, тип контента, ETag.
- Информация о контенте: кодировка, язык, диспозиция.
- Настройки кеширования: Cache-Control, срок действия.
- Безопасность: серверное шифрование.
- Пользовательские метаданные.
Подгрузка дополнительных объектов
При наличии большого количества объектов в bucket доступна функция «Загрузить ещё» для пошаговой загрузки объектов без потери производительности.
Vault. Секреты
Виджет позволяет просматривать секреты в HashiCorp Vault или Deckhouse Stronghold. Поддерживается работа с KV v2 секретами.
Виджет не передаёт значения секретов пользователю. На клиентскую сторону передаются только метаданные секретов (версия, время создания и т. д.) и структура ключей без их значений.
Для каждого секрета доступно:
- Просмотр иерархической структуры секретов и директорий.
- Просмотр метаданных секрета: версия, время создания, время удаления, статус уничтожения.
- Просмотр ключей секрета в формате таблицы «ключ/значение» (вместо значений отображается плейсхолдер).
- Навигация по вложенным секретам и директориям.
Авторизация
Конфигурация авторизации описана в разделе «Внешние сервисы».
Конфигурация
| Название | Обязательность | Описание | Значение по умолчанию |
|---|---|---|---|
| Путь | Да | Путь к секрету или директории в Vault. Необходимо явно указывать путь с /data/. Примеры: services/data/, services/data/example | - |
| Префикс UI | Нет | Префикс для URL интерфейса. Используйте vault для HashiCorp Vault или stronghold для Deckhouse Stronghold | - |
Особенности работы с путями
Для работы с KV v2 секретами путь должен явно содержать /data/. Примеры корректных путей:
services/data/— для просмотра всех секретов в директорииservices.services/data/example— для просмотра конкретного секретаexample.services/data/nested/secret— для вложенных секретов.
Отображаемые данные
Виджет отображает следующую информацию:
Структура секретов
- «Директории» — отображаются с завершающим слешем (например,
nested/) и всегда помечаются как директории, даже если содержат ключи. - «Секреты» — отображаются без завершающего слеша и содержат ключи.
Метаданные секрета
Для каждого секрета отображаются следующие метаданные (если доступны):
- «Версия» — версия секрета в KV v2.
- «Время создания» — дата и время создания секрета.
- «Время удаления» — дата и время удаления секрета (для удалённых версий).
- «Статус уничтожения» — индикатор того, что секрет был уничтожен.
Ключи секрета
Ключи секрета отображаются в формате таблицы «ключ/значение»:
- Ключ — полный путь к ключу в структуре секрета (например,
database.host). - Значение — всегда маскируется символами
********и не может быть раскрыто.
График
Виджет позволяет выводить информацию об объектах DDP в виде одного из следующих типов графиков:
- Столбчатая диаграмма;
- Кольцевая диаграмма;
- Круговая диаграмма;
- Полярная диаграмма;
- Радарная диаграмма.
Конфигурация
| Название | Обязательность | Описание | Значение по умолчанию |
|---|---|---|---|
| Тип графика | Да | Тип визуализации графика | - |
| Название таблицы | Да | Название таблицы в базе данных, из которой будут браться записи для визуализации | - |
| Название поля | Да | Название поля, по которому будет происходить агрегация записей | - |
| Фильтры | Нет | Поля, по которым будут фильтроваться полученные записи, и их значения | - |
| Тип агрегации | Да | Принцип, по которому будут группироваться полученные записи | - |
| Параметры агрегации | Нет | Выбор временного периода и шага группировки при агрегации записей по дате | - |
При настройке виджета следует учитывать, что названия полей в базе данных могут отличаться от названий полей в спецификации объектов. Общий принцип таков: формат camelCase в спецификации объектов при сохранении структур в базу данных преобразуется в snake_case. Например:
- Поле
createdAtв спецификации следует указывать в конфигурации виджета какcreated_at. - Поле
resourceUuidв спецификации следует указывать в конфигурации виджета какresource_uuid.
Доступно обращение к вложенным значениям. В таком случае разделителем для вложенности служит символ точки. Например, чтобы выполнить агрегацию по статусу сущностей, виджет следует настроить следующим образом:
| Название таблицы | Название поля |
|---|---|
entities | health.status |
Типы агрегации
Дата
Данные на графике будут отсортированы и сгруппированы по выбранным временным интервалам.
В параметрах агрегации можно задать параметры:
- «Единица измерения шага» — например: секунды, минуты, часы, дни и т. д.
- «Количество единиц в одном шаге» — например: 5 минут, 2 часа, 1 день и т. п.
Это позволяет управлять детализацией отображения данных во времени и адаптировать график под нужный масштаб анализа.
Значение
Данные на графике отображаются в отсортированном порядке — по значениям.
Для каждого уникального значения в исходном наборе данных:
- Выполняется подсчёт количества вхождений.
- На графике отображается пара: значение — количество.
Это позволяет быстро увидеть распределение и частоту повторения различных значений.
Разбивка по интервалам
Тип агрегации «Разбивка по интервалам» позволяет гибко настроить отображение данных на графике, разделяя значения по заданным числовым диапазонам (интервалам). Это удобно для построения гистограмм и анализа распределения данных.
Доступны два режима настройки интервалов:
«Автоматическая разбивка по количеству интервалов».
Указывается только количество интервалов, на которые нужно разделить доступные данные.
Интервалы будут рассчитаны автоматически — равномерно от минимального до максимального значения.«Ручное задание границ интервалов».
Указывается массив числовых границ интервалов.
Например:0, 10, 20, 50В этом случае:
- Числа будут автоматически отсортированы по возрастанию.
- Интервалы сформируются на основе отсортированных значений:
[0, 10),[10, 20),[20, 50]
В параметрах агрегации должно быть указано хотя бы одно из двух:
Количество— количество интервалов;Границы— границы интервалов.
Примеры:
Количество = 5— построится 5 равных интервалов на основании данных.Границы = 100, 0, 50— после сортировки:[0, 50, 100], график будет построен по интервалам[0, 50),[50, 100].
Квоты ресурсов Kubernetes
Виджет позволяет отображать данные о квотах ресурсов в кластере Kubernetes.
Для каждой квоты происходит визуализация занятых ресурсов.
Авторизация
Конфигурация авторизации описана в разделе «Внешние сервисы».
Конфигурация
| Название | Обязательность | Описание | Значение по умолчанию |
|---|---|---|---|
| URL | Да | URL API сервера Kubernetes. Используется для получения данных из Kubernetes | - |
| Namespace | Да | Неймспейс, из которого будут загружаться данные в виджет. Пример: default | - |
Процентное значение
Виджет позволяет отображать заданное процентное значение.
Конфигурация
| Название | Обязательность | Описание | Значение по умолчанию |
|---|---|---|---|
| Ресурс | Нет | Ресурс, из которого извлекаются необходимые значения при обработке шаблона | - |
| Процентное значение | Нет | Значение, которое будет выводиться на виджет. Шаблонизация поддерживается. Пример без шаблонизации: 100. Пример с шаблонизацией: {{ .entity.properties.id }} | - |
Таблицы сущностей
Виджет позволяет отображать сущности, созданные в DDP, в виде таблицы.
Конфигурация
| Название | Обязательность | Описание | Значение по умолчанию |
|---|---|---|---|
| Источник | Нет | Сущности, которые необходимо отобразить в виде таблицы | - |
| Показывать действия | Нет | Необходимость отображения действий с сущностями (возможность запуска действий и сценариев, возможность удаления и др.) | false |
Временная шкала сущностей
Виджет отображает сущности выбранного ресурса на временной шкале.
Отображаемые данные
- «График временной шкалы» — горизонтальная диаграмма, где каждая сущность отображается в виде полосы, показывающей период времени (от даты начала до даты окончания).
- «Информация о сущностях» — при наведении на полосу отображается название сущности, дата начала и дата окончания периода.
- «Сортировка» — сущности отсортированы от самых старых (сверху) к самым новым (снизу).
Конфигурация
| Название | Обязательность | Описание | Значение по умолчанию |
|---|---|---|---|
| Ресурс | Да | Ресурс, для которого отображается временная шкала | - |
| Поле даты начала | Да | Поле, из которого берётся дата начала периода. Может быть системным полем (createdAt, updatedAt) или параметром типа Date | - |
| Поле даты окончания | Да | Поле, из которого берётся дата окончания периода. Может быть системным полем (createdAt, updatedAt) или параметром типа Date | - |
Особенности
- Виджет автоматически масштабирует временную шкалу для отображения всех сущностей;
- Сущности с некорректными датами (дата начала позже даты окончания) автоматически исключаются из отображения.
Календарь сущностей
Виджет отображает сущности выбранного ресурса в календаре.
Отображаемые данные
- «Недельный календарь» — сетка из 7 дней текущей недели.
- «Сущности по датам» — для каждого дня отображаются все сущности, у которых дата в выбранном поле соответствует этому дню.
- «Информация о сущностях» — для каждой сущности отображаются название и описание (если указано).
- «Навигация по неделям» — кнопки для перехода к предыдущей и следующей неделе.
Конфигурация
| Название | Обязательность | Описание | Значение по умолчанию |
|---|---|---|---|
| Ресурс | Да | Ресурс, для которого отображается календарь | - |
| Поле даты | Да | Поле, из которого берётся дата для отображения сущности в календаре. Может быть системным полем (createdAt, updatedAt) или параметром типа Date | - |
Особенности
- Виджет отображает текущую неделю по умолчанию (с понедельника по воскресенье).
- Доступна навигация между неделями с помощью кнопок «Предыдущая неделя» и «Следующая неделя».
- Для каждого дня отображается дата в формате
ДД.ММ. - Сущности отображаются в виде карточек с возможностью перехода на страницу сущности.
- Сущности с пустой или нулевой датой автоматически исключаются из отображения.
Статус сущности
Виджет отображает информацию о статусе сущности и результатах проверок статуса.
Отображаемые данные
Виджет показывает следующую информацию.
Общий статус
- «Прогресс-бар» — визуальное отображение общего статуса сущности с указанием процента успешно пройденных проверок.
- «Счётчик успешных проверок» — количество пройденных проверок из общего числа настроенных проверок статуса.
Список проверок
Для каждой проверки статуса отображается:
- «Название проверки» — название правила проверки.
- «Статус» — результат выполнения проверки:
- «Пройдено» — проверка успешно пройдена.
- «Не пройдено» — проверка не пройдена (ошибок выполнения нет).
- «Ошибка» — при выполнении проверки произошла ошибка.
- «Время последней проверки» — дата и время последнего выполнения проверки.
- «Сообщение об ошибке» — текст ошибки (отображается, если проверка завершилась с ошибкой).
Статистика
В нижней части виджета отображается сводная статистика по проверкам:
- «Пройдено» — количество успешно пройденных проверок.
- «Не пройдено» — количество проверок, которые не были пройдены (без ошибок выполнения).
- «Ошибка» — количество проверок, завершившихся с ошибкой.
Заблокированные действия
Виджет автоматически определяет и отображает действия, которые недоступны при текущем статусе сущности.
Условия отображения:
- действие должно быть доступно для ресурса, связанного с сущностью;
- у действия должны быть настроены разрешённые статусы;
- текущий статус сущности не входит в список разрешённых статусов для этого действия.
Отображаемая информация:
- название действия;
- описание действия (если указано).
Конфигурация
Виджет не требует дополнительной конфигурации.
Для работы виджета необходимо настроить проверки статуса для ресурса, связанного с сущностью, подробнее — в документации.
Особенности
Виджет имеет следующие особенности:
- если для сущности не настроено ни одной проверки статуса, виджет отображает сообщение о том, что проверки отсутствуют;
- если данные о проверках статуса недоступны, виджет отображает сообщение об отсутствии данных.
Статистика событий
Виджет отображает статистику событий, происходящих с сущностями в DDP. Виджет содержит три таба:
- «Статистика событий» — график, показывающий количество событий по типам за выбранный временной период с настраиваемой группировкой по времени.
- «Топ сущностей» — таблица с сущностями, для которых было сгенерировано максимальное количество событий.
- «События в Redis» — таблица со стримами событий из Redis, показывающая для каждого стрима:
- название стрима (кликабельное для просмотра всех событий);
- ресурс, к которому относится стрим;
- количество событий в стриме;
- информацию о последнем событии (сущность, ресурс, тип события, время).
Параметры запроса
| Название | Обязательность | Описание | Значение по умолчанию |
|---|---|---|---|
| Дата от | Да | Начальная дата для выборки событий | 3 дня назад |
| Дата до | Да | Конечная дата для выборки событий | Текущая дата |
| Интервал | Нет | Интервал группировки событий на графике (секунды, минуты, часы, дни, недели, месяцы, годы) | час |
| Шаг интервала | Нет | Количество единиц интервала для группировки | 1 |
| Топ сущностей | Нет | Количество сущностей с максимальным количеством событий для отображения в таблице | 10 |
Типы событий
Виджет поддерживает следующие типы событий:
ENTITY_CREATED— создание сущности.ENTITY_UPDATED— обновление сущности.ENTITY_DELETED— удаление сущности.
Особенности
- График показывает события за выбранный временной период с настраиваемой группировкой по времени (по умолчанию — по часам).
- Таблица отображает все события для каждой сущности (без фильтрации по дате).
- Для удалённых сущностей отображается их название, извлечённое из спецификации события.
- Вкладка «События в Redis» позволяет отслеживать события, хранящиеся в Redis Streams:
- Для каждого стрима отображается количество событий и информация о последнем событии.
- При клике на название стрима открывается диалог со всеми событиями из этого стрима.
- Стримы автоматически привязываются к ресурсам по UUID, указанному в названии стрима.
- При просмотре событий из стрима отображаются последние 1000 событий (новые первыми). Если в стриме больше 1000 событий, более старые события не отображаются.
- Каждая строка в таблице содержит информацию о последнем событии для сущности.
- Доступен просмотр детальной истории изменений для каждой сущности.
- События для удалённых ресурсов не отображаются (удаляются из БД при удалении ресурса).
Числовое значение
Виджет позволяет отображать заданное числовое значение.
Конфигурация
| Название | Обязательность | Описание | Значение по умолчанию |
|---|---|---|---|
| Ресурс | Нет | Ресурс, из которого извлекаются необходимые значения при обработке шаблона | - |
| Числовое значение | Нет | Значение, которое будет выводиться на виджет. Шаблонизация поддерживается. Пример без шаблонизации: 100. Пример с шаблонизацией: {{ .entity.properties.id }} | - |
Kaiten. Карточки пространства
Виджет позволяет отображать структуру задач в пространстве Kaiten в виде многоуровневой таблицы «Доска → Карточки», просматривать задачи на всех уровнях организации работы и получать информацию о критичных параметрах карточек (статус, срочность, блокировки, исполнители и др.).
Конфигурация
| Название | Обязательность | Описание | Значение по умолчанию |
|---|---|---|---|
| ID пространства | Да | Идентификатор пространства в Kaiten | - |
Параметры запроса
| Название | Обязательность | Описание | Значение по умолчанию |
|---|---|---|---|
| Мои задачи | Нет | Фильтр по текущему пользователю | false |
| Создано после | Да | Начальная дата для выборки | 1 месяц назад |
| Создано до | Да | Конечная дата для выборки | сейчас |
Авторизация
Конфигурация авторизации описана в разделе «Внешние сервисы».
Отображаемые данные
Каждая карточка содержит:
- Название карточки.
- Колонка (статус в доске).
- Статус (очередь, в работе, готово).
- Линия.
- Владелец (аватар, имя, email).
- Участники.
- Срок (дата дедлайна, срочность).
- Блокированная/незаблокированная.
Kaiten. Статистика пространства
Виджет предоставляет агрегированные метрики и статистику карточек пространства Kaiten за выбранный период. Позволяет анализировать эффективность работы команды и выявлять узкие места в бизнес-процессах.
Конфигурация
| Название | Обязательность | Описание | Значение по умолчанию |
|---|---|---|---|
| ID пространства | Да | Идентификатор пространства в Kaiten | - |
Параметры запроса
| Название | Обязательность | Описание | Значение по умолчанию |
|---|---|---|---|
| Создано после | Да | Начальная дата для анализа | 1 месяц назад |
| Создано до | Да | Конечная дата для анализа | сейчас |
Авторизация
Конфигурация авторизации описана в разделе «Внешние сервисы».
Отображаемые данные
Виджет содержит четыре вкладки:
Общие показатели
Основные метрики:
- В очереди: задачи в очереди на выполнение.
- Выполнено: завершённые задачи.
- В работе: активные задачи.
Дополнительные метрики:
- Заблокировано: количество заблокированных задач.
- Блокирующих: количество задач, блокирующих другие.
- Архивировано: количество задач в архиве.
- Срочных: количество срочных задач.
- В среднем на выполнение: среднее время выполнения (в минутах).
Статистика по чеклистам:
- Всего с чек-листом: общее количество задач с чек-листами.
- Чеклист полностью выполнен: задачи с полностью выполненными чек-листами.
- Чеклист не выполнен: задачи с невыполненными чек-листами.
По пользователю
- Список пользователей с количеством назначенных задач.
- Визуализация в виде прогресс-баров.
- Количество задач на каждого пользователя.
Забытые задачи
Карточки, которые не обновлялись с момента создания.
Последние обновлённые
Десять последних обновлённых карточек.
Очередь задач
Виджет позволяет отслеживать состояние очереди задач и работу воркеров, обрабатывающих задачи в фоновом режиме. Виджет отображает статистику очереди, информацию о воркерах (консьюмерах) и детали всех задач в очереди.
Отображаемые данные
Виджет состоит из трех основных разделов:
Статистика очереди
В верхней части виджета отображаются четыре ключевых показателя:
- «Размер очереди» — общее количество задач в очереди.
- «Ожидающие задачи» — количество задач, ожидающих обработки.
- «Активные воркеры» — количество активных воркеров (консьюмеров), обрабатывающих задачи.
- «Задачи в очереди» — общее количество задач, включая новые и обрабатываемые.
Таблица воркеров
Таблица содержит информацию о каждом активном воркере:
- «Название консьюмера» — идентификатор воркера (консьюмера).
- «Ожидающие задачи» — количество задач, назначенных данному воркеру и ожидающих обработки.
- «Время простоя» — время с момента последней активности воркера.
В таблице отображаются только активные воркеры. Воркеры, которые не обрабатывают задачи и неактивны более 5 минут, автоматически скрываются из списка.
Таблица задач
Таблица содержит детальную информацию о всех задачах в очереди:
- «UUID задачи» — уникальный идентификатор задачи.
- «Тип» — тип задачи (например,
health_check). - «UUID ресурса» — идентификатор ресурса или сущности, к которой относится задача.
- «Консьюмер» — название консьюмера, обрабатывающего задачу.
- «Время простоя» — время с момента доставки задачи воркеру.
- «Время доставки» — время, когда задача была доставлена воркеру.
- «Статус» — текущий статус задачи:
- «Новая» — задача добавлена в очередь, но ещё не назначена воркеру.
- «В обработке» — задача назначена воркеру и обрабатывается.
Конфигурация
Виджет не требует дополнительной конфигурации и работает сразу после добавления на дашборд.
Технологический радар
Виджет позволяет визуализировать технологии, инструменты и практики, используемые в компании, с их разбивкой по уровням зрелости (Adopt, Trial, Assess, Hold).
На виджете отображается круговая диаграмма: четыре квадранта, четыре кольца и набор элементов с номером, названием и привязкой к квадранту и кольцу. Наполнение радара настраивается в конфигурации виджета.
Конфигурация
| Название | Обязательность | Описание |
|---|---|---|
| Квадранты | Да | Названия квадрантов |
| Элементы | Нет | Список элементов на радаре (не более 200) и их конфигурация |
Конфигурация элемента
| Название | Обязательность | Описание |
|---|---|---|
| Название | Да | Название элемента |
| Номер | Да | Целое число от 0 до 9999 |
| Описание | Нет | Описание элемента, в диалоге просмотра отображается в формате Markdown |
| Квадрант | Да | Квадрант, к которому относится элемент |
| Кольцо | Да | Кольцо, к которому относится элемент: Adopt, Trial, Assess или Hold |