Installing IBM Knowledge Catalog

An instance administrator can install IBM Knowledge Catalog on IBM® Software Hub Version 5.1.

Who needs to complete this task?

Instance administrator To install IBM Knowledge Catalog, you must be an instance administrator. An instance administrator has permission to install 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 installation 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 installation 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 install multiple services at the same time, follow the process in Running a batch installation of solutions and services instead.
If you didn't install IBM Knowledge Catalog as part of a batch installation, complete this task to add IBM Knowledge Catalog to your environment.
Repeat as needed If you are responsible for multiple instances of IBM Software Hub, you can repeat this task to install more instances of IBM Knowledge Catalog on the cluster.

Information you need to complete this task

Review the following information before you install IBM Knowledge Catalog:

Version requirements: All of 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 installed at Version 5.1.3, you must install IBM Knowledge Catalog at Version 5.1.3.

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

Security context constraint: IBM Knowledge Catalog works with the default Red Hat® OpenShift® Container Platform security context constraint, restricted-v2.

Common core services

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

If the common core services are not installed in the operands project for the instance, the common core services are automatically installed when you install IBM Knowledge Catalog. The common core services installation increases the amount of time the installation takes to complete.

Storage requirements

You must specify storage classes when you install IBM Knowledge Catalog. The following storage classes are recommended. However, if you don't use these storage classes on your cluster, ensure that you specify a storage class with an equivalent definition.

Storage	Notes	Storage classes
OpenShift Data Foundation	When you install the service, specify file storage and block storage.	File storage: `ocs-storagecluster-cephfs` Block storage: `ocs-storagecluster-ceph-rbd`
IBM Fusion Data Foundation	When you install the service, specify file storage and block storage.	File storage: `ocs-storagecluster-cephfs` Block storage: `ocs-storagecluster-ceph-rbd`
IBM Fusion Global Data Platform	When you install the service, specify the same storage class for both file storage and block storage.	File storage: Either of the following storage classes: `ibm-spectrum-scale-sc` `ibm-storage-fusion-cp-sc` Block storage: Either of the following storage classes: `ibm-spectrum-scale-sc` `ibm-storage-fusion-cp-sc`
IBM Storage Scale Container Native	When you install the service, specify the same storage class for both file storage and block storage.	File storage: `ibm-spectrum-scale-sc` Block storage: `ibm-spectrum-scale-sc`
Portworx	When you install the service, the `--storage_vendor=portworx` option ensures that the service uses the correct storage classes.	File storage: `portworx-shared-gp3` Block storage: `portworx-cassandra-sc` `portworx-couchdb-sc` `portworx-db2-rwo-sc` `portworx-elastic-sc` `portworx-gp3-sc` `portworx-kafka-sc` `portworx-metastoredb-sc` `portworx-solr-sc`
NFS	When you install the service, specify the same storage class for both file storage and block storage.	File storage: `managed-nfs-storage` Block storage: `managed-nfs-storage`
Amazon Elastic storage	When you install the service, you can specify: File storage only File storage and block storage (recommended) File storage is provided by Amazon Elastic File System. Block storage is provided by Amazon Elastic Block Store.	File storage: `efs-nfs-client` Block storage: Either of the following storage classes: `gp2-csi` `gp3-csi`
NetApp Trident	When you install the service, specify the same storage class for both file storage and block storage.	File storage: `ontap-nas` Block storage: `ontap-nas`
Nutanix	When you install the service, specify file storage and block storage.	File storage: `nutanix-file` Block storage: `nutanix-volume`

Before you begin

This task assumes that the following prerequisites are met:

Prerequisite	Where to find more information
The cluster meets the minimum requirements for installing IBM Knowledge Catalog.	If this task is not complete, see System requirements.
The workstation from which you will run the installation is set up as a client workstation and includes the following command-line interfaces: IBM Software Hub CLI: `cpd-cli` OpenShift CLI: `oc`	If this task is not complete, see Setting up a client workstation.
The IBM Software Hub control plane is installed.	If this task is not complete, see Installing an instance of IBM Software Hub.
For environments that use a private container registry, such as air-gapped environments, the IBM Knowledge Catalog software images are mirrored to the private container registry.	If this task is not complete, see Mirroring images to a private container registry.
For environments that use a private container registry, such as air-gapped environments, the `cpd-cli` is configured to pull the `olm-utils-v3` image from the private container registry.	If this task is not complete, see Pulling the olm-utils-v3 image from the private container registry.
The load balancer timeout settings are adjusted for IBM Knowledge Catalog.	If this task is not complete, see Changing load balancer settings.
The process IDs limit setting is adjusted for IBM Knowledge Catalog.	If this task is not complete, see Changing the process IDs limit.
The kernel parameter settings are adjusted for IBM Knowledge Catalog.	If this task is not complete, see Changing kernel parameter settings.
The GPU settings are adjusted for IBM Knowledge Catalog Standard or IBM Knowledge Catalog Premium.	If this task is not complete, see Installing operators for services that require GPUs.

