Installing the Watson Studio service
A project administrator can install Watson Studio on IBM® Cloud Pak for Data.
- Permissions you need for this task
- You must be an administrator of the OpenShift® project (Kubernetes namespace) where you will deploy Watson Studio.
- Information you need to complete this task
-
- Watson Studio
needs only the
restricted
security context constraint (SCC). - Watson Studio must be installed in the same project as Cloud Pak for Data.
- Watson Studio 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 Studio, the common core services will be automatically installed when you install Watson Studio, which will increase the amount of time the installation takes to complete.
- Watson Studio
uses the following storage classes. If you don't use these storage classes on your cluster, ensure
that you have a storage class with an equivalent definition:
- OpenShift Container
Storage:
ocs-storagecluster-cephfs
- IBM Spectrum®:
ibm-spectrum-scale-sc
- NFS:
managed-nfs-storage
- Portworx:
portworx-shared-gp3
- IBM Cloud File Storage:
ibmc-file-gold-gid
oribm-file-custom-gold-gid
- OpenShift Container
Storage:
- Watson Studio
needs only the
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:
- Cloud Pak for Data is installed. For details, see Installing Cloud Pak for Data.
- 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.
- The cluster is configured to pull the Watson Studio software images. For details, see Configuring your cluster to pull images.
- The Watson Studio catalog source exists. For details, see Creating catalog sources.
- 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:
Installing the service
To install Watson Studio:
- Log in to Red Hat® OpenShift Container Platform as a user with sufficient permissions to
complete the
task:
oc login OpenShift_URL:port
- 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:
- Change to the project where you installed Watson Studio:
oc project project-name
- 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
Complete the following tasks in order before users can access the service:- Complete the steps in Post-installation tasks for Watson Studio before using the service.
- The service is ready to use. For details, see the Analyzing data and building models.