dhi: add packages and tiers

Signed-off-by: Craig Osterhout <craig.osterhout@docker.com>

spacing fix

Signed-off-by: Craig Osterhout <craig.osterhout@docker.com>

Update content/manuals/dhi/_index.md

Co-authored-by: Usha Mandya <47779042+usha-mandya@users.noreply.github.com>
This commit is contained in:
Craig Osterhout
2026-02-24 14:49:48 -08:00
parent ddd84785c0
commit f6c676ec74
43 changed files with 1521 additions and 76 deletions

View File

@@ -0,0 +1,24 @@
command: docker dhi
short: CLI for managing Docker Hardened Images
long: |-
command-line interface for administering Docker Hardened Images.
It provides commands to browse the DHI catalog, mirror images into your organisations and manage customizations.
pname: docker
plink: docker.yaml
cname:
- docker dhi auth
- docker dhi catalog
- docker dhi customization
- docker dhi mirror
clink:
- docker_dhi_auth.yaml
- docker_dhi_catalog.yaml
- docker_dhi_customization.yaml
- docker_dhi_mirror.yaml
deprecated: false
hidden: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false

View File

@@ -0,0 +1,16 @@
command: docker dhi auth
short: Authenticate with Docker Hub
long: Commands to authenticate with Docker Hub
pname: docker dhi
plink: docker_dhi.yaml
cname:
- docker dhi auth apk
clink:
- docker_dhi_auth_apk.yaml
deprecated: false
hidden: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false

View File

@@ -0,0 +1,13 @@
command: docker dhi auth apk
short: Create authentication details for DHI APK repositories
long: Create authentication details for DHI APK repositories
usage: docker dhi auth apk
pname: docker dhi auth
plink: docker_dhi_auth.yaml
deprecated: false
hidden: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false

View File

@@ -0,0 +1,28 @@
command: docker dhi catalog
short: Browse the Docker Hardened Images catalog
long: Commands to browse available Docker Hardened Images and Helm charts
pname: docker dhi
plink: docker_dhi.yaml
cname:
- docker dhi catalog get
- docker dhi catalog list
clink:
- docker_dhi_catalog_get.yaml
- docker_dhi_catalog_list.yaml
options:
- option: org
value_type: string
description: Docker Hub organization (overrides config)
deprecated: false
hidden: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false
hidden: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false

View File

@@ -0,0 +1,35 @@
command: docker dhi catalog get
short: Get details of a Docker Hardened Image
long: |
Get detailed information about a Docker Hardened Image or Helm chart, including available tags and CVE counts
usage: docker dhi catalog get <name>
pname: docker dhi catalog
plink: docker_dhi_catalog.yaml
options:
- option: json
value_type: bool
default_value: "false"
description: Output in JSON format
deprecated: false
hidden: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
inherited_options:
- option: org
value_type: string
description: Docker Hub organization (overrides config)
deprecated: false
hidden: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false
hidden: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false

View File

@@ -0,0 +1,73 @@
command: docker dhi catalog list
short: List available Docker Hardened Images
long: List all available Docker Hardened Images and Helm charts in the catalog
usage: docker dhi catalog list
pname: docker dhi catalog
plink: docker_dhi_catalog.yaml
options:
- option: filter
shorthand: f
value_type: string
description: Filter by name (case-insensitive substring match)
deprecated: false
hidden: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: fips
value_type: bool
default_value: "false"
description: Filter to FIPS compliant images (use --fips=false to exclude)
deprecated: false
hidden: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: json
value_type: bool
default_value: "false"
description: Output in JSON format
deprecated: false
hidden: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: stig
value_type: bool
default_value: "false"
description: Filter to STIG certified images (use --stig=false to exclude)
deprecated: false
hidden: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: type
value_type: string
description: Filter by type (image, helm, chart, or helm-chart)
deprecated: false
hidden: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
inherited_options:
- option: org
value_type: string
description: Docker Hub organization (overrides config)
deprecated: false
hidden: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false
hidden: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false

View File