Procedure

Complete the following tasks to install IBM Knowledge Catalog:

Specifying your IBM Knowledge Catalog edition
Specifying installation options
Installing the service
Validating the installation
What to do next

Specifying your IBM Knowledge Catalog edition

IBM Knowledge Catalog is available in three different editions. You must specify which edition to install.

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

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

If you plan to install IBM Knowledge Catalog, IBM Knowledge Catalog Premium, or IBM Knowledge Catalog Standard, you can specify installation options in a file named install-options.yml in the cpd-cli work directory (For example: cpd-cli-workspace/olm-utils-workspace/work).

The parameters are optional. If you do not set these installation parameters, the default values are used. Uncomment the parameters that you want to override and update the values appropriately.

The sample YAML content uses the default values.

################################################################################
# IBM Knowledge Catalog parameters
################################################################################
custom_spec:
  wkc:
#    enableDataQuality: False
#    enableSemanticAutomation: False
#    enableKnowledgeGraph: False
#    useFDB: False

Property	Description
`enableDataQuality`	Specify whether to enable data quality features in projects. Important: If you enable this feature, DataStage, specifically DataStage Enterprise, is automatically installed. If you did not purchase a DataStage license, use of DataStage Enterprise is limited to creating, managing, and running data quality rules. For examples of accepted use, see Enabling optional features after installation or upgrade for IBM Knowledge Catalog. Editions the setting applies to IBM Knowledge Catalog IBM Knowledge Catalog Premium Default value `False` Valid values `False` Do not enable the data quality feature. `True` Enable the data quality feature.
`enableSemanticAutomation`	Specify whether to enable gen AI based enrichment features in projects. Editions the setting applies to IBM Knowledge Catalog Premium IBM Knowledge Catalog Standard Default value `False` Valid values `False` Do not enable the gen AI based enrichment features. `True` Enable the gen AI based enrichment features. Important: If you enable this feature, the inference foundation models component (`watsonx_ai_ifm`) is automatically installed. This option requires at least one GPU. For information about supported GPUs, see the Hardware requirements.
`enableKnowledgeGraph`	Specify whether to enable the knowledge graph feature. The knowledge graph provides the following capabilities: Relationship explorer and business term relationship search Lineage Important: The preceding features are not available in all environments. For more information, see Which knowledge graph features are available in my environment? Editions the setting applies to IBM Knowledge Catalog IBM Knowledge Catalog Premium IBM Knowledge Catalog Standard Default value `False` Valid values `False` Do not enable the knowledge graph feature. `True` Enable the knowledge graph feature. If you set `enableKnowledgeGraph: True`, review `useFDB` and Which knowledge graph features are available in my environment?.
`useFDB`	If you set `enableKnowledgeGraph: True`, specify which database to use to store the data generated by knowledge graph. The database depends on which features you want to use and whether you are installing or upgrading IBM Knowledge Catalog. Default value `False` Valid values `False` Do not use FoundationDB. Use Neo4j. 5.1.1 and later If FoundationDB is already installed, you cannot set `useFDB` to `false` when you upgrade IBM Knowledge Catalog. `True` Use FoundationDB. 5.1.1 and later If FoundationDB is already installed, `useFDB` is automatically set to `true` when you upgrade IBM Knowledge Catalog.

Which knowledge graph features are available in my environment?

Use the following tables to determine which knowledge graph features will be available in your environment when you set enableKnowledgeGraph: True:

New installations

Lineage	Relationship explorer	Required settings
Not available if you do not install a lineage service.	Available.	Manually set: `enableKnowledgeGraph: True` `useFDB: True`
Available if you install MANTA Automated Data Lineage.	Available.	Manually set: `enableKnowledgeGraph: True` `useFDB: True`
Available if you install IBM Manta Data Lineage.	5.1.0 Not available when IBM Manta Data Lineage is installed. 5.1.1 and later Available.	Manually set: `enableKnowledgeGraph: True`

Upgrades

