Installing Watson Query

An instance administrator can install Watson Query on IBM Cloud Pak® for Data Version 4.8.

Who needs to complete this task?

Instance administrator To install Watson Query, 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.

The tethered projects for the instance

After you install Watson Query, you can deploy Watson Query service instances to the operands project or to projects that are tethered to the operands project.

Note:

You can run only one Watson Query instance in a project. You can run multiple instances of Watson Query for the same Cloud Pak for Data instance by setting up tethered projects and then provisioning one Watson Query instance in each of the tethered projects. For information about setting up tethered projects, see Tethering projects to the IBM Cloud Pak for Data control plane.

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 Query when you installed the Cloud Pak for Data control plane, complete this task to add Watson Query 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 Query on the cluster.

Information you need to complete this task

Review the following information before you install Watson Query:

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.7, you must install Watson Query at Version 4.8.7.

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 Query requires a custom security context constraint (SCC). For more information, see Creating custom security context constraints for services.

Common core services

Watson Query 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 Query. The common core services installation increases the amount of time the installation takes to complete.

Storage requirements
You don't need to specify storage information when you install Watson Query. However, you do 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 an instance of Cloud Pak for Data.
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.
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 custom security context constraint (SCC) for Watson Query exists. If this task is not complete, see Creating custom security context constraints for services.
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:

Procedure

Complete the following tasks to install Watson Query:

  1. Installing the service
  2. Validating the installation
  3. What to do next

Installing the service

To install Watson Query:

  1. 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.
  2. Run the following command to create the required OLM objects for Watson Query in the operators project for the instance:
    cpd-cli manage apply-olm \
    --release=${VERSION} \
    --cpd_operator_ns=${PROJECT_CPD_INST_OPERATORS} \
    --components=dv
    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.

  3. Create the custom resource for Watson Query.
    cpd-cli manage apply-cr \
    --components=dv \
    --release=${VERSION} \
    --cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
    --license_acceptance=true

Validating the installation

Watson Query 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=dv

What to do next

Complete the steps in Post installation set-up for Watson Query.