Configure Voice Microservices

This topic is part of the manual Voice Microservices Private Edition Guide for version Current of Voice Microservices.

Override Helm chart values

For general information about overriding Helm chart values, see Overriding Helm Chart values in the Genesys Engage Cloud Private Edition Guide.

When deploying Voice services, certain parameters need to be enabled or modified based on customer requirements and environment. For each of the Voice services, an override values file needs to be created which will override certain sections of the default configuration for the service. In this document, we use the following format for creating an override values file: <servicename>_override_values.yaml.

The override values file contains the following sections.

Deployment section

This section can be used to specify minimum and max instances that will be started for each service. By default, the min replica is 1, and the max replica is 10. Customers can modify it as per their load requirements. For RQ service alone it is recommended to set replica count 2 or more than that based on load for High availability.

deployment:
namespace: voice      # Namespace of voice service
replicaCount: 1       # Min replica count when service is deployed
maxReplicas: 10       # Max replica count to which the service will scale.

Image section

This section has information about the registry from where the voice services will be deployed.

image:
  registry: pureengage-docker-staging.jfrog.io  # registry from where image needs to be deployed
  pullPolicy: Always                            # whether to pull image always
  imagePullSecrets: "mycred"                    # Secrets needed for pulling image from registry

Config section

The below section contains configuration parameters that need to be overridden for all voice services.

For SIP Service alone, additional information needs to be passed (dnsServer). Get the DNS Server value from the above section (Configure DNS server for voice-sip).

# Set the redis port to be used.
context:
  envs:
    redis:
      port: 6379             # Redis port
    dnsServer: "10.202.0.10" # DNS server address. Needed only for SIP Service.

Secrets section

This section captures all the secrets needed by voice services for connecting to infra services (Consul, Kafka, Redis). The default values for Redis and Kafka secrets are the same as what is created above.

# set the secrets
secrets:
  consulACL:
    volumes:
    - name: consul-shared-secret
      secret:
        secretName: consul-voice-token         # consul secret

HPA section

This section captures whether HPA is enabled for a service or not and also what is the CPU and memory percentage used for scale up and scale down. Common HPA for following voice services: Agent Service, Config Service, Callthread Service, Registrar Service, Sipfe service, DialPlan Service.

hpa:
  targetCPUPercent: 60         # Average CPU percentage which determine scale up and down
  targetMemoryPercent: 60      # Average Memory percentage which determine scale up and down
  enabled: true                # Horizontal Pod scalar enabled

For SIPProxy and RQ, HPA is set to false:

hpa:
  enabled: false                # Horizontal Pod scalar enabled

For SIP and ORS, HPA is set as follows:

hpa:
  targetCPUPercent: 50         # Average CPU percentage which determine scale up and down
  targetMemoryPercent: 50      # Average Memory percentage which determine scale up and down
  enabled: true                # Horizontal Pod scalar enabled

Resources section

This section captures the resource request and limits for each voice service. The default resource given below is set for each service. Customers can modify this request and limit based on their load requirement.

resources:
  requests:
    cpu: "250m"
    memory: "256Mi"
  limits:
    cpu: "500m"
    memory: "512Mi"

For ORS and SIPS service the CPU and memory requirement is high so we recommend it to be set to the following:

resources:
  requests:
    cpu: "500m"
    memory: "1Gi"
  limits:
    cpu: "1500m"
    memory: "4Gi"

Log volume

This section captures parameters pertaining to log volumes needed by SIP Service. These parameters are needed for storing logging of SIP Server binary which is run inside SIP service. The values for storageClass and volumeName should be configured based on the recommendation given in the Persistent Volume section.

# pvc will be created for logs
volumes:
  pvcLog:
    create: true
    claim: sip-log-pvc
    storageClass:
    volumeName:
   
  pvcJsonLog:
    create: true
    claim: sip-json-log-pvc
    storageClass:
    volumeName:
 
  log:
    mountPath:
 
  jsonLog:
    mountPath:

Configure Kubernetes

Content coming soon

Configure security

Security Context Configuration

Before you deploy the Voice Microservices, be sure to read Security Settings in the Setting up Genesys Engage Cloud Private Edition guide.

Bind the Security Context Contraint (SCC) to service accounts used by Voice Services to grant permissions for any operations from the pod/container. The following example is specific to an OpenShift cluster.

oc adm policy add-scc-to-user genesys-restricted -z voice-agent -n voice
oc adm policy add-scc-to-user genesys-restricted -z voice-callthread -n voice
oc adm policy add-scc-to-user genesys-restricted -z voice-config -n voice
oc adm policy add-scc-to-user genesys-restricted -z voice-registrar -n voice
oc adm policy add-scc-to-user genesys-restricted -z voice-sip -n voice
oc adm policy add-scc-to-user genesys-restricted -z voice-sipfe -n voice
oc adm policy add-scc-to-user genesys-restricted -z voice-sipproxy -n voice
oc adm policy add-scc-to-user genesys-restricted -z voice-rq -n voice
oc adm policy add-scc-to-user genesys-restricted -z voice-ors -n voice
oc adm policy add-scc-to-user genesys-restricted -z voice-dialplan -n voice
oc adm policy add-scc-to-user genesys-restricted -z tenant-<TENANT-UUID> -n voice

Secrets for Voice Services

Create the following Kubernetes secrets for other infrastructure services:

Kafka
docker-registry
Redis

Kafka secrets

Kafka secrets must be created when Kafka is deployed. The secret is referenced in the Voice Microservices Values.yaml file.

Redis secrets

Ensure Redis is installed before you deploy the Voice Services.

Use the following commands to create Redis secrets:

export REDIS_PASSWORD=$(kubectl get secret infra-redis-redis-cluster -n infra -o jsonpath="{.data.redis-password}" | base64 --decode)
kubectl create secret generic -n voice redis-agent-token --from-literal=redis-agent-state={\"password\":\"$REDIS_PASSWORD\"}
kubectl create secret generic -n voice redis-callthread-token --from-literal=redis-call-state={\"password\":\"$REDIS_PASSWORD\"}
kubectl create secret generic -n voice redis-config-token --from-literal=redis-config-state={\"password\":\"$REDIS_PASSWORD\"}
kubectl create secret generic -n voice redis-tenant-token --from-literal=redis-tenant-stream={\"password\":\"$REDIS_PASSWORD\"}
kubectl create secret generic -n voice redis-registrar-token --from-literal=redis-registrar-state={\"password\":\"$REDIS_PASSWORD\"}
kubectl create secret generic -n voice redis-sip-token --from-literal=redis-sip-state={\"password\":\"$REDIS_PASSWORD\"}
kubectl create secret generic -n voice redis-ors-stream-token --from-literal=redis-ors-stream={\"password\":\"$REDIS_PASSWORD\"}
kubectl create secret generic -n voice redis-ors-token --from-literal=redis-ors-state={\"password\":\"$REDIS_PASSWORD\"}
kubectl create secret generic -n voice redis-rq-token --from-literal=redis-rq-state={\"password\":\"$REDIS_PASSWORD\"}

JFrog secrets

Use the following commands to create Jfrog secrets:

kubectl create secret docker-registry <credential-name>  --docker-server=<docker-repo> --docker-username="$JFROG_USER" --docker-password="$JFROG_PASSWORD" -n voice

Voice Microservices Private Edition Guide

Overview

Configure and deploy

Configure and deploy Voicemail

Observability

Functionality