Installing Voice Gateway

Information you need to complete this task

Review the following information before you install Voice Gateway:

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:

  source ./cpd_vars.sh

Security context constraint requirements

Voice Gateway uses the restricted security context constraint (SCC).

Installation location

Voice Gateway must be installed in the same project (namespace) as the Cloud Pak for Data control plane. This project is identified by the ${PROJECT_CPD_INSTANCE} environment variable.

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. Logging in to the cluster
2. Installing the operator
3. Installing the service
4. Validating the installation
5. What to do next

Logging in to the cluster

To run cpd-cli manage commands, you must log in to the cluster.

To log in to the cluster:

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.

Installing the operator

The Voice Gateway operator simplifies the process of managing the Voice Gateway service on Red Hat® OpenShift Container Platform.

To install Voice Gateway, you must install the Voice Gateway operator and create the Operator Lifecycle Manager (OLM) objects, such as the catalog source and subscription, for the operator.

Who needs to complete this task?

You must be a cluster administrator (or a user with the appropriate permissions to install operators) to create the OLM objects.

When do you need to complete this task?

Complete this task if the Voice Gateway operator and other OLM artifacts have not been created for the current release.

If you complete this task and the OLM artifacts already exist on the cluster, the cpd-cli detects that you already have the OLM objects for the components at the specified release, the cpd-cli does not attempt to create the OLM objects again.

To install the operator:

1. Create the OLM objects for Voice Gateway:

   cpd-cli manage apply-olm \
   --release=${VERSION} \
   --cpd_operator_ns=${PROJECT_CPD_OPS} \
   --components=voice_gateway

   • If the command succeeds, it returns [SUCCESS]... The apply-olm command ran successfully.
   • If the command fails, it returns [ERROR] and includes information about the cause of the failure.

What to do next: Install the Voice Gateway service.

Installing the service

After the Voice Gateway operator is installed, you can install Voice Gateway.

Who needs to complete this task?

You must be an administrator of the project where you will install Voice Gateway.

When do you need to complete this task?

Complete this task if you want to add Voice Gateway to your environment.

To install the service:

1. Create the custom resource for Voice Gateway:

   cat <<EOF |oc apply -f -
   apiVersion: voicegateway.watson.ibm.com/v1
   kind: VoiceGateway
   metadata:
     name: voicegateway-cr       # This is the recommended name, but you can change it
     namespace: PROJECT_CPD_INSTANCE
   spec:
     license:
       accept: true
       license: Enterprise     # Specify the license you purchased
     replicas: 1                 # Set the number of desired replicas
     sslConfig:
       disableSslCertValidation: true
     resources:                  # Allocate available resources: 80% to mediaRelay and 20% to sipOrchestrator container
       sipOrchestrator:
         requests:
           cpu: "1.0"
           memory: 2Gi
         limits:
           cpu: "1.0"
           memory: 2Gi
       mediaRelay:
         requests:
           cpu: "0.5"
           memory: 1Gi
         limits:
           cpu: "0.5"
           memory: 1Gi 
   EOF

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