Installing Voice Gateway

An instance administrator can install Voice Gateway on IBM Cloud Pak for Data Version 5.0.

Who needs to complete this task?

Instance administrator To install Voice Gateway, you must be an instance administrator. An instance administrator has permission to install software in the following projects:

The operators project for the instance

The operators for this instance of Voice Gateway are installed in the operators project.

In the installation commands, the ${PROJECT_CPD_INST_OPERATORS} environment variable refers to the operators project.

The operands project for the instance

The custom resources for the control plane and Voice Gateway are installed in the operands project.

In the installation 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 install multiple services at the same time, follow the process in Running a batch installation of solutions and services instead.
  • If you didn't install Voice Gateway as part of a batch installation, complete this task to add Voice Gateway to your environment.

    Repeat as needed If you are responsible for multiple instances of Cloud Pak for Data, you can repeat this task to install more instances of Voice Gateway on the cluster.

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 Cloud Pak for Data must be installed at the same release. For example, if the Cloud Pak for Data control plane is installed at Version 5.0.3, you must install Voice Gateway at Version 5.0.3.

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:

Prerequisite Where to find more information
The cluster meets the minimum requirements for installing Voice Gateway. If this task is not complete, see System requirements.
The workstation from which you will run the installation is set up as a client workstation and includes the following command-line interfaces:
  • Cloud Pak for Data CLI: cpd-cli
  • OpenShift CLI: oc
 If this task is not complete, see Setting up a client workstation.
The Cloud Pak for Data control plane is installed. If this task is not complete, see Installing an instance of Cloud Pak for Data.
For environments that use a private container registry, such as air-gapped environments, the Voice Gateway 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-v3 image from the private container registry. If this task is not complete, see Pulling the olm-utils-v3 image from the private container registry.
The vgw-tenantconfig-secret secret must exist in the project that you chose or created for the Voice Gateway installation. The following Watson services are prerequisite:

Procedure

Complete the following tasks to install Voice Gateway:

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

Specifying installation options

Voice Gateway supports numerous installation options. You can use the installation options to override the default settings for:
  • Node selectors
  • Taint tolerations
  • SSL configuration
  • Ports
  • Environment variables
  • Storage
  • Container resources
  • G729 Codec Service
  • Media Resource Control Protocol

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. Run the following command to create the required OLM objects for Voice Gateway in the operators project for the instance:
    cpd-cli manage apply-olm \
--release=${VERSION} \
--cpd_operator_ns=${PROJECT_CPD_INST_OPERATORS} \
--components=voice_gateway
    Wait for the cpd-cli to return the following message before you proceed to the next step:
    [SUCCESS]... The apply-olm command ran successfully

    If the apply-olm fails, see Troubleshooting the apply-olm command during installation or upgrade.

  3. Create the custom resource for Voice Gateway.

    Run the appropriate command to create the custom resource.

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

Validating the installation

When you create the custom resource, the Voice Gateway operator processes the contents of the custom resource and creates a deployment and pods. Voice Gateway is installed when the status of all the pods is Running.

To check the status of the installation:

  1. Get the status of the Voice Gateway pods:
    oc get pods -n ${PROJECT_CPD_INST_OPERANDS} --selector=app.kubernetes.io/name=ibm-voice-gateway -o wide
Tip: To balance the load across multiple Voice Gateway pods, you need an external SIP load balancer or an SBC. The preceding command returns the IP addresses of the pods. You can add these IP addresses in your SIP load balancer or SBC device or you can directly call into them.

What to do next

Voice Gateway is ready to use. To get started with Voice Gateway, see Getting started with Voice Gateway.