Upgrading Watson Speech services from Version 4.6.x to a later 4.6 refresh

A project administrator can upgrade Watson Speech services from one Cloud Pak for Data Version 4.6 refresh to a later 4.6 refresh.

Important: Before upgrading to Watson Speech services version 4.6.3 or 4.6.4, you must make a backup of your data. Preserve the backup in a safe location. For more information about backing up your Watson Speech services data, see Backing up and restoring Watson Speech services data. That topic also includes information about restoring your data if that becomes necessary.
Note: You can upgrade from any version of 4.6.x to a later version of 4.6.x of the Watson Speech services.
What permissions do you need to complete this task?
The permissions that you need depend on which tasks you must complete:
  • To update the Watson Speech services operators, you must have the appropriate permissions to create operators and you must be an administrator of the project where the Cloud Pak for Data operators are installed. This project is identified by the ${PROJECT_CPD_OPS} environment variable.
  • To upgrade Watson Speech services, you must be an administrator of the project where Watson Speech services is installed. This project is identified by the ${PROJECT_CPD_INSTANCE} environment variable.
When do you need to complete this task?
If you didn't upgrade Watson Speech services when you upgraded the platform, you can complete this task to upgrade your existing Watson Speech services installation.

If you want to upgrade all of the Cloud Pak for Data components at the same time, follow the process in Upgrading the platform and services instead.

Important: All of the Cloud Pak for Data components in a deployment must be installed at the same release.

Information you need to complete this task

Review the following information before you upgrade Watson Speech services:

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:
    source ./cpd_vars.sh
Speech custom resource environment variable
Many commands and procedures refer to the Watson Speech services custom resource. To avoid the need to specify the name of the Speech custom resource whenever it is used, append the following lines to the cpd_vars.sh script, and source the script to use the variable in your environment. 

# ------------------------------------------------------------------------------
# Watson Speech services
# ------------------------------------------------------------------------------
# Set the following variable to the name of your Speech services custom resource (CR).
# The variable is set to the default name of the custom resource for new installations.

export CUSTOM_RESOURCE_SPEECH=speech-cr

As of version 4.5.x, the default recommended name of the Speech custom resource is speech-cr. For older versions, the default recommended name was speech-prod-cr. Using the ${CUSTOM_RESOURCE_SPEECH} variable lets the commands and procedures work as written for all users.

Installation location
Watson Speech services is installed in the same project (namespace) as the Cloud Pak for Data control plane. This project is identified by the ${PROJECT_CPD_INSTANCE} environment variable.
Common core services
Watson Speech services requires the Cloud Pak for Data common core services.

If the common core services are not at the required version for the release, the common core services will be automatically upgraded when you upgrade Watson Speech services. This increases the amount of time the upgrade takes to complete.

Storage requirements
You must tell Watson Speech services what storage you use in your existing installation. You cannot change the storage that is associated with Watson Speech services during an upgrade. Ensure that the environment variables point to the correct storage classes for your environment.

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 Watson Speech services. If this task is not complete, see System requirements.
The workstation from which you will run the upgrade is set up as a client workstation and the cpd-cli has the latest version of the olm-utils-play image. If this task is not complete, see Updating client workstations.
The Cloud Pak for Data control plane is upgraded. If this task is not complete, see Upgrading the platform and services.
For environments that use a private container registry, such as air-gapped environments, the Watson Speech services software images are mirrored to the private container registry. If this task is not complete, see Mirroring images to a private container registry.

Be aware of the following when upgrading the Watson Speech services:

  • You cannot uninstall individual microservices once they are installed. Changing their values from true to false in the custom resource or with the --param-file option during upgrade has no effect. To remove any of the following microservices, you must uninstall the Watson Speech services in their entirety and reinstall only the microservices that you need: Speech to Text runtime, Speech to Text asynchronous HTTP, Speech to Text customization, Text to Speech runtime, and Text to Speech customization.

  • If you want to install additional Speech to Text models or Text to Speech voices during upgrade, make sure to install all currently installed models and voices that you want to maintain as well. For example, if want to install the Spanish models but continue to use the previously installed US English models, you must install both the Spanish and US English models during upgrade. If you install the Spanish models but do not install the US English models, the US English models are uninstalled during upgrade.

  • For upgrades to Watson Speech services version 4.6.3 and later, the MinIO backup job can fail to be deleted upon completion. If this happens, the solution is to delete the job, after which the upgrade proceeds normally. For more information, see Upgrade to Watson Speech services version 4.6.3 and later fails to complete.

Procedure

Complete the following tasks to upgrade Watson Speech services:

  1. Logging in to the cluster
  2. Updating the operator
  3. Upgrading the service
  4. Validating the upgrade
  5. What to do next

Logging in to the cluster

To run cpd-cli manage commands, you must log in to the cluster.

To log in to the cluster:

  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.

Updating the operator

The Watson Speech services operator simplifies the process of managing the Watson Speech services service on Red Hat® OpenShift® Container Platform.

To upgrade Watson Speech services, ensure that all of the Operator Lifecycle Manager (OLM) objects in the ${PROJECT_CPD_OPS} project, such as the catalog sources and subscriptions, are upgraded to the appropriate release. All of the OLM objects must be at the same release.

