Installing Watson Knowledge Catalog
An instance administrator can install Watson Knowledge Catalog on IBM Cloud Pak® for Data Version 4.7.
- Who needs to complete this task?
-
Instance administrator To install Watson 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 Watson Knowledge
Catalog when you installed the Cloud Pak for Data control plane, complete this task to add Watson 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 Watson Knowledge Catalog on the cluster.
Information you need to complete this task
Review the following information before you install Watson 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.7.4, you must install Watson Knowledge Catalog at Version 4.7.4.
- 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
-
Watson Knowledge Catalog works with the default Red Hat® OpenShift® Container Platform security context constraint:
- On Version 4.10, the default SCC is
restricted
. - On Version 4.12, the default SCC is
restricted-v2
- On Version 4.10, the default SCC is
- Common core services
-
Watson 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 Watson 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 Watson 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.
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 Watson 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:
|
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 Watson 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 Watson Knowledge Catalog. | If this task is not complete, see Changing required node settings. |
Procedure
Complete the following tasks to install Watson Knowledge Catalog:
Specifying installation options
You can specify the following installation options in the install-options.yml
file in the work
directory.
Follow the instructions based on the license you have for Watson Knowledge Catalog:
For users on the Enterprise/Standard license:
For more information on these optional features, see Preparing to install Watson Knowledge Catalog.
Feature | Description | Setting |
---|---|---|
Knowledge graph | Enable knowledge graph to gain access to the lineage and semantic search features. |
|
Data quality | Enable data quality features in analytics projects. Important: Enabling this
option will install DataStage® with Watson Knowledge
Catalog. To ensure a smooth installation of this feature see Installing DataStage.
Following this link will take you to the DataStage installation documentation.
|
|
Advanced metadata import | Enable advanced metadata import provided through MANTA Automated Data Lineage. Important: Before enabling
MANTA Automated Data Lineage, ensure that the valid CA
(certificate authority) signed certificate has the parameter Subject Alternative
Name, and that it matches the route name used to access Watson Knowledge
Catalog.
For users on version 4.7.0, 4.7.1 and 4.7.2, you can enable MANTA Automated Data Lineage for Watson Knowledge Catalog. For users on 4.7.3, MANTA Automated Data Lineage is installed and enabled separately from Watson Knowledge Catalog. For more information, see MANTA Automated Data Lineage. |
|
Factsheets |
Previously a feature you could enable with Watson Knowledge Catalog. This feature is now a separate service you can install with IBM Cloud Pak for Data. When users upgrade IBM Cloud Pak for Data, installing Watson Knowledge Catalog will remove Factsheet resources. To access the data, you must install the AI Factsheets service on the same cluster where Watson Knowledge Catalog is installed. Additionally, tracking updates will be suspended from the time of the Watson Knowledge Catalog upgrade until AI Factsheets is installed. Tracking will resume after AI Factsheets is installed, but anything during that gap must be manually updated by updating the model metadata like description, name or tags. For more information about AI Factsheets and about installing it see Installing AI Factsheets. |
N/A |
- Create a file called
install-options.yml
in the work directory.The file path for the IBM Cloud Pak for Data command-line interface work directory is cpd-cli-workspace/olm-utils-workspace/work.
- Add the following content to the new file:
Uncomment the options you want to enable by removing the pound symbol (custom_spec: wkc: #enableKnowledgeGraph: True #enableDataQuality: True #enableMANTA: True
#
) next to that option.When you install or upgrade Watson Knowledge Catalog, include the
--param-file=/tmp/work/install-options.yml
option in the command.
For users on the Data Governance Express license:
When using the Data Governance Express license, you can not enable any additional features with Watson Knowledge Catalog. For more information, see Data Governance Express license.
Installing the service
To install Watson Knowledge Catalog:
-
Run the
cpd-cli manage login-to-ocp
command to log in to the cluster as a user with sufficient permissions to complete this task. For example:cpd-cli manage login-to-ocp \ --username=${OCP_USERNAME} \ --password=${OCP_PASSWORD} \ --server=${OCP_URL}
Tip: Thelogin-to-ocp
command takes the same input as theoc login
command. Runoc login --help
for details. - Run the following command to create the required OLM objects for Watson 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 thecpd-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 Watson 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, typicallyibm-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
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, typicallyibm-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, typicallymanaged-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, typicallyefs-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, typicallyontap-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
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