manage case-download

Download CASE packages to a client workstation.

Extended description

If your Red Hat® OpenShift® Container Platform cluster is in a restricted network, you must have the CASE packages for the components that you plan to install on the client workstation from which you will run the installation and upgrade commands.

If you mirror the images to a private container registry and use the same workstation to complete all installation and upgrade tasks, the CASE packages are already on the client workstation.

However, if different users complete installation and upgrade tasks from different workstations, each user can use the case-download command to ensure that they have the CASE packages on their workstation.

Syntax

cpd-cli manage case-download \
--components=<comma-separated-list-of-component-names> \
--release=<version> \
[--from_oci=true|false] \
[--oci_location=<registry-URL>]

Arguments

The case-download command has no arguments.

Options

Table 1: Command options
Option Description
--components A comma-separated list of the components for which you want to mirror 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 for which you want to mirror images.
Valid values
For the list of components, see Component IDs.

You can specify individual components or a comma-separated list of components.
--from_oci Download CASE packages from the IBM Cloud Pak® Open Container Initiative (OCI) registry rather than from GitHub.

This option is recommended for environments that are not allowed to access GitHub (github.com).

Restriction: This setting applies only if you set --case_download=true.
Status
Optional.
Syntax
--from_oci=true|false
Default value
false

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

Valid values
false
Download the CASE packages from GitHub.
true
Download the CASE packages from the IBM Cloud Pak Open Container Initiative.
--oci_location The URL of the Open Container Initiative (OCI) registry from which you want to download CASE packages. For example, specify this option if you want to download the CASE packages from a private OCI registry.
Restriction: This setting applies only if you set --from_oci=true.
Status
Optional.
Syntax
--oci_location=<registry-URL>
Default value
cp.icr.io/cpopen

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

Valid values
The URL of the Open Container Initiative (OCI) registry from which you want to download CASE packages.
--release The release for which you want to mirror images.
Status
Required.
Syntax
--release=<version>
Default value
No default. You must specify the release.
Valid values
  • 5.2.0
  • 5.2.1
  • 5.2.2

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 more information, see Setting up installation environment variables.

Download the CASE packages from GitHub
cpd-cli manage case-download \
--components=${COMPONENTS} \
--release=${VERSION}
Download the CASE packages from the IBM Cloud Pak Open Container Initiative
cpd-cli manage case-download \
--components=${COMPONENTS} \
--release=${VERSION} \
--from_oci=true