Upgrading IBM Knowledge Catalog to IBM Knowledge Catalog Premium

An instance administrator can upgrade IBM Knowledge Catalog to IBM Knowledge Catalog Premium.

Who needs to complete this task?

Instance administrator To upgrade IBM Knowledge Catalog, you must be an instance administrator. An instance administrator has permission to manage software in the following projects:

The operators project for the instance: The operators for this instance of IBM Knowledge Catalog are installed in the operators project. In the upgrade commands, the ${PROJECT_CPD_INST_OPERATORS} environment variable refers to the operators project.
The operands project for the instance: The custom resources for the control plane and IBM Knowledge Catalog are installed in the operands project. In the upgrade commands, the ${PROJECT_CPD_INST_OPERANDS} environment variable refers to the operands project.

When do you need to complete this task?

Review the following options to determine whether you need to complete this task:

If you want to upgrade the IBM® Software Hub control plane and one or more services at the same time, follow the process in Upgrading an instance of IBM Software Hub instead.
If you didn't upgrade IBM Knowledge Catalog when you upgraded the IBM Software Hub control plane, complete this task to upgrade IBM Knowledge Catalog.
Repeat as needed If you are responsible for multiple instances of IBM Software Hub, you can repeat this task to upgrade more instances of IBM Knowledge Catalog on the cluster.

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:

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

Where to find more information
If this task is not complete, see Mirroring images to a 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.

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.

Image pull secrets

This task assumes that the secrets that contain the image pull credentials for the instance exist.

Where to find more information
If this task is not complete, see Creating image pull secrets for an instance of IBM Software Hub.

Procedure

Complete the following tasks to upgrade IBM Knowledge Catalog:

Specifying installation options
Upgrading the service
What to do next

Specifying installation options

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

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

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'

For more information about the available installation options, see IBM Knowledge Catalog installation parameters.

Upgrading the service

Complete the following tasks to upgrade IBM Knowledge Catalog to IBM Knowledge Catalog Premium:

Upgrade IBM Knowledge Catalog to version 5.4. Follow the instructions for the version from which you are upgrading:
- Upgrading IBM Knowledge Catalog from Version 5.2 to 5.4
- Upgrading IBM Knowledge Catalog from Version 5.3 to Version 5.4
Install IBM Knowledge Catalog Premium 5.4 as described in Installing IBM Knowledge Catalog 5.4.

What to do next

IBM Knowledge Catalog Premium is ready to use. To get started with IBM Knowledge Catalog Premium, see Getting started with IBM Knowledge Catalog.