mirror of
https://github.com/docker/docs.git
synced 2026-03-27 14:28:47 +07:00
ec72262eed
Upstream docs had a formatting issue that needed a hotfix. Rather than fixing the vendored yaml, which would be overwritten the next time update (any) vendored modules, I decided to manually copy the cli reference yaml to the data dir. Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
141 lines
3.8 KiB
YAML
141 lines
3.8 KiB
YAML
command: docker scout policy
|
|
short: |
|
|
Evaluate policies against an image and display the policy evaluation results (experimental)
|
|
long: |-
|
|
The `docker scout policy` command evaluates policies against an image.
|
|
The image analysis is uploaded to Docker Scout where policies get evaluated.
|
|
|
|
The policy evaluation results may take a few minutes to become available.
|
|
usage: docker scout policy [IMAGE | REPO]
|
|
pname: docker scout
|
|
plink: docker_scout.yaml
|
|
options:
|
|
- option: env
|
|
value_type: string
|
|
description: Name of the environment to compare to
|
|
deprecated: true
|
|
hidden: true
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
- option: exit-code
|
|
shorthand: e
|
|
value_type: bool
|
|
default_value: "false"
|
|
description: Return exit code '2' if policies are not met, '0' otherwise
|
|
deprecated: false
|
|
hidden: false
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
- option: only-policy
|
|
value_type: stringSlice
|
|
default_value: '[]'
|
|
description: Comma separated list of policies to evaluate
|
|
deprecated: false
|
|
hidden: false
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
- option: org
|
|
value_type: string
|
|
description: Namespace of the Docker organization
|
|
deprecated: false
|
|
hidden: false
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
- option: output
|
|
shorthand: o
|
|
value_type: string
|
|
description: Write the report to a file
|
|
deprecated: false
|
|
hidden: false
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
- option: platform
|
|
value_type: string
|
|
description: Platform of image to pull policy results from
|
|
deprecated: false
|
|
hidden: false
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
- option: to-env
|
|
value_type: string
|
|
description: Name of the environment to compare to
|
|
deprecated: false
|
|
hidden: false
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
- option: to-latest
|
|
value_type: bool
|
|
default_value: "false"
|
|
description: Latest image processed to compare to
|
|
deprecated: false
|
|
hidden: false
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
inherited_options:
|
|
- option: debug
|
|
value_type: bool
|
|
default_value: "false"
|
|
description: Debug messages
|
|
deprecated: false
|
|
hidden: true
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
- option: verbose-debug
|
|
value_type: bool
|
|
default_value: "false"
|
|
description: Verbose debug
|
|
deprecated: false
|
|
hidden: true
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
examples: |-
|
|
### Evaluate policies against an image and display the results
|
|
|
|
```console
|
|
$ docker scout policy dockerscoutpolicy/customers-api-service:0.0.1
|
|
```
|
|
|
|
### Evaluate policies against an image for a specific organization
|
|
|
|
```console
|
|
$ docker scout policy dockerscoutpolicy/customers-api-service:0.0.1 --org dockerscoutpolicy
|
|
```
|
|
|
|
### Evaluate policies against an image with a specific platform
|
|
|
|
```console
|
|
$ docker scout policy dockerscoutpolicy/customers-api-service:0.0.1 --platform linux/amd64
|
|
```
|
|
|
|
### Compare policy results for a repository in a specific environment
|
|
|
|
```console
|
|
$ docker scout policy dockerscoutpolicy/customers-api-service --to-env production
|
|
```
|
|
deprecated: false
|
|
experimental: false
|
|
experimentalcli: true
|
|
kubernetes: false
|
|
swarm: false
|
|
|