Installing Watson Query

A project administrator can install Watson Query on IBM Cloud Pak® for Data.

What permissions do you need to complete this task?

The permissions that you need depend on which tasks you must complete:

To install the Watson Query operators, you must have the appropriate permissions to create operators and you must be an administrator of the project where the Cloud Pak for Data operators are installed. This project is identified by the ${PROJECT_CPD_OPS} environment variable.
To install Watson Query, you must be an administrator of the project where you will install Watson Query. This project is identified by the ${PROJECT_CPD_INSTANCE} environment variable.

When do you need to complete this task?: If you didn't install Watson Query when you installed the platform, you can complete this task to add Watson Query to your environment.
If you want to install all of the Cloud Pak for Data components at the same time, follow the process in Installing the platform and services instead.

Important: All of the Cloud Pak for Data components in a deployment must be installed at the same release.

Information you need to complete this task

Review the following information before you install Watson Query:

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 Query uses a custom security context constraint (SCC). For details, see Creating the custom SCC for Watson Query.

Installation location: Watson Query 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.

Common core services: Watson Query requires the Cloud Pak for Data common core services.
If the common core services are not installed in the project where you plan to install Watson Query, the common core services are automatically installed when you install Watson Query. This increases the amount of time the installation takes to complete.

Storage requirements: You don't need to specify storage when you install Watson Query; however you will need to specify storage when you provision an instance of Watson Query.

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 Query.	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 the platform and services.
For environments that use a private container registry, such as air-gapped environments, the Watson Query software images are mirrored to the private container registry.	If this task is not complete, see Mirroring images to a private container registry.
The custom security context constraint (SCC) required to run Watson Query exists.	If this task is not complete, see Creating the custom SCC for Watson Query.
The node settings are adjusted for Watson Query.	If this task is not complete, see Changing required node settings.

Prerequisite services

Before you install Watson Query, ensure that the following services are installed and running:

Db2® Data Management Console: If you do not manually install Db2 Data Management Console, Watson Query installs it for you. If you have already installed Db2 Data Management Console, make sure that a Db2 Data Management Console instance has been provisioned. For more information, see Installing Db2 Data Management Console.

Procedure

To install Watson Query, complete the following tasks.

Log in to the cluster.
Install the operator.
Install the service.
Validate the installation.
Find out 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:

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 Query operator simplifies the process of managing the Watson Query service on Red Hat® OpenShift Container Platform.

To install Watson Query, you must install the Watson Query 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 Query 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:

Create the OLM objects for Watson Query:
```
cpd-cli manage apply-olm \
--release=${VERSION} \
--cpd_operator_ns=${PROJECT_CPD_OPS} \
--components=dv
```
- 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 Query service.

Installing the service

After the Watson Query operator is installed, you can install Watson Query.

Who needs to complete this task?: You must be an administrator of the project where you will install Watson Query.

When do you need to complete this task?: Complete this task if you want to add Watson Query to your environment.

To install the service:

Create the custom resource for Watson Query.

cpd-cli manage apply-cr \
--components=dv \
--release=${VERSION} \
--cpd_instance_ns=${PROJECT_CPD_INSTANCE} \
--license_acceptance=true

Validating the installation

Watson Query is installed when the apply-cr command returns [SUCCESS]... The apply-cr command ran successfully.

However, you can optionally run the cpd-cli manage get-cr-status command if you want to confirm that the custom resource status is Completed:

cpd-cli manage get-cr-status \
--cpd_instance_ns=${PROJECT_CPD_INSTANCE} \
--components=dv

What to do next

Post-installation setup for Watson Query.