From 2c6eb3ac3e3107abc94c7e1a235b2844225d5ae9 Mon Sep 17 00:00:00 2001 From: Chris Chinchilla Date: Wed, 28 Jun 2023 17:40:00 +0200 Subject: [PATCH] Improve Scout entry points and update overview page Signed-off-by: Chris Chinchilla Reorg Signed-off-by: Chris Chinchilla Add mentions of images from Docker Hub Signed-off-by: Chris Chinchilla Fix links Signed-off-by: Chris Chinchilla --- _data/toc.yaml | 4 ++-- desktop/use-desktop/images.md | 2 +- docker-hub/dsos-program.md | 14 +++++------- docker-hub/dvp-program.md | 9 +++----- scout/dashboard.md | 3 ++- scout/index.md | 42 ++++++++++++++++++++++------------- 6 files changed, 39 insertions(+), 35 deletions(-) diff --git a/_data/toc.yaml b/_data/toc.yaml index f88f272e08..6fd964f097 100644 --- a/_data/toc.yaml +++ b/_data/toc.yaml @@ -1936,12 +1936,12 @@ manuals: title: Advanced image analysis - path: /scout/dashboard/ title: Dashboard + - path: /scout/ci/ + title: Continuous integration - path: /scout/artifactory/ title: Artifactory integration - path: /scout/advisory-db-sources/ title: Advisory Database - - path: /scout/ci/ - title: Continuous integration - sectiontitle: Docker Admin (Early Access) section: diff --git a/desktop/use-desktop/images.md b/desktop/use-desktop/images.md index 5ea04be90d..e1f1472bc6 100644 --- a/desktop/use-desktop/images.md +++ b/desktop/use-desktop/images.md @@ -52,7 +52,7 @@ To inspect an image, select the image row. Inspecting an image displays detailed - Vulnerabilities found - Packages inside the image -The image view is powered by [Docker Scout](../../scout/index.md). +[Docker Scout](../../scout/index.md) powers this vulnerability information. For more information about this view, see [Image details view](../../scout/image-details-view.md) ## Pull the latest image from Docker Hub diff --git a/docker-hub/dsos-program.md b/docker-hub/dsos-program.md index 51daf2f017..cfaa5f2df4 100644 --- a/docker-hub/dsos-program.md +++ b/docker-hub/dsos-program.md @@ -66,8 +66,7 @@ Docker verifies that developers can trust images with this badge on Docker Hub a ### Insights and analytics -The [insights and analytics](/docker-hub/publish/insights-analytics){: -target="blank" rel="noopener" class=""} service provides usage metrics for how +The [insights and analytics](/docker-hub/publish/insights-analytics) service provides usage metrics for how the community uses Docker images, granting insight into user behavior. The usage metrics show the number of image pulls by tag or by digest, and breakdowns by @@ -80,15 +79,13 @@ either a summary or raw format. ### Vulnerability analysis -[Docker Scout](/scout/){: -target="blank" rel="noopener" class=""} provides automatic vulnerability analysis +[Docker Scout](/scout/) provides automatic vulnerability analysis for DVP images published to Docker Hub. Scanning images ensures that the published content is secure, and proves to developers that they can trust the image. Analysis is enabled on a per-repository -basis, refer to [vulnerability scanning](/docker-hub/vulnerability-scanning/){: -target="blank" rel="noopener" class=""} for more information about how to use +basis, refer to [vulnerability scanning](/docker-hub/vulnerability-scanning/) for more information about how to use it. > **Note** @@ -98,8 +95,7 @@ it. ### Who's eligible for the Docker-Sponsored Open Source program? -To qualify for the program, a publisher must share the project namespace in public repositories, meet [the Open Source Initiative definition](https://opensource.org/docs/osd), and be in active development with no pathway to commercialization. +To qualify for the program, a publisher must share the project namespace in public repositories, meet [the Open Source Initiative definition](https://opensource.org/docs/osd){:target="_blank" rel="noopener" class="_"}, and be in active development with no pathway to commercialization. Find out more by heading to the -[Docker-Sponsored Open Source Program](https://www.docker.com/community/open-source/application/#){:target="_blank" -rel="noopener" class="_"} application page. +[Docker-Sponsored Open Source Program](https://www.docker.com/community/open-source/application/){:target="_blank" rel="noopener" class="_"} application page. diff --git a/docker-hub/dvp-program.md b/docker-hub/dvp-program.md index ef2c1800c8..32fd272dab 100644 --- a/docker-hub/dvp-program.md +++ b/docker-hub/dvp-program.md @@ -85,8 +85,7 @@ to identify projects that Docker has verified as high quality publishers and wit ### Insights and analytics -The [insights and analytics](/docker-hub/publish/insights-analytics){: -target="blank" rel="noopener" class=""} service provides usage metrics for how +The [insights and analytics](/docker-hub/publish/insights-analytics) service provides usage metrics for how the community uses Docker images, granting insight into user behavior. The usage metrics show the number of image pulls by tag or by digest, and breakdowns by @@ -99,15 +98,13 @@ either a summary or raw format. ### Vulnerability analysis -[Docker Scout](/scout/){: -target="blank" rel="noopener" class=""} provides automatic vulnerability analysis +[Docker Scout](/scout/) provides automatic vulnerability analysis for DVP images published to Docker Hub. Scanning images ensures that the published content is secure, and proves to developers that they can trust the image. Analysis is enabled on a per-repository -basis, refer to [vulnerability scanning](/docker-hub/vulnerability-scanning/){: -target="blank" rel="noopener" class=""} for more information about how to use +basis, refer to [vulnerability scanning](/docker-hub/vulnerability-scanning/) for more information about how to use it. ### Who's eligible to become a verified publisher? diff --git a/scout/dashboard.md b/scout/dashboard.md index 010fe3194e..becd5c1fd8 100644 --- a/scout/dashboard.md +++ b/scout/dashboard.md @@ -19,7 +19,8 @@ The **Overview** tab shows the total number of vulnerabilities across all your D ## Repository settings -Enable Docker Scout analysis on repositories in the current organization by selecting the settings icon next to your user profile picture and then the **Repository settings** menu item. +Enable Docker Scout analysis on repositories from Docker Hub in the current organization +by selecting the settings icon next to your user profile picture and then the **Repository settings** menu item. Select the checkboxes for the repositories on which you want to enable Docker Scout analysis and select **Enable image analysis**. diff --git a/scout/index.md b/scout/index.md index 2f78908b97..31f64b2e89 100644 --- a/scout/index.md +++ b/scout/index.md @@ -25,25 +25,38 @@ packages and layers called a [Software bill of materials (SBOM)](https://ntia.go It then correlates this inventory with a continuously updated vulnerability database to identify vulnerabilities in your images. -You can use Docker Scout in Docker Desktop, Docker Hub, the Docker CLI, and in -the Docker Scout Dashboard. If you host your images in JFrog Artifactory, you -can also use Docker Scout to analyze your images there. +You can use Docker Scout in [Docker Desktop](#docker-desktop), [Docker Hub](#docker-hub), [continuous integration](./ci.md), the [Docker CLI](#docker-scout-cli), +and in +the [Docker Scout Dashboard](./dashboard.md). If you host your images in JFrog Artifactory, you +can also [use Docker Scout to analyze your images](./artifactory.md) there. + +{% include scout-plans.md %} + +## Quickstart _The following video shows an end-to-end workflow of using Docker Scout to remediate a reported vulnerability_.
+> **Quickstart with Docker Scout** +> +> For a self-guided quickstart that shows you how to use Docker Scout to identify and remediate vulnerabilities in your images, read the [quickstart](./quickstart.md). +{: .tip } -{% include scout-plans.md %} +## Enabling Docker Scout -## Docker Desktop +_The following video shows how to enable Docker Scout on your repositories_. + +
+ +### Docker Desktop Docker Scout analyzes all images stored locally in Docker Desktop, providing you with up-to-date vulnerability information as you build your images. For more information, read the [Advanced image analysis guide](./advanced-image-analysis.md). -## Docker Hub +### Docker Hub If you enable [Advanced image analysis](./advanced-image-analysis.md) for a repository in Docker Hub, Docker Scout analyzes your images every time you push @@ -52,11 +65,11 @@ that repository. The analysis updates continuously, meaning that the vulnerability report for an image is always up to date as Docker Scout becomes aware of new CVEs. No need to -re-scan an image. +re-analyze an image. For more information, read the [Advanced image analysis guide](./advanced-image-analysis.md). -## Docker Scout CLI plugin {#docker-scout-cli} +### Docker Scout CLI plugin {#docker-scout-cli} The `docker scout` CLI plugin provides a terminal interface for using Docker Scout with local and remote images. @@ -67,7 +80,7 @@ using a structured format, such as Static Analysis Results Interchange Format (SARIF). For more information about how to use the `docker scout` CLI, see the -[reference documentation](../engine/reference/commandline/scout_cves.md). +[reference documentation](../engine/reference/commandline/scout.md). The plugin is available in Docker Desktop starting with version 4.17 and available as a standalone binary. @@ -91,20 +104,17 @@ the [plugin's repository](https://github.com/docker/scout-cli). The plugin is also available as [a container image](https://hub.docker.com/r/docker/scout-cli) and as [a GitHub action](https://github.com/docker/scout-action). -## Docker Scout Dashboard +### Docker Scout Dashboard The [Docker Scout Dashboard](https://scout.docker.com){: target="\_blank" rel="noopener" } helps you share the analysis and security status of images in -an organization with your team. You can also [use the dashboard to enable analysis of multiple repositories at once](./dashboard.md#repository-settings). +an organization with your team. You can also use the dashboard settings to enable +Docker Scout on multiple images from Docker Hub at once. For more information, read the [Docker Scout Dashboard guide](./dashboard.md). -## JFrog Artifactory integration +### JFrog Artifactory integration Users of JFrog Artifactory, or JFrog Container Registry, can integrate Docker Scout to enable automatic analysis of images locally and remotely. For more information, see [Artifactory integration](./artifactory.md). - -_The following video shows how to enable Docker Scout on your repositories_. - -
\ No newline at end of file