Skip to content

Commit 633bcbc

Browse files
amaksimovvamaksimovv
committed
added policies updated at field and description of OSA components pages
1 parent df13305 commit 633bcbc

4 files changed

Lines changed: 82 additions & 6 deletions

File tree

‎docs/osa/components.en.md‎

Lines changed: 39 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,13 +17,33 @@ The list of scanned packages can be viewed in the `OSA -> Packages` subsection.
1717
- **Authors** – authors;
1818
- **Vulnerabilities** - number of vulnerabilities found;
1919
- **Block status** – component blocking status at the time of the last request;
20-
- **Release date** – date of publication of the package in the public domain;
20+
- **Released** – date and time when the package version was published;
2121
- **Last requested at** – date and time of the last package request.
2222

2323
The package table can be filtered by technology, license, blocking status, or time of last component request.
2424

2525
By clicking on the name of the package, you can go to its individual page, where information about the found vulnerabilities and triggered policies is displayed.
2626

27+
## Package details page
28+
29+
The package details page contains the main component attributes:
30+
31+
- **PURL** – unique package identifier;
32+
- **Actual** – component actuality status;
33+
- **Technology** – package technology;
34+
- **Licenses** – package licenses;
35+
- **Version** – package version;
36+
- **Authors** – package authors;
37+
- **Home page** – link to the project page;
38+
- **Index URL** – link to the package index page;
39+
- **Released** – date and time when this version was published;
40+
- **Last requested at** – date and time of the latest request;
41+
- **First requested at** – date and time of the first request;
42+
- **Policies updated** – date and time of the latest policy update for the component according to the [update mechanism](/osa/update.en/#update-mechanism);
43+
- **Repository** – repository name where the package was received from;
44+
- **Repository manager** – repository manager name;
45+
- **Package link** – link to the package in the repository manager.
46+
2747
## View a list of container images
2848

2949
Container images are displayed in the `OSA -> Container images` subsection after connecting the corresponding [registry](/on-premise/how-to/registries.en/). Each entry in the list contains the following information:
@@ -43,6 +63,24 @@ By default, the added image is not scanned. To carry out the analysis, you need
4363

4464
A SBOM and a PDF report are available for download, based on the data from the most recent successful image scan.
4565

66+
## Container image details page
67+
68+
The container image details page contains the main component attributes:
69+
70+
- **PURL** – unique image identifier;
71+
- **Digest** – image digest;
72+
- **Tags** – image tags;
73+
- **Actual** – component actuality status;
74+
- **Policies updated** – date and time of the latest policy update for the component according to the [update mechanism](/osa/update.en/#update-mechanism);
75+
- **Last requested at** – date and time of the latest request;
76+
- **First requested at** – date and time of the first request;
77+
- **Last scanned** – date and time of the latest scan;
78+
- **Block status** – component blocking status at the time of the last request;
79+
- **Container registry** – registry name where the image is stored;
80+
- **Image links in registry** – links to the image in connected registries;
81+
- **Repository** – repository name where the image was received from;
82+
- **Repository manager** – repository manager name.
83+
4684
## View component requests
4785

4886
The list of component requests from proxy repositories with the plugin connected can be viewed in the `OSA -> Requests` subsection.

‎docs/osa/components.md‎

Lines changed: 39 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,13 +17,33 @@ hide:
1717
- **Авторы** – авторы;
1818
- **Уязвимости** – количество найденных уязвимостей в пакете;
1919
- **Статус блокировки** – статус блокировки компонента на момент последнего запроса;
20-
- **Дата выпуска** – дата публикации пакета в свободном доступе;
20+
- **Выпущено** – дата и время публикации версии пакета;
2121
- **Последний запрос** – дата и время последнего запроса пакета.
2222

2323
Таблицу с пакетами можно отфильтровать по технологии, лицензии, статусу блокировки или времени последнего запроса компонента.
2424

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

27+
## Индивидуальная страница пакета
28+
29+
На индивидуальной странице пакета отображаются основные атрибуты компонента:
30+
31+
- **PURL** – уникальный идентификатор пакета;
32+
- **Актуальный** – статус актуальности компонента;
33+
- **Технология** – технология пакета;
34+
- **Лицензии** – лицензии пакета;
35+
- **Версия** – версия пакета;
36+
- **Авторы** – авторы пакета;
37+
- **Домашняя страница** – ссылка на страницу проекта;
38+
- **Index URL** – ссылка на страницу пакета в пакетном индексе;
39+
- **Выпущено** – дата и время публикации версии;
40+
- **Последний запрос** – дата и время последнего запроса;
41+
- **Первый запрос** – дата и время первого запроса;
42+
- **Политики обновлены** – дата и время последнего обновления политик для компонента в соответствии с [механизмом обновления](/osa/update/#_1);
43+
- **Репозиторий** – имя репозитория, из которого получен пакет;
44+
- **Менеджер репозиториев** – название подключенного менеджера репозиториев;
45+
- **Ссылка на пакет** – ссылка на пакет в менеджере репозиториев.
46+
2747
## Просмотр списка контейнерных образов
2848

2949
Контейнерные образы отображаются в подразделе `OSA -> Образы контейнеров` после подключения соответствующего [реестра](/osa/registries/). Каждая запись в списке содержит следующую информацию:
@@ -43,6 +63,24 @@ hide:
4363

4464
Для образа доступно скачивание SBOM и PDF-отчета по данным последнего успешного сканирования.
4565

66+
## Индивидуальная страница контейнерного образа
67+
68+
На индивидуальной странице контейнерного образа отображаются основные атрибуты компонента:
69+
70+
- **PURL** – уникальный идентификатор образа;
71+
- **Дайджест** – дайджест образа;
72+
- **Теги** – теги образа;
73+
- **Актуальный** – статус актуальности компонента;
74+
- **Политики обновлены** – дата и время последнего обновления политик для компонента в соответствии с [механизмом обновления](/osa/update/#_1);
75+
- **Последний запрос** – дата и время последнего запроса;
76+
- **Первый запрос** – дата и время первого запроса;
77+
- **Последнее сканирование** – дата и время последнего сканирования;
78+
- **Статус блокировки** – статус блокировки компонента на момент последнего запроса;
79+
- **Реестр контейнеров** – имя реестра, в котором размещен образ;
80+
- **Ссылки на образ в реестре** – ссылки на образ в подключенных реестрах;
81+
- **Репозиторий** – имя репозитория, из которого получен образ;
82+
- **Менеджер репозиториев** – название подключенного менеджера репозиториев.
83+
4684
## Просмотр запросов компонентов
4785

4886
Список запросов компонентов из прокси-репозиториев с подключенным плагином можно посмотреть в подразделе `OSA -> Запросы`.

‎docs/osa/update.en.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ CodeScoring.OSA automatically updates information about previously requested com
99

1010
## Update mechanism
1111

12-
Packages and images that have been requested at least once in the last 14 days are considered up-to-date, the period can be changed in the settings. The system updates data on such packages every 2 hours, including information on vulnerabilities, licenses, and meta-information on packages.
12+
Packages and images that have been successfully requested at least once in the last 14 days are considered up-to-date, the period can be changed in the settings. The system updates data on such packages every 2 hours, including information on vulnerabilities, licenses, and meta-information on packages.
1313

1414
If a component has not been requested for 14 days, it is automatically transferred to the **archived** status. Such components are no longer updated until the next request.
1515

@@ -29,4 +29,4 @@ The `OSA → Packages`, `OSA → Images` and Alerts sections have a filter **Is
2929
- **Yes** — only actual (updated) components are displayed;
3030
- **No** — only archived (not updated) components are displayed.
3131

32-
By default, all components are displayed.
32+
By default, all components are displayed.

‎docs/osa/update.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ CodeScoring.OSA автоматически в фоне обновляет инф
99

1010
## Механизм обновления
1111

12-
Пакеты и образы, которые запрашивались хотя бы один раз за последние 14 дней, считаются актуальными, срок можно поменять в настройках. Система обновляет по таким пакетам данные каждые 2 часа, включая сведения по уязвимостям, лицензиям и мета-информацию по пакетам.
12+
Пакеты и образы, которые успешно запрашивались хотя бы один раз за последние 14 дней, считаются актуальными, срок можно поменять в настройках. Система обновляет по таким пакетам данные каждые 2 часа, включая сведения по уязвимостям, лицензиям и мета-информацию по пакетам.
1313

1414
Если компонент не запрашивался в течение 14 дней, он автоматически переводится в статус **архивного**. Такие компоненты больше не обновляются до следующего запроса.
1515

@@ -29,4 +29,4 @@ CodeScoring.OSA автоматически в фоне обновляет инф
2929
- **Да** — отображаются только актуальные (обновляемые) компоненты;
3030
- **Нет** — отображаются только архивные (не обновляемые) компоненты.
3131

32-
По умолчанию отображаются все компоненты.
32+
По умолчанию отображаются все компоненты.

0 commit comments

Comments
 (0)