@@ -0,0 +1,39 @@
command: docker dhi customization
short: Manage Docker Hardened Images customizations
long: |
Commands to list, create, edit, and delete Docker Hardened Images customizations
pname: docker dhi
plink: docker_dhi.yaml
cname:
- docker dhi customization build
- docker dhi customization create
- docker dhi customization delete
- docker dhi customization edit
- docker dhi customization get
- docker dhi customization list
- docker dhi customization prepare
clink:
- docker_dhi_customization_build.yaml
- docker_dhi_customization_create.yaml
- docker_dhi_customization_delete.yaml
- docker_dhi_customization_edit.yaml
- docker_dhi_customization_get.yaml
- docker_dhi_customization_list.yaml
- docker_dhi_customization_prepare.yaml
options:
- option: org
value_type: string
description: Docker Hub organization (overrides config)
deprecated: false
hidden: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false
hidden: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false

View File

@@ -0,0 +1,30 @@
command: docker dhi customization build
short: Manage customization builds
long: Commands to manage Docker Hardened Images customization builds
pname: docker dhi customization
plink: docker_dhi_customization.yaml
cname:
- docker dhi customization build get
- docker dhi customization build list
- docker dhi customization build logs
clink:
- docker_dhi_customization_build_get.yaml
- docker_dhi_customization_build_list.yaml
- docker_dhi_customization_build_logs.yaml
inherited_options:
- option: org
value_type: string
description: Docker Hub organization (overrides config)
deprecated: false
hidden: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false
hidden: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false

View File

@@ -0,0 +1,35 @@
command: docker dhi customization build get
short: Get details of a build
long: |
Get detailed information about a Docker Hardened Images customization build
usage: docker dhi customization build get <repository> <name> <build-id>
pname: docker dhi customization build
plink: docker_dhi_customization_build.yaml
options:
- option: json
value_type: bool
default_value: "false"
description: Output in JSON format
deprecated: false
hidden: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
inherited_options:
- option: org
value_type: string
description: Docker Hub organization (overrides config)
deprecated: false
hidden: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false
hidden: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false

View File

@@ -0,0 +1,35 @@
command: docker dhi customization build list
short: List builds of a customization
long: |
List all builds of a Docker Hardened Images customization by repository and name
usage: docker dhi customization build list <repository> <name>
pname: docker dhi customization build
plink: docker_dhi_customization_build.yaml
options:
- option: json
value_type: bool
default_value: "false"
description: Output in JSON format
deprecated: false
hidden: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
inherited_options:
- option: org
value_type: string
description: Docker Hub organization (overrides config)
deprecated: false
hidden: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false
hidden: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false

View File

@@ -0,0 +1,34 @@
command: docker dhi customization build logs
short: Get logs of a build
long: Get the logs of a Docker Hardened Images customization build
usage: docker dhi customization build logs <repository> <name> <build-id>
pname: docker dhi customization build
plink: docker_dhi_customization_build.yaml
options:
- option: json
value_type: bool
default_value: "false"
description: Output in JSON format
deprecated: false
hidden: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
inherited_options:
- option: org
value_type: string
description: Docker Hub organization (overrides config)
deprecated: false
hidden: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false
hidden: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false

View File

@@ -0,0 +1,24 @@
command: docker dhi customization create
short: Create a new customization from YAML file
long: |
Create a new Docker Hardened Images customization using a YAML file as input. The file should contain the complete customization structure without an 'id' field.
usage: docker dhi customization create <file>
pname: docker dhi customization
plink: docker_dhi_customization.yaml
inherited_options:
- option: org
value_type: string
description: Docker Hub organization (overrides config)
deprecated: false
hidden: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false
hidden: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false

View File

@@ -0,0 +1,35 @@
command: docker dhi customization delete
short: Delete a customization
long: Delete a Docker Hardened Images customization by repository and name
usage: docker dhi customization delete <repository> <name>
pname: docker dhi customization
plink: docker_dhi_customization.yaml
options:
- option: "yes"
shorthand: "y"
value_type: bool
default_value: "false"
description: Skip confirmation prompt
deprecated: false
hidden: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
inherited_options:
- option: org
value_type: string
description: Docker Hub organization (overrides config)
deprecated: false
hidden: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false
hidden: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false

