Upgrading IBM Knowledge Catalog from Version 5.3 to Version 5.4

Information you need to complete this task

Review the following information before you upgrade IBM Knowledge Catalog:

Version requirements

All the components that are associated with an instance of IBM Software Hub must be installed at the same release. For example, if the IBM Software Hub control plane is at Version 5.4.0, you must upgrade IBM Knowledge Catalog to Version 5.4.0.

Environment variables

The commands in this task use environment variables so that you can run the commands exactly as written.

• If you don't have the script that defines the environment variables, see Setting up installation environment variables.
• To use the environment variables from the script, you must source the environment variables before you run the commands in this task. For example, run:

  source ./cpd_vars.sh

Common core services

IBM Knowledge Catalog requires the IBM Software Hub common core services.

If the common core services are not at the correct version in the operands project for the instance, the common core services are automatically upgraded when you upgrade IBM Knowledge Catalog. The common core services upgrade increases the amount of time the upgrade takes to complete.

Before you begin

This task assumes that the following prerequisites are met:

System requirements

This task assumes that the cluster meets the minimum requirements for IBM Knowledge Catalog.

Where to find more information
If this task is not complete, see System requirements.

In addition, if you plan to use features that require GPU, ensure that you have the appropriate type and number of GPU for IBM Knowledge Catalog.

Where to find more information
If this task is not complete, see GPU requirements.

Workstation

This task assumes that the workstation from which you will run the upgrade is set up as a client workstation and has the following command-line interfaces:

• IBM Software Hub CLI: cpd-cli
• OpenShift® CLI: oc
• Helm CLI: helm

Where to find more information
If this task is not complete, see Updating client workstations.

Control plane

This task assumes that the IBM Software Hub control plane is upgraded.

Where to find more information
If this task is not complete, see Upgrading an instance of IBM Software Hub.

Private container registry

If your environment uses a private container registry (for example, your cluster is air-gapped), this task assumes that the following tasks are complete:

1. The IBM Knowledge Catalog software images are mirrored to the private container registry.

   Where to find more information
   If this task is not complete, see Mirroring images to a private container registry.

2. The cpd-cli is configured to pull the olm-utils-v4 image from the private container registry.

   Where to find more information
   If this task is not complete, see Pulling the olm-utils-v4 image from the private container registry.

GPU operators

If you plan to use features that require GPUs, this task assumes that the operators required to use GPUs are installed.

Where to find more information
If this task is not complete, see Installing operators for services that require GPUs.

Red Hat® OpenShift AI

If you plan to use features that require Red Hat OpenShift AI, this task assumes that Red Hat OpenShift AI is installed.

Where to find more information
If this task is not complete, see Installing Red Hat OpenShift AI.

Cluster-scoped resources

This task assumes that the cluster-scoped resources, such as custom resource definitions, cluster roles, and cluster role bindings, were updated.

Where to find more information
If this task is not complete, see Updating the cluster-scoped resources for the platform and services.

Procedure

Complete the following tasks to upgrade IBM Knowledge Catalog:

1. Specifying your IBM Knowledge Catalog edition
2. Specifying installation options
3. Reverting temporary patches
4. Upgrading the service
5. Validating the upgrade
6. What to do next

Specifying your IBM Knowledge Catalog edition

You must specify which edition to you want to upgrade.

Set the IKC_TYPE environment variable to the edition of IBM Knowledge Catalog that you want to upgrade:

IBM Knowledge Catalog

export IKC_TYPE=wkc

IBM Knowledge Catalog Premium

export IKC_TYPE=ikc_premium

IBM Knowledge Catalog Standard

export IKC_TYPE=ikc_standard

Specifying installation options

When you upgrade IBM Knowledge Catalog, the options that you specified when you installed IBM Knowledge Catalog are used.

Specify the following options in the install-options.yml file in the cpd-cli work directory (For example: cpd-cli-workspace/olm-utils-workspace/work) only if you want to modify the behavior of IBM Knowledge Catalog.

IBM Knowledge Catalog

The sample YAML content uses the default values.

Retain the --- syntax at the beginning of the entry to ensure that this entry is treated as a separate document.

---
# ............................................................................
# IBM Knowledge Catalog parameters
# ............................................................................
non_olm:
  wkc:
    enableDataQuality: False
    enableKnowledgeGraph: False
    useFDB: False

IBM Knowledge Catalog Premium

The sample YAML content uses the default values.

