mirror of
https://github.com/docker/docs.git
synced 2026-03-27 14:28:47 +07:00
scout: update watch reference (#24169)
<!--Delete sections as needed --> ## Description Quick fix to manually add the examples from the upstream markdown to this downstream yaml. https://github.com/docker/scout-cli/blob/main/docs/scout_watch.md#docker-scout-watch We switched to upstream yaml from the md because of a formatting issue. Will look into it and try to get back to using the upstream md as the md and yaml have diverged over time. https://deploy-preview-24169--docsdocker.netlify.app/reference/cli/docker/scout/watch/ ## Related issues or tickets https://github.com/docker/docs/pull/23921 https://docker.slack.com/archives/C04C69EM70C/p1771418602873829?thread_ts=1754573643.278429&cid=C04C69EM70C ## Reviews <!-- Notes for reviewers here --> <!-- List applicable reviews (optionally @tag reviewers) --> - [ ] Editorial review Signed-off-by: Craig Osterhout <craig.osterhout@docker.com>
This commit is contained in:
94
data/scout-cli/docker_scout_watch.yaml
generated
94
data/scout-cli/docker_scout_watch.yaml
generated
@@ -128,7 +128,99 @@ inherited_options:
|
||||
experimentalcli: false
|
||||
kubernetes: false
|
||||
swarm: false
|
||||
examples: " Watch for new images from two repositories and push them\n $ docker scout watch --org my-org --repository registry-1.example.com/repo-1 --repository registry-2.example.com/repo-2\e[0m\n\n Only push images with a specific tag\n $ docker scout watch --org my-org --repository registry.example.com/my-service --tag latest\e[0m\n\n Watch all repositories of a registry\n $ docker scout watch --org my-org --registry registry.example.com\e[0m\n\n Push all images and not just the new ones\n $ docker scout watch --org my-org --repository registry.example.com/my-service --all-images\e[0m"
|
||||
examples: |-
|
||||
### Watch for new images from two repositories and push them
|
||||
|
||||
```console
|
||||
$ docker scout watch --org my-org --repository registry-1.example.com/repo-1 --repository registry-2.example.com/repo-2
|
||||
```
|
||||
|
||||
### Only push images with a specific tag
|
||||
|
||||
```console
|
||||
$ docker scout watch --org my-org --repository registry.example.com/my-service --tag latest
|
||||
```
|
||||
|
||||
### Watch all repositories of a registry
|
||||
|
||||
```console
|
||||
$ docker scout watch --org my-org --registry registry.example.com
|
||||
```
|
||||
|
||||
### Push all images and not just the new ones
|
||||
|
||||
```console
|
||||
$ docker scout watch --org my-org --repository registry.example.com/my-service --all-images
|
||||
```
|
||||
|
||||
### Configure Artifactory integration
|
||||
|
||||
The following example creates a web hook endpoint for Artifactory to push new
|
||||
image events into:
|
||||
|
||||
```console
|
||||
$ export DOCKER_SCOUT_ARTIFACTORY_API_USER=user
|
||||
$ export DOCKER_SCOUT_ARTIFACTORY_API_PASSWORD=password
|
||||
$ export DOCKER_SCOUT_ARTIFACTORY_WEBHOOK_SECRET=foo
|
||||
|
||||
$ docker scout watch --registry "type=artifactory,registry=example.jfrog.io,api=https://example.jfrog.io/artifactory,include=*/frontend*,exclude=*/dta/*,repository=docker-local,port=9000,subdomain-mode=true" --refresh-registry
|
||||
```
|
||||
|
||||
This will launch an HTTP server on port `9000` that will receive all `component` web
|
||||
hook events, optionally validating the HMAC signature.
|
||||
|
||||
### Configure Harbor integration
|
||||
|
||||
The following example creates a web hook endpoint for Harbor to push new image
|
||||
events into:
|
||||
|
||||
```console
|
||||
$ export DOCKER_SCOUT_HARBOR_API_USER=admin
|
||||
$ export DOCKER_SCOUT_HARBOR_API_PASSWORD=password
|
||||
$ export DOCKER_SCOUT_HARBOR_WEBHOOK_AUTH="token foo"
|
||||
|
||||
$ docker scout watch --registry 'type=harbor,registry=demo.goharbor.io,api=https://demo.goharbor.io,include=*/foo/*,exclude=*/bar/*,port=9000' --refresh-registry
|
||||
```
|
||||
|
||||
This will launch an HTTP server on port `9000` that will receive all `component` web
|
||||
hook events, optionally validating the HMAC signature.
|
||||
|
||||
### Configure Nexus integration
|
||||
|
||||
The following example shows how to configure Sonartype Nexus integration:
|
||||
|
||||
```console
|
||||
$ export DOCKER_SCOUT_NEXUS_API_USER=admin
|
||||
$ export DOCKER_SCOUT_NEXUS_API_PASSWORD=admin124
|
||||
|
||||
$ docker scout watch --registry 'type=nexus,registry=localhost:8082,api=http://localhost:8081,include=*/foo/*,exclude=*/bar/*,"repository=docker-test1,docker-test2"' --refresh-registry
|
||||
```
|
||||
|
||||
This ingests all images and tags in Nexus repositories called `docker-test1`
|
||||
and `docker-test2` that match the `*/foo/*` include and `*/bar/*` exclude glob
|
||||
pattern.
|
||||
|
||||
You can also create a web hook endpoint for Nexus to push new image events into:
|
||||
|
||||
```console
|
||||
$ export DOCKER_SCOUT_NEXUS_API_USER=admin
|
||||
$ export DOCKER_SCOUT_NEXUS_API_PASSWORD=admin124
|
||||
$ export DOCKER_SCOUT_NEXUS_WEBHOOK_SECRET=mysecret
|
||||
|
||||
$ docker scout watch --registry 'type=nexus,registry=localhost:8082,api=http://localhost:8081,include=*/foo/*,exclude=*/bar/*,"repository=docker-test1,docker-test2",port=9000' --refresh-registry
|
||||
```
|
||||
|
||||
This will launch an HTTP server on port `9000` that will receive all `component` web
|
||||
hook events, optionally validating the HMAC signature.
|
||||
|
||||
### Configure integration for other OCI registries
|
||||
|
||||
The following example shows how to integrate an OCI registry that implements the
|
||||
`_catalog` endpoint:
|
||||
|
||||
```console
|
||||
$ docker scout watch --registry 'type=oci,registry=registry.example.com,include=*/scout-artifact-registry/*'
|
||||
```
|
||||
deprecated: false
|
||||
experimental: false
|
||||
experimentalcli: false
|
||||
|
||||
Reference in New Issue
Block a user