Skip to content

Commit ccc4db3

Browse files
authored
Merge pull request #20792 from dvdksn/scout-org-policy-scores
scout: scores now based on org policy config
2 parents 3cc95a2 + bd0a846 commit ccc4db3

File tree

2 files changed

+43
-13
lines changed

2 files changed

+43
-13
lines changed

content/manuals/scout/policy/scores.md

Lines changed: 30 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -51,18 +51,32 @@ along with each policy that contributed to the score.
5151

5252
## Scoring system
5353

54-
Health scores are determined by evaluating images against a set of Docker Scout
54+
Health scores are determined by evaluating images against Docker Scout
5555
[policies](./_index.md). These policies align with best practices for
5656
the software supply chain and are recommended by Docker as foundational
57-
standards for images.
57+
standards for images. Some examples of these policies include:
58+
59+
- **Supply chain attestations**: Images should have supply chain attestations.
60+
- **No outdated base images**: Images should not use outdated base images.
61+
- **No AGPL v3 licenses**: Images should not contain AGPL v3-licensed packages.
62+
63+
If your image repositories are already enrolled with Docker Scout, the health
64+
score is calculated automatically based on the policies that are enabled for
65+
your organization. This also includes any custom policies that you have
66+
configured.
67+
68+
If you're not using Docker Scout, the health scores show the compliance of your
69+
images with the default, [out-of-the-box policies](/manuals/scout/policy/_index.md#out-of-the-box-policies).
70+
You can enable Docker Scout for your organization to get a more relevant health
71+
score based on your specific policies.
72+
73+
### Scoring process
5874

5975
Each policy is assigned a points value. If the image is compliant with a
6076
policy, it is awarded the points value for that policy. The health score of an
6177
image is calculated based on the percentage of points achieved relative to the
6278
total possible points.
6379

64-
### Scoring process
65-
6680
1. Policy compliance is evaluated for the image.
6781
2. Points are awarded based on adherence to these policies.
6882
3. The points achieved percentage is calculated:
@@ -102,15 +116,18 @@ If you see an `N/A` score, consider the following:
102116

103117
The policies that influence the score, and their respective weights, are as follows:
104118

105-
| Policy | Points |
106-
| ---------------------------------------------------------------------------------------------------------- | ------ |
107-
| [No fixable critical or high vulnerabilities](/scout/policy#no-fixable-critical-or-high-vulnerabilities) | 20 |
108-
| [No high-profile vulnerabilities](/scout/policy#no-high-profile-vulnerabilities) | 20 |
109-
| [Supply chain attestations](/scout/policy#supply-chain-attestations) | 15 |
110-
| [No unapproved base images](/scout/policy/#no-unapproved-base-images) | 15 |
111-
| [No outdated base images](/scout/policy#no-outdated-base-images) | 10 |
112-
| [Default non-root user](/scout/policy#default-non-root-user) | 5 |
113-
| [No AGPL v3 licenses](/manuals/scout/policy/_index.md#no-agpl-v3-licenses) | 5 |
119+
| Policy | Points |
120+
| -------------------------------------------------------------------------------------------------------------------------- | ------ |
121+
| [No fixable critical or high vulnerabilities](/manuals/scout/policy/_index.md#no-fixable-critical-or-high-vulnerabilities) | 20 |
122+
| [No high-profile vulnerabilities](/manuals/scout/policy/_index.md#no-high-profile-vulnerabilities) | 20 |
123+
| [Supply chain attestations](/manuals/scout/policy/_index.md#supply-chain-attestations) | 15 |
124+
| [No unapproved base images](/manuals/scout/policy/_index.md#no-unapproved-base-images) | 15 |
125+
| [No outdated base images](/manuals/scout/policy/_index.md#no-outdated-base-images) | 10 |
126+
| [SonarQube quality gates passed](/manuals/scout/policy/_index.md#sonarqube-quality-gates-passed) \* | 10 |
127+
| [Default non-root user](/manuals/scout/policy/_index.md#default-non-root-user) | 5 |
128+
| [No AGPL v3 licenses](/manuals/scout/policy/_index.md#no-agpl-v3-licenses) | 5 |
129+
130+
\* _This policy is not enabled by default and must be configured by the user._
114131

115132
### Evaluation
116133

content/manuals/scout/release-notes/platform.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,19 @@ for what's coming next.
2020

2121
New features and enhancements released in the third quarter of 2024.
2222

23+
### 2024-09-05
24+
25+
This release changes how [health scores](/manuals/scout/policy/scores.md) are
26+
calculated in Docker Scout. The health score calculation now considers optional
27+
and custom policies that you have configured for your organization.
28+
29+
This means that if you have enabled, disabled, or customized any of the default
30+
policies, Docker Scout will now take those policies into account when
31+
calculating the health score for your organization's images.
32+
33+
If you haven't yet enabled Docker Scout for your organization, the health score
34+
calculation will be based on the out-of-the-box policies.
35+
2336
### 2024-08-13
2437

2538
This release changes the out-of-the-box policies to align with the policy

0 commit comments

Comments
 (0)