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 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 4.7.4, you must install Voice Gateway at 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

Security context constraint

Voice Gateway works with the default Red Hat® OpenShift® Container Platform security context constraint:

• On Version 4.10, the default SCC is restricted.
• On Version 4.12, the default SCC is 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:

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

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

Installing the service

To install Voice Gateway:

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. 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 --selector=app.kubernetes.io/name=ibm-voice-gateway-operator -o wide

What to do next