Upgrading Watson Speech services from Version 4.6 to Version 4.7

An instance administrator can upgrade Watson Speech services from Cloud Pak for Data Version 4.6 to Version 4.7.

Important: Before upgrading to Watson Speech services version 4.7 or later, 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 from a previous version . That topic also includes information about restoring your data if that becomes necessary.
Warning: When upgrading to Watson Speech services version 4.7 or later, the MinIO to Multicloud Object Gateway migration may fail, blocking the upgrade. For more details, refer to the known issue. Apply the solution before upgrading.
Who needs to complete this task?

Instance administrator To upgrade Watson Speech services, you must be an instance administrator. An instance administrator has permission to manage software in the following projects:

The operators project for the instance

The operators for this instance of Cloud Pak for Data are installed in the operators project. In the upgrade commands, the ${PROJECT_CPD_INST_OPERATORS} environment variable refers to the operators project.

The operands project for the instance

The Cloud Pak for Data control plane and the services for this instance of Cloud Pak for Data are installed in the operands project. In the upgrade commands, the ${PROJECT_CPD_INST_OPERANDS} environment variable refers to the operands project.

When do you need to complete this task?

Review the following options to determine whether you need to complete this task:

  • If you want to upgrade the Cloud Pak for Data control plane and one or more services at the same time, follow the process in Upgrading an instance of Cloud Pak for Data instead.
  • If you didn't upgrade Watson Speech services when you upgraded the Cloud Pak for Data control plane, complete this task to upgrade Watson Speech services.

    Repeat as needed If you are responsible for multiple instances of Cloud Pak for Data, you can repeat this task to upgrade more instances of Watson Speech services on the cluster.

Information you need to complete this task

Review the following information before you upgrade Watson Speech services:

Version requirements

All 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 at Version 4.7.4, you must upgrade Watson Speech services to 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
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
Common core services
Watson Speech services requires the Cloud Pak for Data common core services.

If the common core services are not at the correct version in the operands project for the instance, the common core services are automatically upgraded when you upgrade Watson Speech services. The common core services upgrade increases the amount of time the upgrade takes to complete.

Storage requirements
Specify the storage that 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 following command-line interfaces:
  • Cloud Pak for Data CLI: cpd-cli
  • OpenShift® CLI: oc
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 an instance of Cloud Pak for Data.
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.
For environments that use a private container registry, such as air-gapped environments, the cpd-cli is configured to pull the olm-utils-v2 image from the private container registry. If this task is not complete, see Pulling the olm-utils-v2 image from the private container registry.
Multicloud Object Gateway is installed and configured. If this task is not complete, see Installing Multicloud Object Gateway.
The secrets that enable Watson Speech services to connect to Multicloud Object Gateway exist. If this task is not complete, see Creating secrets for services that use Multicloud Object Gateway.

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

  • You cannot uninstall individual microservices after 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 microservices, you must uninstall the Watson Speech services and reinstall only the microservices that you need. You can remove and reinstall the following microservices:
    • Speech to Text runtime
    • Speech to Text asynchronous HTTP
    • Speech to Text customization
    • Text to Speech runtime
    • Text to Speech customization
  • If you want to install more Speech to Text models or Text to Speech voices during upgrade, install all currently installed models and voices that you want to maintain. For example, if you 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 might not be deleted when it finishes. To ensure that the upgrade completes successfully, delete the MinIO backup job manually. 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. Upgrading the service
  2. Validating the upgrade
  3. Optional: Removing MinIO resources
  4. What to do next

Upgrading the service

Important: The Operator Lifecycle Manager (OLM) objects for Watson Speech services were updated when you upgraded the Cloud Pak for Data platform. The cpd-cli manage apply-olm updates all of the OLM objects in the operators project at the same time.