Lineage	Relationship explorer	Required settings
Not available. No lineage service is installed.	Available.	5.1.0 Manually set: `enableKnowledgeGraph: True` * `useFDB: True` 5.1.1 and later Manually set: `enableKnowledgeGraph: True` * * You can omit this option if knowledge graph is already enabled.
MANTA Automated Data Lineage (existing)	Available.	5.1.0 Manually set: `enableKnowledgeGraph: True` * `useFDB: True` 5.1.1 and later Manually set: `enableKnowledgeGraph: True` * * You can omit this option if knowledge graph is already enabled.
MANTA Automated Data Lineage (adding during upgrade)	Available.	5.1.0 Manually set: `enableKnowledgeGraph: True` `useFDB: True` 5.1.1 and later Manually set: `enableKnowledgeGraph: True`
IBM Manta Data Lineage (replacing MANTA Automated Data Lineage after upgrade)	5.1.0 Not available. 5.1.1 and later Available.	Settings are changed by patching the custom resource after upgrade. For more information, see Migrating from MANTA Automated Data Lineage to IBM Manta Data Lineage.
IBM Manta Data Lineage (adding during upgrade)	5.1.0 Not available. 5.1.1 and later Available.	5.1.0 Manually set: `enableKnowledgeGraph: True` `useFDB: False` 5.1.1 and later Manually set: `enableKnowledgeGraph: True`

Installing the service

To install IBM Knowledge Catalog:

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.
Run the following command to create the required OLM objects for IBM Knowledge Catalog in the operators project for the instance:
```
cpd-cli manage apply-olm \
--release=${VERSION} \
--cpd_operator_ns=${PROJECT_CPD_INST_OPERATORS} \
--components=${IKC_TYPE}
```
Wait for the cpd-cli to return the following message before you proceed to the next step:
```
[SUCCESS]... The apply-olm command ran successfully
```
If the apply-olm fails, see Troubleshooting the apply-olm command during installation or upgrade.

Create the custom resource for IBM Knowledge Catalog.

The command that you run depends on the storage on your cluster.

Red Hat OpenShift Data Foundation storage

Run the appropriate command to create the custom resource.

Default installation (without installation options)

cpd-cli manage apply-cr \
--components=${IKC_TYPE} \
--release=${VERSION} \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--block_storage_class=${STG_CLASS_BLOCK} \
--file_storage_class=${STG_CLASS_FILE} \
--license_acceptance=true

Custom installation (with installation options)

cpd-cli manage apply-cr \
--components=${IKC_TYPE} \
--release=${VERSION} \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--block_storage_class=${STG_CLASS_BLOCK} \
--file_storage_class=${STG_CLASS_FILE} \
--param-file=/tmp/work/install-options.yml \
--license_acceptance=true

IBM Fusion Data Foundation storage

Run the appropriate command to create the custom resource.

Default installation (without installation options)

cpd-cli manage apply-cr \
--components=${IKC_TYPE} \
--release=${VERSION} \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--block_storage_class=${STG_CLASS_BLOCK} \
--file_storage_class=${STG_CLASS_FILE} \
--license_acceptance=true

Custom installation (with installation options)

cpd-cli manage apply-cr \
--components=${IKC_TYPE} \
--release=${VERSION} \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--block_storage_class=${STG_CLASS_BLOCK} \
--file_storage_class=${STG_CLASS_FILE} \
--param-file=/tmp/work/install-options.yml \
--license_acceptance=true

IBM Fusion Global Data Platform storage

Remember: When you use IBM Fusion Global Data Platform storage, both ${STG_CLASS_BLOCK} and ${STG_CLASS_FILE} point to the same storage class, typically ibm-spectrum-scale-sc or ibm-storage-fusion-cp-sc.

Run the appropriate command to create the custom resource.

Default installation (without installation options)

cpd-cli manage apply-cr \
--components=${IKC_TYPE} \
--release=${VERSION} \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--block_storage_class=${STG_CLASS_BLOCK} \
--file_storage_class=${STG_CLASS_FILE} \
--license_acceptance=true

Custom installation (with installation options)

cpd-cli manage apply-cr \
--components=${IKC_TYPE} \
--release=${VERSION} \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--block_storage_class=${STG_CLASS_BLOCK} \
--file_storage_class=${STG_CLASS_FILE} \
--param-file=/tmp/work/install-options.yml \
--license_acceptance=true

IBM Storage Scale Container Native storage

Remember: When you use IBM Storage Scale Container Native storage, both ${STG_CLASS_BLOCK} and ${STG_CLASS_FILE} point to the same storage class, typically ibm-spectrum-scale-sc.

Run the appropriate command to create the custom resource.

Default installation (without installation options)

cpd-cli manage apply-cr \
--components=${IKC_TYPE} \
--release=${VERSION} \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--block_storage_class=${STG_CLASS_BLOCK} \
--file_storage_class=${STG_CLASS_FILE} \
--license_acceptance=true

Custom installation (with installation options)

cpd-cli manage apply-cr \
--components=${IKC_TYPE} \
--release=${VERSION} \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--block_storage_class=${STG_CLASS_BLOCK} \
--file_storage_class=${STG_CLASS_FILE} \
--param-file=/tmp/work/install-options.yml \
--license_acceptance=true

