VM/Current/VMPEGuide/Deploy - Revision history

WikiSysop at 08:31, March 27, 2023

2023-03-27T08:31:49Z

WikiSysop at 14:30, October 13, 2022

2022-10-13T14:30:52Z

Show changes

WikiSysop at 20:01, September 13, 2022

2022-09-13T20:01:19Z

WikiSysop at 14:46, September 8, 2022

2022-09-08T14:46:23Z

Show changes

Corinneh: Published

2022-01-27T20:39:45Z

Published

Corinne.hicks@genesys.com: Published

2021-11-01T18:11:25Z

Published

Show changes

Corinne.hicks@genesys.com: Published

2021-06-30T19:23:19Z

Published

New page

{{Article
|Standalone=No
|DisplayName=Deploy Voice Microservices
|Context=Learn how to deploy Voice Microservices.
|ComingSoon=No
|Section={{Section
|alignment=Vertical
|structuredtext={{NoteFormat|Make sure to review {{Link-SomewhereInThisVersion|manual=VMPEGuide|topic=Planning}} for the full list of prerequisites required to deploy Voice Microservices.
<br/>
To deploy the Tenant service, see the ''{{Link-AnywhereElse|product=PrivateEdition|version=Current|manual=TenantPEGuide|display text=Tenant Service Private Edition Guide}}''.|}}For solution-level deployment information, see {{SuiteLevelLink|openshift}}.
|Status=No
}}{{Section
|sectionHeading=General deployment prerequisites
|alignment=Vertical
|structuredtext=Before you deploy the Voice Services, you must deploy the infrastructure services. See {{Link-SomewhereInThisVersion|manual=VMPEGuide|topic=Planning|anchor=ThirdParty|display text=Third-party prerequisites}} for the list of required infrastructure services.

To override values for both the infrastructure services and voice services, see {{Link-SomewhereInThisVersion|manual=VMPEGuide|topic=Configure|anchor=OverrideHelmValues|display text=Override Helm chart values}}.

Genesys recommends the following order of deployment for the Voice Microservices:

*{{Link-SomewhereInThisVersion|manual=VMPEGuide|topic=Deploy|anchor=DeployVoice|display text=Voice Services}}
*{{Link-AnywhereElse|product=PrivateEdition|version=Current|manual=TenantPEGuide|display text=Tenant Service}}
*{{Link-SomewhereInThisVersion|manual=VMPEGuide|topic=DeployVoicemail|display text=Voicemail Service}}

===Deploy Consul===
Consul is required for multiple Services in the Genesys package. In addition to any other Consul configuration, the following Consul features are required for Voice Services:

*connectinject – to deploy sidecar containers in voice pods.
*controller – to provide service intention functionality.
*openshift – to set OpenShift specific permissions.
*syncCatalog – to sync K8 services into Consul: set '''toK8S: false''' and '''addK8SNamespaceSuffix: false''' for syncing services only from K8 to Consul.
*AccessControlList – to enable ACL, set '''manageSystemACLs: true'''.
*storageclass – to set the storage class to a predefined storage class.
*TLS – to enable TLS, set '''enabled: true''' and follow the steps/commands described below to set up TLS.

Here is the file content for the Consul configuration:
<source lang="text">
# config.yaml
global:
name: consul
tls:
enabled: true
caCert:
secretName: consul-ca-cert
# The key of the Kubernetes secret.
secretKey: tls.crt
caKey:
# The name of the Kubernetes secret.
secretName: consul-ca-key
# The key of the Kubernetes secret.
secretKey: tls.key
acls:
manageSystemACLs: true
openshift:
enabled: true
connectInject:
enabled: true
controller:
enabled: true
syncCatalog:
enabled: true
toConsul: true
toK8S: false
addK8SNamespaceSuffix: false
</source>

====Add a rule for Consul DNS forwarding====
OpenShift sends DNS requests to the DNS server in the '''openshift-dns''' namespace. To forward Consul FQDN resolution to a Consul DNS server, add a forwarding rule to '''configmap''' of the default DNS operator. Save the Consul's DNS IP address using the following command:
<source lang="text">
kubectl get svc consul-dns -n <consul namespace> -o jsonpath={.spec.clusterIP} (Internal IP of consul-dns service)
> oc edit dns.operator/default
Add the below specs:
spec:
servers:
- name: consul-dns
zones:
- consul
forwardPlugin:
upstreams:
- <Internal IP of consul-dns service>
</source>
|Status=No
}}{{Section
|sectionHeading=Deployment of Redis
|alignment=Vertical
|structuredtext====Deployment of Redis===
====Add a Helm repository====
<source lang="text">
kubectl create namespace infra
helm repo add bitnami https://charts.bitnami.com/bitnami
helm repo add elastic https://helm.elastic.co
helm repo add confluentinc https://confluentinc.github.io/cp-helm-charts/
helm repo update
</source>

====Deploy the Helm Charts====
<source lang="text">
#REDIS#
helm install infra-redis bitnami/redis-cluster --set usePassword=true --set cluster.nodes=6 --set persistence.size=1G -n infra
</source>
|Status=Yes
}}{{Section
|alignment=Vertical
|structuredtext====Create the Voice namespace===
Before deploying Voice Services and their dependencies, create a namespace using the following command:
<source lang="text">
kubectl create ns voice
</source>
In all Voice Services and their dependencies configuration files, the namespace is '''voice'''. If you want a specific/custom namespace, create the namespace (using the above command) and change the namespace in files, as required.
|Status=No
}}{{Section
|sectionHeading=Deploy Voice services
|anchor=DeployVoice
|alignment=Vertical
|structuredtext====Register the Redis service in Consul===
After the creation of the Redis cluster, the Redis IP address should be registered with Consul. Cluster information needs to be created for the Kubernetes services and endpoints with Redis. Once they are created, Consul will automatically sync those Kubernetes services and register them in Consul.

====Kubernetes Service and endpoint creation====
The Redis registration should be done for all of the following Redis service names. The Voice services will use these service names for connecting to the Redis cluster.
<source lang="text">
redis-agent-state
redis-call-state
redis-config-state
redis-ors-state
redis-ors-stream
redis-registrar-state
redis-rq-state
redis-sip-state
redis-tenant-stream
</source>

=====Manifest file=====
For all the Redis service names mentioned above, create a separate service and endpoint using the following example:
<source lang="text">
apiVersion: v1
kind: Service
metadata:
name: <redis-service-name> (ex, redis-agent-state)
namespace: <namespace> (ex, voice)
annotations:
"consul.hashicorp.com/service-sync": "true"
spec:
clusterIP: None
---
apiVersion: v1
kind: Endpoints
metadata:
name: <redis-service-name> (ex, redis-agent-state)
namespace: <namespace> (ex, voice)
subsets:
- addresses:
- ip: <redis MASTER IP> (ex, 51.143.122.147)
ports:
- port: <redis port> (ex, 6379)
name: redisport
protocol: <redis transport> (ex, TCP)
</source>

Get the Redis primary IP using the following command:
<source lang="text">
kubectl get pods infra-redis-redis-cluster-0 -n infra -o jsonpath='{.status.podIP}' (get IPaddress of the master redis pod)
</source>
|Status=No
}}{{Section
|alignment=Vertical
|structuredtext====Deploy Voice Services===
Before deploying Voice Services, we must create Persistent Volume Claims (PVC) that are required for Voice Services.

====Persistent volumes====
The Voice SIP Cluster Service uses the persistent volume, a "piece" of storage, to store traditional SIP Server logs in OpenShift.

=====Persistent Volume in OCS Storage Type=====
A Storage Class might have been already created in the OCP (OpenShift Container Platform). This Storage Class is used for creating PVC and must be set in the override values of '''sip_node_override_values.yaml'''.

For the OpenShift cluster with OpenShift Container Storage (OCS) storage, configure the Storage Class to be used for creating the persistent volume. In the case of OCS storage, PV will be created automatically when PVC is claimed. For such clusters, the '''volumeName''' parameter in '''sip_node_override_values.yaml''' must be empty.
<source lang="text">
# pvc will be created for logs
volumes:
pvcLog:
create: true
claim: sip-log-pvc
storageClass: voice
volumeName:

pvcJsonLog:
create: true
claim: sip-json-log-pvc
storageClass: voice
volumeName:
</source>

The created persistent volume must be configured in '''sip_node_override_values.yaml''' as shown below:
<source lang="text">
# pvc will be created for logs
volumes:
pvcLog:
create: true
claim: sip-log-pvc
storageClass: voice
volumeName: <pv name> (ex sip-log-pv)

pvcJsonLog:
create: true
claim: sip-json-log-pvc
storageClass: voice
volumeName: <pv name> (ex sip-log-pv)
</source>

====Configure the DNS Server for voice-sip====
The Voice SIP Cluster Service requires that the DNS server is configured in '''sip_node_override_values.yaml'''.

In the OCP environment, the Kubernetes DNS server name can be obtained using the following command:
<source lang="text">
oc get dns.operator/default -o jsonpath={.status.clusterIP}
</source>

In a non-OCP environment, follow the steps provided in [https://kubernetes.io/docs/tasks/administer-cluster/dns-debugging-resolution/ Kubernetes documentation] and install the '''dnsutils''' pod. Using the '''dnsutils''' pods, get the '''dnsserver''' that is used in the environment.

Default value in the SIP Helm chart is "10.0.0.10"; if the DNS server address is different, update it in '''sip_node_override_values.yaml''' as shown below:
<source lang="text">
# update dns server ipaddress
context:
envs:
dnsServer: "10.202.0.10"
</source>

====Voice Service Helm chart deployment====
Deploy the Voice Services using the provided Helm charts.
<source lang="text">
helm upgrade --install --force --wait --timeout 300s -n voice -f ./voice_helm_values/agent_override_values.yaml voice-agent <helm-repo>/voice-agent-<helmchart-version>.tgz --set version=<container-version> --username "$JFROG_USER" --password "$JFROG_PASSWORD"

helm upgrade --install --force --wait --timeout 300s -n voice -f ./voice_helm_values/callthread_override_values.yaml voice-callthread <helm-repo>/voice-callthread-<helmchart-version>.tgz --set version=<container-version> --username "$JFROG_USER" --password "$JFROG_PASSWORD"

helm upgrade --install --force --wait --timeout 200s -n voice -f ./voice_helm_values/config_override_values.yaml voice-config <helm-repo>/voice-config-<helmchart-version>.tgz --set version=<container-version> --username "$JFROG_USER" --password "$JFROG_PASSWORD"

helm upgrade --install --force --wait --timeout 300s -n voice -f ./voice_helm_values/dialplan_override_values.yaml voice-dialplan <helm-repo>/voice-dialplan-<helmchart-version>.tgz --set version=<container-version> --username "$JFROG_USER" --password "$JFROG_PASSWORD"

helm upgrade --install --force --wait --timeout 200s -n voice -f ./voice_helm_values/ors_node_override_values.yaml voice-ors <helm-repo>/voice-ors-<helmchart-version>.tgz --set version=<container-version> --username "$JFROG_USER" --password "$JFROG_PASSWORD"

helm upgrade --install --force --wait --timeout 300s -n voice -f ./voice_helm_values/registrar_override_values.yaml voice-registrar <helm-repo>/voice-registrar-<helmchart-version>.tgz --set version=<container-version> --username "$JFROG_USER" --password "$JFROG_PASSWORD"

helm upgrade --install --force --wait --timeout 200s -n voice -f ./voice_helm_values/rq_node_override_values.yaml voice-rq <helm-repo>/voice-rq-<helmchart-version>.tgz --set version=<container-version> --username "$JFROG_USER" --password "$JFROG_PASSWORD"

helm upgrade --install --force --wait --timeout 200s -n voice -f ./voice_helm_values/sip_node_override_values.yaml voice-sip <helm-repo>/voice-sip-<helmchart-version>.tgz --set version=<container-version> --username "$JFROG_USER" --password "$JFROG_PASSWORD"

helm upgrade --install --force --wait --timeout 300s -n voice -f ./voice_helm_values/sipfe_override_values.yaml voice-sipfe <helm-repo>/voice-sipfe-<helmchart-version>.tgz --set version=<container-version> --username "$JFROG_USER" --password "$JFROG_PASSWORD"

helm upgrade --install --force --wait --timeout 300s -n voice -f ./voice_helm_values/sipproxy_override_values.yaml voice-sipproxy <helm-repo>/voice-sipproxy-<helmchart-version>.tgz --set version=<container-version> --username "$JFROG_USER" --password "$JFROG_PASSWORD"
</source>
The following table contains a list of the minimum recommended Helm chart versions that should be used:
{{{!}} class="wikitable"
!Service name
!Helm chart version
{{!}}-
{{!}}voice-config
{{!}}voice-config-9.0.11.tgz
{{!}}-
{{!}}voice-dialplan
{{!}}voice-dialplan-9.0.08.tgz
{{!}}-
{{!}}voice-registrar
{{!}}voice-registrar-9.0.14.tgz
{{!}}-
{{!}}voice-agent
{{!}}voice-agent-9.0.10.tgz
{{!}}-
{{!}}voice-callthread
{{!}}voice-callthread-9.0.12.tgz
{{!}}-
{{!}}voice-sip
{{!}}voice-sip-9.0.22.tgz
{{!}}-
{{!}}voice-sipfe
{{!}}voice-sipfe-9.0.06.tgz
{{!}}-
{{!}}voice-sipproxy
{{!}}voice-sipproxy-9.0.09.tgz
{{!}}-
{{!}}voice-rq
{{!}}voice-rq-9.0.08.tgz
{{!}}-
{{!}}voice-ors
{{!}}voice-ors-9.0.08.tgz
{{!}}}
|Status=No
}}{{Section
|sectionHeading=Deploy the Tenant service
|alignment=Vertical
|structuredtext=The Tenant Service is included with the Voice Microservices, but has its own deployment procedure. To deploy the Tenant Service, see {{Link-AnywhereElse|product=PrivateEdition|version=Current|manual=TenantPEGuide|topic=Deploy|display text=Deploy the Tenant Service}}.
|Status=No
}}{{Section
|sectionHeading=Deploy in OpenShift
|alignment=Vertical
|structuredtext=To deploy in the OpenShift platform, you use the '''oc''' command instead of the '''kubectl''' command.
|Status=No
}}{{Section
|sectionHeading=Validate the deployment in OpenShift
|anchor=Validate
|alignment=Vertical
|structuredtext={{Notices|Notice=PEComingSoon}}
|Status=No
}}
|PEPageType=45d1441f-dc69-4a17-bd47-af5d811ce167
}}

@@ Line 131: / Line 131: @@
 {{!}}voice-ors-9.0.08.tgz
 {{!}}}
 |Status=No
 }}{{Section

@@ Line 4: / Line 4: @@
 |Section={{Section
 |alignment=Vertical
-|structuredtext={{NoteFormat|Make sure to review {{Link-SomewhereInThisVersion|manual=VMPEGuide|topic=Planning}} for the full list of prerequisites required to deploy Voice Microservices.
+|structuredtext={{NoteFormat|Make sure to review {{Link-SomewhereInThisVersion|manual=VMPEGuide|topic=Planning}} for the full list of prerequisites required to deploy Voice Microservices.<br/>
-<br/>
+To deploy the Tenant service, see the ''{{Link-AnywhereElse|product=PrivateEdition|version=Current|manual=TenantPEGuide|display text=Tenant Service Private Edition Guide}}''.<br/>
-To deploy the Tenant service, see the ''{{Link-AnywhereElse|product=PrivateEdition|version=Current|manual=TenantPEGuide|display text=Tenant Service Private Edition Guide}}''.|}}
+For information about deploying Voicemail Service, see {{Link-SomewhereInThisVersion|manual=VMPEGuide|topic=DeployVoicemail|display text=Deploy Voicemail}}.|}}
 <!--For solution-level deployment information, see {{SuiteLevelLink|openshift}}.-->
 |Status=No
@@ Line 369: / Line 369: @@
 }}{{Section
 |sectionHeading=Validate the deployment
-|anchor=Validate
+|anchor=Validatedep
 |alignment=Vertical
 |structuredtext=Follow the steps below to validate the successful deployment of voice microservices.

@@ Line 8: / Line 8: @@
 |structuredtext={{NoteFormat|Make sure to review {{Link-SomewhereInThisVersion|manual=VMPEGuide|topic=Planning}} for the full list of prerequisites required to deploy Voice Microservices.
 <br/>
-To deploy the Tenant service, see the ''{{Link-AnywhereElse|product=PrivateEdition|version=Current|manual=TenantPEGuide|display text=Tenant Service Private Edition Guide}}''.|}}For solution-level deployment information, see {{SuiteLevelLink|openshift}}.
+To deploy the Tenant service, see the ''{{Link-AnywhereElse|product=PrivateEdition|version=Current|manual=TenantPEGuide|display text=Tenant Service Private Edition Guide}}''.|}}
 |Status=No
 }}{{Section
@@ Line 183: / Line 185: @@
 subsets:
    - addresses:
-       - ip: <redis MASTER IP> (ex, 51.143.122.147)
+       - ip: <redis Cluster IP> (ex, 51.143.122.147)
      ports:
        - port: <redis port> (ex, 6379)
@@ Line 192: / Line 194: @@
 In addition, get the Redis primary IP using the following command:
 <source lang="text">
-kubectl get pods infra-redis-redis-cluster-0 -n infra -o jsonpath='{.status.podIP}' (get IPaddress of the master redis pod)
+kubectl get service infra-redis-redis-cluster -n infra -o jsonpath='{.spec.clusterIP}' (get Cluster IP of the Redis Service)
 </source>
 |Status=No