Installing the Watson Studio service

Before you begin

Ensure that the cluster meets the minimum requirements for installing Watson Studio. For details, see System requirements.

Additionally, ensure that a cluster administrator completed the required Pre-installation tasks for your environment. Specifically, verify that a cluster administrator completed the following tasks:

1. Cloud Pak for Data is installed. For details, see Installing Cloud Pak for Data.
2. For environments that use a private container registry, such as air-gapped environments, the Watson Studio software images are mirrored to the private container registry. For details, see Mirroring images to your container registry.
3. The cluster is configured to pull the Watson Studio software images. For details, see Configuring your cluster to pull images.
4. The Watson Studio catalog source exists. For details, see Creating catalog sources.
5. The Watson Studio operator subscription exists. For details, see Creating operator subscriptions.

If these tasks are not complete, the Watson Studio installation will fail.

Procedure

Complete the following tasks to install Watson Studio:

1. Installing the service
2. Verifying the installation
3. Choosing a service upgrade plan
4. What to do next

Installing the service

To install Watson Studio:

1. Log in to Red Hat® OpenShift Container Platform as a user with sufficient permissions to complete the task:

   oc login OpenShift_URL:port

2. Create a WS custom resource to install Watson Studio. Follow the appropriate guidance for your environment.
   Important: By creating a WS custom resource with spec.license.accept: true, you are accepting the license terms for Watson Studio. You can find links to the relevant licenses in IBM Cloud Pak for Data License Information.

   ---

   The cluster uses Red Hat OpenShift Container Storage

   Create a custom resource with the following format.

   cat <<EOF |oc apply -f -
   apiVersion: ws.cpd.ibm.com/v1beta1
   kind: WS
   metadata:
     name: ws-cr     # This is the recommended name, but you can change it
     namespace: project-name     # Replace with the project where you will install Watson Studio
   spec:
     license:
       accept: true
       license: Enterprise | Standard     # Specify the license you purchased.
     version: 4.0.9
     storageVendor: ocs
     storageClass: ocs-storagecluster-cephfs          #if you use a different storage class, replace it with the appropriate storage class                      
   EOF

   ---

   The cluster uses IBM Spectrum Scale Container Native

   Create a custom resource with the following format.

   cat <<EOF |oc apply -f -
   apiVersion: ws.cpd.ibm.com/v1beta1
   kind: WS
   metadata:
     name: ws-cr     # This is the recommended name, but you can change it
     namespace: project-name     # Replace with the project where you will install Watson Studio
   spec:
     license:
       accept: true
       license: Enterprise | Standard     # Specify the license you purchased
     version: 4.0.9
     storageClass: ibm-spectrum-scale-sc          #if you use a different storage class, replace it with the appropriate storage class                    
   EOF

   ---

   The cluster uses Portworx

   Create a custom resource with the following format.

   cat <<EOF |oc apply -f -
   apiVersion: ws.cpd.ibm.com/v1beta1
   kind: WS
   metadata:
     name: ws-cr     # This is the recommended name, but you can change it
     namespace: project-name     # Replace with the project where you will install Watson Studio
   spec:
     license:
       accept: true
       license: Enterprise | Standard     # Specify the license you purchased
     version: 4.0.9
     storageVendor: portworx
     storageClass: portworx-shared-gp3          #if you use a different storage class, replace it with the appropriate storage class                    
   EOF

   ---

   The cluster uses NFS

   Create a custom resource with the following format.

   cat <<EOF |oc apply -f -
   apiVersion: ws.cpd.ibm.com/v1beta1
   kind: WS
   metadata:
     name: ws-cr     # This is the recommended name, but you can change it
     namespace: project-name     # Replace with the project where you will install Watson Studio
   spec:
     license:
       accept: true
       license: Enterprise | Standard     # Specify the license you purchased
     version: 4.0.9
     storageClass: managed-nfs-storage          #if you use a different storage class, replace it with the appropriate storage class                   
   EOF

   ---

Verifying the installation

When you create the custom resource, the Watson Studio operator processes the contents of the custom resource and starts up the microservices that comprise Watson Studio, including WS. (The WS microservice is defined by the ws-cr custom resource.) Watson Studio is installed when the WS status is Completed.

To check the status of the installation:

1. Change to the project where you installed Watson Studio:

   oc project project-name

2. Get the status of Watson Studio (ws-cr):

   oc get WS ws-cr -o jsonpath='{.status.wsStatus} {"\n"}'

   Watson Studio is ready when the command returns Completed

Choosing a service upgrade plan

You can choose how Watson Studio is upgraded when you install a newer version of the Watson Studio operator on the cluster.

Automatic upgrade (recommended)

If you want Watson Studio to be automatically upgraded when you install a newer version of the Watson Studio operator on the cluster, remove the version entry from the WS custom resource.

To remove the version entry, run the following command. You must update the command with the appropriate project name before you run the command.

oc patch WS ws-cr \
--namespace project-name \
--type=json \
--patch '[{ "op": "remove", "path": "/spec/version" }]'

Manual upgrade

If you want to manually upgrade Watson Studio after you install a newer version of the Watson Studio operator, you can pin the installation at a specific version in the WS custom resource.

By default, when you create the WS custom resource, it includes the version entry, so no additional action is required.

If you removed the version entry from the WS custom resource, run the following command to pin the installation at Version 4.0.9. You must update the command with the appropriate project name before you run the command.

oc patch WS ws-cr \
--namespace project-name \
--type=merge \
--patch '{"spec": {"version":"4.0.9"}}'

For a list of operand versions supported by the Watson Studio operator, see Operator and operand versions.

What to do next

1. Complete the steps in Post-installation tasks for Watson Studio before using the service.
2. The service is ready to use. For details, see the Analyzing data and building models.