manage list-images

Get the list of images that are associated with the specified components.

Extended description

Use the list-images command to:

  • Ensure you have access to the images you want to install
  • Itemize the images that will be mirrored to a private container registry
  • Inspect the contents of a private container registry

If your cluster is in a restricted network, you must download the CASE packages before you inspect the contents of the private container registry.

The output is saved to the list_images.csv file in the work/offline/${VERSION} directory.

Syntax

cpd-cli manage list-images \
--release=<version> \
--components=<comma-separated-list-of-component-names> \
[--case_download=true|false] \
[--inspect_source_registry=true|false] \
[--target_registry=<registry-URL>]

Arguments

The list-images command has no arguments.

Options

Table 1: Command options
Option Description
--case_download Specify whether to download the CASE packages for the specified components if they are not detected in the work directory.
Important: The command will fail if the CASE packages are not in the work directory.
Default location
  • If you made the cpd-cli executable from any directory, the path to the directory is:

    <current-directory>/cpd-cli-workspace/olm-utils-workspace/work

  • If you did not make the cpd-cli executable from any directory, the path to the directory is:

    <cli-install-directory>/cpd-cli-workspace/olm-utils-workspace/work

Custom location
If you set the CPD_CLI_MANAGE_WORKSPACE environment variable, path to the directory is:

${CPD_CLI_MANAGE_WORKSPACE}/work

Status
Optional.
Syntax
--case_download=true|false
Default value
true

If you omit this option, the default value is used.

Valid values
false
Specify false if you are running the commands in a restricted network where the download will fail.

If you specify false and the CASE packages are not in the work directory, the command will fail.

true
Specify true to download the CASE packages.

If you are not allowed to download the CASE packages from GitHub, ensure that you set --from_oci=true.
--components A comma-separated list of the components for which you want to see the associated images.
Status
Required.
Syntax
--components=<comma-separated-list-of-component-names>
Default value
There is no default value. The list depends on which components you want to get more information about.
Valid values
For the list of components, see Component IDs.

You can specify individual components or a comma-separated list of components.
--inspect_source_registry Specify whether you want to confirm that the images for the specified components are accessible from the IBM® Entitled Registry.
Status
Optional.
Syntax
--inspect_source_registry=true|false
Default value
false

If you omit this option, the default value is used.

Valid values
false
Do not confirm that you can access the images from the IBM Entitled Registry.
true
Confirm that you can access the images from the IBM Entitled Registry.
Important: Before you run the command with this option:
--release The release that you want to install or upgrade to.
Status
Required.
Syntax
--release=<version>
Default value
No default. You must specify the release.
Valid values
  • 5.0.0
  • 5.0.1
  • 5.0.2
  • 5.0.3
--target_registry The URL of the target registry.

Specify this option if you want to confirm that the images for the specified components were mirrored to the registry.

Status
Optional.
Syntax
--target_registry=<registry-URL>
Default value
No default.
Valid values
Specify the URL of the registry, either:
  • The URL of the private container registry.
  • The URL of the intermediary container registry: 127.0.0.1:12443.

Examples

Note: The following example uses the recommended installation environment variables.

It is strongly recommended that you use a script to create environment variables with the correct values for your environment. For details, see Setting up installation environment variables.

List the images that will be mirrored for the specified components
cpd-cli manage list-images \
--components=${COMPONENTS} \
--release=${VERSION}
Ensure that you have access to the images in the IBM Entitled Registry for the specified components
Remember: Before you run the command:
  • Ensure that the client is connected to the internet.
  • Run the login-entitled-registry command.
cpd-cli manage list-images \
--components=${COMPONENTS} \
--release=${VERSION} \
--inspect_source_registry=true
List the images that will be mirrored to the intermediary container registry
cpd-cli manage list-images \
--components=${COMPONENTS} \
--release=${VERSION} \
--target_registry=127.0.0.1:12443
Inspect the images that were mirrored to the private container registry
cpd-cli manage list-images \
--components=${COMPONENTS} \
--release=${VERSION} \
--target_registry=${PRIVATE_REGISTRY_LOCATION} \
--case_download=false