Installing Watson Assistant

Information you need to complete this task

Review the following information before you install Watson Assistant:

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 Assistant 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 Assistant 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

Common core services

Watson Assistant 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 Assistant. 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 Assistant. 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.

Storage	Notes	Storage classes
OpenShift Data Foundation	When you install the service, specify file storage and block storage.	File storage: ocs-storagecluster-cephfs Block storage: ocs-storagecluster-ceph-rbd
IBM® Storage Fusion Data Foundation	When you install the service, specify file storage and block storage.	File storage: ocs-storagecluster-cephfs Block storage: ocs-storagecluster-ceph-rbd
IBM Storage Fusion Global Data Platform	When you install the service, specify the same storage class for both file storage and block storage.	File storage: ibm-spectrum-scale-sc Block storage: ibm-spectrum-scale-sc
IBM Storage Scale Container Native	When you install the service, specify the same storage class for both file storage and block storage.	File storage: ibm-spectrum-scale-sc Block storage: ibm-spectrum-scale-sc
Portworx	When you install the service, the --storage_vendor=portworx option ensures that the service uses the correct storage classes.	File storage: portworx-shared-gp3 Block storage: portworx-watson-assistant-sc
NFS	Not supported.	Not applicable.
Amazon Elastic storage	When you install the service, specify file storage and block storage. File storage is provided by Amazon Elastic File System. Block storage is provided by Amazon Elastic Block Store.	File storage: efs-nfs-client Block storage: gp2-csi or gp3-csi
NetApp Trident	When you install the service, specify the same storage class for both file storage and block storage.	File storage: ontap-nas Block storage: ontap-nas

Restriction: This service does not support the backup and restore methods provided by the underlying storage. For example, if you use IBM Storage Fusion for storage, the service cannot use IBM Spectrum® Protect Plus for backups. For information on backing up this service, see Services that support backup and restore.

Before you begin

This task assumes that the following prerequisites are met:

Procedure

Complete the following tasks to install Watson Assistant:

1. Specifying additional installation options
2. Installing the service
3. Validating the installation
4. What to do next

Specifying installation options

Watson Assistant supports numerous installation options.

To specify one or more of these installation options:

1. Create a file called install-options.yml in the work directory (cpd-cli-workspace/olm-utils-workspace/work).
2. Edit the YAML file to include the installation options that you want to specify:

   watson_assistant_size: Starter     # Choose your deployment size. The options are Starter, Production, or large.
   watson_assistant_languages:
   - en     # Do not remove or comment out English
   - es     # Add support for Spanish
   #- fr
   #- pt-br
   #- it
   #- ja
   #- de
   #- ko
   #- ar
   #- nl
   #- zh-tw
   #- zh-cn  
   #- cs
   watson_assistant_bigpv: true
   watson_assistant_analytics_enabled: false     # Set false to disable Analytics or true to enable Analytics

   Tip: You can use the same file to provide input for multiple components. Each setting name is prefixed with the component name.

When you install Watson Assistant, include the --param-file=/tmp/work/install-options.yml option in your install command.

Installing the service

To install Watson Assistant:

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.
2. Run the following command to create the required OLM objects for Watson Assistant in the operators project for the instance:

   cpd-cli manage apply-olm \
   --release=${VERSION} \
   --cpd_operator_ns=${PROJECT_CPD_INST_OPERATORS} \
   --components=watson_assistant

   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 Assistant.

   The command that you run depends on the storage on your cluster.

   ---

   Red Hat OpenShift Data Foundation storage

   Run the following command to create the custom resource.

   cpd-cli manage apply-cr \
   --components=watson_assistant \
   --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 following command to create the custom resource.

   cpd-cli manage apply-cr \
   --components=watson_assistant \
   --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, typically ibm-spectrum-scale-sc.

   Run the following command to create the custom resource.

   cpd-cli manage apply-cr \
   --components=watson_assistant \
   --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 following command to create the custom resource.

   cpd-cli manage apply-cr \
   --components=watson_assistant \
   --release=${VERSION} \
   --cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
   --storage_vendor=portworx \
   --param-file=/tmp/work/install-options.yml \
   --license_acceptance=true

   ---

   AWS with EFS and EBS storage

   Run the following command to create the custom resource.

   cpd-cli manage apply-cr \
   --components=watson_assistant \
   --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, typically ontap-nas.

   Run the following command to create the custom resource.

   cpd-cli manage apply-cr \
   --components=watson_assistant \
   --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

[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=watson_assistant

What to do next