Who needs to complete this task?
You must be a cluster administrator (or a user with the appropriate permissions to install operators) to create the OLM objects.
When do you need to complete this task?
Complete this task only if the OLM artifacts have not been updated for the current release using the cpd-cli manage apply-olm command with the --upgrade=true option.

It is not necessary to run this command multiple times for each service that you plan to upgrade. If you complete this task and the OLM artifacts already exist on the cluster, the cpd-cli will recreate the OLM objects for all of the existing components in the ${PROJECT_CPD_OPS} project.

To update the operator:

  1. Update the OLM objects:
    cpd-cli manage apply-olm \
--release=${VERSION} \
--cpd_operator_ns=${PROJECT_CPD_OPS} \
--upgrade=true
    • If the command succeeds, it returns [SUCCESS]... The apply-olm command ran successfully.
    • If the command fails, it returns [ERROR] and includes information about the cause of the failure.

What to do next: Upgrade the Watson Speech services service.

Upgrading the service

After the Watson Speech services operator is updated, you can upgrade Watson Speech services.

Who needs to complete this task?
You must be an administrator of the project where Watson Speech services is installed.
When do you need to complete this task?
Complete this task for each instance of Watson Speech services that is associated with an instance of Cloud Pak for Data Version 4.6.

To upgrade the service:

  1. Update the custom resource for Watson Speech services.

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

    Red Hat OpenShift Data Foundation storage

    Run the following command to update the custom resource.

    cpd-cli manage apply-cr \
--components=watson_speech \
--release=${VERSION} \
--cpd_instance_ns=${PROJECT_CPD_INSTANCE} \
--block_storage_class=${STG_CLASS_BLOCK} \
--file_storage_class=${STG_CLASS_FILE} \
--license_acceptance=true \
--upgrade=true
    IBM Storage Fusion storage

    Run the following command to update the custom resource.

    Remember: When you use IBM Storage Fusion storage, both ${STG_CLASS_BLOCK} and ${STG_CLASS_FILE} point to the same storage class.
    cpd-cli manage apply-cr \
--components=watson_speech \
--release=${VERSION} \
--cpd_instance_ns=${PROJECT_CPD_INSTANCE} \
--block_storage_class=${STG_CLASS_BLOCK} \
--file_storage_class=${STG_CLASS_FILE} \
--license_acceptance=true \
--upgrade=true
    IBM Storage Scale Container Native storage

    Run the following command to update the custom resource.

    Remember: When you use IBM Storage Scale Container Native storage, both ${STG_CLASS_BLOCK} and ${STG_CLASS_FILE} point to the same storage class.
    cpd-cli manage apply-cr \
--components=watson_speech \
--release=${VERSION} \
--cpd_instance_ns=${PROJECT_CPD_INSTANCE} \
--block_storage_class=${STG_CLASS_BLOCK} \
--file_storage_class=${STG_CLASS_FILE} \
--license_acceptance=true \
--upgrade=true
    Portworx storage

    Run the following command to update the custom resource.

    cpd-cli manage apply-cr \
--components=watson_speech \
--release=${VERSION} \
--cpd_instance_ns=${PROJECT_CPD_INSTANCE} \
--storage_vendor=portworx \
--license_acceptance=true \
--upgrade=true
    AWS with EFS and EBS storage

    Run the following command to update the custom resource.

    cpd-cli manage apply-cr \
--components=watson_speech \
--release=${VERSION} \
--cpd_instance_ns=${PROJECT_CPD_INSTANCE} \
--block_storage_class=${STG_CLASS_BLOCK} \
--file_storage_class=${STG_CLASS_FILE} \
--license_acceptance=true
    IBM Cloud with IBM Cloud File Storage and IBM Cloud Block Storage

    Run the following command to update the custom resource.

    cpd-cli manage apply-cr \
--components=watson_speech \
--release=${VERSION} \
--cpd_instance_ns=${PROJECT_CPD_INSTANCE} \
--block_storage_class=${STG_CLASS_BLOCK} \
--file_storage_class=${STG_CLASS_FILE} \
--license_acceptance=true \
--upgrade=true
    NetApp Trident

    Run the following command to create the custom resource.

    Remember: When you use NetApp Trident storage, both ${STG_CLASS_BLOCK} and ${STG_CLASS_FILE} point to the same storage class.
    cpd-cli manage apply-cr \
--components=watson_speech \
--release=${VERSION} \
--cpd_instance_ns=${PROJECT_CPD_INSTANCE} \
--block_storage_class=${STG_CLASS_BLOCK} \
--file_storage_class=${STG_CLASS_FILE} \
--license_acceptance=true
    Remember: To specify advanced installation options for Watson Speech services add the following line before the --license_acceptance entry:
    --param-file=/tmp/work/install-options.yml \

Validating the upgrade

Watson Speech services is upgraded when the apply-cr command returns [SUCCESS]... The apply-cr command ran successfully.

However, you can optionally run the cpd-cli manage get-cr-status command if you want to confirm that the custom resource status is Completed:

cpd-cli manage get-cr-status \
--cpd_instance_ns=${PROJECT_CPD_INSTANCE} \
--components=watson_speech

What to do next

Watson Speech services is ready to use. To get started with Watson Speech services, see Processing spoken audio with Watson Speech services.