Installing Watson Text to Speech service
A project administrator can install the Watson Text to Speech service on IBM® Cloud Pak for Data.
Before you begin
Required role: To complete this task, you must be an administrator of the project (namespace) where you will deploy Watson Text to Speech.
Before you install Watson Text to Speech, ensure that:
- The Cloud Pak for Data control plane is already installed on your Red Hat® OpenShift® cluster. For details, see Installing IBM Cloud Pak for Data.
- The cluster meets the minimum requirements for installing Watson Text to Speech. For details, see System requirements for services.
- You completed the steps in Preparing to install and upgrade services.
- You completed the steps in Creating an override file for Watson Text to Speech.
If you are installing multiple services on your cluster, you must run the installations one at a time and wait until the installation completes before installing another service. You cannot run the installations in parallel.
./cpd-cli install --help
Procedure
- Complete the appropriate steps to install Watson Text to Speech on your environment:
- Verifying that the installation completed successfully
- Complete the tasks listed in What to do next
Installing on clusters connected to the internet
From your installation node:
- Change to the directory where you placed the Cloud Pak for Data command-line interface and the repo.yaml file.
- Log in to your Red Hat OpenShift cluster as a project
administrator:
oc login OpenShift_URL:port
- Set up required labels. You must add a label to the namespace where IBM Cloud Pak for Data is installed.
oc label --overwrite namespace {namespace-name} ns={namespace-name}
where
{namespace-name}
is the namespace where IBM Cloud Pak for Data is installed, normallyzen
. - Make sure you are pointing at the correct OpenShift project.
oc project {namespace-name}
where
{namespace-name}
is the namespace where IBM Cloud Pak for Data is installed. - Install an EnterpriseDB PostgreSQL server that is used by the Watson Text to Speech service.
Specify the following additional parameter with the installation command:
--optional-modules edb-pg-base:x86_64
For example:cpd-cli install \ --assembly edb-operator \ --optional-modules edb-pg-base:x86_64 \ --namespace zen \ --repo repo.yaml \ --cluster-pull-prefix $(oc registry info --internal)/zen \ --transfer-image-to=$(oc registry info)/zen \ --ask-push-registry-credentials \ --insecure-skip-tls-verify
- Run the
following command to see a preview of what will be installed when you install the
service.Important: If you are using the internal Red Hat OpenShift registry and you are using the default self-signed certificate, specify the
--insecure-skip-tls-verify
flag to prevent x509 errors../cpd-cli install \ --repo ./repo.yaml \ --assembly watson-speech \ --namespace Project \ --instance Instance_name \ --storageclass Storage_class_name \ --transfer-image-to Registry_location \ --cluster-pull-prefix Registry_from_cluster \ --ask-push-registry-credentials \ --latest-dependency \ --dry-run
Important: By default, this command gets the latest version of the assembly. If you want to install a specific version of Watson Text to Speech, add the following line to your command after the--assembly
flag:--version Assembly_version \
The
--latest-dependency
flag gets the latest version of the dependent assemblies. If you remove the--latest-dependency
flag, the installer will get the minimum version of the dependent assemblies.Add the following line to your installation command after the--namespace
flag to specify the fully qualified name of your installation override file:--override speech-override
Replace the following values:
Variable Replace with Assembly_version The version of Watson Text to Speech that you want to install. The assembly versions are listed in System requirements for services.Project Use the value provided by your cluster administrator. You should have obtained this information when you completed Preparing to install and upgrade services. Instance_name The name that you want to use for this instance of Watson Text to Speech. Storage_class_name Use the value provided by your cluster administrator. You should have obtained this information when you completed Preparing to install and upgrade services. Registry_location Use the value provided by your cluster administrator. You should have obtained this information when you completed Preparing to install and upgrade services. Registry_from_cluster Use the value provided by your cluster administrator. You should have obtained this information when you completed Preparing to install and upgrade services. - Rerun the previous command without the
--dry-run
flag to install the service.
Installing on air-gapped clusters
From your installation node:
- Change to the directory where you placed the Cloud Pak for Data command-line interface.
- Log in to your Red Hat OpenShift cluster as a project
administrator:
oc login OpenShift_URL:port
- Set up required labels. You must add a label to the namespace where IBM Cloud Pak for Data is installed.
oc label --overwrite namespace {namespace-name} ns={namespace-name}
where
{namespace-name}
is the namespace where IBM Cloud Pak for Data is installed, normallyzen
. - Make sure you are pointing at the correct OpenShift project.
oc project {namespace-name}
where
{namespace-name}
is the namespace where IBM Cloud Pak for Data is installed. - Install an EnterpriseDB PostgreSQL server that is used by the Watson Text to Speech service.
Specify the following additional parameter with the installation command:
--optional-modules edb-pg-base:x86_64
For example:cpd-cli install \ --assembly edb-operator \ --optional-modules edb-pg-base:x86_64 \ --namespace zen \ --load-from cpd-cli-workspace \ --latest-dependency \ --cluster-pull-prefix $(oc registry info --internal)/zen
- Run
the following command to see a preview of what will be installed when you install the
service.Important: If you are using the internal Red Hat OpenShift registry:
- Do not specify the
--ask-pull-registry-credentials
parameter. - If you are using the default self-signed certificate, specify the
--insecure-skip-tls-verify
flag to prevent x509 errors.
./cpd-cli install \ --assembly watson-speech \ --namespace Project \ --instance Instance_name \ --storageclass Storage_class_name \ --cluster-pull-prefix Registry_from_cluster \ --ask-pull-registry-credentials \ --load-from Image_directory_location \ --latest-dependency \ --dry-run
Note: If the assembly was downloaded using thedelta-images
command, remove the--latest-dependency
flag from the command. If you don't remove the--latest-dependency
flag you will get an error indicating that the flag cannot be used.Add the following line to your installation command after the--namespace
flag to specify the fully qualified name of your installation override file:--override speech-override
Replace the following values:
Variable Replace with Project Use the value provided by your cluster administrator. You should have obtained this information when you completed Preparing to install and upgrade services. Instance_name The name that you want to use for this instance of Watson Text to Speech. Storage_class_name Use the value provided by your cluster administrator. You should have obtained this information when you completed Preparing to install and upgrade services. Registry_from_cluster Use the value provided by your cluster administrator. You should have obtained this information when you completed Preparing to install and upgrade services. Image_directory_location The location of the cpd-cli-workspace directory. Use the value provided by your cluster administrator. You should have obtained this information when you completed Preparing to install and upgrade services.
- Do not specify the
- Rerun the previous command without the
--dry-run
flag to install the service.
Verifying that the installation completed successfully
From your installation node:
- Run the following
command:
./cpd-cli status \ --assembly watson-speech \ --namespace Project
If you specified an instance name when you installed Watson Text to Speech, add the following line to your command after the--assembly
flag:
Replace Instance_name with the value you used in when you installed Watson Text to Speech.--instance Instance_name
Replace Project with the value you used in when you installed Watson Text to Speech.
- If the installation completed successfully, the status of the assembly and the modules in the assembly is Ready.
- If the installation failed, contact IBM Support for assistance.
What to do next
- The service is ready to use.