Skip to content

Commit 36aa64d

Browse files
venalenjoaofnfernandes
authored andcommitted
Added screens and minor re-wording for scanning
1 parent 3bf3ad3 commit 36aa64d

7 files changed

+29
-8
lines changed
Loading
Loading
Loading
Loading
Loading
Loading

datacenter/dtr/2.2/guides/user/manage-images/scan-images-for-vulnerabilities.md

+29-8
Original file line numberDiff line numberDiff line change
@@ -13,27 +13,36 @@ Scanning. The results of these scans are reported for each image tag.
1313
Docker Security Scanning is available as an add-on to Docker Trusted Registry,
1414
and an administrator configures it for your DTR instance. If you do not see
1515
security scan results available on your repositories, your organization may not
16-
have purchased the Security Scanning feature or it may be disabled.
16+
have purchased the Security Scanning feature or it may be disabled. See [Set up
17+
Security Scanning in DTR](../../admin/configure/set-up-vulnerability-scans.md) for more details.
1718

1819
> **Tip**: Only users with write access to a repository can manually start a
1920
scan. Users with read-only access can view the scan results, but cannot start
2021
a new scan.
2122

2223
## The Docker Security Scan process
2324

24-
Scans run either on demand when a user clicks the **Start Scan** links or
25-
**Scan** button, or automatically on any `docker push` to the repository.
25+
Scans run either on demand when a user clicks the **Start a Scan** links or
26+
**Scan** button (see [Manual scanning](#manual-scanning) below), or automatically
27+
on any `docker push` to the repository.
2628

2729
First the scanner performs a binary scan on each layer of the image, identifies
28-
the software components in each layer, and indexes the SHA of each component. A
29-
binary scan evaluates the components on a bit-by-bit level, so vulnerable
30-
components are discovered no matter what they're named or statically-linked.
30+
the software components in each layer, and indexes the SHA of each component in a
31+
bill-of-materials. A binary scan evaluates the components on a bit-by-bit level,
32+
so vulnerable components are discovered even if they are statically-linked or
33+
under a different name.
34+
35+
[//]: # (Placeholder for DSS workflow. @sarahpark is working on the diagram.)
3136

3237
The scan then compares the SHA of each component against the US National
33-
Vulnerability Database that is installed on your DTR instance. when
38+
Vulnerability Database that is installed on your DTR instance. When
3439
this database is updated, DTR reviews the indexed components for newly
3540
discovered vulnerabilities.
3641

42+
If you have subscribed to a webhook (see [Manage webhooks](../create-and-manage-webhooks.md))
43+
for scan completed/scan failed, then you will received the results of the scan
44+
as a json to the specified endpoint.
45+
3746
Most scans complete within an hour, however larger repositories may take longer
3847
to scan depending on your system resources.
3948

@@ -58,8 +67,15 @@ To start a security scan:
5867
2. Click the **Images** tab.
5968
3. Locate the image tag that you want to scan.
6069
4. In the **Vulnerabilities** column, click **Start a scan**.
70+
![](../../images/scanning-images-1.png){: .with-border}
71+
72+
You can also start a scan from the image details screen:
6173

62-
DTR begins the scanning process. You may need to refresh the page to see the
74+
1. Click **View Details** on the desired image tag.
75+
2. Click **Scan** on the right-hand side, above the layers table.
76+
![](../../images/scanning-images-2.png){: .with-border}
77+
78+
DTR begins the scanning process. You will need to refresh the page to see the
6379
results once the scan is complete.
6480

6581
## Change the scanning mode
@@ -77,6 +93,7 @@ To change the repository scanning mode:
7793
1. Navigate to the repository, and click the **Settings** tab.
7894
2. Scroll down to the **Image scanning** section.
7995
3. Select the desired scanning mode.
96+
![](../../images/security-scanning-setup-5.png){: .with-border}
8097

8198
## View security scan results
8299

@@ -85,6 +102,7 @@ Once DTR has run a security scan for an image, you can view the results.
85102
The **Images** tab for each repository includes a summary of the most recent
86103
scan results for each image.
87104

105+
![](../../images/scanning-images-4.png){: .with-border}
88106
- A green shield icon with a check mark indicates that the scan did not find
89107
any vulnerabilities.
90108
- A red or orange shield icon indicates that vulnerabilities were found, and
@@ -113,6 +131,8 @@ by the Dockerfile.
113131
> **Tip**: The layers view can be long, so be sure
114132
to scroll down if you don't immediately see the reported vulnerabilities.
115133

134+
![](../../images/scanning-images-5.png){: .with-border}
135+
116136
- The **Components** view lists the individual component libraries indexed by
117137
the scanning system, in order of severity and number of vulnerabilities found,
118138
most vulnerable first.
@@ -123,6 +143,7 @@ most vulnerable first.
123143
the scan report provides details on each one. The component details also
124144
include the license type used by the component, and the filepath to the
125145
component in the image.
146+
![](../../images/scanning-images-6.png){: .with-border}
126147

127148
### What do I do next?
128149

0 commit comments

Comments
 (0)