Installing IBM Knowledge Catalog

An instance administrator can install IBM Knowledge Catalog on IBM Cloud Pak® for Data Version 4.8.

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 Cloud Pak for Data 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 Cloud Pak for Data control plane and the services for this instance of Cloud Pak for Data 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 the Cloud Pak for Data control plane and one or more services at the same time, follow the process in Installing an instance of Cloud Pak for Data instead.
If you didn't install IBM Knowledge Catalog when you installed the Cloud Pak for Data control plane, complete this task to add IBM Knowledge Catalog to your environment.
Repeat as needed If you are responsible for multiple instances of Cloud Pak for Data, 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 Cloud Pak for Data must be installed at the same release. For example, if the Cloud Pak for Data control plane is installed at Version 4.8.5, you must install IBM Knowledge Catalog at Version 4.8.5.

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 Cloud Pak for Data 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® Storage 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 Storage 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`

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: Cloud Pak for Data CLI: `cpd-cli` OpenShift CLI: `oc`	If this task is not complete, see Setting up a client workstation.
The Cloud Pak for Data control plane is installed.	If this task is not complete, see Installing an instance of Cloud Pak for Data.
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-v2` image from the private container registry.	If this task is not complete, see Pulling the olm-utils-v2 image from the private container registry.
The node settings are adjusted for IBM Knowledge Catalog.	If this task is not complete, see Changing required node settings.

Procedure

Complete the following tasks to install IBM Knowledge Catalog:

Specifying installation options
Installing the service
Validating the installation
What to do next

Specifying installation options

If you plan to install IBM Knowledge Catalog, you can specify the following installation options in a file named install-options.yml in the work directory.

Restriction: If you purchased the Data Governance Express® license, you cannot specify these installation options.

These installation options are available only with IBM Cloud Pak for Data Enterprise Edition of IBM Cloud Pak for Data Standard Edition.

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:
#    enableKnowledgeGraph: False
#    enableDataQuality: False

Property Description

Property	Description
`enableKnowledgeGraph`	Specify whether to enable the knowledge graph feature, which provides lineage and semantic search capabilities. Default value `False` Valid values `False` Do not enable the knowledge graph feature. `True` Enable the knowledge graph feature.
`enableDataQuality`	Specify whether to enable data quality features in projects. Default value `False` Valid values `False` Do not enable the data quality feature. `True` Enable the data quality feature. 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.

enableKnowledgeGraph

Specify whether to enable the knowledge graph feature, which provides lineage and semantic search capabilities.

Default value

False

Valid values

False: Do not enable the knowledge graph feature.
True: Enable the knowledge graph feature.

enableDataQuality

Specify whether to enable data quality features in projects.

Default value

False

Valid values

False: Do not enable the data quality feature.
True: Enable the data quality feature.
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.

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=wkc
```
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=wkc \
--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=wkc \
--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 Fusion Data Foundation storage

Run the appropriate command to create the custom resource.

Default installation (without installation options)

cpd-cli manage apply-cr \
--components=wkc \
--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=wkc \
--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 Fusion Global Data Platform storage

Remember: When you use IBM Storage 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=wkc \
--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=wkc \
--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=wkc \
--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=wkc \
--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=wkc \
--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=wkc \
--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=wkc \
--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=wkc \
--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=wkc \
--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=wkc \
--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=wkc \
--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=wkc \
--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=wkc \
--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=wkc \
--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=wkc

What to do next

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