VM/Current/VMPEGuide/Configure - Revision history

WikiSysop at 08:31, March 27, 2023

2023-03-27T08:31:43Z

WikiSysop at 14:30, October 13, 2022

2022-10-13T14:30:49Z

WikiSysop at 00:30, May 17, 2022

2022-05-17T00:30:34Z

Ed.jamer@genesys.com: Text replacement - "Genesys Engage [cC]loud" to "Genesys Multicloud CX"

2021-11-09T20:28:57Z

Text replacement - "Genesys Engage [cC]loud" to "Genesys Multicloud CX"

Corinne.hicks@genesys.com: Published

2021-11-01T18:06:28Z

Published

Corinne.hicks@genesys.com: Published

2021-09-24T14:03:44Z

Published

Show changes

Corinne.hicks@genesys.com: Published

2021-06-30T19:23:32Z

Published

New page

{{Article
|Standalone=No
|DisplayName=Configure Voice Microservices
|Context=Learn how to configure Voice Microservices.
|ComingSoon=No
|Section={{Section
|sectionHeading=Override Helm chart values
|anchor=OverrideHelmValues
|alignment=Vertical
|structuredtext=For general information about overriding Helm chart values, see {{Link-AnywhereElse|product=PrivateEdition|version=Current|manual=PEGuide|topic=HelmOverrides|display text=Overriding Helm Chart values}} in the ''{{Link-AnywhereElse|product=PrivateEdition|version=Current|manual=PEGuide|display text=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.
<source lang="text">
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.
</source>

===Image section===
This section has information about the registry from where the voice services will be deployed.
<source lang="text">
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
</source>

===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).
<source lang="text">
# 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.
</source>

===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.
<source lang="text">
# set the secrets
secrets:
consulACL:
volumes:
- name: consul-shared-secret
secret:
secretName: consul-voice-token # consul secret
</source>

===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.
<source lang="text">
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
</source>

For SIPProxy and RQ, HPA is set to false:
<source lang="text">
hpa:
enabled: false # Horizontal Pod scalar enabled
</source>

For SIP and ORS, HPA is set as follows:
<source lang="text">
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
</source>

===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.
<source lang="text">
resources:
requests:
cpu: "250m"
memory: "256Mi"
limits:
cpu: "500m"
memory: "512Mi"
</source>

For ORS and SIPS service the CPU and memory requirement is high so we recommend it to be set to the following:
<source lang="text">
resources:
requests:
cpu: "500m"
memory: "1Gi"
limits:
cpu: "1500m"
memory: "4Gi"
</source>

===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.
<source lang="text">
# 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:
</source>
|Status=No
}}{{Section
|sectionHeading=Configure Kubernetes
|alignment=Vertical
|structuredtext={{Notices|Notice=PEComingSoon}}
|Status=No
}}{{Section
|sectionHeading=Configure security
|alignment=Vertical
|structuredtext====Security Context Configuration===
Before you deploy the Voice Microservices, be sure to read {{Link-AnywhereElse|product=PrivateEdition|version=Current|manual=PEGuide|topic=ConfigSecurity|display text=Security Settings}} in the {{Link-AnywhereElse|product=PrivateEdition|version=Current|manual=PEGuide|display text=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. <source lang="text">
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
</source>
|Status=No
}}{{Section
|alignment=Vertical
|structuredtext====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:
<source lang="text">
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\"}
</source>

====JFrog secrets====
Use the following commands to create Jfrog secrets:
<source lang="text">
kubectl create secret docker-registry <credential-name> --docker-server=<docker-repo> --docker-username="$JFROG_USER" --docker-password="$JFROG_PASSWORD" -n voice
</source>
|Status=No
}}
|PEPageType=9c3ae89b-4f75-495b-85f8-d8c4afcb3f97
}}

@@ Line 10: / Line 10: @@
 |structuredtext=For general information about overriding Helm chart values, see {{Link-AnywhereElse|product=PrivateEdition|version=Current|manual=PEGuide|topic=HelmOverrides|display text=Overriding Helm Chart values}} in the ''{{Link-AnywhereElse|product=PrivateEdition|version=Current|manual=PEGuide|display text=Genesys Multicloud CX Private Edition Guide}}''.
 When deploying Voice services, certain parameters must be enabled or modified based on customer requirements and environment. For each of the Voice services, an override '''values.yaml''' file must be created that overrides certain sections of the default configuration for the service. In this document, we use the following format for creating an override '''values.yaml''' file: '''<servicename>_override_values.yaml'''.
@@ Line 182: / Line 181: @@
    runAsGroup: 500
    runAsNonRoot: true
 </source>
 |Status=No

@@ Line 12: / Line 12: @@
 If you want to use arbitrary UIDs in your OpenShift deployment, you must override the '''securityContext''' settings in the '''values.yaml''' file, so that no user or group IDs are specified. For details, see {{Link-SomewhereInThisVersion|manual=VMPEGuide|topic=Configure|anchor=SecurityContextConfig|display text=Security context configuration}}, below.
-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.yaml''' file must be created that overrides certain sections of the default configuration for the service. In this document, we use the following format for creating an override '''values.yaml''' file: '''<servicename>_override_values.yaml'''.
+When deploying Voice services, certain parameters must be enabled or modified based on customer requirements and environment. For each of the Voice services, an override '''values.yaml''' file must be created that overrides certain sections of the default configuration for the service. In this document, we use the following format for creating an override '''values.yaml''' file: '''<servicename>_override_values.yaml'''.
 The '''override_values.yaml''' file contains the following sections:
@@ Line 47: / Line 47: @@
 The config section contains configuration parameters that need to be overridden for all voice services.
-Additional information needs to be passed for SIP Service: dnsServer. Get the DNS Server value from the above section (Configure DNS server for voice-sip).
+Additional information needs to be passed for SIP Cluster Service: dnsServer. Get the DNS Server value from the above section (Configure DNS server for voice-sip).
 <source lang="text">
 # Set the redis port to be used.
@@ Line 83: / Line 83: @@
 </source>
-For SIPProxy and RQ, HPA is set to false:
+For SIP Proxy and RQ Services, HPA is set to false:
 <source lang="text">
 hpa:
@@ Line 89: / Line 89: @@
 </source>
-For SIP and ORS, HPA is set as follows:
+For SIP Cluster and Orchestration Services, HPA is set as follows:
 <source lang="text">
 hpa:
@@ Line 110: / Line 110: @@
 </source>
-For ORS and SIPS service the CPU and memory requirement is high so Genesys recommends the following setting:
+For Orchestration and SIP Cluster Services, the CPU and memory requirement is high. Genesys recommends the following setting:
 <source lang="text">
 resources:
@@ Line 123: / Line 123: @@
 {{AnchorDiv|logvolume}}
 ===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 that is run inside the SIP Cluster service. The values for '''storageClass''' and '''volumeName''' should be configured based on the recommendation given in the Persistent Volume section.
+This section captures parameters pertaining to log volumes needed by SIP Cluster Service. These parameters are needed for storing logging of SIP Server binary, which runs inside the SIP Cluster Service. Configure the values for '''storageClass''' and '''volumeName''' based on the recommendation given in the Persistent Volume section.
 <source lang="text">
 # pvc will be created for logs

@@ Line 8: / Line 8: @@
 |anchor=OverrideHelmValues
 |alignment=Vertical
-|structuredtext=For general information about overriding Helm chart values, see {{Link-AnywhereElse|product=PrivateEdition|version=Current|manual=PEGuide|topic=HelmOverrides|display text=Overriding Helm Chart values}} in the ''{{Link-AnywhereElse|product=PrivateEdition|version=Current|manual=PEGuide|display text=Genesys Engage Cloud Private Edition Guide}}''.
+|structuredtext=For general information about overriding Helm chart values, see {{Link-AnywhereElse|product=PrivateEdition|version=Current|manual=PEGuide|topic=HelmOverrides|display text=Overriding Helm Chart values}} in the ''{{Link-AnywhereElse|product=PrivateEdition|version=Current|manual=PEGuide|display text=Genesys Multicloud CX Private Edition Guide}}''.
 If you want to use arbitrary UIDs in your OpenShift deployment, you must override the '''securityContext''' settings in the '''values.yaml''' file, so that no user or group IDs are specified. For details, see {{Link-SomewhereInThisVersion|manual=VMPEGuide|topic=Configure|anchor=SecurityContextConfig|display text=Security context configuration}}, below.
@@ Line 152: / Line 152: @@
 |anchor=ConfigureSecurity
 |alignment=Vertical
-|structuredtext=Before you deploy the Voice Microservices, be sure to read {{Link-AnywhereElse|product=PrivateEdition|version=Current|manual=PEGuide|topic=ConfigSecurity|display text=Security Settings}} in the ''{{Link-AnywhereElse|product=PrivateEdition|version=Current|manual=PEGuide|display text=Setting up Genesys Engage Cloud Private Edition}}'' guide.
+|structuredtext=Before you deploy the Voice Microservices, be sure to read {{Link-AnywhereElse|product=PrivateEdition|version=Current|manual=PEGuide|topic=ConfigSecurity|display text=Security Settings}} in the ''{{Link-AnywhereElse|product=PrivateEdition|version=Current|manual=PEGuide|display text=Setting up Genesys Multicloud CX Private Edition}}'' guide.
 {{AnchorDiv|SecurityContextConfig}}

@@ Line 63: / Line 63: @@
 # set the secrets
 secrets:
    consulACL:
      volumes:
      - name: consul-shared-secret
        secret:
-         secretName: consul-voice-token         # consul secret
+         secretName: consul-voice-token
 </source>
@@ Line 145: / Line 148: @@
 }}{{Section
 |sectionHeading=Configure Kubernetes
 |alignment=Vertical
-|structuredtext={{Notices|Notice=PEComingSoon}}
+|structuredtext=For information, see the following resources:
 |Status=No
 }}{{Section
@@ Line 197: / Line 206: @@
 |anchor=Secrets
 |alignment=Vertical
-|structuredtext====Secrets for Voice Services===
+|structuredtext====Secrets for Voice services===
 Create the following Kubernetes secrets for other infrastructure services:

@@ Line 120: / Line 120: @@
 {{AnchorDiv|logvolume}}
 ===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 that is run inside the SIP service. The values for '''storageClass''' and '''volumeName''' should be configured based on the recommendation given in the Persistent Volume section.
+This section captures parameters pertaining to log volumes needed by SIP Service. These parameters are needed for storing logging of SIP Server binary that is run inside the SIP Cluster service. The values for '''storageClass''' and '''volumeName''' should be configured based on the recommendation given in the Persistent Volume section.
 <source lang="text">
 # pvc will be created for logs
@@ Line 195: / Line 195: @@
 |Status=No
 }}{{Section
 |alignment=Vertical
 |structuredtext====Secrets for Voice Services===
@@ Line 205: / Line 206: @@
 ====Kafka secrets====
 Kafka secrets must be created when Kafka is deployed. The secret is referenced in the Voice Microservices '''values.yaml''' file.
 ====Redis secrets====
@@ Line 224: / Line 237: @@
 ====JFrog secrets====
-Use the following commands to create Jfrog secrets:
+Use the following commands to create JFrog secrets:
 <source lang="text">
 kubectl create secret docker-registry <credential-name>  --docker-server=<docker-repo> --docker-username="$JFROG_USER" --docker-password="$JFROG_PASSWORD" -n voice