Mirroring Content-Aware Storage (CAS) images

IBM Fusion supports a range of CAS versions, and it can upgrade independently of IBM Fusion within a certain range. In IBM Fusion 2.12.1, the supported CAS version range is any version < v1.1.2. You can run this procedure multiple times to upgrade to each newer version of CAS within the supported range.

1. Log in to your Docker registry:
   1. 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>

   2. 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 contains the correct entitlement.
   3. 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.1.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"

   4. 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, sds-images/isf or sds-images.

2. Configure the ibm-pak plugin to use the oc-mirror command:

   oc ibm-pak config mirror-tools -e oc-mirror

3. 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}"

4. 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}
   
   

5. 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}

6. 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.

7. 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.