Retain the --- syntax at the beginning of the entry to ensure that this entry is treated as a separate document.

---
# ............................................................................
# IBM Knowledge Catalog Premium parameters
# ............................................................................
non_olm:
  ikcPremium:
    enableDataQuality: False
    enableKnowledgeGraph: False
    useFDB: False
    enableAISearch: False
    enableSemanticAutomation: False
    enableSemanticEnrichment: True
    enableSemanticEmbedding: False
    enableTextToSql: False
    enableModelsOn: 'cpu'

IBM Knowledge Catalog Standard

The sample YAML content uses the default values.

Retain the --- syntax at the beginning of the entry to ensure that this entry is treated as a separate document.

---
# ............................................................................
# IBM Knowledge Catalog Standard parameters
# ............................................................................
non_olm:
  ikcStandard:
    enableKnowledgeGraph: False
    useFDB: False
    enableAISearch: False
    enableSemanticAutomation: False
    enableSemanticEnrichment: True
    enableSemanticEmbedding: False
    enableTextToSql: False
    enableModelsOn: 'cpu'

Reverting temporary patches

If you applied any patches to your current installation of IBM Knowledge Catalog, check the patch instructions for cleanup steps and complete these before you start the upgrade. The patch instructions will contain cleanup instructions similar to the ones in this example: Installing the patch for version 5.0.3 in the IBM Cloud Pak® for Data 5.0 documentation.

Upgrading the service

To upgrade IBM Knowledge Catalog:

1. Log the cpd-cli in to the Red Hat OpenShift Container Platform cluster:

   ${CPDM_OC_LOGIN}

   Remember: CPDM_OC_LOGIN is an alias for the cpd-cli manage login-to-ocp command.
2. Update the operator and custom resource for IBM Knowledge Catalog.

   Run the appropriate command to create the custom resource.

   Default installation (without installation options)

   cpd-cli manage install-components \
   --license_acceptance=true \
   --components=${IKC_TYPE} \
   --release=${VERSION} \
   --patch_id=${PATCH_ID} \
   --operator_ns=${PROJECT_CPD_INST_OPERATORS} \
   --instance_ns=${PROJECT_CPD_INST_OPERANDS} \
   --image_pull_prefix=${IMAGE_PULL_PREFIX} \
   --image_pull_secret=${IMAGE_PULL_SECRET} \
   --upgrade=true

   Custom installation (with installation options)

   cpd-cli manage install-components \
   --license_acceptance=true \
   --components=${IKC_TYPE} \
   --release=${VERSION} \
   --patch_id=${PATCH_ID} \
   --operator_ns=${PROJECT_CPD_INST_OPERATORS} \
   --instance_ns=${PROJECT_CPD_INST_OPERANDS} \
   --image_pull_prefix=${IMAGE_PULL_PREFIX} \
   --image_pull_secret=${IMAGE_PULL_SECRET} \
   --param-file=/tmp/work/install-options.yml \
   --upgrade=true

Validating the upgrade

[SUCCESS]... The install-components command ran successfully

If you want to confirm that the custom resource status is Completed, you can run the cpd-cli manage get-cr-status command:

cpd-cli manage get-cr-status \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--components=${IKC_TYPE}

What to do next

You must complete the following tasks before users can access the service:

1. The Analytics Engine powered by Apache Spark service is also upgraded automatically, but the instance for Analytics Engine powered by Apache Spark must be upgraded manually.
2. After upgrading IBM Knowledge Catalog Premium or IBM Knowledge Catalog Standard with generative AI capabilities enabled:
   • The granite-4-h-small model is set as the new default model for the deployment mode gpu. Unless you have sufficient GPUs to host the previously used and the new model, remove the ibm/granite-3-8b-instruct model as described in Removing foundation models from IBM watsonx.ai™.
   • If you decided to work with the models running on CPU after the upgrade instead of the models running on GPU, manually remove the ibm/granite-3-8b-instruct and granite-4-h-small models as described in Removing foundation models from IBM watsonx.ai.
   • In this version, the foundation model that is used to generate semantic embeddings was changed to a multilingual embedding model. If semantic embeddings were enabled in the previous version (enableSemanticEmbedding: true), you must regenerate all embeddings for continued use of the Text-to-SQL capabilities. For more information, see Updating projects and metadata with a new embedding model after upgrading.

After you complete the preceding steps, IBM Knowledge Catalog is ready to use. For more details, see Applying data governance.