diff --git a/content/documentation/admin/external-services.ru.md b/content/documentation/admin/external-services.ru.md index bffb6080..e225546d 100644 --- a/content/documentation/admin/external-services.ru.md +++ b/content/documentation/admin/external-services.ru.md @@ -105,6 +105,22 @@ Authorization: <ваш-api-token> Authorization: Token <ваш-defectdojo-api-v2-key> ``` +### Argo CD + +**Тип авторизации:** Bearer Token (API-токен Argo CD). + +**Заголовки:** + +| Заголовок | Формат значения | +|-----------------|------------------| +| `Authorization` | `Bearer <токен>` | + +**Пример:** + +```sh +Authorization: Bearer <ваш-api-токен-argo-cd> +``` + ### Bitbucket **Тип авторизации:** Bearer Token (Personal Access Token). diff --git a/content/documentation/admin/widgets/types.ru.md b/content/documentation/admin/widgets/types.ru.md index c95975ee..5ec67a3e 100644 --- a/content/documentation/admin/widgets/types.ru.md +++ b/content/documentation/admin/widgets/types.ru.md @@ -71,6 +71,103 @@ title: Типы виджетов Конфигурация авторизации описана в разделе [«Внешние сервисы»](../external-services/#gitlab). +### Argo CD. Приложения + +Виджет показывает список Application в Argo CD: сводку по состоянию, фильтры, таблицу приложений и состав выбранного Application (управляемые ресурсы, отличия, манифест, логи подов). + +#### Авторизация + +Конфигурация авторизации описана в разделе [«Внешние сервисы»](../external-services/#argo-cd). + +#### Конфигурация + +| Название | Обязательность | Описание | Значение по умолчанию | +|-------------------------------|----------------|---------------------------------------------------------------------------------------------------------------|-----------------------| +| URL | **да** | Базовый URL сервера Argo CD | - | +| Проекты Argo CD | нет | По одному названию проекта на строку; пусто — все проекты, доступные токену | - | +| Название приложения содержит | нет | Подстрочный фильтр без учёта регистра по `metadata.name` (если не включено «Регулярное выражение»). Примеры: `prod` — «backend-prod», «prod-api»; `guest-` — «guest-booking»; пусто — без фильтра по названию | - | +| Регулярное выражение | нет | Если **да**, поле «Название приложения содержит» — шаблон Go regexp (RE2) по `metadata.name`. Примеры: `^prod-`, `staging$` | нет | + +#### Использование виджета + +На панели виджета отображаются карточки «Приложения», «Деградация» и «Не синхронизировано» — нажатие переключает соответствующий фильтр. Доступны поиск, фильтры по проекту, статусу Sync и Health, быстрый фильтр («Все», «Ошибки», «Не синхронизировано»). + +В таблице для каждого Application можно открыть «Состав», запустить синхронизацию, включить или отключить автоматическую синхронизацию, перейти в Argo CD или к коммиту. Для нескольких выбранных строк доступны массовые действия: синхронизация, включение и отключение автоматической синхронизации. + +В панели состава доступны просмотр манифеста и server-side отличий ресурса, общий diff Application, логи пода и синхронизация Application. + +{{< alert level="info" >}} +Действия с Application требуют включённой функции действий в настройках виджета и соответствующих прав токена в Argo CD. +{{< /alert >}} + +### Argo CD. Приложение + +Виджет показывает состав одного Application: дерево управляемых ресурсов и те же операции, что в виджете «Argo CD. Приложения», без таблицы списка. + +#### Авторизация + +Конфигурация авторизации описана в разделе [«Внешние сервисы»](../external-services/#argo-cd). + +#### Конфигурация + +| Название | Обязательность | Описание | Значение по умолчанию | +|--------------------------------|----------------|---------------------------------------------------------------------------------------------------------------|-----------------------| +| URL | **да** | Базовый URL сервера Argo CD | - | +| Название Application | **да** | Точное совпадение с `metadata.name` ресурса Application в Kubernetes | - | +| Namespace Application | **да** | Точное совпадение с `metadata.namespace` ресурса Application в Kubernetes | - | +| Проект Argo CD (необязательно) | нет | При указании сравнивается без учёта регистра с полем `project` в spec Application | - | + +Если Application не найдено или недоступно токену, отображается предупреждение. + +### Argo CD. История синхронизаций + +Виджет показывает хронологию синхронизаций и последних операций по Application с фильтрами и ссылками на Argo CD. + +#### Авторизация + +Конфигурация авторизации описана в разделе [«Внешние сервисы»](../external-services/#argo-cd). + +#### Конфигурация + +| Название | Обязательность | Описание | Значение по умолчанию | +|-------------------------------|----------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------| +| URL | **да** | Базовый URL сервера Argo CD | - | +| Проекты Argo CD | нет | По одному названию проекта на строку; пусто — все проекты, доступные токену | - | +| Название приложения содержит | нет | Подстрочный фильтр без учёта регистра по `metadata.name` (если не включено «Регулярное выражение»). Примеры: `prod` — «backend-prod», «prod-api»; `guest-` — «guest-booking»; пусто — без фильтра по названию | - | +| Регулярное выражение | нет | Если **да**, поле «Название приложения содержит» — шаблон Go regexp (RE2) по `metadata.name`. Примеры: `^prod-`, `staging$` | нет | +| Максимум строк истории | нет | Максимальное число строк в таблице (сначала новые) по истории каждого приложения и последней операции | 80 | + +#### Использование виджета + +Записи сгруппированы по Application. Доступны поиск, быстрый фильтр («Все», «Только проблемы»), фильтр по приложению и кнопка «Очистить». + +### Argo CD. Аналитика времени деплоя + +Виджет показывает метрики длительности синхронизаций за выбранный период (24 ч, 7 сут, 30 сут): среднюю длительность, тренд к предыдущему периоду, долю успеха, гистограмму распределения и таблицы по приложениям. + +#### Авторизация + +Конфигурация авторизации описана в разделе [«Внешние сервисы»](../external-services/#argo-cd). + +#### Конфигурация + +| Название | Обязательность | Описание | Значение по умолчанию | +|----------------------------------------------------------|----------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------| +| URL | **да** | Базовый URL сервера Argo CD | - | +| Проекты Argo CD | нет | По одному названию проекта на строку; пусто — все проекты, доступные токену | - | +| Название приложения содержит | нет | Подстрочный фильтр без учёта регистра по `metadata.name` (если не включено «Регулярное выражение»). Примеры: `prod` — «backend-prod», «prod-api»; `guest-` — «guest-booking»; пусто — без фильтра по названию | - | +| Регулярное выражение | нет | Если **да**, поле «Название приложения содержит» — шаблон Go regexp (RE2) по `metadata.name`. Примеры: `^prod-`, `staging$` | нет | +| Верхние границы корзин гистограммы (с) | нет | По одному значению в строке: верхняя граница интервала в секундах (не включительно), по возрастанию; пусто — 60, 180, 300 | 60, 180, 300 | +| Размер списка по максимальной длительности синка (строк) | нет | Сколько приложений в рейтинге по максимальной длительности синка в окне; 0 — 5; не более 10 | 5 | +| Минимальное отклонение для аномалий (с) | нет | Приложение попадает в таблицу аномалий, если последний деплой в окне медленнее медианы остальных деплоев минимум на столько секунд | 120 | +| Время кэширования ответа (с) | нет | Сколько секунд ответ хранится на сервере без повторного запроса к Argo CD; 0 — без кэша | 300 | + +#### Использование виджета + +Кнопка «Таблицы по приложениям» открывает вкладки «Макс. длительность» и «Аномалии». В таблице аномалий кнопка «История синхронизаций» открывает диалог с записями по выбранному Application. + +Если список приложений усечён на стороне сервера, под заголовком виджета отображается соответствующая подсказка. + ### Bitbucket. Pull Requests Виджет позволяет отображать данные о Pull Requests (PR) в Bitbucket и выполнять действия с ними. @@ -265,8 +362,8 @@ title: Типы виджетов При просмотре виджета доступна настройка следующих параметров: -* **Активные уязвимости** - если включено, то загружаются уязвимости продукта с флагом ‘Active’ = true. Если отключено, то загружаются уязвимости продукта с флагом ‘Active’ = false. Включено по умолчанию. -* **Дублирующиеся уязвимости** - если включено, то загружаются уязвимости продукта с флагом ‘Duplicate’ = true. Если отключено, то загружаются уязвимости продукта с флагом ‘Duplicate’ = false. Отключено по умолчанию. +- **Активные уязвимости** - если включено, то загружаются уязвимости продукта с флагом ‘Active’ = true. Если отключено, то загружаются уязвимости продукта с флагом ‘Active’ = false. Включено по умолчанию. +- **Дублирующиеся уязвимости** - если включено, то загружаются уязвимости продукта с флагом ‘Duplicate’ = true. Если отключено, то загружаются уязвимости продукта с флагом ‘Duplicate’ = false. Отключено по умолчанию. ### DefectDojo. Уязвимости в продукте (общая статистика) @@ -287,8 +384,8 @@ title: Типы виджетов При просмотре виджета доступна настройка следующих параметров: -* **Активные уязвимости** - если включено, то загружаются уязвимости продукта с флагом ‘Active’ = true. Если отключено, то загружаются уязвимости продукта с флагом ‘Active’ = false. Включено по умолчанию. -* **Дублирующиеся уязвимости** - если включено, то загружаются уязвимости продукта с флагом ‘Duplicate’ = true. Если отключено, то загружаются уязвимости продукта с флагом ‘Duplicate’ = false. Отключено по умолчанию. +- **Активные уязвимости** - если включено, то загружаются уязвимости продукта с флагом ‘Active’ = true. Если отключено, то загружаются уязвимости продукта с флагом ‘Active’ = false. Включено по умолчанию. +- **Дублирующиеся уязвимости** - если включено, то загружаются уязвимости продукта с флагом ‘Duplicate’ = true. Если отключено, то загружаются уязвимости продукта с флагом ‘Duplicate’ = false. Отключено по умолчанию. ### Docker образы @@ -391,8 +488,8 @@ title: Типы виджетов Виджет отображает: -* **Редактор кода** - Monaco Editor для редактирования файла `.gitlab-ci.yml`. -* **Дифф-просмотр** - отображение изменений между оригинальной и редактируемой версией конфигурации. +- **Редактор кода** - Monaco Editor для редактирования файла `.gitlab-ci.yml`. +- **Дифф-просмотр** - отображение изменений между оригинальной и редактируемой версией конфигурации. #### Дополнительные возможности виджета @@ -412,9 +509,9 @@ title: Типы виджетов ##### Ограничения -* Виджет работает только с файлом `.gitlab-ci.yml` в корне проекта. -* Для создания запроса на слияние требуются права на запись в репозиторий. -* Максимальный размер файла конфигурации ограничен возможностями GitLab API. +- Виджет работает только с файлом `.gitlab-ci.yml` в корне проекта. +- Для создания запроса на слияние требуются права на запись в репозиторий. +- Максимальный размер файла конфигурации ограничен возможностями GitLab API. ### GitLab. Статистика пайплайнов @@ -437,36 +534,36 @@ title: Типы виджетов ##### Основные метрики -* **Общее количество пайплайнов** - общее число пайплайнов за выбранный период. -* **Процент успеха** - процент успешно выполненных пайплайнов. -* **Процент неудач** - процент неудачно выполненных пайплайнов. -* **Средняя длительность** - среднее время выполнения пайплайнов. +- **Общее количество пайплайнов** - общее число пайплайнов за выбранный период. +- **Процент успеха** - процент успешно выполненных пайплайнов. +- **Процент неудач** - процент неудачно выполненных пайплайнов. +- **Средняя длительность** - среднее время выполнения пайплайнов. ##### Распределение по статусам -* Успешные пайплайны. -* Неудачные пайплайны. -* Отмененные пайплайны. -* Пропущенные пайплайны. -* Ручные пайплайны. +- Успешные пайплайны. +- Неудачные пайплайны. +- Отмененные пайплайны. +- Пропущенные пайплайны. +- Ручные пайплайны. ##### Распределение по источникам -* Push (коммиты). -* Merge requests (запросы слияния). -* Schedule (по расписанию). -* Web (через веб-интерфейс). +- Push (коммиты). +- Merge requests (запросы слияния). +- Schedule (по расписанию). +- Web (через веб-интерфейс). ##### Топ участников -* Список участников с наибольшим количеством запущенных пайплайнов. -* Аватары участников (при наличии). -* Количество пайплайнов для каждого участника. +- Список участников с наибольшим количеством запущенных пайплайнов. +- Аватары участников (при наличии). +- Количество пайплайнов для каждого участника. ##### Активность веток -* Список веток с наибольшим количеством пайплайнов. -* Количество пайплайнов для каждой ветки. +- Список веток с наибольшим количеством пайплайнов. +- Количество пайплайнов для каждой ветки. #### Параметры запроса @@ -478,9 +575,9 @@ title: Типы виджетов #### Ограничения -* Виджет анализирует максимум 100 пайплайнов за один запрос для оптимизации производительности. -* Статистика рассчитывается только для пайплайнов с валидными данными (имеющими статус и время выполнения). -* Данные обновляются при каждом обновлении виджета. +- Виджет анализирует максимум 100 пайплайнов за один запрос для оптимизации производительности. +- Статистика рассчитывается только для пайплайнов с валидными данными (имеющими статус и время выполнения). +- Данные обновляются при каждом обновлении виджета. ### GitLab. Теги @@ -530,8 +627,8 @@ title: Типы виджетов Виджет отображает список тегов репозитория с информацией о каждом теге: -* **Название тега** — название тега. -* **Коммит** — хеш коммита, сообщение коммита, автор, дата создания, ссылка на коммит в Bitbucket. +- **Название тега** — название тега. +- **Коммит** — хеш коммита, сообщение коммита, автор, дата создания, ссылка на коммит в Bitbucket. #### Дополнительные возможности виджета @@ -643,9 +740,9 @@ title: Типы виджетов Конфигурация авторизации описана в разделе [«Внешние сервисы»](../external-services/#gitlab). -* [GitLab](../external-services/#gitlab). -* [Bitbucket](../external-services/#bitbucket). -* [GitHub](../external-services/#github). +- [GitLab](../external-services/#gitlab). +- [Bitbucket](../external-services/#bitbucket). +- [GitHub](../external-services/#github). #### Конфигурация @@ -699,17 +796,17 @@ title: Типы виджетов Для обычных пайплайнов виджет отображает: -* **Список сборок** — таблица со всеми сборками пайплайна с информацией о номере, статусе, длительности, времени выполнения и пользователе. -* **Последняя сборка** — информация о последней выполненной сборке. -* **Последняя успешная сборка** — информация о последней успешной сборке. -* **Последняя неудачная сборка** — информация о последней неудачной сборке. +- **Список сборок** — таблица со всеми сборками пайплайна с информацией о номере, статусе, длительности, времени выполнения и пользователе. +- **Последняя сборка** — информация о последней выполненной сборке. +- **Последняя успешная сборка** — информация о последней успешной сборке. +- **Последняя неудачная сборка** — информация о последней неудачной сборке. ##### Multibranch пайплайны Для multibranch пайплайнов виджет отображает: -* **Список веток** — таблица со всеми ветками с информацией о статусе, количестве сборок и последней сборке для каждой ветки. -* Всю информацию, описанную в разделе «обычные пайплайны», в разрезе каждой ветки. +- **Список веток** — таблица со всеми ветками с информацией о статусе, количестве сборок и последней сборке для каждой ветки. +- Всю информацию, описанную в разделе «обычные пайплайны», в разрезе каждой ветки. #### Дополнительные возможности виджета @@ -717,21 +814,21 @@ title: Типы виджетов ##### Для обычных пайплайнов -* **Запустить сборку** — запуск новой сборки. Если у сборки есть параметры, отображается диалог для их ввода: - * Строковые параметры. - * Пароли. - * Выбор из списка. - * Булевы значения. -* **Отменить сборку** — отмена выполняющейся сборки. -* **Повторить сборку** — повторный запуск последней сборки. -* **Просмотр логов** — просмотр логов выполнения сборки. +- **Запустить сборку** — запуск новой сборки. Если у сборки есть параметры, отображается диалог для их ввода: + - Строковые параметры. + - Пароли. + - Выбор из списка. + - Булевы значения. +- **Отменить сборку** — отмена выполняющейся сборки. +- **Повторить сборку** — повторный запуск последней сборки. +- **Просмотр логов** — просмотр логов выполнения сборки. ##### Для multibranch пайплайнов -* **Запустить сборку ветки** — запуск новой сборки для конкретной ветки. Если у сборки есть параметры, отображается диалог для их ввода. -* **Получить сборки ветки** — загрузка списка сборок для конкретной ветки. -* **Сканировать multibranch** — запуск сканирования multibranch пайплайна для обнаружения новых веток. -* **Просмотр логов** — просмотр логов выполнения сборки. +- **Запустить сборку ветки** — запуск новой сборки для конкретной ветки. Если у сборки есть параметры, отображается диалог для их ввода. +- **Получить сборки ветки** — загрузка списка сборок для конкретной ветки. +- **Сканировать multibranch** — запуск сканирования multibranch пайплайна для обнаружения новых веток. +- **Просмотр логов** — просмотр логов выполнения сборки. ### Jira. Задачи @@ -757,9 +854,9 @@ title: Типы виджетов #### Дополнительные возможности виджета -* **Просмотр описания** — при клике на кнопку "Просмотр описания" открывается диалоговое окно с полным описанием задачи. -* **Переход в Jira** — клик по ключу задачи открывает задачу в Jira в новой вкладке. -* **Динамическая фильтрация** — возможность изменить JQL-запрос и максимальное количество результатов прямо в виджете без изменения конфигурации. +- **Просмотр описания** — при клике на кнопку "Просмотр описания" открывается диалоговое окно с полным описанием задачи. +- **Переход в Jira** — клик по ключу задачи открывает задачу в Jira в новой вкладке. +- **Динамическая фильтрация** — возможность изменить JQL-запрос и максимальное количество результатов прямо в виджете без изменения конфигурации. ### Helm. Релизы @@ -767,9 +864,9 @@ title: Типы виджетов Данные, отображаемые на виджете: -* **Список релизов Helm**: информация о текущих релизах, созданных с помощью Helm в указанном Kubernetes пространстве. -* **Манифесты релизов**: манифесты, связанные с Helm-релизами в указанном Kubernetes пространстве. Это включает в себя файлы YAML, которые определяют конфигурацию и состояние ресурсов. -* **Values**: переменные, которые использовались для развертывания Helm-релизов. +- **Список релизов Helm**: информация о текущих релизах, созданных с помощью Helm в указанном Kubernetes пространстве. +- **Манифесты релизов**: манифесты, связанные с Helm-релизами в указанном Kubernetes пространстве. Это включает в себя файлы YAML, которые определяют конфигурацию и состояние ресурсов. +- **Values**: переменные, которые использовались для развертывания Helm-релизов. #### Авторизация @@ -802,21 +899,21 @@ title: Типы виджетов Для каждого ACL отображается следующая информация: -* Субъект. -* Тип ресурса. -* Шаблон. -* Тип шаблона. -* Хост. -* Операция. -* Тип разрешения. +- Субъект. +- Тип ресурса. +- Шаблон. +- Тип шаблона. +- Хост. +- Операция. +- Тип разрешения. #### Аутентификация Для работы с виджетом требуется учётная запись пользователя. Система поддерживает следующие методы аутентификации: -* PLAINTEXT. -* SCRAM-SHA-256. -* SCRAM-SHA-512. +- PLAINTEXT. +- SCRAM-SHA-256. +- SCRAM-SHA-512. #### Конфигурация @@ -838,8 +935,8 @@ title: Типы виджетов При активированной функции действий в настройках виджет позволяет: -* Создавать новые правила ACL. -* Удалять существующие правила ACL. +- Создавать новые правила ACL. +- Удалять существующие правила ACL. ### Kafka. Топики @@ -847,20 +944,20 @@ title: Типы виджетов Для каждого топика доступно: -* Общая информация о топике: основные параметры, конфигурация и статус. -* Информация о партициях: лидер и оффсеты, количество реплик и т.д. -* Информация о консьюмерах: список активных потребителей, их группы, текущие оффсеты и лаги. -* Сообщения: просмотр содержимого сообщений топиков. -* Поиск сообщений: фильтрация сообщений по timestamp и offset. -* Настройки топика: просмотр конфигурации топика в виде таблицы ключ-значение. +- Общая информация о топике: основные параметры, конфигурация и статус. +- Информация о партициях: лидер и оффсеты, количество реплик и т.д. +- Информация о консьюмерах: список активных потребителей, их группы, текущие оффсеты и лаги. +- Сообщения: просмотр содержимого сообщений топиков. +- Поиск сообщений: фильтрация сообщений по timestamp и offset. +- Настройки топика: просмотр конфигурации топика в виде таблицы ключ-значение. #### Аутентификация Для работы с виджетом требуется учётная запись пользователя. Система поддерживает следующие методы аутентификации: -* PLAINTEXT. -* SCRAM-SHA-256. -* SCRAM-SHA-512. +- PLAINTEXT. +- SCRAM-SHA-256. +- SCRAM-SHA-512. {{< alert level="info" >}} Доступность информации в виджете определяется уровнем прав подключённой учётной записи. @@ -881,10 +978,10 @@ title: Типы виджетов При активированной функции действий в настройках виджет позволяет: -* Создавать новые топики. -* Удалять существующие топики. -* Отправлять сообщение в топик. -* Очищать топик от сообщений. +- Создавать новые топики. +- Удалять существующие топики. +- Отправлять сообщение в топик. +- Очищать топик от сообщений. ### Kubernetes deployments @@ -915,9 +1012,9 @@ title: Типы виджетов Для каждого Ingress доступны: -* Просмотр спецификации Ingress в виде YAML-конфигурации. -* Правила Ingress. -* Настройки TLS. +- Просмотр спецификации Ingress в виде YAML-конфигурации. +- Правила Ingress. +- Настройки TLS. #### Авторизация @@ -937,9 +1034,9 @@ title: Типы виджетов Для каждого pod доступны: -* Просмотр спецификации пода в виде YAML-конфигурации. -* Логи контейнеров. -* Различная информация о состоянии пода: статус, количество перезапусков и др. +- Просмотр спецификации пода в виде YAML-конфигурации. +- Логи контейнеров. +- Различная информация о состоянии пода: статус, количество перезапусков и др. #### Авторизация @@ -1027,9 +1124,9 @@ rate(nginx_ingress_controller_nginx_process_connections[5m]) При просмотре виджета возможно настроить диапазон отображаемых значений. Доступные параметры отображения диапазона: -* Интервал. -* Минимальное значение (начальная точка отсчета для вертикальной линии на графике). -* Максимальное значение (предельная точка отсчета для вертикальной линии на графике). +- Интервал. +- Минимальное значение (начальная точка отсчета для вертикальной линии на графике). +- Максимальное значение (предельная точка отсчета для вертикальной линии на графике). ### Prometheus metrics (single) @@ -1089,18 +1186,18 @@ sum(ingress_nginx_detail_requests_total) Для каждого объекта доступно: -* Просмотр списка объектов в контейнере (bucket) с информацией о размере, дате изменения и классе хранения. -* Поиск объектов по префиксу (пути). -* Загрузка файлов из bucket. -* Просмотр детальной метаинформации объектов (размер, тип контента, метаданные, настройки кеширования и т.д.). -* Навигация по папкам bucket. +- Просмотр списка объектов в контейнере (bucket) с информацией о размере, дате изменения и классе хранения. +- Поиск объектов по префиксу (пути). +- Загрузка файлов из bucket. +- Просмотр детальной метаинформации объектов (размер, тип контента, метаданные, настройки кеширования и т.д.). +- Навигация по папкам bucket. #### Аутентификация Для работы с виджетом требуется учётная запись с правами доступа к S3 Bucket. Система поддерживает следующие методы аутентификации: -* Access Key ID и Secret Access Key. -* Поддержка различных S3-совместимых провайдеров через настройку эндпоинта. +- Access Key ID и Secret Access Key. +- Поддержка различных S3-совместимых провайдеров через настройку эндпоинта. {{< alert level="info" >}} В отличие от других виджетов, S3 Bucket виджет не поддерживает использование внешних сервисов для передачи учётных данных. Все параметры аутентификации указываются непосредственно в конфигурации виджета. @@ -1110,8 +1207,8 @@ sum(ingress_nginx_detail_requests_total) Для повышения безопасности можно использовать механизм шаблонизации с учётными данными: -* `{{ .credentials.accessKeyId }}` - подставить Access Key ID из учётных данных. -* `{{ .credentials.secretAccessKey }}` - подставить Secret Access Key из учётных данных. +- `{{ .credentials.accessKeyId }}` - подставить Access Key ID из учётных данных. +- `{{ .credentials.secretAccessKey }}` - подставить Secret Access Key из учётных данных. {{< alert level="info" >}} Доступность информации в виджете определяется уровнем прав подключённой учётной записи. @@ -1149,11 +1246,11 @@ sum(ingress_nginx_detail_requests_total) При клике на иконку документа для каждого объекта отображается детальная информация: -* Основные параметры: ключ, размер, дата изменения, класс хранения, тип контента, ETag. -* Информация о контенте: кодировка, язык, диспозиция. -* Настройки кеширования: Cache-Control, срок действия. -* Безопасность: серверное шифрование. -* Пользовательские метаданные. +- Основные параметры: ключ, размер, дата изменения, класс хранения, тип контента, ETag. +- Информация о контенте: кодировка, язык, диспозиция. +- Настройки кеширования: Cache-Control, срок действия. +- Безопасность: серверное шифрование. +- Пользовательские метаданные. #### Подгрузка дополнительных объектов @@ -1169,10 +1266,10 @@ sum(ingress_nginx_detail_requests_total) Для каждого секрета доступно: -* Просмотр иерархической структуры секретов и директорий. -* Просмотр метаданных секрета: версия, время создания, время удаления, статус уничтожения. -* Просмотр ключей секрета в формате таблицы «ключ/значение» (вместо значений отображается плейсхолдер). -* Навигация по вложенным секретам и директориям. +- Просмотр иерархической структуры секретов и директорий. +- Просмотр метаданных секрета: версия, время создания, время удаления, статус уничтожения. +- Просмотр ключей секрета в формате таблицы «ключ/значение» (вместо значений отображается плейсхолдер). +- Навигация по вложенным секретам и директориям. #### Авторизация @@ -1189,9 +1286,9 @@ sum(ingress_nginx_detail_requests_total) Для работы с KV v2 секретами путь должен явно содержать `/data/`. Примеры корректных путей: -* `services/data/` — для просмотра всех секретов в директории `services`. -* `services/data/example` — для просмотра конкретного секрета `example`. -* `services/data/nested/secret` — для вложенных секретов. +- `services/data/` — для просмотра всех секретов в директории `services`. +- `services/data/example` — для просмотра конкретного секрета `example`. +- `services/data/nested/secret` — для вложенных секретов. #### Отображаемые данные @@ -1199,34 +1296,34 @@ sum(ingress_nginx_detail_requests_total) ##### Структура секретов -* **Директории** — отображаются с завершающим слешем (например, `nested/`) и всегда помечаются как директории, даже если содержат ключи. -* **Секреты** — отображаются без завершающего слеша и содержат ключи. +- **Директории** — отображаются с завершающим слешем (например, `nested/`) и всегда помечаются как директории, даже если содержат ключи. +- **Секреты** — отображаются без завершающего слеша и содержат ключи. ##### Метаданные секрета Для каждого секрета отображаются следующие метаданные (если доступны): -* **Версия** — версия секрета в KV v2. -* **Время создания** — дата и время создания секрета. -* **Время удаления** — дата и время удаления секрета (для удаленных версий). -* **Статус уничтожения** — индикатор того, что секрет был уничтожен. +- **Версия** — версия секрета в KV v2. +- **Время создания** — дата и время создания секрета. +- **Время удаления** — дата и время удаления секрета (для удаленных версий). +- **Статус уничтожения** — индикатор того, что секрет был уничтожен. ##### Ключи секрета Ключи секрета отображаются в формате таблицы «ключ/значение»: -* **Ключ** — полный путь к ключу в структуре секрета (например, `database.host`). -* **Значение** — всегда маскируется символами `********` и не может быть раскрыто. +- **Ключ** — полный путь к ключу в структуре секрета (например, `database.host`). +- **Значение** — всегда маскируется символами `********` и не может быть раскрыто. ### График Виджет позволяет выводить информацию об объектах DDP в виде одного из следующих типов графиков: -* Столбчатая диаграмма. -* Кольцевая диаграмма. -* Круговая диаграмма. -* Полярная диаграмма. -* Радарная диаграмма. +- Столбчатая диаграмма. +- Кольцевая диаграмма. +- Круговая диаграмма. +- Полярная диаграмма. +- Радарная диаграмма. #### Конфигурация @@ -1241,8 +1338,8 @@ sum(ingress_nginx_detail_requests_total) При настройке виджета следует учитывать, что названия полей в базе данных могут отличаться от названий полей в спецификации объектов. Общий принцип таков: формат camelCase в спецификации объектов при сохранении структур в базу данных преобразуется в snake_case. Например: -* Поле `createdAt` в спецификации следует указывать в конфигурации виджета как `created_at`. -* Поле `resourceUuid` в спецификации следует указывать в конфигурации виджета как `resource_uuid`. +- Поле `createdAt` в спецификации следует указывать в конфигурации виджета как `created_at`. +- Поле `resourceUuid` в спецификации следует указывать в конфигурации виджета как `resource_uuid`. Доступно обращение к вложенным значениям. В таком случае разделителем для вложенности служит символ точки. Например, чтобы выполнить агрегацию по статусу сущностей, виджет следует настроить следующим образом: @@ -1448,6 +1545,7 @@ sum(ingress_nginx_detail_requests_total) #### Особенности Виджет имеет следующие особенности: + - если для сущности не настроено ни одной проверки статуса, виджет отображает сообщение о том, что проверки отсутствуют; - если данные о проверках статуса недоступны, виджет отображает сообщение об отсутствии данных. @@ -1531,6 +1629,7 @@ sum(ingress_nginx_detail_requests_total) #### Отображаемые данные Каждая карточка содержит: + - Название карточки. - Колонка (статус в доске). - Статус (очередь, в работе, готово). diff --git a/content/documentation/release-notes/v1.6.0.ru.md b/content/documentation/release-notes/v1.6.0.ru.md index 3f47810e..9a65c0b0 100644 --- a/content/documentation/release-notes/v1.6.0.ru.md +++ b/content/documentation/release-notes/v1.6.0.ru.md @@ -21,6 +21,10 @@ weight: 910 Добавлена функция шаблонизации [«toSlug»](../../user/templating/#toslug). +### Виджеты Argo CD + +Добавлены виджеты [«Argo CD. Приложения»](../../admin/widgets/types/#argo-cd-приложения), [«Argo CD. Приложение»](../../admin/widgets/types/#argo-cd-приложение), [«Argo CD. История синхронизаций»](../../admin/widgets/types/#argo-cd-история-синхронизаций) и [«Argo CD. Аналитика времени деплоя»](../../admin/widgets/types/#argo-cd-аналитика-времени-деплоя) для мониторинга Application и анализа длительности синхронизаций. + ## Улучшения интерфейса - Добавлена возможность создания новых действий, либо редактирования существующих, из окна конфигурации элемента процесса.