View File

@@ -0,0 +1,25 @@
command: docker dhi customization edit
aliases: docker dhi customization edit, docker dhi customization update
short: Edit an existing customization from YAML file
long: |
Edit an existing Docker Hardened Images customization using a YAML file as input. The file should contain the complete customization structure with an 'id' field to identify which customization to update.
usage: docker dhi customization edit <file>
pname: docker dhi customization
plink: docker_dhi_customization.yaml
inherited_options:
- option: org
value_type: string
description: Docker Hub organization (overrides config)
deprecated: false
hidden: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false
hidden: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false

View File

@@ -0,0 +1,35 @@
command: docker dhi customization get
short: Get details of a specific customization
long: |
Get detailed information about a Docker Hardened Images customization by repository and name. Outputs YAML to stdout by default, or to file if --output is specified.
usage: docker dhi customization get <repository> <name>
pname: docker dhi customization
plink: docker_dhi_customization.yaml
options:
- option: output
shorthand: o
value_type: string
description: Output file path (if not specified, outputs to stdout)
deprecated: false
hidden: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
inherited_options:
- option: org
value_type: string
description: Docker Hub organization (overrides config)
deprecated: false
hidden: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false
hidden: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false

View File

@@ -0,0 +1,64 @@
command: docker dhi customization list
short: List all customizations
long: List all Docker Hardened Images customizations
usage: docker dhi customization list
pname: docker dhi customization
plink: docker_dhi_customization.yaml
options:
- option: filter
shorthand: f
value_type: string
description: Filter by customization name (case-insensitive substring match)
deprecated: false
hidden: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: json
value_type: bool
default_value: "false"
description: Output in JSON format
deprecated: false
hidden: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: repo
shorthand: r
value_type: string
description: |
Filter by destination repository (case-insensitive substring match)
deprecated: false
hidden: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: source
value_type: string
description: Filter by DHI source repository (case-insensitive substring match)
deprecated: false
hidden: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
inherited_options:
- option: org
value_type: string
description: Docker Hub organization (overrides config)
deprecated: false
hidden: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false
hidden: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false

View File

@@ -0,0 +1,72 @@
command: docker dhi customization prepare
short: Prepare a new customization YAML file from a DHI base image tag
long: |-
Prepare a new customization YAML file by fetching tag details from a Docker Hardened Images repository.
This creates a scaffold YAML file that can be used with the create command.
The repository argument must be a DHI source repository name, not a mirrored destination repository.
Supported formats:
- golang
- dhi/golang
- dhi.io/golang
usage: docker dhi customization prepare <dhi-repository> <tag>
pname: docker dhi customization
plink: docker_dhi_customization.yaml
options:
- option: destination
shorthand: d
value_type: string
description: Destination repository (e.g. myorg/dhi-golang)
deprecated: false
hidden: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: name
shorthand: "n"
value_type: string
description: Name for the customization
deprecated: false
hidden: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: output
shorthand: o
value_type: string
description: Output file path (if not specified, outputs to stdout)
deprecated: false
hidden: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: tag-suffix
shorthand: t
value_type: string
description: Tag suffix for the customized image
deprecated: false
hidden: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
inherited_options:
- option: org
value_type: string
description: Docker Hub organization (overrides config)
deprecated: false
hidden: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false
hidden: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false

View File

@@ -0,0 +1,30 @@
command: docker dhi mirror
short: Mirror Docker Hardened Images to your organization
long: Commands to mirror Docker Hardened Images to your organization's registry
pname: docker dhi
plink: docker_dhi.yaml
cname:
- docker dhi mirror list
- docker dhi mirror start
- docker dhi mirror stop
clink:
- docker_dhi_mirror_list.yaml
- docker_dhi_mirror_start.yaml
- docker_dhi_mirror_stop.yaml
options:
- option: org
value_type: string
description: Docker Hub organization (overrides config)
deprecated: false
hidden: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false
hidden: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false

View File

