Skip to content

Add: Add quickstart.md improvements #22272

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Apr 23, 2025
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added content/manuals/scout/images/image-details.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added content/manuals/scout/images/policy-inspect.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
26 changes: 21 additions & 5 deletions content/manuals/scout/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -95,6 +95,10 @@
+ "express": "4.17.3"
}
```
> [!TIP]
>
> The express package is constantly being updated and depending on when you are running this tutorial, other vulnerabilities with different levels of criticality may be listed. In order to follow this tutorial properly, it is suggested that all vulnerabilities are fixed.
> In general, it will only be necessary to modify the version of the `express` package to the most current version.

2. Rebuild the image with a new tag and push it to your Docker Hub repository:

Expand Down Expand Up @@ -172,6 +176,10 @@
? │ Supply chain attestations │ No data
```

> [!NOTE]
>
> The report shown by the `docker scout quickview` command, run on your local machine, may be different from the one shown in the example above.

Check warning on line 181 in content/manuals/scout/quickstart.md

View workflow job for this annotation

GitHub Actions / vale

[vale] reported by reviewdog 🐶 [Docker.RecommendedWords] Consider using 'previous' instead of 'above' Raw Output: {"message": "[Docker.RecommendedWords] Consider using 'previous' instead of 'above'", "location": {"path": "content/manuals/scout/quickstart.md", "range": {"start": {"line": 181, "column": 139}}}, "severity": "INFO"}

Exclamation marks in the status column indicate a violated policy.
Question marks indicate that there isn't enough metadata to complete the evaluation.
A check mark indicates compliance.
Expand Down Expand Up @@ -209,7 +217,7 @@
which is how the provenance attestations are attached to an image.

Open **Settings** in Docker Desktop. Under the **General** section, make sure
that the **Use containerd for pulling and storing images** option is checked.
that the **Use containerd for pulling and storing images** option is checked, then click the `Apply & Restart` button to apply the changes.

Check warning on line 220 in content/manuals/scout/quickstart.md

View workflow job for this annotation

GitHub Actions / vale

[vale] reported by reviewdog 🐶 [Docker.RecommendedWords] Consider using 'select' instead of 'click' Raw Output: {"message": "[Docker.RecommendedWords] Consider using 'select' instead of 'click'", "location": {"path": "content/manuals/scout/quickstart.md", "range": {"start": {"line": 220, "column": 84}}}, "severity": "INFO"}
Note that changing image stores temporarily hides images and containers of the
inactive image store until you switch back.

Expand All @@ -230,7 +238,11 @@
3. Select **Images** in the left-hand navigation.

The images page lists your Scout-enabled repositories.
Select the image in the list to open the **Image details** sidebar.

Select the docker image you want to analyze and click the button shown in the image below to display the **Image details** sidebar.

Check failure on line 242 in content/manuals/scout/quickstart.md

View workflow job for this annotation

GitHub Actions / vale

[vale] reported by reviewdog 🐶 [Docker.Capitalization] Please capitalize Docker. Raw Output: {"message": "[Docker.Capitalization] Please capitalize Docker.", "location": {"path": "content/manuals/scout/quickstart.md", "range": {"start": {"line": 242, "column": 11}}}, "severity": "ERROR"}

Check warning on line 242 in content/manuals/scout/quickstart.md

View workflow job for this annotation

GitHub Actions / vale

[vale] reported by reviewdog 🐶 [Docker.RecommendedWords] Consider using 'select' instead of 'click' Raw Output: {"message": "[Docker.RecommendedWords] Consider using 'select' instead of 'click'", "location": {"path": "content/manuals/scout/quickstart.md", "range": {"start": {"line": 242, "column": 49}}}, "severity": "INFO"}

Check warning on line 242 in content/manuals/scout/quickstart.md

View workflow job for this annotation

GitHub Actions / vale

[vale] reported by reviewdog 🐶 [Docker.RecommendedWords] Consider using 'following' instead of 'below' Raw Output: {"message": "[Docker.RecommendedWords] Consider using 'following' instead of 'below'", "location": {"path": "content/manuals/scout/quickstart.md", "range": {"start": {"line": 242, "column": 85}}}, "severity": "INFO"}

![View Image Details](./images/image-details.png)

The sidebar shows a compliance overview for the last pushed tag of a repository.

> [!NOTE]
Expand All @@ -239,13 +251,17 @@
> It might take a few minutes before the results appear if this is your
> first time using the Docker Scout Dashboard.

Inspect the **Up-to-Date Base Images** policy.
Go back to the image list and click on the image version, available in the **Most recent image** column.

Check warning on line 254 in content/manuals/scout/quickstart.md

View workflow job for this annotation

GitHub Actions / vale

[vale] reported by reviewdog 🐶 [Docker.RecommendedWords] Consider using 'select' instead of 'click' Raw Output: {"message": "[Docker.RecommendedWords] Consider using 'select' instead of 'click'", "location": {"path": "content/manuals/scout/quickstart.md", "range": {"start": {"line": 254, "column": 31}}}, "severity": "INFO"}
Then, at the top right of the page, click on the **Update base image** button to inspect the policy.

Check warning on line 255 in content/manuals/scout/quickstart.md

View workflow job for this annotation

GitHub Actions / vale

[vale] reported by reviewdog 🐶 [Docker.RecommendedWords] Consider using 'select' instead of 'click' Raw Output: {"message": "[Docker.RecommendedWords] Consider using 'select' instead of 'click'", "location": {"path": "content/manuals/scout/quickstart.md", "range": {"start": {"line": 255, "column": 37}}}, "severity": "INFO"}

![Policy Inspect](./images/policy-inspect.png)

This policy checks whether base images you use are up-to-date.
It currently has a non-compliant status,
because the example image uses an old version `alpine` as a base image.

Select the **View fix** button next to the policy name for details about the violation,
and recommendations on how to address it.
Close the **Recommended fixes for base image** popup. In the policy listing, click the **View fixes** button, next to the policy name for details about the violation, and recommendations on how to address it.

Check warning on line 263 in content/manuals/scout/quickstart.md

View workflow job for this annotation

GitHub Actions / vale

[vale] reported by reviewdog 🐶 [Docker.RecommendedWords] Consider using 'select' instead of 'click' Raw Output: {"message": "[Docker.RecommendedWords] Consider using 'select' instead of 'click'", "location": {"path": "content/manuals/scout/quickstart.md", "range": {"start": {"line": 263, "column": 78}}}, "severity": "INFO"}

In this case, the recommended action is to enable
[Docker Scout's GitHub integration](./integrations/source-code-management/github.md),
which helps keep your base images up-to-date automatically.
Expand Down