Installing Voice Gateway

Information you need to complete this task

Review the following information before you install Voice Gateway:

Version requirements

All of the components that are associated with an instance of IBM Software Hub must be installed at the same release. For example, if the IBM Software Hub control plane is installed at Version 5.4.0, you must install Voice Gateway at Version 5.4.0.

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

Security context constraint

Voice Gateway works with the default Red Hat® OpenShift® Container Platform security context constraint, restricted-v2.

Storage requirements

You don't need to specify storage when you install Voice Gateway. For more information about available storage options, see Storage considerations.

Before you begin

This task assumes that the following prerequisites are met:

System requirements

This task assumes that the cluster meets the minimum requirements for Voice Gateway.

Where to find more information
If this task is not complete, see System requirements.

Workstation

This task assumes that the workstation from which you will run the installation is set up as a client workstation and has the following command-line interfaces:

• IBM Software Hub CLI: cpd-cli
• OpenShift CLI: oc
• Helm CLI: helm

Where to find more information
If this task is not complete, see Setting up a client workstation.

Control plane

This task assumes that the IBM Software Hub control plane is installed.

Where to find more information
If this task is not complete, see Installing an instance of IBM Software Hub.

Private container registry

If your environment uses a private container registry (for example, your cluster is air-gapped), this task assumes that the following tasks are complete:

1. The Voice Gateway software images are mirrored to the private container registry.

   Where to find more information
   If this task is not complete, see Mirroring images to a private container registry.

2. The cpd-cli is configured to pull the olm-utils-v4 image from the private container registry.

   Where to find more information
   If this task is not complete, see Pulling the olm-utils-v4 image from the private container registry.

SMT settings

The simultaneous multithreading (SMT) settings for Kernel-based Virtual Machine (KVM) capable systems and big core PowerVM capable systems are adjusted, if applicable.

Where to find more information
If this task is not complete, see Changing Power settings.

Prerequisite services

Before you install Voice Gateway, ensure that the following services are installed and running:

• watsonx Assistant

• Watson Speech services

Procedure

Complete the following tasks to install Voice Gateway:

1. Specifying installation options
2. Installing the service
3. Validating the installation
4. What to do next

Specifying installation options

For information on overriding the default settings, see Setting installation options for Voice Gateway.

Installing the service

To install Voice Gateway:

1. Log the cpd-cli in to the Red Hat OpenShift Container Platform cluster:

   ${CPDM_OC_LOGIN}

   Remember: CPDM_OC_LOGIN is an alias for the cpd-cli manage login-to-ocp command.
2. Install the operator and custom resource for Voice Gateway.

   Run the appropriate command for your environment:

   Default installation (without installation options)

   cpd-cli manage install-components \
   --license_acceptance=true \
   --components=voice_gateway \
   --release=${VERSION} \
   --patch_id=${PATCH_ID} \
   --operator_ns=${PROJECT_CPD_INST_OPERATORS} \
   --instance_ns=${PROJECT_CPD_INST_OPERANDS} \
   --image_pull_prefix=${IMAGE_PULL_PREFIX} \
   --image_pull_secret=${IMAGE_PULL_SECRET}

   Custom installation (with installation options)

   cpd-cli manage install-components \
   --license_acceptance=true \
   --components=voice_gateway \
   --release=${VERSION} \
   --patch_id=${PATCH_ID} \
   --operator_ns=${PROJECT_CPD_INST_OPERATORS} \
   --instance_ns=${PROJECT_CPD_INST_OPERANDS} \
   --image_pull_prefix=${IMAGE_PULL_PREFIX} \
   --image_pull_secret=${IMAGE_PULL_SECRET} \
   --param-file=/tmp/work/install-options.yml

Validating the installation

[SUCCESS]... The install-components command ran successfully

If you want to confirm that the custom resource status is Ready, 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=voice_gateway

What to do next