Portworx storage

Run the appropriate command to create the custom resource.

Default installation (without installation options)

cpd-cli manage apply-cr \
--components=${IKC_TYPE} \
--release=${VERSION} \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--storage_vendor=portworx \
--license_acceptance=true

Custom installation (with installation options)

cpd-cli manage apply-cr \
--components=${IKC_TYPE} \
--release=${VERSION} \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--storage_vendor=portworx \
--param-file=/tmp/work/install-options.yml \
--license_acceptance=true

NFS storage

Remember: When you use NFS storage, both ${STG_CLASS_BLOCK} and ${STG_CLASS_FILE} point to the same storage class, typically managed-nfs-storage.

Run the appropriate command to create the custom resource.

Default installation (without installation options)

cpd-cli manage apply-cr \
--components=${IKC_TYPE} \
--release=${VERSION} \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--block_storage_class=${STG_CLASS_BLOCK} \
--file_storage_class=${STG_CLASS_FILE} \
--license_acceptance=true

Custom installation (with installation options)

cpd-cli manage apply-cr \
--components=${IKC_TYPE} \
--release=${VERSION} \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--block_storage_class=${STG_CLASS_BLOCK} \
--file_storage_class=${STG_CLASS_FILE} \
--param-file=/tmp/work/install-options.yml \
--license_acceptance=true

AWS with EFS storage only

Remember: When you use EFS storage, both ${STG_CLASS_BLOCK} and ${STG_CLASS_FILE} point to the same storage class, typically efs-nfs-client.

Run the appropriate command to create the custom resource.

Default installation (without installation options)

cpd-cli manage apply-cr \
--components=${IKC_TYPE} \
--release=${VERSION} \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--block_storage_class=${STG_CLASS_BLOCK} \
--file_storage_class=${STG_CLASS_FILE} \
--license_acceptance=true

Custom installation (with installation options)

cpd-cli manage apply-cr \
--components=${IKC_TYPE} \
--release=${VERSION} \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--block_storage_class=${STG_CLASS_BLOCK} \
--file_storage_class=${STG_CLASS_FILE} \
--param-file=/tmp/work/install-options.yml \
--license_acceptance=true

AWS with EFS and EBS storage

Run the appropriate command to create the custom resource.

Default installation (without installation options)

cpd-cli manage apply-cr \
--components=${IKC_TYPE} \
--release=${VERSION} \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--block_storage_class=${STG_CLASS_BLOCK} \
--file_storage_class=${STG_CLASS_FILE} \
--license_acceptance=true

Custom installation (with installation options)

cpd-cli manage apply-cr \
--components=${IKC_TYPE} \
--release=${VERSION} \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--block_storage_class=${STG_CLASS_BLOCK} \
--file_storage_class=${STG_CLASS_FILE} \
--param-file=/tmp/work/install-options.yml \
--license_acceptance=true

NetApp Trident

Remember: When you use NetApp Trident storage, both ${STG_CLASS_BLOCK} and ${STG_CLASS_FILE} point to the same storage class, typically ontap-nas.

Run the appropriate command to create the custom resource.

Default installation (without installation options)

cpd-cli manage apply-cr \
--components=${IKC_TYPE} \
--release=${VERSION} \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--block_storage_class=${STG_CLASS_BLOCK} \
--file_storage_class=${STG_CLASS_FILE} \
--license_acceptance=true

Custom installation (with installation options)

cpd-cli manage apply-cr \
--components=${IKC_TYPE} \
--release=${VERSION} \
--cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
--block_storage_class=${STG_CLASS_BLOCK} \
--file_storage_class=${STG_CLASS_FILE} \
--param-file=/tmp/work/install-options.yml \
--license_acceptance=true

Validating the installation

IBM Knowledge Catalog is installed when the apply-cr command returns:

[SUCCESS]... The apply-cr 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}

Enable GPU model on IBM Knowledge Catalog Premium

5.1.3When installing IBM Knowledge Catalog Premium on version 5.1.3, and you have the enableSemanticAutomation option set to true, the GPU model will not be enabled by default.

To take full advantage of the gen AI-based enrichment features in projects, you will need to run the following workaround steps:

Add the enableSemanticEnrichment: true flag to the semanticautomation resource by running the following patch command:

oc patch semanticautomation semanticautomation-cr -n ${PROJECT_CPD_INST_OPERANDS} --type=merge -p '{"spec": {"enableSemanticEnrichment": true}}'

Wait a few minutes for the operator to reconcile.

Validate that the GPU model (granite-8b-code-instruct) is running:

oc get watsonxaiifm -n ${PROJECT_CPD_INST_OPERANDS} -o yaml | grep granite

What to do next

Complete the steps in Post-installation tasks for IBM Knowledge Catalog.