Creating a service instance for Watson OpenScale with the cpd-cli service-instance create command

Information you need to complete this task

Review the following information before you create a service instance for Watson OpenScale:

Version requirements

All of the components that are associated with an instance of Cloud Pak for Data must be installed or created at the same release. For example, if Watson OpenScale is installed at Version 5.0.3, you must create the service instance at Version 5.0.3.

Important: Watson OpenScale uses a different version number from Cloud Pak for Data. This topic includes a table that shows the Watson OpenScale version for each refresh of Cloud Pak for Data. Use this table to find the correct version based on the version of Cloud Pak for Data that is installed.

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

Before you begin

This task assumes that the following prerequisites are met:

Procedure

Complete the following tasks to create a service instance:

1. Creating a service instance
2. Validating that the service instance was created
3. What to do next

Creating a service instance

To create a service instance:

1. Change to the directory on your workstation where you want to create the JSON file that defines the service instance payload.
2. Set the environment variables that are used to populate the JSON payload for the service instance:
   1. Set the INSTANCE_NAME environment variable to the unique name that you want to use as the display name for the service instance:

      export INSTANCE_NAME="<display-name>"

      This name is displayed on the Instances page of the Cloud Pak for Data web client.

      The display name is a string and can contain alphanumeric characters (a-z, A-Z, 0-9), spaces ( ), dashes (-), underscores (_), and periods (.). Make sure that you surround the display name with quotation marks, as shown in the preceding export command.

   2. Set the INSTANCE_VERSION environment variable to the version that corresponds to the version of Cloud Pak for Data on your cluster:

      export INSTANCE_VERSION=<version>

      Use the following table to determine the appropriate value:

      Cloud Pak for Data version	Service instance version
      5.0.3	5.0.3
      5.0.2	5.0.1
      5.0.1	5.0.1
      5.0.0	5.0.0

3. Create the openscale-instance.json payload file.

   cat << EOF > ./openscale-instance.json
   {
       "addon_type": "aios",
       "display_name": "${INSTANCE_NAME}",
       "namespace": "${PROJECT_CPD_INST_OPERANDS}",
       "addon_version": "${INSTANCE_VERSION}",
       "create_arguments": {
           "description": "IBM Watson OpenScale",
           "metadata": {},
           "parameters": {}
       }
   }
   EOF

   The following environment variables use the values that are already defined in your installation environment variables script:

   • ${PROJECT_CPD_INST_OPERANDS}
4. Set the PAYLOAD_FILE environment variable to the fully qualified name of the JSON payload file on your workstation:

   export PAYLOAD_FILE=<fully-qualified-JSON-file-name>

5. Create the service instance from the payload file:

   cpd-cli service-instance create \
   --profile=${CPD_PROFILE_NAME} \
   --from-source=${PAYLOAD_FILE}

Validating that the service instance was created

To validate that the service instance was created, run the following command:

cpd-cli service-instance status ${INSTANCE_NAME} \
--profile=${CPD_PROFILE_NAME} \
--output=json

• If the command returns PROVISIONED, the service instance was successfully created.
• If the command returns PROVISION_IN_PROGRESS, wait a few minutes and run the command again.
• If the command returns FAILED, review the pod logs for the zen-core-api and zen-watcher pods for possible causes.

What to do next

The service instance is ready to use. To get started with Watson OpenScale, see Validating and monitoring AI models with Watson OpenScale.