To upgrade Watson Speech services:

  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. 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 appropriate command to create the custom resource.

    Default installation (without installation options)
    cpd-cli manage apply-cr \
    --components=watson_speech \
    --release=${VERSION} \
    --cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
    --block_storage_class=${STG_CLASS_BLOCK} \
    --file_storage_class=${STG_CLASS_FILE} \
    --license_acceptance=true \
    --upgrade=true
    Custom installation (with installation options)
    cpd-cli manage apply-cr \
    --components=watson_speech \
    --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 \
    --upgrade=true

    IBM Storage Fusion Data Foundation storage

    Run the appropriate command to create the custom resource.

    Default installation (without installation options)
    cpd-cli manage apply-cr \
    --components=watson_speech \
    --release=${VERSION} \
    --cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
    --block_storage_class=${STG_CLASS_BLOCK} \
    --file_storage_class=${STG_CLASS_FILE} \
    --license_acceptance=true \
    --upgrade=true
    Custom installation (with installation options)
    cpd-cli manage apply-cr \
    --components=watson_speech \
    --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 \
    --upgrade=true

    IBM Storage Fusion Global Data Platform storage
    Remember: When you use IBM Storage Fusion storage, both ${STG_CLASS_BLOCK} and ${STG_CLASS_FILE} point to the same storage class, typically ibm-spectrum-scale-sc.

    Run the appropriate command to create the custom resource.

    Default installation (without installation options)
    cpd-cli manage apply-cr \
    --components=watson_speech \
    --release=${VERSION} \
    --cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
    --block_storage_class=${STG_CLASS_BLOCK} \
    --file_storage_class=${STG_CLASS_FILE} \
    --license_acceptance=true \
    --upgrade=true
    Custom installation (with installation options)
    cpd-cli manage apply-cr \
    --components=watson_speech \
    --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 \
    --upgrade=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 appropriate command to create the custom resource.

    Default installation (without installation options)
    cpd-cli manage apply-cr \
    --components=watson_speech \
    --release=${VERSION} \
    --cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
    --block_storage_class=${STG_CLASS_BLOCK} \
    --file_storage_class=${STG_CLASS_FILE} \
    --license_acceptance=true \
    --upgrade=true
    Custom installation (with installation options)
    cpd-cli manage apply-cr \
    --components=watson_speech \
    --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 \
    --upgrade=true

    Portworx storage

    Run the appropriate command to create the custom resource.

    Default installation (without installation options)
    cpd-cli manage apply-cr \
    --components=watson_speech \
    --release=${VERSION} \
    --cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
    --storage_vendor=portworx \
    --license_acceptance=true \
    --upgrade=true
    Custom installation (with installation options)
    cpd-cli manage apply-cr \
    --components=watson_speech \
    --release=${VERSION} \
    --cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
    --storage_vendor=portworx \
    --param-file=/tmp/work/install-options.yml \
    --license_acceptance=true \
    --upgrade=true

    AWS with EFS and EBS storage

    Run the appropriate command to create the custom resource.

    Default installation (without installation options)
    cpd-cli manage apply-cr \
    --components=watson_speech \
    --release=${VERSION} \
    --cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
    --block_storage_class=${STG_CLASS_BLOCK} \
    --file_storage_class=${STG_CLASS_FILE} \
    --license_acceptance=true \
    --upgrade=true
    Custom installation (with installation options)
    cpd-cli manage apply-cr \
    --components=watson_speech \
    --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 \
    --upgrade=true

    NetApp Trident
    Remember: When you use NetApp Trident storage, both ${STG_CLASS_BLOCK} and ${STG_CLASS_FILE} point to the same storage class.

    Run the appropriate command to create the custom resource.

    Default installation (without installation options)
    cpd-cli manage apply-cr \
    --components=watson_speech \
    --release=${VERSION} \
    --cpd_instance_ns=${PROJECT_CPD_INST_OPERANDS} \
    --block_storage_class=${STG_CLASS_BLOCK} \
    --file_storage_class=${STG_CLASS_FILE} \
    --license_acceptance=true \
    --upgrade=true
    Custom installation (with installation options)
    cpd-cli manage apply-cr \
    --components=watson_speech \
    --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 \
    --upgrade=true

Validating the upgrade

Watson Speech services is upgraded when the apply-cr command returns:
[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_speech

Optional: Removing MinIO resources

If you have MinIO custom resources and persistent volumes that are no longer in use, you can remove them.
  1. Find any unused MinIO custom resource.
    oc get miniocluster -l release=${CUSTOM_RESOURCE_SPEECH} -n ${PROJECT_CPD_INST_OPERANDS}
    Delete the MinIO custom resource.
    oc delete miniocluster ${CUSTOM_RESOURCE_SPEECH} -n ${PROJECT_CPD_INST_OPERANDS}
  2. Find any unused MinIO PVCs.
    oc get pvc -n ${PROJECT_CPD_INST_OPERANDS} -l release=${CUSTOM_RESOURCE_SPEECH} | grep minio
    Delete the MinIO PVCs.
    oc get pvc -n ${PROJECT_CPD_INST_OPERANDS} -l release=${CUSTOM_RESOURCE_SPEECH} | grep minio | awk '{print $1}' | xargs oc delete pvc -n ${PROJECT_CPD_INST_OPERANDS}
  3. Delete the MinIO auth secrets and configmap.
    oc delete secret ${CUSTOM_RESOURCE_SPEECH}-ibm-minio-auth -n ${PROJECT_CPD_INST_OPERANDS}
    oc delete configmap ${CUSTOM_RESOURCE_SPEECH}-minio-kes-config  -n ${PROJECT_CPD_INST_OPERANDS}

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.