Table of contents

Installing the Watson Knowledge Catalog service

A project administrator can install the Watson™ Knowledge Catalog service on IBM® Cloud Pak for Data.

Before you begin

Required role: To complete this task, you must be an administrator of the project (namespace) where you will deploy the service.

Before you can install this service, a cluster administrator must complete the steps in Prepare the cluster for the Watson Knowledge Catalog service.

If you are running the installation on an air-gapped cluster, ensure that a Red Hat OpenShift administrator has completed the steps in Preparing for air-gapped installations to download the required files for the service.

Portworx users only: Ensure that a Red Hat OpenShift administrator completed the steps in Creating storage class override files for installation to create the appropriate override.yaml file on the cluster. This file defines the list of Portworx storage classes that are required to install the service.

Ensure that the Mac OS or Linux machine where you will run the commands meets the appropriate requirements for your environment:

Requirements for the machine Cluster is connected to the internet Cluster is air-gapped
Can connect to the cluster.
Is connected to the internet.  
Has the oc command-line interface.

You can download the appropriate client tools for your operating system from OKD. Ensure that the version is compatible with the version of Red Hat OpenShift on your cluster.

Has the Cloud Pak for Data command-line interface.

See Obtaining the installation files. Use the same version of the command-line interface each time you run the commands.

Has the updated repo.yaml file in the same directory as the Cloud Pak for Data command-line interface.

See Obtaining the installation files.

 
Has the cpd-Operating_System-workspace directory, which contains the required files.

See Preparing for air-gapped installations.

 

Ensure that you have the following information from your Red Hat OpenShift cluster administrator:

Required information Description
OpenShift_URL:port The URL and port number to use when logging in to your Red Hat OpenShift cluster.

Ensure that you have the appropriate credentials to log into the cluster using oc login.

Value:

Your cluster administrator should tell you whether your cluster is connected to the internet or is air-gapped.

Assembly_version

Needed for air-gapped installations only.

The version of the assembly to install.

Value:

Storage_class_name The name of the storage class to use to provision storage for the service.

If your cluster is not set up to use dynamic storage provisioning, work with an IBM Support representative to determine how you can specify persistent volume claims when you install the service.

Value:

Registry_location The location to store the images in the registry server.

If you are installing the service when you are connected to the internet, ensure that you have the appropriate credentials to push images to the registry server.

Value:

Guidance for Red Hat OpenShift registry users:
  • This is the external route to the location in the registry. The default external route is:
    docker-registry-default.9.87.654.321.nip.io/project

    Where default.9.87.654.321.nip.io is your public IP address.

  • When you specify a value for the Registry_location variable, ensure that you include the project name.
Registry_from_cluster The location from which pods on the cluster can pull images.

Value:

Guidance for Red Hat OpenShift registry users:
  • This is the internal name of the registry service. The default service name is:
    docker-registry.default.svc:5000/project
  • When you specify a value for the Registry_from_cluster variable, ensure that you include the project name.
Project The project (namespace) where the IBM Cloud Pak for Data control plane is installed.

Value:

About this task

These instructions assume that the IBM Cloud Pak for Data control plane is already installed on your Red Hat OpenShift cluster. If you are installing multiple services on your cluster, you must run the installations one at a time and wait until the installation completes before installing another service. You cannot run the installations in parallel.

Procedure

Run the appropriate cpd command for your environment:
Tip: For a list of all available options, enter the command: ./cpd-Operating_System --help.
  • To install the service on a cluster that can connect to the internet:
    1. Change to the directory where you placed the Cloud Pak for Data command-line interface and the repo.yaml file.
    2. Log in to your Red Hat OpenShift cluster as a project administrator:
      oc login OpenShift_URL:port
    3. Run the following command to install the service:
      ./cpd-Operating_System --repo ./repo.yaml \
      --assembly wkc \
      --namespace Project \
      --storageclass Storage_class_name \
      --transfer-image-to Registry_location \
      --cluster-pull-prefix Registry_from_cluster \
      --ask-push-registry-credentials

      Include the --override override.yaml option if the cluster administrator set the time zone for the master node.

      Portworx users only: If you are using Portworx storage, specify the default storage class and the --override argument with the fully qualified location of the override.yaml file for the service:

      ./cpd-Operating_System --repo ./repo.yaml \
      --assembly wkc \
      --namespace Project \
      --storageclass portworx-shared-gp \
      --override wkc-override.yaml \
      --transfer-image-to Registry_location \
      --cluster-pull-prefix Registry_from_cluster \
      --ask-push-registry-credentials

      Replace the following values:

      Variable Replace with
      Operating_System For Linux, specify linux. For Mac OS, specify darwin.
      Project Use the value provided by your cluster administrator.
      Storage_class_name Use the value provided by your cluster administrator.
      Registry_location Use the value provided by your cluster administrator.
      Registry_from_cluster Use the value provided by your cluster administrator.
  • To install the service on an air-gapped cluster:
    1. Change to the directory where you placed the Cloud Pak for Data command-line interface.
    2. Log in to your Red Hat OpenShift cluster as a project administrator:
      oc login OpenShift_URL:port
    3. Remove the images directory from the cpd-Operating_System-workspace/assembly/Assembly_name/Assembly_arch/Assembly_version directory.

      You can either delete the images directory or you can move it outside the cpd-Operating_System-workspace directory.

    4. Run the following command to install the service:
      Important: If you are using the internal Red Hat OpenShift registry, do not specify the --ask-pull-registry-credentials parameter.
      ./cpd-Operating_System \
      --assembly wkc \
      --version Assembly_version \
      --namespace Project \
      --storageclass Storage_class_name \
      --cluster-pull-prefix Registry_from_cluster \
      --ask-pull-registry-credentials \
      --load-from Image_directory_location

      Include the --override override.yaml option if the cluster administrator set the time zone for the master node.

      Portworx users only: If you are using Portworx storage, specify the default storage class and the --override argument with the fully qualified location of the override.yaml file for the service:

      ./cpd-Operating_System \
      --assembly wkc \
      --version Assembly_version \
      --namespace Project \
      --storageclass portworx-shared-gp \
      --override wkc-override.yaml \
      --cluster-pull-prefix Registry_from_cluster \
      --ask-pull-registry-credentials \
      --load-from Image_directory_location

      Replace the following values:

      Variable Replace with
      Operating_System For Linux, specify linux. For Mac OS, specify darwin.
      Assembly_version Use the value provided by your cluster administrator.
      Project Use the value provided by your cluster administrator.
      Storage_class_name Use the value provided by your cluster administrator.
      Registry_from_cluster Use the value provided by your cluster administrator.
      Image_directory_location The location of the cpd-Operating_System-workspace directory.

What to do next

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