Merge pull request #234 from docker/release/v1.23.0 · docker/scout-cli@c7ac4ce · GitHub
Skip to content

Commit c7ac4ce

Browse files
AndreSilva1993AndreSilva1993
authored
Merge pull request #234 from docker/release/v1.23.0
[BOT] Update docs for v1.23.0 release
2 parents c81c531 + a79ec10 commit c7ac4ce

9 files changed

Lines changed: 248 additions & 49 deletions

‎docs/docker_scout_compare.yaml‎

Lines changed: 40 additions & 0 deletions

‎docs/docker_scout_policy.yaml‎

Lines changed: 43 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
command: docker scout policy
22
short: |
3-
Evaluate policies against an image and display the policy evaluation results (experimental)
3+
Evaluate local Rego policies against an image and display the results (experimental)
44
long: |-
55
The `docker scout policy` command evaluates policies against an image.
66
The image analysis is uploaded to Docker Scout where policies get evaluated.
@@ -9,16 +9,11 @@ long: |-
99
usage: docker scout policy [IMAGE | REPO]
1010
pname: docker scout
1111
plink: docker_scout.yaml
12+
cname:
13+
- docker scout policy publish
14+
clink:
15+
- docker_scout_policy_publish.yaml
1216
options:
13-
- option: env
14-
value_type: string
15-
description: Name of the environment to compare to
16-
deprecated: true
17-
hidden: true
18-
experimental: false
19-
experimentalcli: false
20-
kubernetes: false
21-
swarm: false
2217
- option: exit-code
2318
shorthand: e
2419
value_type: bool
@@ -61,26 +56,57 @@ options:
6156
swarm: false
6257
- option: platform
6358
value_type: string
64-
description: Platform of image to pull policy results from
59+
description: Platform of image to evaluate policies against
6560
deprecated: false
6661
hidden: false
6762
experimental: false
6863
experimentalcli: false
6964
kubernetes: false
7065
swarm: false
71-
- option: to-env
66+
- option: policy-bundle
67+
value_type: stringArray
68+
default_value: '[]'
69+
description: OCI reference of a policy bundle to evaluate (repeatable)
70+
deprecated: false
71+
hidden: false
72+
experimental: false
73+
experimentalcli: false
74+
kubernetes: false
75+
swarm: false
76+
- option: policy-config
7277
value_type: string
73-
description: Name of the environment to compare to
78+
description: |
79+
Path or http(s) URL to a JSON file configuring policy enablement and inputs
7480
deprecated: false
7581
hidden: false
7682
experimental: false
7783
experimentalcli: false
7884
kubernetes: false
7985
swarm: false
80-
- option: to-latest
81-
value_type: bool
82-
default_value: "false"
83-
description: Latest image processed to compare to
86+
- option: policy-dir
87+
value_type: stringArray
88+
default_value: '[]'
89+
description: Path to a directory of local .rego policy files (repeatable)
90+
deprecated: false
91+
hidden: false
92+
experimental: false
93+
experimentalcli: false
94+
kubernetes: false
95+
swarm: false
96+
- option: policy-file
97+
value_type: stringArray
98+
default_value: '[]'
99+
description: Path or http(s) URL to a .rego policy file (repeatable)
100+
deprecated: false
101+
hidden: false
102+
experimental: false
103+
experimentalcli: false
104+
kubernetes: false
105+
swarm: false
106+
- option: result-file
107+
value_type: string
108+
description: |
109+
Write the full Rego evaluation result (pass, violations, query bindings and OPA metrics) of each evaluated policy to a JSON file (useful when iterating on local --policy-file policies)
84110
deprecated: false
85111
hidden: false
86112
experimental: false

