diff --git a/_data/toc.yaml b/_data/toc.yaml index 05fd707e2f..e7980b8e7d 100644 --- a/_data/toc.yaml +++ b/_data/toc.yaml @@ -1885,6 +1885,8 @@ manuals: title: Image details view - path: /scout/advanced-image-analysis/ title: Advanced image analysis + - path: /scout/web-app/ + title: Web App - path: /scout/artifactory/ title: Artifactory integration - path: /scout/advisory-db-sources/ diff --git a/scout/images/webapp-hierachy.png b/scout/images/webapp-hierachy.png new file mode 100644 index 0000000000..50d28a99b0 Binary files /dev/null and b/scout/images/webapp-hierachy.png differ diff --git a/scout/images/webapp-images.png b/scout/images/webapp-images.png new file mode 100644 index 0000000000..2c838d0b32 Binary files /dev/null and b/scout/images/webapp-images.png differ diff --git a/scout/images/webapp-overview.png b/scout/images/webapp-overview.png new file mode 100644 index 0000000000..9fe863b17d Binary files /dev/null and b/scout/images/webapp-overview.png differ diff --git a/scout/images/webapp-pandd.png b/scout/images/webapp-pandd.png new file mode 100644 index 0000000000..f69d70504b Binary files /dev/null and b/scout/images/webapp-pandd.png differ diff --git a/scout/images/webapp-suggested-fix.png b/scout/images/webapp-suggested-fix.png new file mode 100644 index 0000000000..5e1ed0df35 Binary files /dev/null and b/scout/images/webapp-suggested-fix.png differ diff --git a/scout/images/webapp-vulns.png b/scout/images/webapp-vulns.png new file mode 100644 index 0000000000..35dd26d68f Binary files /dev/null and b/scout/images/webapp-vulns.png differ diff --git a/scout/web-app.md b/scout/web-app.md new file mode 100644 index 0000000000..ddeb2b09e6 --- /dev/null +++ b/scout/web-app.md @@ -0,0 +1,100 @@ +--- +description: The Docker Scout Web App helps review and share the analysis of images. +keywords: scanning, analysis, vulnerabilities, Hub, supply chain, security, report, reports, web app +title: Web App +redirect_from: + - /scout/reports/ +--- + +{% include scout-early-access.md %} + +The Docker Scout Web App helps you share the analysis of images in an organization with your team. Developers can now see an overview of their security status across all their images from both Docker Hub and Artifactory, and get remediation advice at their fingertips. It helps team members in roles such as security, compliance, and operations to know what vulnerabilities and issues they need to focus on. + +## Overview + +![A screenshot of the Docker Scout vulnerabilities overview](./images/webapp-overview.png) + +The **Overview** tab shows the total number of vulnerabilities across all your Scout-enabled repositories, over time. This calculation takes the most recent image in each repository to avoid including old irrelevant images. + +## Images + +![A screenshot of the Docker Scout images list for an organization](./images/webapp-images.png) + +The **Images** tab 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. Clicking the link for the repository opens the list of tags for the repository. +- The most recent version of the image and the vulnerabilities for that version. Clicking the link for the base image opens [the image layer view](#image-layer-view). +- The operating system and architecture of the image. +- The base image and version used by the repository and the vulnerabilities for that version. Clicking the link for the base image opens [the image layer view](#image-layer-view). +- The recommended fixes, which can include options such as changing tags or rebuilding an image. +- The predicted improvement to the vulnerabilities if you apply the recommended fixes. +- An action button to show implementable recommended fixes. + + ![Screenshot of recommended fixes for an image](./images/webapp-suggested-fix.png) + +### Repository tag list + +The repository tag list shows all tags for a repository. You can search for specific tag versions using the search box. + +Each entry in the list shows the following details: + +- The tag version. Clicking the link for version opens [the image layer view](#image-layer-view). +- 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. + +### Image layer view + +The image 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. + +![Screenshot showing Docker Scout image hierarchy](./images/webapp-hierachy.png) + +> **Note** +> +> You can find more details on the elements in the image layer view in [the image details view docs](./image-details-view.md). + +Click the **View recommended fixes** button to see instructions to apply the recommended fixes for the image. + +![Screenshot of recommended fixes for an image](./images/webapp-suggested-fix.png) + +## Packages and dependencies + +![A screenshot of the Docker Scout packages and dependencies list](./images/webapp-pandd.png) + +The **Packages and dependencies** tab shows all packages and base images part of your images in an organization. You can sort the list by package name. + +Each entry in the list shows the following details: + +- The package name. +- The package type. +- The license(s) used by the package. +- The versions of the package used by images in the organization. +- The package type. +- The number of images that use the package. + +## Vulnerabilities + +![Screenshot showing Docker Scout Vulnerabilities list](./images/webapp-vulns.png) + +The **Vulnerabilities** tab shows a list of all vulnerabilities from images in the organization. You can sort the list by severity and search for Common Vulnerabilities and Exposures (CVE) ID using the search box. + +Each entry in the list shows the following details: + +- Severity of the vulnerability. + + > **Note** + > + > Docker Scout bases the calculation behind this severity level on a variety + > of sources. + +- The vulnerability CVE ID. +- 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. +- If Docker Scout knows of a fix for the vulnerability, and if so, the package version of the fix.