diff --git a/_data/registry-cli/docker_registry.yaml b/_data/registry-cli/docker_registry.yaml new file mode 100644 index 0000000000..abae6f778f --- /dev/null +++ b/_data/registry-cli/docker_registry.yaml @@ -0,0 +1,30 @@ +command: docker registry +short: Manage Docker registries +long: Manage Docker registries +usage: docker registry COMMAND +pname: docker +plink: docker.yaml +cname: +- docker registry events +- docker registry history +- docker registry info +- docker registry inspect +- docker registry joblogs +- docker registry jobs +- docker registry ls +- docker registry rmi +clink: +- docker_registry_events.yaml +- docker_registry_history.yaml +- docker_registry_info.yaml +- docker_registry_inspect.yaml +- docker_registry_joblogs.yaml +- docker_registry_jobs.yaml +- docker_registry_ls.yaml +- docker_registry_rmi.yaml +deprecated: false +experimental: false +experimentalcli: false +kubernetes: false +swarm: false + diff --git a/_data/registry-cli/docker_registry_events.yaml b/_data/registry-cli/docker_registry_events.yaml new file mode 100644 index 0000000000..d46da49a53 --- /dev/null +++ b/_data/registry-cli/docker_registry_events.yaml @@ -0,0 +1,57 @@ +command: docker registry events +short: List registry events (DTR Only) +long: List registry events (Only supported by Docker Trusted Registry) +usage: docker registry events HOST | REPOSITORY [OPTIONS] +pname: docker registry +plink: docker_registry.yaml +options: +- option: format + value_type: string + description: Pretty-print output using a Go template + deprecated: false + experimental: false + experimentalcli: false + kubernetes: false + swarm: false +- option: limit + value_type: int64 + default_value: "50" + description: Specify the number of event results + deprecated: false + experimental: false + experimentalcli: false + kubernetes: false + swarm: false +- option: no-trunc + value_type: bool + default_value: "false" + description: Don't truncate output + deprecated: false + experimental: false + experimentalcli: false + kubernetes: false + swarm: false +- option: object-type + value_type: string + description: | + Specify the type of Event target object [REPOSITORY | TAG | BLOB | MANIFEST | WEBHOOK | URI | PROMOTION | PUSH_MIRRORING | POLL_MIRRORING] + deprecated: false + experimental: false + experimentalcli: false + kubernetes: false + swarm: false +- option: type + value_type: string + description: | + Specify the type of Event [CREATE | GET | DELETE | UPDATE | SEND | FAIL] + deprecated: false + experimental: false + experimentalcli: false + kubernetes: false + swarm: false +deprecated: false +experimental: false +experimentalcli: false +kubernetes: false +swarm: false + diff --git a/_data/registry-cli/docker_registry_history.yaml b/_data/registry-cli/docker_registry_history.yaml new file mode 100644 index 0000000000..f9ead65376 --- /dev/null +++ b/_data/registry-cli/docker_registry_history.yaml @@ -0,0 +1,40 @@ +command: docker registry history +short: Inspect registry image history (DTR Only) +long: Inspect registry image history (DTR Only) +usage: docker registry history IMAGE [OPTIONS] +pname: docker registry +plink: docker_registry.yaml +options: +- option: format + value_type: string + description: Pretty-print history using a Go template + deprecated: false + experimental: false + experimentalcli: false + kubernetes: false + swarm: false +- option: human + shorthand: H + value_type: bool + default_value: "true" + description: Print sizes and dates in human readable format + deprecated: false + experimental: false + experimentalcli: false + kubernetes: false + swarm: false +- option: no-trunc + value_type: bool + default_value: "false" + description: Don't truncate output + deprecated: false + experimental: false + experimentalcli: false + kubernetes: false + swarm: false +deprecated: false +experimental: false +experimentalcli: false +kubernetes: false +swarm: false + diff --git a/_data/registry-cli/docker_registry_info.yaml b/_data/registry-cli/docker_registry_info.yaml new file mode 100644 index 0000000000..6670793626 --- /dev/null +++ b/_data/registry-cli/docker_registry_info.yaml @@ -0,0 +1,22 @@ +command: docker registry info +short: Display information about a registry (DTR Only) +long: Display information about a registry (Only supported by Docker Trusted Registry + and must be authenticated as an admin user) +usage: docker registry info HOST [OPTIONS] +pname: docker registry +plink: docker_registry.yaml +options: +- option: format + value_type: string + description: Pretty-print output using a Go template + deprecated: false + experimental: false + experimentalcli: false + kubernetes: false + swarm: false +deprecated: false +experimental: false +experimentalcli: false +kubernetes: false +swarm: false + diff --git a/_data/registry-cli/docker_registry_inspect.yaml b/_data/registry-cli/docker_registry_inspect.yaml new file mode 100644 index 0000000000..1c0a1e768e --- /dev/null +++ b/_data/registry-cli/docker_registry_inspect.yaml @@ -0,0 +1,21 @@ +command: docker registry inspect +short: Inspect registry image +long: Inspect registry image +usage: docker registry inspect IMAGE [OPTIONS] +pname: docker registry +plink: docker_registry.yaml +options: +- option: format + value_type: string + description: Pretty-print output using a Go template + deprecated: false + experimental: false + experimentalcli: false + kubernetes: false + swarm: false +deprecated: false +experimental: false +experimentalcli: false +kubernetes: false +swarm: false + diff --git a/_data/registry-cli/docker_registry_joblogs.yaml b/_data/registry-cli/docker_registry_joblogs.yaml new file mode 100644 index 0000000000..cd72c1ec85 --- /dev/null +++ b/_data/registry-cli/docker_registry_joblogs.yaml @@ -0,0 +1,21 @@ +command: docker registry joblogs +short: List registry job logs (DTR Only) +long: List registry job logs (DTR Only) +usage: docker registry joblogs HOST JOB_ID [OPTIONS] +pname: docker registry +plink: docker_registry.yaml +options: +- option: format + value_type: string + description: Pretty-print output using a Go template + deprecated: false + experimental: false + experimentalcli: false + kubernetes: false + swarm: false +deprecated: false +experimental: false +experimentalcli: false +kubernetes: false +swarm: false + diff --git a/_data/registry-cli/docker_registry_jobs.yaml b/_data/registry-cli/docker_registry_jobs.yaml new file mode 100644 index 0000000000..a79e51be71 --- /dev/null +++ b/_data/registry-cli/docker_registry_jobs.yaml @@ -0,0 +1,49 @@ +command: docker registry jobs +short: List registry jobs (DTR Only) +long: List registry jobs (Only supported by Docker Trusted Registry and must be authenticated + as an admin user) +usage: docker registry jobs HOST [OPTIONS] +pname: docker registry +plink: docker_registry.yaml +options: +- option: action + value_type: string + description: | + Specify the type of Job action [onlinegc | onlinegc_metadata | onlinegc_joblogs | onlinegc_events | license_update | scan_check | scan_check_single | scan_check_all | update_vuln_db | nautilus_update_db | push_mirror_tag | poll_mirror | tag_prune] + deprecated: false + experimental: false + experimentalcli: false + kubernetes: false + swarm: false +- option: format + value_type: string + description: Pretty-print output using a Go template + deprecated: false + experimental: false + experimentalcli: false + kubernetes: false + swarm: false +- option: limit + value_type: int64 + default_value: "50" + description: Specify the number of job results + deprecated: false + experimental: false + experimentalcli: false + kubernetes: false + swarm: false +- option: no-trunc + value_type: bool + default_value: "false" + description: Don't truncate output + deprecated: false + experimental: false + experimentalcli: false + kubernetes: false + swarm: false +deprecated: false +experimental: false +experimentalcli: false +kubernetes: false +swarm: false + diff --git a/_data/registry-cli/docker_registry_ls.yaml b/_data/registry-cli/docker_registry_ls.yaml new file mode 100644 index 0000000000..3693f3ef79 --- /dev/null +++ b/_data/registry-cli/docker_registry_ls.yaml @@ -0,0 +1,49 @@ +command: docker registry ls +short: List registry images +long: List registry images +usage: docker registry ls REPOSITORY[:TAG] [OPTIONS] +pname: docker registry +plink: docker_registry.yaml +options: +- option: digests + value_type: bool + default_value: "false" + description: Show digests + deprecated: false + experimental: false + experimentalcli: false + kubernetes: false + swarm: false +- option: format + value_type: string + description: Pretty-print output using a Go template + deprecated: false + experimental: false + experimentalcli: false + kubernetes: false + swarm: false +- option: quiet + shorthand: q + value_type: bool + default_value: "false" + description: Only display image names + deprecated: false + experimental: false + experimentalcli: false + kubernetes: false + swarm: false +- option: verbose + value_type: bool + default_value: "false" + description: Display verbose image information + deprecated: false + experimental: false + experimentalcli: false + kubernetes: false + swarm: false +deprecated: false +experimental: false +experimentalcli: false +kubernetes: false +swarm: false + diff --git a/_data/registry-cli/docker_registry_rmi.yaml b/_data/registry-cli/docker_registry_rmi.yaml new file mode 100644 index 0000000000..5c98345f97 --- /dev/null +++ b/_data/registry-cli/docker_registry_rmi.yaml @@ -0,0 +1,12 @@ +command: docker registry rmi +short: Remove a registry image (DTR Only) +long: Remove a registry image (DTR Only) +usage: docker registry rmi REPOSITORY:TAG [OPTIONS] +pname: docker registry +plink: docker_registry.yaml +deprecated: false +experimental: false +experimentalcli: false +kubernetes: false +swarm: false + diff --git a/_data/toc.yaml b/_data/toc.yaml index 189e963b0f..8cd4db25f0 100644 --- a/_data/toc.yaml +++ b/_data/toc.yaml @@ -766,6 +766,24 @@ reference: title: docker pull - path: /engine/reference/commandline/push/ title: docker push + - sectiontitle: docker registry * + section: + - path: /engine/reference/commandline/registry/ + title: docker registry + - path: /engine/reference/commandline/registry_events/ + title: docker registry events + - path: /engine/reference/commandline/registry_history/ + title: docker registry history + - path: /engine/reference/commandline/registry_info/ + title: docker registry info + - path: /engine/reference/commandline/registry_inspect/ + title: docker registry inspect + - path: /engine/reference/commandline/registry_joblogs/ + title: docker registry joblogs + - path: /engine/reference/commandline/registry_ls/ + title: docker registry ls + - path: /engine/reference/commandline/registry_rmi/ + title: docker registry rmi - path: /engine/reference/commandline/rename/ title: docker rename - path: /engine/reference/commandline/restart/ diff --git a/engine/reference/commandline/registry.md b/engine/reference/commandline/registry.md new file mode 100644 index 0000000000..9a756fafb3 --- /dev/null +++ b/engine/reference/commandline/registry.md @@ -0,0 +1,15 @@ +--- +datafolder: registry-cli +datafile: docker_registry +title: docker registry +--- + + + +{% include cli.md datafolder=page.datafolder datafile=page.datafile %} diff --git a/engine/reference/commandline/registry_events.md b/engine/reference/commandline/registry_events.md new file mode 100644 index 0000000000..d5a7d543b8 --- /dev/null +++ b/engine/reference/commandline/registry_events.md @@ -0,0 +1,15 @@ +--- +datafolder: registry-cli +datafile: docker_registry_events +title: docker registry events +--- + + + +{% include cli.md datafolder=page.datafolder datafile=page.datafile %} diff --git a/engine/reference/commandline/registry_history.md b/engine/reference/commandline/registry_history.md new file mode 100644 index 0000000000..d577f76118 --- /dev/null +++ b/engine/reference/commandline/registry_history.md @@ -0,0 +1,15 @@ +--- +datafolder: registry-cli +datafile: docker_registry_history +title: docker registry history +--- + + + +{% include cli.md datafolder=page.datafolder datafile=page.datafile %} diff --git a/engine/reference/commandline/registry_info.md b/engine/reference/commandline/registry_info.md new file mode 100644 index 0000000000..61838dd329 --- /dev/null +++ b/engine/reference/commandline/registry_info.md @@ -0,0 +1,15 @@ +--- +datafolder: registry-cli +datafile: docker_registry_info +title: docker registry info +--- + + + +{% include cli.md datafolder=page.datafolder datafile=page.datafile %} diff --git a/engine/reference/commandline/registry_inspect.md b/engine/reference/commandline/registry_inspect.md new file mode 100644 index 0000000000..034e61430a --- /dev/null +++ b/engine/reference/commandline/registry_inspect.md @@ -0,0 +1,15 @@ +--- +datafolder: registry-cli +datafile: docker_registry_inspect +title: docker registry inspect +--- + + + +{% include cli.md datafolder=page.datafolder datafile=page.datafile %} diff --git a/engine/reference/commandline/registry_joblogs.md b/engine/reference/commandline/registry_joblogs.md new file mode 100644 index 0000000000..00d5f9cf01 --- /dev/null +++ b/engine/reference/commandline/registry_joblogs.md @@ -0,0 +1,15 @@ +--- +datafolder: registry-cli +datafile: docker_registry_joblogs +title: docker registry joblogs +--- + + + +{% include cli.md datafolder=page.datafolder datafile=page.datafile %} diff --git a/engine/reference/commandline/registry_jobs.md b/engine/reference/commandline/registry_jobs.md new file mode 100644 index 0000000000..b71a4cb9c8 --- /dev/null +++ b/engine/reference/commandline/registry_jobs.md @@ -0,0 +1,15 @@ +--- +datafolder: registry-cli +datafile: docker_registry_jobs +title: docker registry jobs +--- + + + +{% include cli.md datafolder=page.datafolder datafile=page.datafile %} diff --git a/engine/reference/commandline/registry_ls.md b/engine/reference/commandline/registry_ls.md new file mode 100644 index 0000000000..f00b117897 --- /dev/null +++ b/engine/reference/commandline/registry_ls.md @@ -0,0 +1,15 @@ +--- +datafolder: registry-cli +datafile: docker_registry_ls +title: docker registry ls +--- + + + +{% include cli.md datafolder=page.datafolder datafile=page.datafile %} diff --git a/engine/reference/commandline/registry_rmi.md b/engine/reference/commandline/registry_rmi.md new file mode 100644 index 0000000000..21226aaaf9 --- /dev/null +++ b/engine/reference/commandline/registry_rmi.md @@ -0,0 +1,15 @@ +--- +datafolder: registry-cli +datafile: docker_registry_rmi +title: docker registry rmi +--- + + + +{% include cli.md datafolder=page.datafolder datafile=page.datafile %}