‎docs/docker_scout_policy_publish.yaml‎

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
command: docker scout policy publish
2+
short: |
3+
Package local Rego policies into an OCI bundle and push it to a registry (experimental)
4+
long: |-
5+
The docker scout policy publish command packages Rego policies into an OCI policy bundle and pushes it to a registry. The published bundle can then be evaluated with docker scout policy --policy-bundle REFERENCE.
6+
7+
When no --policy-file or --policy-dir is given, the built-in default policy set is published. Authentication uses your existing registry credentials (run "docker login" first).
8+
usage: docker scout policy publish [OPTIONS] REFERENCE
9+
pname: docker scout policy
10+
plink: docker_scout_policy.yaml
11+
options:
12+
- option: policy-dir
13+
value_type: stringArray
14+
default_value: '[]'
15+
description: |
16+
Path to a directory of local .rego policy files to include (repeatable)
17+
deprecated: false
18+
hidden: false
19+
experimental: false
20+
experimentalcli: false
21+
kubernetes: false
22+
swarm: false
23+
- option: policy-file
24+
value_type: stringArray
25+
default_value: '[]'
26+
description: Path or http(s) URL to a .rego policy file to include (repeatable)
27+
deprecated: false
28+
hidden: false
29+
experimental: false
30+
experimentalcli: false
31+
kubernetes: false
32+
swarm: false
33+
inherited_options:
34+
- option: debug
35+
value_type: bool
36+
default_value: "false"
37+
description: Debug messages
38+
deprecated: false
39+
hidden: true
40+
experimental: false
41+
experimentalcli: false
42+
kubernetes: false
43+
swarm: false
44+
- option: verbose-debug
45+
value_type: bool
46+
default_value: "false"
47+
description: Verbose debug
48+
deprecated: false
49+
hidden: true
50+
experimental: false
51+
experimentalcli: false
52+
kubernetes: false
53+
swarm: false
54+
examples: " Publish the built-in default policies:\n $ docker scout policy publish registry.example.com/policies:latest\e[0m\n\n Publish a directory of local policies:\n $ docker scout policy publish --policy-dir ./rego registry.example.com/policies:latest\e[0m\n\n Publish specific policy files:\n $ docker scout policy publish --policy-file fixable.rego --policy-file licenses.rego registry.example.com/policies:latest\e[0m"
55+
deprecated: false
56+
experimental: false
57+
experimentalcli: true
58+
kubernetes: false
59+
swarm: false
60+

‎docs/docker_scout_quickview.yaml‎

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -115,6 +115,46 @@ options:
115115
experimentalcli: false
116116
kubernetes: false
117117
swarm: false
118+
- option: policy-bundle
119+
value_type: stringArray
120+
default_value: '[]'
121+
description: OCI reference of a policy bundle to evaluate (repeatable)
122+
deprecated: false
123+
hidden: false
124+
experimental: false
125+
experimentalcli: false
126+
kubernetes: false
127+
swarm: false
128+
- option: policy-config
129+
value_type: string
130+
description: |
131+
Path or http(s) URL to a JSON file configuring policy enablement and inputs
132+
deprecated: false
133+
hidden: false
134+
experimental: false
135+
experimentalcli: false
136+
kubernetes: false
137+
swarm: false
138+
- option: policy-dir
139+
value_type: stringArray
140+
default_value: '[]'
141+
description: Path to a directory of local .rego policy files (repeatable)
142+
deprecated: false
143+
hidden: false
144+
experimental: false
145+
experimentalcli: false
146+
kubernetes: false
147+
swarm: false
148+
- option: policy-file
149+
value_type: stringArray
150+
default_value: '[]'
151+
description: Path or http(s) URL to a .rego policy file (repeatable)
152+
deprecated: false
153+
hidden: false
154+
experimental: false
155+
experimentalcli: false
156+
kubernetes: false
157+
swarm: false
118158
- option: ref
119159
value_type: string
120160
description: |-

‎docs/scout.md‎

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -9,28 +9,28 @@ Command line tool for Docker Scout
99

1010
### Subcommands
1111

