Backing up and restoring Watson Speech services data

Preparing for backup

To back up your data, you need the following:

• The name of your Speech services custom resource.
• The name of the PostgreSQL datastore authentication secret that you used during installation of the Speech services. The default value is custom-resource-name-postgres-auth-secret.
• The name of the MinIO datastore authentication secret that you used during installation of the Speech services. The default value is custom-resource-name-ibm-minio-auth.
• The instance IDs of your service instances. You need the IDs to transfer ownership of the resources in the event of a catastrophic failure.

You can find the instance ID for a service instance in its URL under the Access information section in the Cloud Pak for Data console. For example, the following example shows two Speech services instances, one for Text to Speech and one for Speech to Text:

Clicking the name of the Speech to Text instance, speech-to-text-c248, causes the console to display the About this instance page with details about the instance. The instance ID in the following example is circled in the URL that is located under Access information:

You can use this procedure to find the instance IDs for all service instances in any deployment.

Backing up your data

From a Linux machine that has internet access, use the import_export.sh script to back up your data to a local directory:

1. Change directories to the root of the directory into which you downloaded or cloned the utilities:

   cd speech-import-export

2. Run the import_export.sh script with the following options:

   ./import_export.sh export -c ${CUSTOM_RESOURCE_SPEECH} \
      -o <export_directory> -v <version> \
      -p <postgres_auth_secret_name> -m <minio_auth-secret-name> \
      -n ${PROJECT_CPD_INSTANCE} --no-quiesce

   where the options and arguments provide the following information:

   ${CUSTOM_RESOURCE_SPEECH}

   The required name of the Speech services custom resource from which the script is to back up data.

   export_directory

   The required path name of the directory in which the script is to save the backed up data. The script creates the directory if it does not already exist. If the directory does already exist but is not empty, the script overwrites the existing contents.

   version

   The version from which you are backing up data. Use 46 for Cloud Pak for Data version 4.6.x.

   postgres_auth_secret_name

   The Kubernetes secret that is used to authenticate to the PostgreSQL datastore. You can omit the authentication secret if is the same as the default value (custom-resource-name-postgres-auth-secret). You must provide the secret if it is different from the default value.

   minio_auth_secret_name

   The Kubernetes secret that is used to authenticate to the MinIO datastore. You can omit the authentication secret if is the same as the default value (custom-resource-name-ibm-minio-auth). You must provide the secret if it is different from the default value.

   ${PROJECT_CPD_INSTANCE}

   The name of the project namespace in which the Speech services are installed. If the namespace is different from the current Red Hat OpenShift context, you must provide the Red Hat OpenShift namespace in which the Speech services are installed. Otherwise, you can omit the namespace.

   --no-quiesce

   Proceeds with the backup without first putting the service into read-only mode, so the backup takes less time. Do not use the option in production environments.

3. Create a file to record the instance IDs of your service instances. Save the file outside of the export_directory to which your data is backed up. Do not store the instance IDs in the export_directory. That directory has a well-defined structure that must remain unchanged. For more information about the format of the backup data, see Exported data format.

4. To store your backup data efficiently, you can compress the output directory and the file of instance IDs by using a lossless compression algorithm.

5. Store your backup data on a mounted volume or file system that resides on a different host from the datastores. Alternatively, you can copy the backup files to a safe location.

The script reports on its status as it creates the backup data. It shows its status for each individual datastore and then provides a final status report when the entire backup operation is complete. If the script reports no errors, the backup process completed successfully. For more information about what the script does when it backs up data, see What happens when you export data.

Preparing for restore

To restore your data, you need the following:

• The name of your Speech services custom resource.
• The name of the PostgreSQL datastore authentication secret that you used during installation of the Speech services. The default value is custom-resource-name-postgres-auth-secret.
• The name of the MinIO datastore authentication secret that you used during installation of the Speech services. The default value is custom-resource-name-ibm-minio-auth.

• To restore your data, your deployment must already have installed the same Red Hat OpenShift and Speech services versions as the deployment from which the data was backed up. The deployment must run the same Speech microservices as the original deployment.

  • For Speech to Text, the microservices can include sttRuntime, sttAsync, and sttCustomization.
  • For Text to Speech, they can include ttsRuntime and ttsCustomization.

  For example, if the deployment from which you backed up the data ran all of these microservices, the deployment to which you are restoring the data must also run all of the microservices. Otherwise, the necessary datastores might not exist, and the restore will fail.

Restoring your data

From a Linux machine that has internet access, use the import_export.sh script to restore the data that you previously backed up:

1. Determine the type of restore you are performing:

   • If you are restoring your data to a new deployment, possibly to recover from a catastrophic failure, you must reinstall Red Hat OpenShift and the Speech services to duplicate the environment from which the data was backed up. For more information, see Installing Watson Speech services.

   • If you are restoring your data to the same deployment, possibly to recover from corruption or to revert to a previous known good state, you do not need to re-create your deployment. So long as all of the microservices remain the same and have the same instance IDs, you can restore to the same existing deployment.

2. Change directories to the root of the directory into which you downloaded or cloned the utilities:

   cd speech-import-export

3. Run the import_export.sh script with the following options:

   ./import_export.sh import -c ${CUSTOM_RESOURCE_SPEECH} \
      -o <import_directory> -v <version> \
      -p <postgres_auth_secret_name> -m <minio_auth-secret-name> \
      -n ${PROJECT_CPD_INSTANCE} --no-quiesce

   where the options and arguments provide the following information:

   ${CUSTOM_RESOURCE_SPEECH}

   The required name of the Speech services custom resource to which the script is to restore data.

   import_directory

   The required path name of the directory from which the script can access the previously backed up data. The directory must exist and must contain the backup data in the format in which it was created. If you compressed the backup data, you must uncompress the data before you can restore it.

   version

   The version to which you are restoring data. Use 46 for version 4.6.x of Cloud Pak for Data.

   postgres_auth_secret_name

   The Kubernetes secret that is used to authenticate to the PostgreSQL datastore. You can omit the authentication secret if is the same as the default value (custom-resource-name-postgres-auth-secret). You must provide the secret if it is different from the default value.

   minio_auth_secret_name

   The Kubernetes secret that is used to authenticate to the MinIO datastore. You can omit the authentication secret if is the same as the default value (custom-resource-name-ibm-minio-auth). You must provide the secret if it is different from the default value.

   ${PROJECT_CPD_INSTANCE}

   The name of the project namespace in which the Speech services are installed. If the namespace is different from the current Red Hat OpenShift context, you must provide the Red Hat OpenShift namespace in which the Speech services are installed. Otherwise, you can omit the namespace.

   --no-quiesce

   Proceeds with the restore without first putting the service into read-only mode, so the restore takes less time. Do not use the option in production environments.

4. Determine whether you need to transfer ownership of the restored date:

   • If you are restoring your data to a new deployment, you must transfer ownership of the restored resources to make the data accessible in the new deployment. To transfer ownership, complete the procedure in Transferring resource ownership. You can transfer ownership as soon as the import script is complete. You do not need to wait for the services to exit read-only mode to transfer ownership.

   • If you are restoring your data to the same deployment, you do not need to transfer ownership. The original instance IDs already exist because the deployment already exists.

The script reports on its status as it restores data. It shows its status for each datastore and then provides a final status report when the entire restore operation is complete. If the script reports no errors, the restore process completed successfully. For more information about what the script does when it restores data, see What happens when you import data.