supports a range of CAS versions, and it
can upgrade independently of IBM Fusion HCI within a certain range. In 2.10.0, the supported CAS version range is any version < v1.1.0.
You can run this procedure multiple times to upgrade to each newer version of CAS within the supported range.
About this task
High level steps to mirror
CAS service:
- Log in to the relevant Docker registries
- Define variables to configure and mirror the CAS component of IBM Fusion HCI.
- Run the
ibm-pak
configuration tool to automatically generate the files needed
by the oc-mirror
CLI tool.
- Run the
oc-mirror
CLI tool to mirror the CAS components.
Note:
- Use this procedure when you want to upgrade your offline CAS installation to a newer version, without
having to upgrade the IBM Fusion installation.
- If you choose to mirror specific sub-components, use the same TARGET_PATH variable so that all
the components mirror into the same location, and the generated
ImageDigestMirrorSet
remains the same across all components.
- For more information about Air gap setup for network restricted Red Hat®
OpenShift® Container Platform clusters, see Offline setup for network restricted Red Hat OpenShift Container
Platform clusters.
Procedure
-
Log in to your Docker registry:
- Run the following command to login to the Docker registry with your Red Hat enterprise credentials:
docker login registry.redhat.io -u <Red Hat enterprise registry username> -p <Red Hat enterprise registry password>
- Log in to the IBM Entitled Container Registry using the IBM entitlement key.
docker login cp.icr.io -u cp -p <your entitlement key>
Note: Ensure that your entitlement key for IBM Fusion HCI contains the correct
entitlement.
- Set the following environment variables:
export LOCAL_ISF_REGISTRY="<Your enterprise registry host>:<port>"
export LOCAL_ISF_REPOSITORY="<Your image path>"
export TARGET_PATH="$LOCAL_ISF_REGISTRY/$LOCAL_ISF_REPOSITORY"
echo "$TARGET_PATH"
export CASE_NAME=ibm-cas
export CASE_VERSION=1.0.2
Note: Port is a non-mandatory value when setting the LOCAL_ISF_REGISTRY
variable.
You can ignore this if your enterprise registry is accessible and has a secure connection.
Sample value without
port:
export LOCAL_ISF_REGISTRY="registryhost.com"
export LOCAL_ISF_REGISTRY="registryhost.com:443"
export LOCAL_ISF_REPOSITORY="fusion-mirror"
- Run the command to login to the Docker registry with your enterprise registry
credentials.
docker login $LOCAL_ISF_REGISTRY -u <your enterprise registry username> -p <your enterprise registry password>
LOCAL_ISF_REGISTRY
is your entitlement registry.
LOCAL_ISF_REPOSITORY
is the image path in which you want to mirror the images.
You can choose your own repository paths. For example, hci-2.10.0/isf or hci-2.10.0.
- Configure the
ibm-pak
plugin to use the oc-mirror
command:
oc ibm-pak config mirror-tools -e oc-mirror
- From the mirroring host, run the get command to download the mirroring metadata from
IBM’s public
CloudPak
repository:
oc ibm-pak get --version "${CASE_VERSION}" "${CASE_NAME}"
- Run the ibm-pak generate command to generate the
oc
mirror
configuration files specific to your environment:
oc ibm-pak generate mirror-manifests --version "${CASE_VERSION}" "${CASE_NAME}" "${TARGET_PATH}"
An example output of a successfully completed
generate
command:
...
- To mirror the non curated catalog:
oc mirror --config /root/.ibm-pak/data/mirror/${CASE_NAME}/${CASE_VERSION}/image-set-config.yaml docker://${TARGET_PATH}
- Run the oc mirror command for the “non curated catalog” provided in
the output of the generate
command.
Example:
oc mirror --config /root/.ibm-pak/data/mirror/${CASE_NAME}/${CASE_VERSION}/image-set-config.yaml docker://${TARGET_PATH}
- Go to the directory that contains the image-set-config.yaml file
that is referenced in the
oc-mirror
command:
cd /root/.ibm-pak/data/mirror/${CASE_NAME}/${CASE_VERSION}/
This directory contains several files that were automatically generated by the
ibm-pak
tool.
- Apply the
ImageDigestMirrorSet
file to your
cluster: oc apply -f image-digest-mirror-set.yaml
oc apply -f catalog-sources-linux-amd64.yaml
Note: After applying the catalog source
catalog-sources-linux-amd64.yaml
, it gets deleted automatically and it recreates
once CAS is deployed.
For the
offline upgrade to work, it is required to apply the CatalogSource file generated by
ibm-pak.
There is no need to apply the generated
catalog-source.yaml file in
this directory as Fusion applies the CatalogSource for
CAS.