scout: refresh dashboard overview

Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
This commit is contained in:
David Karlsson 2024-02-14 20:27:06 +01:00
parent c39ea1a7b1
commit ef15b740d2
9 changed files with 50 additions and 183 deletions

View File

@ -38,217 +38,84 @@ chart using the drop-down menu.
Use the header menu at the top of the website to access the different main
sections of the Docker Scout Dashboard:
- [Images](#images)
- [Policies](#policies)
- [Vulnerabilities](#vulnerabilities)
- [Base images](#base-images)
- [Packages](#packages)
## Images
The **Images** view shows a list of images in an organization. You can search
for specific repositories using the search box.
Each entry in the list shows the following details:
- The repository name for the image. Selecting the link for the repository opens [the list of tags for the repository](#repository-tag-list).
- The most recent tag of the image in the selected environment. Selecting the link for the base image opens [the image details view](#image-details-view).
- The operating system and architecture of the image.
- The date of the last push for the image.
- The vulnerabilities for the most recent image version.
- Policy status, including the change for the most recent version, and a link to more details for non-compliant images.
### Repository tag list
![Screenshot of tags for a repository](./images/dashboard-repo-tags.webp?border=true)
There are two tabs on this page:
- The **Policy** tab displays the policy delta for the latest version of the
image.
- The **Tags** tab contains the repository tag list, and shows all tags for the
repository.
In the **Tags** tab, you can filter the list by environment, or by tag or
digest using the search box.
Each entry in the list shows the following details:
- A checkbox to mark the tag for comparison to one other.
> **Tip**
>
> Compare two image tags by selecting the checkboxes next to them and selecting the **Compare images** button at the top of the list.
{ .tip }
- The tag version or image digest. Clicking the link for version opens [the image layer view](#image-details-view).
- The [environments](./integrations/environment/_index.md) that the image is assigned to.
- The operating system and architecture of the image.
- The vulnerabilities for the tag version.
- The last push for the tag version.
- The base image and version used by the repository and the vulnerabilities for that version.
#### Compare images
You can compare two or more images in the list. Mark the image versions that
you want to compare, and select **Compare images**.
The top section of the comparison view shows an overview of the two selected
image tags. The tabs section of the view shows the following:
- Select the **Packages** tab to see packages added, removed, or changed in each image. Each entry in the table shows the differences between the versions and vulnerabilities in each image. Select the disclosure triangle next to a package to see more detail on the vulnerabilities changed.
- Select the **Vulnerabilities** tab to see changes to the vulnerabilities present in each image.
### Image details view
Selecting an image tag takes you to the image details view. This view contains
two tabs that let you drill down into the details of the composition and
policy compliance for the image: **Policy status** and **Image layers**.
{{< tabs >}}
{{< tab name="Policy status" >}}
![Screenshot of the policy tab in the image details view](./images/dashboard-image-policies.webp?border=true)
The policy tab shows you the policy evaluation results for the image. Use the
**View details** and **View fixes** links to the right to view the full
evaluation results, and learn how to improve compliance score for non-compliant
images.
For more information about policy, see [Policy Evaluation](./policy/_index.md).
{{< /tab >}}
{{< tab name="Image layers" >}}
![Screenshot showing Docker Scout image layers](./images/dashboard-image-layers.webp?border=true)
The layer view shows a breakdown of the Docker Scout analysis, including
an overview of the digest Secure Hash Algorithms (SHA), version, the image hierarchy (base images), image
layers, packages, and vulnerabilities.
> **Note**
>
> You can find more details on the elements in the image layer view in [the image details view docs](./image-details-view.md).
{{< /tab >}}
{{< /tabs >}}
- **Policies**: shows the policy compliance for the organization, see [Policies](#policies)
- **Images**: lists all Docker Scout-enabled repositories in the organization, see [Images](#images)
- **Base images**: lists all base images used by repositories in an organization
- **Packages**: lists all packages across repositories in the organization
- **Vulnerabilities**: lists all CVEs in the organization's images, see [Vulnerabilities](#vulnerabilities)
- **Integrations**: create and manage third-party integrations, see [Integrations](#integrations)
- **Settings**: manage repository and billing settings, see [Settings](#settings)
## Policies
![A screenshot of the Docker Scout policies view](./images/dashboard-policies-view.webp?border=true)
The **Policies** view shows a breakdown of policy compliance for all of the
images in the selected organization and environment. You can use the **Image**
drop-down menu to view a policy breakdown for a specific environment.
For more information about policies, see [Policy Evaluation](./policy/_index.md).
## Base images
## Images
![A screenshot of the Docker Scout view showing base images used](./images/dashboard-base-images.webp?border=true)
The **Images** view shows all images in Scout-enabled repositories for the selected environment.
You can filter the list by selecting a different environment, or by repository name using the text filter.
The **Base images** view shows all base images used by repositories in an organization.
![Screenshot of the images view](./images/dashboard-images.webp)
Each entry in the list shows the following details:
For each repository, the list displays the following details:
- The base image name.
- The versions of the base image used by images in the organization.
- The number of images that use the base image. Selecting the link opens [the list of images that use the base image view](#images-using-base-image).
- The number of packages in the base image.
- The repository name (image reference without the tag or digest)
- The most recent tag of the image in the selected environment
- Operating systems and architectures for the most recent tag
- Vulnerabilities status for the most recent tag
- Policy status for the most recent tag
### Images using base image
Selecting a repository link takes you to a list of all images in that repository that have been analyzed.
From here you can view the full analysis results for a specific image,
and compare tags to view the differences in packages and vulnerabilities
The **Images** tab shows all images in an organization that use a specific base image.
Selecting an image link takes you to a details view for the selected tag or digest.
This view contains two tabs that detail the composition and policy compliance for the image:
Each entry in the list shows the following details:
- **Policy status** shows the policy evaluation results for the selected image.
Here you also have links for details about the policy violations.
- The repository name. Selecting the link opens [the list of tags for the repository](#repository-tag-list).
- The most recent tag of the image and its vulnerabilities. Selecting the link for the tag opens [the Image layer detail view](#image-details-view) for the repository.
- The operating system and architecture of the image.
- The base image tag used by the repository. Selecting the link opens [the image layer detail view](#image-details-view) for that version.
- The current base image digest for the repository.
- The date of the last push for the repository.
For more information about policy, see [Policy Evaluation](./policy/_index.md).
## Packages
The **Packages** view shows all packages across repositories in an organization.
Each entry in the list shows the following details:
- The package name.
- The package type.
- The versions of the package used by images in the organization.
- The number of images that use the package.
- **Image layers** shows a breakdown of the image analysis results.
You can get a complete view of the vulnerabilities your image contains
and understand how they got in.
## Vulnerabilities
The **Vulnerabilities** view shows a list of all vulnerabilities from images in
the organization. You can sort and filter the list by severity and search for
Common Vulnerabilities and Exposures (CVE) ID using the search box.
The **Vulnerabilities** view shows a list of all vulnerabilities for images in the organization.
This list includes details about CVE such as the severity and Common Vulnerability Scoring System (CVSS) score,
as well as whether there's a fix version available.
The CVSS score displayed here is the highest score out of all available [sources](./advisory-db-sources.md).
Each entry in the list shows the following details:
Selecting the links on this page opens the vulnerability details page,
This page is a publicly visible page, and shows detailed information about a CVE.
You can share the link to a particular CVE description with other people
even if they're not a member of your Docker organization or signed in to Docker Scout.
- Severity of the vulnerability.
If you are signed in, the **My images** tab on this page lists all of your images
affected by the CVE.
> **Note**
>
> Docker Scout bases the calculation behind this severity level on a variety
> of sources.
- The severity of the vulnerability.
- The vulnerability CVE ID. Selecting the link for the CVE ID opens [the vulnerability details page](#vulnerability-details-page).
- The package name and version affected by this CVE.
- The Common Vulnerability Scoring System (CVSS) score for the vulnerability. Docker Scout shows the highest CVSS score from multiple sources.
- The number of images in the organization that use the package affected by this CVE. Selecting this link opens the [vulnerability details page](#vulnerability-details-page).
- If Docker Scout knows of a fix for the vulnerability, and if so, the package version of the fix.
### Vulnerability details page
The vulnerability details page shows detailed information about a particular
CVE. This page is a publicly open page. You can share the link to a particular
CVE description with other people even if they're not a member of your Docker
organization.
The page shows the following information:
- The CVE ID and severity.
- A description of the vulnerability.
- The number of packages affected by the vulnerability.
- The vulnerability publish date.
Following this information is a list of all repositories affected by the
vulnerability, searchable by image name. Each entry in the list shows the
following details:
- The repository name. Selecting the link for the repository name opens [the repository tag list view](#repository-tag-list).
- The current tag version of the image. Selecting the link for the tag name opens [the repository tag list layer view](#image-details-view).
- The date the image was last pushed.
- The registry where the image is stored.
- The affected package name and version in the image.
## Settings
The settings menu under the drop-down in the website header contains link to go
to the [Integrations](#integrations) page and [Repository
settings](#repository-settings).
### Integrations
## Integrations
The **Integrations** page lets you create and manage your Docker Scout
integrations, such as environment integrations and registry integrations. For
more information on how to get started with integrations, see [Integrating
Docker Scout with other systems](./integrations/_index.md).
more information on how to get started with integrations, see
[Integrating Docker Scout with other systems](./integrations/_index.md).
### Repository settings
## Settings
The **Repository settings** is where you enable and disable Docker Scout for
repositories in your organization.
The settings menu in the Docker Scout Dashboard contains:
To enable repositories, select the checkboxes for the repositories on which you
want to enable Docker Scout analysis and select **Enable image analysis**.
- **Billing** for managing your Docker Scout subscription and payments
- **Repository settings** for enabling and disabling repositories
When you enable image analysis for a repository, Docker Scout analyzes new tags
automatically when you push to that repository.
Disable Docker Scout analysis on selected repositories by selecting **Disable
image analysis**.
When you enable Docker Scout for a repository,
Docker Scout analyzes new tags automatically when you push to that repository.
To enable repositories in Amazon ECR, Azure ACR, or other third-party registries,
you first need to integrate them.
See [Container registry integrations](./integrations/_index.md#container-registries)

Binary file not shown.

Before

Width:  |  Height:  |  Size: 123 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 104 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 65 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 716 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 71 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 82 KiB

After

Width:  |  Height:  |  Size: 105 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 53 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 35 KiB