@@ -0,0 +1,72 @@
command: docker dhi mirror list
short: List all mirrored Docker Hardened Images
long: |-
List all Docker Hardened Images currently being mirrored to your organization's registry.
Shows the source repositories, destination repositories, and mirroring status.
Examples:
# List all mirrored repositories
dhictl mirror list --org myorg
# List only image repositories
dhictl mirror list --org myorg --type image
# List only helm chart repositories
dhictl mirror list --org myorg --type helm-chart
# Search for a specific repository by name
dhictl mirror list --org myorg --filter dhi-python
# Output in JSON format
dhictl mirror list --org myorg --json
usage: docker dhi mirror list
pname: docker dhi mirror
plink: docker_dhi_mirror.yaml
options:
- option: filter
shorthand: f
value_type: string
description: Filter by repository name (partial match)
deprecated: false
hidden: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: json
value_type: bool
default_value: "false"
description: Output in JSON format
deprecated: false
hidden: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: type
value_type: string
description: Filter by repository type (image or helm-chart)
deprecated: false
hidden: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
inherited_options:
- option: org
value_type: string
description: Docker Hub organization (overrides config)
deprecated: false
hidden: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false
hidden: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false

View File

@@ -0,0 +1,77 @@
command: docker dhi mirror start
short: Start mirroring Docker Hardened Images
long: |-
Start mirroring one or more Docker Hardened Images to your organization's registry.
Repository mappings are specified using the -r flag. The following formats are supported:
source Only the source repository; destination is auto-generated as
<org>/dhi-<source-name>
source,destination Source and destination; namespaces are filled from config if omitted
ns/source,ns/dest Fully qualified source and destination
The source namespace defaults to "dhi" when not specified.
The destination namespace defaults to the configured organization (--org or config).
Examples:
# These are all equivalent (assuming --org myorg):
dhictl mirror start --org myorg -r dhi/golang,myorg/dhi-golang
dhictl mirror start --org myorg -r golang,dhi-golang
dhictl mirror start --org myorg -r golang
# Mirror multiple repositories
dhictl mirror start --org myorg -r golang -r python
usage: docker dhi mirror start
pname: docker dhi mirror
plink: docker_dhi_mirror.yaml
options:
- option: dependencies
shorthand: d
value_type: bool
default_value: "false"
description: Mirrors any existing dependencies
deprecated: false
hidden: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: json
value_type: bool
default_value: "false"
description: Output in JSON format
deprecated: false
hidden: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: repo
shorthand: r
value_type: stringArray
default_value: '[]'
description: |
Repository mapping in format source,destination (can be specified multiple times)
deprecated: false
hidden: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
inherited_options:
- option: org
value_type: string
description: Docker Hub organization (overrides config)
deprecated: false
hidden: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false
hidden: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false

View File

@@ -0,0 +1,49 @@
command: docker dhi mirror stop
short: Stop mirroring a Docker Hardened Image
long: |-
Stop mirroring a Docker Hardened Image repository.
The repository can be specified as:
- Just the repository name (e.g., dhi-python) - uses --org flag or config
- Full path with org (e.g., myorg/dhi-python) - org must match --org flag or config
Examples:
# Stop mirroring using --org flag
dhictl mirror stop dhi-python --org myorg
# Stop mirroring with full path (org must match)
dhictl mirror stop myorg/dhi-python --org myorg
# Stop mirroring and delete the repository
dhictl mirror stop dhi-python --org myorg --delete
usage: docker dhi mirror stop <repository>
pname: docker dhi mirror
plink: docker_dhi_mirror.yaml
options:
- option: delete
value_type: bool
default_value: "false"
description: Delete the repository after stopping mirroring
deprecated: false
hidden: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
inherited_options:
- option: org
value_type: string
description: Docker Hub organization (overrides config)
deprecated: false
hidden: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false
hidden: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false

View File

@@ -172,7 +172,7 @@ Docker Desktop CLI kubernetes:
Docker Desktop CLI diagnose:
requires: Docker Desktop 4.60 and later
Docker Hardened Images:
subscription: [Docker Hardened Images Enterprise]
subscription: [Docker Hardened Images Select or Enterprise]
Docker Init:
requires: Docker Desktop [4.27](/manuals/desktop/release-notes.md#4270) and later
Docker Model Runner: