Obtaining the olm-utils-v3 image before running IBM Software Hub installation commands in a restricted network

If your cluster is in a restricted network, you must ensure that a supported version of the olm-utils-v3 image is on the client workstation from which you will run the installation commands. The latest version of the image is recommended.

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 not here. Preparing to run installs in a restricted network
  • You are here icon. 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?

In a restricted network, you must ensure that you have the olm-utils-v3 image on your client workstation.

You have the following choices for completing this task:

  • One-time setup If you plan to mirror the IBM Software Hub software images to a private container registry, the registry administrator can complete this task before they mirror the images. Then, other users can pull the image from the private container registry.
  • Repeat as needed If you plan to pull the images from the IBM Entitled Registry, complete this task on each workstation that will be used to perform installation tasks.

Procedure

The steps that you complete depend on whether you plan to use the same workstation in the cluster network:

You plan to use the same workstation inside the cluster network
  1. When the workstation is connected to the internet, run the following command to update the olm-utils-v3 image on the workstation:
    cpd-cli manage restart-container

    Wait for the cpd-cli to return the following messages:

    [SUCCESS] ... Successfully pulled the container image icr.io/cpopen/cpd/olm-utils-v3:latest
[SUCCESS] ... Successfully started the container olm-utils-play
[SUCCESS] ... Container olm-utils-play has been re-created
You plan to use a different workstation inside the cluster network
Before you begin

You must have the cpd-cli installed on a workstation in the cluster network

  1. From a workstation that can connect to the internet:
    1. Ensure that Docker or Podman is running on the workstation.
    2. Run the following command to save the olm-utils-v3 image to the client workstation:
      x86-64 clusters
      cpd-cli manage save-image \
--from=icr.io/cpopen/cpd/olm-utils-v3:${VERSION}.amd64

      This command saves the image as a compressed TAR file named icr.io_cpd_olm-utils-v3_${VERSION}.amd64.tar.gz in the cpd-cli-workspace/olm-utils-workspace/work/offline directory.

      ppc64le clusters
      cpd-cli manage save-image \
--from=icr.io/cpopen/cpd/olm-utils-v3:${VERSION}.ppc64le

      This command saves the image as a compressed TAR file named icr.io_cpopen_cpd_olm-utils-v3_${VERSION}.ppc64le.tar.gz in the cpd-cli-workspace/olm-utils-workspace/work/offline directory.

      s390x clusters
      cpd-cli manage save-image \
--from=icr.io/cpopen/cpd/olm-utils-v3:${VERSION}.s390x

      This command saves the image as a compressed TAR file named icr.io_cpopen_cpd_olm-utils-v3_${VERSION}.s390x.tar.gz in the cpd-cli-workspace/olm-utils-workspace/work/offline directory.

  2. Transfer the compressed file to a client workstation that can connect to the cluster.

    Ensure that you place the TAR file in the work/offline directory:

    x86-64 clusters
    icr.io_cpd_olm-utils-v3_${VERSION}.amd64.tar.gz
    ppc64le clusters
    icr.io_cpopen_cpd_olm-utils-v3_${VERSION}.ppc64le.tar.gz
    s390x clusters
    icr.io_cpopen_cpd_olm-utils-v3_${VERSION}.s390x.tar.gz
  3. From the workstation that can connect to the cluster:
    1. Ensure that Docker or Podman is running on the workstation.
    2. Run the following command to load the olm-utils-v3 image on the client workstation:
      x86-64 clusters
      cpd-cli manage load-image \
--source-image=icr.io/cpopen/cpd/olm-utils-v3:${VERSION}.amd64

      The command returns the following message when the image is loaded:

      Loaded image: icr.io/cpopen/cpd/olm-utils:latest
      ppc64le clusters
      cpd-cli manage load-image \
--source-image=icr.io/cpopen/cpd/olm-utils-v3:${VERSION}.ppc64le

      The command returns the following message when the image is loaded:

      Loaded image: icr.io/cpopen/cpd/olm-utils:latest.ppc64le
      s390x clusters
      cpd-cli manage load-image \
--source-image=icr.io/cpopen/cpd/olm-utils-v3:${VERSION}.s390x

      The command returns the following message when the image is loaded:

      Loaded image: icr.io/cpopen/cpd/olm-utils:latest.s390x
    3. Set the OLM_UTILS_IMAGE environment variable to ensure that the cpd-cli uses the version of the image on the client workstation:
      x86-64 clusters
      export OLM_UTILS_IMAGE=icr.io/cpopen/cpd/olm-utils-v3:${VERSION}.amd64
      ppc64le clusters
      export OLM_UTILS_IMAGE=icr.io/cpopen/cpd/olm-utils-v3:${VERSION}.ppc64le
      s390x clusters
      export OLM_UTILS_IMAGE=icr.io/cpopen/cpd/olm-utils-v3:${VERSION}.s390x

What to do next

Now that you've made the olm-utils-v3 image available on the client workstation, you're ready to complete Downloading CASE packages before running IBM Software Hub installation commands in a restricted network.