Downloading CASE packages before running IBM Software Hub installation commands in a restricted network

If you will run the IBM Software Hub installation commands 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 commands.

Installation phase
  • You are not here. Setting up a client workstation
  • You are not here. Setting up a cluster
  • You are not here. Collecting required information
  • You are here icon. Preparing to run installs in a restricted network
  • You are not here. Preparing to run installs from a private container registry
  • You are not here. Preparing the cluster for IBM Software Hub
  • You are not here. Preparing to install an instance of IBM Software Hub
  • You are not here. Installing an instance of IBM Software Hub
  • You are not here. Setting up the control plane
  • You are not here. Installing solutions and services
Who needs to complete this task?

All administrators Cluster administrators, registry administrators, and instance administrators must complete this task.

When do you need to complete this task?

Repeat as needed Complete this task on each workstation that will be used to complete one or more of the preceding tasks.

Alternatively, you can complete this task once and transfer the CASE packages to each workstation from which you will complete installation tasks.

Before you begin

Best practice: You can run the commands in this task exactly as written if you set up environment variables. For instructions, see Setting up installation environment variables.

Ensure that you source the environment variables before you run the commands in this task.

About this task

You can download the CASE packages from either of the following locations:
  • GitHub (github.com)
  • IBM Cloud Pak Open Container Initiative (icr.io)
Important: The client workstation must be able to access the site from which you plan to download the CASE packages.

Procedure

To prepare to run installs in a restricted network:

  1. Download the CASE packages for the components that you plan to install.
    Run the appropriate command depending on the site from which you plan to download the CASE packages:
    GitHub
    cpd-cli manage case-download \
    --components=${COMPONENTS} \
    --release=${VERSION} \
    --patch_id=${PATCH_ID}

    IBM Cloud Pak Open Container Initiative
    cpd-cli manage case-download \
    --components=${COMPONENTS} \
    --release=${VERSION} \
    --patch_id=${PATCH_ID} \
    --from_oci=true

  2. watsonx Assistant and watsonx Orchestrate users only. Download the CASE package for the ibm_events_operator component.
    Run the appropriate command depending on the site from which you plan to download the CASE packages:
    GitHub
    cpd-cli manage case-download \
    --components=ibm_events_operator \
    --release=${VERSION} \
    --patch_id=${PATCH_ID}

    IBM Cloud Pak Open Container Initiative
    cpd-cli manage case-download \
    --components=ibm_events_operator \
    --release=${VERSION} \
    --patch_id=${PATCH_ID} \
    --from_oci=true

  3. IBM Software Hub Control Center users only. Download the CASE package for the ibm_swhcc component.
    Run the appropriate command depending on the site from which you plan to download the CASE packages:
    GitHub
    cpd-cli manage case-download \
    --components=ibm_swhcc \
    --release=${VERSION} \
    --patch_id=${PATCH_ID}

    IBM Cloud Pak Open Container Initiative
    cpd-cli manage case-download \
    --components=ibm_swhcc \
    --release=${VERSION} \
    --patch_id=${PATCH_ID} \
    --from_oci=true

Results

The CASE packages for the specified components are downloaded to the work directory.
Important: If you transfer the CASE packages to other workstations, ensure that you complete the following steps on each workstation:
  1. Change to the directory that contains the work directory.
  2. Set the following permissions on the work directory:
    chown -R 1001 ./work
    chmod -R 775 ./work
  3. Restart the container:
    cpd-cli manage restart-container

What to do next

Now that you've downloaded the CASE packages to your client workstation, you're ready to complete Preparing to run IBM Software Hub installs from a private container registry.