Updating the olm-utils
image
in the private container registry (Upgrading from Version 4.6.x to a later 4.6 refresh)
If you need to run cpd-cli
manage
commands against a cluster in a restricted network, you must make
the cpd-cli
and the olm-utils
image available inside the cluster network. If you mirrored the olm-utils
image to the private container registry, you must mirror the
latest version of the image to the private container registry before you upgrade.
If you want to make the olm-utils
image available to a single workstation inside
the cluster network, follow Updating the olm-utils image on a single client workstation (Upgrading from Version 4.6.x to a later 4.6 refresh) instead.
- Upgrade phase
- Setting up a client workstation
- Who needs to complete this task?
- A user who has permissions to push images to the private container registry must complete this task.
- When do you need to complete this task?
- You must complete this task before you move the client workstation inside the cluster network.
Before you begin
Ensure that you source the environment variables before you run the commands in this task. For details, see Sourcing the environment variables.
Procedure
The steps that you must complete depend on whether the workstation can connect to both the internet and the private container registry at the same time:
The workstation can connect to the internet and to the private container registry
- Ensure that Docker or Podman is running on the workstation.
- Log in to the private container registry.
The following command assumes that you are using private container registry that is secured with credentials:
cpd-cli manage login-private-registry \ ${PRIVATE_REGISTRY_LOCATION} \ ${PRIVATE_REGISTRY_PUSH_USER} \ ${PRIVATE_REGISTRY_PUSH_PASSWORD}
If your private registry is not secured, see
cpd-cli manage login-private-registry
for additional options. - Run the following command to copy the
olm-utils
image from the IBM® Entitled Registry to the private container registry:- x86-64 clusters
-
cpd-cli manage copy-image \ --from=icr.io/cpopen/cpd/olm-utils:latest \ --to=${PRIVATE_REGISTRY_LOCATION}/cpd/olm-utils:latest
- s390x clusters
-
cpd-cli manage copy-image \ --from=icr.io/cpopen/cpd/olm-utils:latest.s390x \ --to=${PRIVATE_REGISTRY_LOCATION}/cpd/olm-utils:latest.s390x
The workstation cannot connect to the private container registry at the same time
- From a workstation that can connect to the internet:
- Ensure that Docker or Podman is running on the workstation.
- Run the following command to save the
olm-utils
image to the client workstation:- x86-64 clusters
-
cpd-cli manage save-image \ --from=icr.io/cpopen/cpd/olm-utils:latest
This command saves the image as a compressed TAR file named
icr.io_cpopen_cpd_olm-utils_latest.tar.gz
in thecpd-cli-workspace/olm-utils-workspace/work/offline
directory. - s390x clusters
-
cpd-cli manage save-image \ --from=icr.io/cpopen/cpd/olm-utils:latest.s390x
This command saves the image as a compressed TAR file named
icr.io_cpopen_cpd_olm-utils_latest.s390x.tar.gz
in thecpd-cli-workspace/olm-utils-workspace/work/offline
directory.
- Transfer the compressed file to a client workstation that can connect to
the cluster.
Ensure that you place the TAR file in the
cpd-cli-workspace/olm-utils-workspace/work/offline
directory:- x86-64 clusters
icr.io_cpopen_cpd_olm-utils_latest.tar.gz
- s390x clusters
icr.io_cpopen_cpd_olm-utils_latest.s390x.tar.gz
- From the workstation that can connect to the cluster:
- Ensure that Docker or Podman is running on the workstation.
- Run the following command to load the
olm-utils
image on the client workstation:- x86-64 clusters
-
cpd-cli manage load-image \ --source-image=icr.io/cpopen/cpd/olm-utils:latest
The command returns the following message when the image is loaded:
Loaded image: icr.io/cpopen/cpd/olm-utils:latest
- s390x clusters
-
cpd-cli manage load-image \ --source-image=icr.io/cpopen/cpd/olm-utils:latest.s390x
The command returns the following message when the image is loaded:
Loaded image: icr.io/cpopen/cpd/olm-utils:latest.s390x
- Log in to the private container registry.
The following command assumes that you are using private container registry that is secured with credentials:
cpd-cli manage login-private-registry \ ${PRIVATE_REGISTRY_LOCATION} \ ${PRIVATE_REGISTRY_PUSH_USER} \ ${PRIVATE_REGISTRY_PUSH_PASSWORD}
If your private registry is not secured, see
cpd-cli manage login-private-registry
for additional options. - Run the following command to copy the
olm-utils
image to the private container registry:- x86-64 clusters
-
cpd-cli manage copy-image \ --from=icr.io/cpopen/cpd/olm-utils:latest \ --to=${PRIVATE_REGISTRY_LOCATION}/cpd/olm-utils:latest
- s390x clusters
-
cpd-cli manage copy-image \ --from=icr.io/cpopen/cpd/olm-utils:latest.s390x \ --to=${PRIVATE_REGISTRY_LOCATION}/cpd/olm-utils:latest.s390x
What to do next
After you push the olm-utils
image to the private
container registry, users who want to run cpd-cli
manage
commands against the cluster must complete Pulling the olm-utils
image
from the private container registry.