mirror of https://github.com/docker/docs.git
scout: configurable policies m1
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
This commit is contained in:
parent
431dfa78ca
commit
ede7b23eee
|
@ -11,7 +11,7 @@ description: |
|
||||||
>
|
>
|
||||||
> Policy Evaluation is an [Early Access](/release-lifecycle/#early-access-ea)
|
> Policy Evaluation is an [Early Access](/release-lifecycle/#early-access-ea)
|
||||||
> feature of Docker Scout.
|
> feature of Docker Scout.
|
||||||
> { .restricted }
|
{ .restricted }
|
||||||
|
|
||||||
In software supply chain management, maintaining the security and reliability
|
In software supply chain management, maintaining the security and reliability
|
||||||
of artifacts is a top priority. Policy Evaluation in Docker Scout introduces a
|
of artifacts is a top priority. Policy Evaluation in Docker Scout introduces a
|
||||||
|
@ -61,26 +61,32 @@ Docker Scout ships the following out-of-the-box policies:
|
||||||
- [High-profile vulnerabilities](#high-profile-vulnerabilities)
|
- [High-profile vulnerabilities](#high-profile-vulnerabilities)
|
||||||
- [Supply chain attestations](#supply-chain-attestations)
|
- [Supply chain attestations](#supply-chain-attestations)
|
||||||
|
|
||||||
These policies are enabled by default for Scout-enabled repositories. There's
|
Policies are enabled by default for Scout-enabled repositories. If you want to
|
||||||
currently no way to turn off or configure these policies.
|
customize the criteria of a policy, you can create custom policies based on the
|
||||||
|
default, out-of-the-box policies. You can also disable a policy altogether if
|
||||||
|
it isn't relevant to you. For more information, see [Configure
|
||||||
|
policies](./configure.md).
|
||||||
|
|
||||||
### Fixable critical and high vulnerabilities
|
### Fixable critical and high vulnerabilities
|
||||||
|
|
||||||
The **Fixable critical and high vulnerabilities** policy requires that your
|
The **Fixable critical and high vulnerabilities** policy requires that your
|
||||||
artifacts aren't exposed to known vulnerabilities with a critical or high
|
artifacts aren't exposed to known vulnerabilities where there's a fix version
|
||||||
severity, and where there's a fix version available. Essentially, this means
|
available. Essentially, this means that there's an easy fix that you can deploy
|
||||||
that there's an easy fix that you can deploy for images that fail this policy:
|
for images that fail this policy: upgrade the vulnerable package to a version
|
||||||
upgrade the vulnerable package to a version containing a fix for the
|
containing a fix for the vulnerability.
|
||||||
vulnerability.
|
|
||||||
|
|
||||||
This policy only flags vulnerabilities that were published more than 30
|
This policy only flags critical and high severity vulnerabilities that were
|
||||||
days ago, with the rationale that newly discovered vulnerabilities
|
published more than 30 days ago. The rationale for only flagging
|
||||||
shouldn't cause your evaluations to fail until you've had a chance to
|
vulnerabilities of a certain age is that newly discovered vulnerabilities
|
||||||
address them.
|
shouldn't cause your evaluations to fail until you've had a chance to address
|
||||||
|
them.
|
||||||
|
|
||||||
This policy is unfulfilled if an artifact is affected by one or more critical-
|
This policy is unfulfilled if an artifact is affected by one or more critical-
|
||||||
or high-severity vulnerability, where a fix version is available.
|
or high-severity vulnerability, where a fix version is available.
|
||||||
|
|
||||||
|
You can configure the severity level and age thresholds by creating a custom
|
||||||
|
policy. For more information, see [Configure policies](./configure.md).
|
||||||
|
|
||||||
### Critical vulnerabilities
|
### Critical vulnerabilities
|
||||||
|
|
||||||
The **Critical vulnerabilities** policy requires that your artifacts contain no
|
The **Critical vulnerabilities** policy requires that your artifacts contain no
|
||||||
|
@ -91,6 +97,9 @@ This policy flags all critical vulnerabilities, whether or not there's a fix
|
||||||
version available, and regardless of how long it's been since the vulnerability
|
version available, and regardless of how long it's been since the vulnerability
|
||||||
was first disclosed.
|
was first disclosed.
|
||||||
|
|
||||||
|
You can configure the severity level by creating a custom policy, see
|
||||||
|
[Configure policies](./configure.md).
|
||||||
|
|
||||||
### Copyleft licenses
|
### Copyleft licenses
|
||||||
|
|
||||||
The **Copyleft licenses** policy requires that your artifacts don't contain
|
The **Copyleft licenses** policy requires that your artifacts don't contain
|
||||||
|
@ -101,6 +110,9 @@ unsuitable for use in your software because of the restrictions they enforce.
|
||||||
This policy is unfulfilled if your artifacts contain one or more packages with
|
This policy is unfulfilled if your artifacts contain one or more packages with
|
||||||
a violating license.
|
a violating license.
|
||||||
|
|
||||||
|
You can configure the list of licenses by creating a custom policy, see
|
||||||
|
[Configure policies](./configure.md).
|
||||||
|
|
||||||
### Outdated base images
|
### Outdated base images
|
||||||
|
|
||||||
The **Outdated base images** policy requires that the base images you use are
|
The **Outdated base images** policy requires that the base images you use are
|
||||||
|
@ -141,6 +153,9 @@ The list includes the following vulnerabilities:
|
||||||
- [CVE-2023-38545 (cURL SOCKS5 heap buffer overflow)](https://scout.docker.com/v/CVE-2023-38545)
|
- [CVE-2023-38545 (cURL SOCKS5 heap buffer overflow)](https://scout.docker.com/v/CVE-2023-38545)
|
||||||
- [CVE-2023-44487 (HTTP/2 Rapid Reset)](https://scout.docker.com/v/CVE-2023-44487)
|
- [CVE-2023-44487 (HTTP/2 Rapid Reset)](https://scout.docker.com/v/CVE-2023-44487)
|
||||||
|
|
||||||
|
You can configure the CVEs included in this list by creating a custom policy.
|
||||||
|
For more information, see [Configure policies](./configure.md).
|
||||||
|
|
||||||
### Supply chain attestations
|
### Supply chain attestations
|
||||||
|
|
||||||
The **Supply chain attestations** policy requires that your artifacts have
|
The **Supply chain attestations** policy requires that your artifacts have
|
||||||
|
|
|
@ -0,0 +1,65 @@
|
||||||
|
---
|
||||||
|
title: Configure policies
|
||||||
|
description: Learn how to configure or disable the default policies in Docker Scout
|
||||||
|
keywords: scout, policy, configure, disable, enable, parametrize, thresholds
|
||||||
|
---
|
||||||
|
|
||||||
|
Some of the existing policies are configurable. This means that you can clone
|
||||||
|
an existing policy and create new, custom policies with your own configuration.
|
||||||
|
You can also disable a policy altogether, if a policy doesn't quite match your
|
||||||
|
needs.
|
||||||
|
|
||||||
|
## Configure a policy
|
||||||
|
|
||||||
|
To change the configuration of a policy, you must clone one of the existing
|
||||||
|
default policies, and then save your configuration as a new policy. You can
|
||||||
|
edit the display name and description of the new policy to help distinguish
|
||||||
|
it from the default policy it's based on.
|
||||||
|
|
||||||
|
The available configuration parameters for a policy depends on the default
|
||||||
|
policy you used as a base for your custom policy. The following table lists the
|
||||||
|
default policies that you can configure, and the available configuration
|
||||||
|
parameters that you can use to create a custom policy.
|
||||||
|
|
||||||
|
| Default policy | Configuration parameters |
|
||||||
|
| ----------------------------------------- | ------------------------ |
|
||||||
|
| All critical vulnerabilities | Severities |
|
||||||
|
| Copyleft licenses | License names |
|
||||||
|
| Fixable critical and high vulnerabilities | Severities, age |
|
||||||
|
| High-profile vulnerabilities | CVEs |
|
||||||
|
|
||||||
|
To configure a policy:
|
||||||
|
|
||||||
|
1. Go to the [Docker Scout Dashboard](https://scout.docker.com/).
|
||||||
|
2. Go to the **Policies** section.
|
||||||
|
3. Select the policy you want to configure.
|
||||||
|
4. Select the **View configuration** button to open the policy configuration.
|
||||||
|
|
||||||
|
If the button is disabled, the selected policy doesn't have any
|
||||||
|
configuration parameters.
|
||||||
|
|
||||||
|
5. Select the **Edit policy** button. This prompts you to create a clone of the
|
||||||
|
default policy.
|
||||||
|
6. Select **Copy and edit policy** to create a clone of the default policy.
|
||||||
|
7. Update the policy parameters.
|
||||||
|
8. Save the changes:
|
||||||
|
|
||||||
|
- Select **Save and enable** to commit the changes and enable the policy for
|
||||||
|
your current organization.
|
||||||
|
- Select **Save changes** to save the policy configuration without enabling
|
||||||
|
it.
|
||||||
|
|
||||||
|
## Disable a policy
|
||||||
|
|
||||||
|
When you disable a policy, evaluation results for that policy are hidden, and
|
||||||
|
no longer appear in the Docker Scout Dashboard or in the CLI. Historic
|
||||||
|
evaluation results aren't deleted if you disable a policy, so if you change
|
||||||
|
your mind and re-enable a policy later, results from earlier evaluations will
|
||||||
|
still be available.
|
||||||
|
|
||||||
|
To disable a policy:
|
||||||
|
|
||||||
|
1. Go to the [Docker Scout Dashboard](https://scout.docker.com/).
|
||||||
|
2. Go to the **Policies** section.
|
||||||
|
3. Select the policy you want to disable.
|
||||||
|
4. Select **Disable policy**.
|
|
@ -1380,6 +1380,8 @@ Manuals:
|
||||||
title: Overview
|
title: Overview
|
||||||
- path: /scout/policy/view/
|
- path: /scout/policy/view/
|
||||||
title: View policy status
|
title: View policy status
|
||||||
|
- path: /scout/policy/configure/
|
||||||
|
title: Configure policies
|
||||||
- path: /scout/policy/ci/
|
- path: /scout/policy/ci/
|
||||||
title: Policy Evaluation in CI
|
title: Policy Evaluation in CI
|
||||||
- sectiontitle: Integrations
|
- sectiontitle: Integrations
|
||||||
|
|
Loading…
Reference in New Issue