Installing Watson Knowledge Studio

Information you need to complete this task

Review the following information before you install Watson Knowledge Studio:

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:

  source ./cpd_vars.sh

Security context constraint requirements

Watson Knowledge Studio uses the restricted security context constraint (SCC).

Installation location

Watson Knowledge Studio must be installed in the same project (namespace) as the Cloud Pak for Data control plane. This project is identified by the ${PROJECT_CPD_INSTANCE} environment variable.

Storage requirements

You must tell Watson Knowledge Studio what storage to use. 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.

See the following table.

Before you begin

This task assumes that the following prerequisites are met:

Procedure

Complete the following tasks to install Watson Knowledge Studio:

1. Logging in to the cluster
2. Installing the operator
3. Specifying additional installation options
4. Installing the service
5. Validating the installation
6. What to do next

Logging in to the cluster

To run cpd-cli manage commands, you must log in to the cluster.

To log in to the cluster:

1. 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: The login-to-ocp command takes the same input as the oc login command. Run oc login --help for details.

Installing the operator

The Watson Knowledge Studio operator simplifies the process of managing the Watson Knowledge Studio service on Red Hat® OpenShift Container Platform.

To install Watson Knowledge Studio, you must install the Watson Knowledge Studio operator and create the Operator Lifecycle Manager (OLM) objects, such as the catalog source and subscription, for the operator.

Who needs to complete this task?

You must be a cluster administrator (or a user with the appropriate permissions to install operators) to create the OLM objects.

When do you need to complete this task?

Complete this task if the Watson Knowledge Studio operator and other OLM artifacts have not been created for the current release.

If you complete this task and the OLM artifacts already exist on the cluster, the cpd-cli detects that you already have the OLM objects for the components at the specified release, the cpd-cli does not attempt to create the OLM objects again.

To install the operator:

1. Create the OLM objects for Watson Knowledge Studio:

   cpd-cli manage apply-olm \
   --release=${VERSION} \
   --cpd_operator_ns=${PROJECT_CPD_OPS} \
   --components=watson_ks

   • If the command succeeds, it returns [SUCCESS]... The apply-olm command ran successfully.
   • If the command fails, it returns [ERROR] and includes information about the cause of the failure.

What to do next: Install the Watson Knowledge Studio service.

Specifying additional installation options

You can patch or edit custom resource specifications after the installation completes. To patch Watson™ Knowledge Studio custom resources after installation, see Customizing the Watson Knowledge Studio installation.

Installing the service

After the Watson Knowledge Studio operator is installed, you can install Watson Knowledge Studio.

Who needs to complete this task?

You must be an administrator of the project where you will install Watson Knowledge Studio.

When do you need to complete this task?

Complete this task if you want to add Watson Knowledge Studio to your environment.

To install the service, run the following command to create a custom resource named KnowledgeStudio. The file content is different depending on the release.

cat <<EOF |oc apply -f -
apiVersion: knowledgestudio.watson.ibm.com/v1
kind: KnowledgeStudio
metadata:
  name: wks     # Do not change this name
  namespace: ${PROJECT_CPD_INSTANCE}
spec:
  license:
    accept: true
  global: 
    blockStorageClass: ${STG_CLASS_BLOCK}
    fileStorageClass: ${STG_CLASS_FILE}
    size: small        # default size
EOF

cat <<EOF |oc apply -f -
apiVersion: knowledgestudio.watson.ibm.com/v1
kind: KnowledgeStudio
metadata:
  name: wks     # Do not change this name
  namespace: ${PROJECT_CPD_INSTANCE}
spec:
  license:
    accept: true
  global: 
    storageClassName: ${STG_CLASS}
    size: small        # default size
EOF

Validating the installation

What to do next