12-
| Name | Description |
13-
|:--------------------------------------------------------------|:--------------------------------------------------------------------------------------------|
14-
| [`attestation`](scout_attestation.md) | Manage attestations on images |
15-
| [`cache`](scout_cache.md) | Manage Docker Scout cache and temporary files |
16-
| [`compare`](scout_compare.md) | Compare two images and display differences (experimental) |
17-
| [`config`](scout_config.md) | Manage Docker Scout configuration |
18-
| [`cves`](scout_cves.md) | Display CVEs identified in a software artifact |
19-
| [`docker-cli-plugin-hooks`](scout_docker-cli-plugin-hooks.md) | runs the plugins hooks |
20-
| [`enroll`](scout_enroll.md) | Enroll an organization with Docker Scout |
21-
| [`environment`](scout_environment.md) | Manage environments (experimental) |
22-
| [`help`](scout_help.md) | Display information about the available commands |
23-
| [`integration`](scout_integration.md) | Commands to list, configure, and delete Docker Scout integrations |
24-
| [`policy`](scout_policy.md) | Evaluate policies against an image and display the policy evaluation results (experimental) |
25-
| [`push`](scout_push.md) | Push an image or image index to Docker Scout |
26-
| [`quickview`](scout_quickview.md) | Quick overview of an image |
27-
| [`recommendations`](scout_recommendations.md) | Display available base image updates and remediation recommendations |
28-
| [`repo`](scout_repo.md) | Commands to list, enable, and disable Docker Scout on repositories |
29-
| [`sbom`](scout_sbom.md) | Generate or display SBOM of an image |
30-
| [`stream`](scout_stream.md) | Manage streams (experimental) |
31-
| [`version`](scout_version.md) | Show Docker Scout version information |
32-
| [`vex`](scout_vex.md) | Manage VEX attestations on images |
33-
| [`watch`](scout_watch.md) | Watch repositories in a registry and push images and indexes to Docker Scout |
12+
| Name | Description |
13+
|:--------------------------------------------------------------|:-------------------------------------------------------------------------------------|
14+
| [`attestation`](scout_attestation.md) | Manage attestations on images |
15+
| [`cache`](scout_cache.md) | Manage Docker Scout cache and temporary files |
16+
| [`compare`](scout_compare.md) | Compare two images and display differences (experimental) |
17+
| [`config`](scout_config.md) | Manage Docker Scout configuration |
18+
| [`cves`](scout_cves.md) | Display CVEs identified in a software artifact |
19+
| [`docker-cli-plugin-hooks`](scout_docker-cli-plugin-hooks.md) | runs the plugins hooks |
20+
| [`enroll`](scout_enroll.md) | Enroll an organization with Docker Scout |
21+
| [`environment`](scout_environment.md) | Manage environments (experimental) |
22+
| [`help`](scout_help.md) | Display information about the available commands |
23+
| [`integration`](scout_integration.md) | Commands to list, configure, and delete Docker Scout integrations |
24+
| [`policy`](scout_policy.md) | Evaluate local Rego policies against an image and display the results (experimental) |
25+
| [`push`](scout_push.md) | Push an image or image index to Docker Scout |
26+
| [`quickview`](scout_quickview.md) | Quick overview of an image |
27+
| [`recommendations`](scout_recommendations.md) | Display available base image updates and remediation recommendations |
28+
| [`repo`](scout_repo.md) | Commands to list, enable, and disable Docker Scout on repositories |
29+
| [`sbom`](scout_sbom.md) | Generate or display SBOM of an image |
30+
| [`stream`](scout_stream.md) | Manage streams (experimental) |
31+
| [`version`](scout_version.md) | Show Docker Scout version information |
32+
| [`vex`](scout_vex.md) | Manage VEX attestations on images |
33+
| [`watch`](scout_watch.md) | Watch repositories in a registry and push images and indexes to Docker Scout |
3434

3535

3636

‎docs/scout_compare.md‎

Lines changed: 4 additions & 0 deletions

0 commit comments

Comments
 (0)