PEC-OU/Current/CXCPEGuide/Deploy - Revision history

WikiSysop at 08:00, February 21, 2023

2023-02-21T08:00:45Z

WikiSysop at 14:16, September 28, 2022

2022-09-28T14:16:17Z

WikiSysop at 13:01, June 30, 2022

2022-06-30T13:01:17Z

WikiSysop at 15:42, March 30, 2022

2022-03-30T15:42:40Z

Arjun.D.IX: Published

2022-02-11T16:26:53Z

Published

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

2021-11-09T20:29:11Z

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

Mary.hachey@genesys.com: Published

2021-10-29T18:03:27Z

Published

New page

{{Article
|Standalone=No
|DisplayName=Deploy CX Contact
|Context=Learn how to deploy CX Contact.
|ComingSoon=No
|Section={{Section
|alignment=Vertical
|structuredtext=<div style="background-color: aliceblue; font-style: italic;">Include a link to the "suite-level" documentation that describes the particular cloud platform - for the initial Genesys Engage cloud private edition release, this is OpenShift: {{SuiteLevelLink|openshift}} </div>

{{NoteFormat|Review {{Link-SomewhereInThisVersion|topic=Planning}} for the full list of prerequisites required to deploy CX Contact.|}}

CX Contact is a shared service and is deployed in each region, as required. After deployment, it will be fully functional only in the tenant's primary region.
|Status=No
}}{{Section
|sectionHeading=Prepare cluster resources
|anchor=PrepCluster
|alignment=Vertical
|structuredtext=To prepare your cluster resources, create a storage class.
{{NoteFormat|Creating the storage class is optional. If you have an existing storage class, you can use it and a different provisioner, but the storage class must have ReadWriteMany (RWX) capabilities.|2}}

===Create the Storage Class===

#In the Outbound Contact (OC) Command Line Interface (CLI), log in to the Cluster UI.
#Go to '''Storage''', and click '''Storage Claim''' > '''Create Storage Class'''.
#Click '''Edit YAML'''.
#Update the values in the template using the example below that works with the setup of your environment.
#*If your cluster is on-premises (NFS-based storage)<nowiki>:</nowiki>
#*;<source>apiVersion: storage.k8s.io/v1
kind: StorageClass
metadata:
name: cxc-storage
provisioner: cluster.local/nfs-vce-c00ds-vol1-nfs-subdir-external-provisioner
reclaimPolicy: Delete
volumeBindingMode: Immediate
</source>
#;You might want to use Kubernetes to provision the NFS storage in your OpenShift cluster. In GitHub, see [https://github.com/kubernetes-sigs/nfs-subdir-external-provisioner Kubernetes NFS Subdir External Provisioner]. Ask your cluster administrator for assistance with the configuration.
#*If your cluster is in the cloud (Azure files-based storage)<nowiki>:</nowiki>
#*;<source>apiVersion: storage.k8s.io/v1
kind: StorageClass
metadata:
name: cxc-storage
provisioner: kubernetes.io/azure-file
reclaimPolicy: Delete
volumeBindingMode: Immediate
</source>
#Click '''Create'''.
|Status=No
}}{{Section
|sectionHeading=Deploy CX Contact
|anchor=DplyCXC
|alignment=Vertical
|structuredtext=Complete the following procedure using Kubectl, the Helm tools, and if you deploy to OpenShift, the OC CLI:

#Create a new project.
#*For Kubernetes, enter <source>kubectl create namespace cxc</source>
#*For OpenShift, enter <source>oc new-project cxcontact</source>
#Create the pull secret.
#;Use the following code snippets as examples of how to create the default pull secret for Kubernetes and OpenShift:
#*For generic Kubernetes<nowiki>:</nowiki> <source>oc create secret docker-registry mycred --docker-server=pureengage.jfrog.io --docker-username=<username> --docker-password=<API key from jfrog></source>
#*For OpenShift<nowiki>:</nowiki> <source>oc secrets link default mycred --for=pull</source>
#Download latest version of the CX Contact installation Helm Charts from the artifactory. See the [https://pureengage.jfrog.io/ui/packages/helm:%2F%2Fcxcontact?name=cxcontact&type=packages JFrog Platform Artifactory].
#Extract parameters from chart to see multiple (default) values used to fine-tune the installation.
#;<source>helm install cxc ./cxcontact-<chart_version>.tgz > values.yaml</source>
#;You can apply multiple override values to customize your setup. However, Genesys recommends using minimal overriding values in the installation<nowiki>:</nowiki>
#;For example, '''override_values.yaml'''
#;<source>
configserver:
user_name: cloudcon
user_password: cloudcon

cxcontact:

replicas: 2
log:
level: info

compliance_data:
cdp_url: false
cdp_ng:
gcloud_id: false
gcloud_secret: false

# override: #if connecting to Nexus. Otherwise Dial Manager is off
# dial-manager:
# enabled: false
# nexus:
# host: ..
# port: ..
# api_key: .. #required

monitoring:
enabled: true
dashboards: false
alarms: false
pagerduty: false

redis:
enabled: true
cluster: true
# can be comma-delimited list of redis nodes, for e.g.
# nodes: redis://redis-node1:6379,redis://redis-node2:6379,redis://redis-node3:6379
nodes: redis://infra-redis-redis-cluster.infra.svc.cluster.local:6379
#use_tls: false
requirepass: true
password: <redis_password>

elasticsearch:
enabled: true
host: http://elastic-es-http.infra.svc.cluster.local
port: 9200

gws:
# secret in plain text
client_id: cx_contact
client_secret: cx_contact

# GWS Ingress URL
frontend_host: https://gauth.apps.<your_cluster>
frontend_port: 443

# Services. Will be used for connection to GWS if GWS Internal Ingress URL is disabled (empty values)
core:
auth:
host: http://gauth-auth.gauth
port: 80
environment:
host: http://gauth-environment.gauth
port: 80
platform:
ocs:
host: http://gws-service-proxy.gws
port: 80
configuration:
host: http://gws-service-proxy.gws
port: 80
statistics:
host: http://gws-service-proxy.gws
port: 80
setting:
host: http://gws-service-proxy.gws
port: 80
voice:
host: http://gws-service-proxy.gws
port: 80

ingress:
enabled: true
#tls_enabled: false
cxc_frontend: cxc.apps.<your_cluster>
annotations:
# !!!Ingress Session Stickiness is required.
# Default annotations:
nginx.ingress.kubernetes.io/affinity: cookie
nginx.ingress.kubernetes.io/session-cookie-samesite: "Lax"
nginx.ingress.kubernetes.io/session-cookie-name: "cxc-session-cookie"
nginx.ingress.kubernetes.io/proxy-body-size: "0"
tls: []
# - hosts:
# - chart-example.local
# secretName: chart-example-tls

# Additional ingress to expose internal backend endpoints.
# If disabled - all endpoints will be exposed on ingress.cxc_frontend
internal_ingress:
enabled: true
tls_enabled: false
cxc_backend: cxc-int.apps.<your_cluster>
annotations:
# Default annotations:
nginx.ingress.kubernetes.io/proxy-body-size: "0"
nginx.ingress.kubernetes.io/ssl-redirect: 'false'
tls: []
# - hosts:
# - chart-example.local
# secretName: chart-example-tls

storage:
# Persistent Volumes Claim Configuration
pvc:
enabled: true
create: true
# Instructs Helm to skip deleting PVC when a helm operation (such as helm uninstall, helm upgrade or helm rollback)
# would result in its deletion. However, this resource becomes orphaned. Helm will no longer manage it in any way.
# https://helm.sh/docs/howto/charts_tips_and_tricks/#tell-helm-not-to-uninstall-a-resource
# If PVC is already orphaned and you want to re-use it - set `storage.pvc.create` to `false`.
keepAfterDeletion: false
size: 10Gi
name: cxc-claim
storageClassName: cxc-storage
</source>
#Validate the Helm chart and provided values, enter<nowiki>:</nowiki>
#;<source>$ helm template cxc ./cxcontact-<chart_version>.tgz -f override_values.yaml</source>
#Install the CX Contact chart, using the override values file that you prepared in step, enter<nowiki>:</nowiki>
#;<source>$ helm install cxc ./cxcontact-<chart_version>.tgz -f override_values.yaml</source>
#If errors occur, verify the input values, YAML files syntax, and your Kubernetes context. enter<nowiki>:</nowiki>
#;<source>$ kubectl config get-contexts
$ oc status
</source>
#If troubleshooting is necessary, try adding the '''--dry-run''' command line parameter in '''helm install ..''' for verbose error output.

{{NoteFormat|
*To see the full set of available parameters, extract the default helm values from helm package:
*;<source>$ helm show values cxcontact-<chart_version>.tgz > values.yaml </source>
*For persistent volume claims in production, Genesys recommends 100-200 GB.|2}}

This completes the CX Contact shared service installation.

'''Next steps:'''

*Provision tenant for CX Contact/outbound. See {{Link-SomewhereInThisVersion|manual=CXCPEGuide|topic=Provision}}.
*Validate the deployment.
|Status=No
}}{{Section
|sectionHeading=Validate the deployment in OpenShift
|alignment=Vertical
|structuredtext=#Watch the helm output at the end of installation. It provides the status and additional information about where to log in to the CX Contact UI. See the following sample output:
#;<source>
Release "cxc" has been upgraded. Happy Helming!
NAME: cxc
LAST DEPLOYED: Tue Jul 13 10:18:07 2021
NAMESPACE: cxc
STATUS: deployed
REVISION: 1
TEST SUITE: None
NOTES:
Please be patient while CXContact <release_number> is being deployed

ENDPOINTS:
UI: http://cxc.apps.<your_cluster>/ui/cxcontact/#!/campaign/list
API basepath: http://cxc.apps.<your_cluster>/cx-contact/v3/
API swagger doc: http://cxc.apps.<your_cluster>/cx-contact/v3/explore
CXC backend basepath: http://cxc-int.apps.<your_cluster>/
</source>
#Check the status of the Events and Pods in the OpenShift Administration Console. Pods should be up and running—8 CX Contact components in total (7, if you have not defined Nexus for digital outbound).
#Check the '''amark-app''' and other pods logs, primarily for errors related to connectivity to Redis and Elasticsearch.
#If you have provisioned tenants for CX Contact, log in to the CX Contact UI (use URL from the Helm output above) using the tenant's administrator credentials. If you can log in successfully, that confirms that CX Contact works with the Redis cluster:
#*Check the CX Contact '''About''' > '''Versions''' page for the health status of the CX Contact components. They should be all green.
#*Check the '''Analytics''' page. It should show your successful log in, and confirm that CX Contact works with Elasticsearch.
#*Try to create a test Contact list. If you succeed, CX Contact will display a success confirmation message.
|Status=No
}}{{Section
|sectionHeading=Configure monitoring and logging
|anchor=CnfgMntrgLog
|alignment=Vertical
|structuredtext=CX Contact monitoring is enabled by default.

See monitoring details and how to configure logging parameters in {{Link-SomewhereInThisVersion|manual=CXCPEGuide|topic=Observability}}.
|Status=No
}}
|PEPageType=45d1441f-dc69-4a17-bd47-af5d811ce167
}}

@@ Line 30: / Line 30: @@
 volumeBindingMode: Immediate
 </source>
 #*If your cluster is in the cloud (Azure files-based storage)<nowiki>:</nowiki>
 #*;<source>apiVersion: storage.k8s.io/v1
@@ Line 46: / Line 45: @@
 |anchor=DplyCXC
 |alignment=Vertical
-|structuredtext=Complete the following procedure using Kubectl, the Helm tools, and if you deploy to OpenShift, the OC CLI:
+|structuredtext=Complete the following procedure using Kubectl and the Helm tools:
 #Create a new project or a namespace.
 #*For Kubernetes, enter <source>kubectl create namespace cxc</source>
 #*For GKE, enter <source>kubectl create ns cxc</source>
 #*For AKS, enter <source>kubectl create namespace cxc</source>
 #Create the pull secret.Use the following code snippets as examples of how to create the default pull secret:
 #*For generic Kubernetes<nowiki>:</nowiki> <source>oc create secret docker-registry mycred --docker-server=<docker repo> --docker-username=<username> --docker-password=<API key from jfrog></source>
 #*For GKE <nowiki>:</nowiki> <source>kubectl create secret docker-registry mycred --docker-server=<docker repo> --docker-username=<username> --docker-password=<API key from jfrog> --docker-email=<emailid></source>
 #*For AKS<nowiki>:</nowiki> <source>kubectl create secret docker-registry mycred --docker-server=<docker repo> --docker-username=<username> --docker-password=<API key from jfrog> --docker-email=<emailid></source>

@@ Line 48: / Line 48: @@
 |structuredtext=Complete the following procedure using Kubectl, the Helm tools, and if you deploy to OpenShift, the OC CLI:
-#Create a new project.
+#Create a new project or a namespace.
 #*For Kubernetes, enter <source>kubectl create namespace cxc</source>
 #*For OpenShift, enter <source>oc new-project cxcontact</source>
 #*For GKE, enter <source>kubectl create ns cxc</source>
 #Create the pull secret.Use the following code snippets as examples of how to create the default pull secret:
-#*For generic Kubernetes<nowiki>:</nowiki> <source>oc create secret docker-registry mycred --docker-server=pureengage.jfrog.io --docker-username=<username> --docker-password=<API key from jfrog></source>
+#*For generic Kubernetes<nowiki>:</nowiki> <source>oc create secret docker-registry mycred --docker-server=<docker repo> --docker-username=<username> --docker-password=<API key from jfrog></source>
-#*For OpenShift<nowiki>:</nowiki> <source>oc secrets link default mycred --for=pull</source>
+#*For OpenShift, map the secret to the default service account<nowiki>:</nowiki> <source>oc secrets link default mycred --for=pull</source>
-#*For GKE <nowiki>:</nowiki> <source>kubectl create secret docker-registry mycred --docker-server=pureengage-docker-staging.jfrog.io --docker-username=<camelot-username> --docker-password=<API key from jfrog> --docker-email=<emailid></source>
+#*For GKE <nowiki>:</nowiki> <source>kubectl create secret docker-registry mycred --docker-server=<docker repo> --docker-username=<username> --docker-password=<API key from jfrog> --docker-email=<emailid></source>
 #Download latest version of the CX Contact installation Helm Charts from the artifactory. See the [https://pureengage.jfrog.io/ui/packages/helm:%2F%2Fcxcontact?name=cxcontact&type=packages JFrog Platform Artifactory].
 #Extract parameters from chart to see multiple (default) values used to fine-tune the installation.

@@ Line 1: / Line 1: @@
-{{Article
+{{ArticlePEServiceDeploy
-|Standalone=No
+|ServiceId=bd34fb74-a5d2-4463-8a08-05cb52928172
-|DisplayName=Deploy CX Contact
+|IncludeAssumptions=Yes
 |Section={{Section
 |alignment=Vertical

@@ Line 6: / Line 6: @@
 |Section={{Section
 |alignment=Vertical
+|structuredtext={{NoteFormat|Review {{Link-SomewhereInThisVersion|topic=Planning}} for the full list of prerequisites required to deploy CX Contact.|}}
 CX Contact is a shared service and is deployed in each region, as required. After deployment, it will be fully functional only in the tenant's primary region.
@@ Line 20: / Line 19: @@
 ===Create the Storage Class===
-#In the Outbound Contact (OC) Command Line Interface (CLI), log in to the Cluster UI.
+#Log in to the cluster using the Command Line Interface (CLI).
 #Go to '''Storage''', and click '''Storage Claim''' &gt; '''Create Storage Class'''.
 #Click '''Edit YAML'''.
@@ Line 54: / Line 53: @@
 #*For Kubernetes, enter <source>kubectl create namespace cxc</source>
 #*For OpenShift, enter <source>oc new-project cxcontact</source>
-#Create the pull secret.
+#*For GKE, enter <source>kubectl create ns cxc</source>
-#;Use the following code snippets as examples of how to create the default pull secret for Kubernetes and OpenShift:
+#Create the pull secret.Use the following code snippets as examples of how to create the default pull secret:
 #*For generic Kubernetes<nowiki>:</nowiki> <source>oc create secret docker-registry mycred --docker-server=pureengage.jfrog.io --docker-username=<username> --docker-password=<API key from jfrog></source>
 #*For OpenShift<nowiki>:</nowiki> <source>oc secrets link default mycred --for=pull</source>
 #Download latest version of the CX Contact installation Helm Charts from the artifactory. See the [https://pureengage.jfrog.io/ui/packages/helm:%2F%2Fcxcontact?name=cxcontact&type=packages JFrog Platform Artifactory].
 #Extract parameters from chart to see multiple (default) values used to fine-tune the installation.
@@ Line 197: / Line 197: @@
 #If errors occur, verify the input values, YAML files syntax, and your Kubernetes context. enter<nowiki>:</nowiki>
 #;<source>$ kubectl config get-contexts
-$ oc status
+$ kubectl get pods -n cxc
 </source>
 #If troubleshooting is necessary, try adding the '''--dry-run''' command line parameter in '''helm install ..''' for verbose error output.
@@ Line 215: / Line 218: @@
 |Status=No
 }}{{Section
-|sectionHeading=Validate the deployment in OpenShift
+|sectionHeading=Validate the deployment
 |alignment=Vertical
 |structuredtext=#Watch the helm output at the end of installation. It provides the status and additional information about where to log in to the CX Contact UI. See the following sample output:
@@ Line 236: / Line 239: @@
 CXC backend basepath: http://cxc-int.apps.<your_cluster>/
 </source>
-#Check the status of the Events and Pods in the OpenShift Administration Console. Pods should be up and running&mdash;8 CX Contact components in total (7, if you have not defined Nexus for digital outbound).
+#Check the status of the Events and Pods. Pods should be up and running&mdash;8 CX Contact components in total (7, if you have not defined Nexus for digital outbound).
 #Check the '''amark-app''' and other pods logs, primarily for errors related to connectivity to Redis and Elasticsearch.
 #If you have provisioned tenants for CX Contact, log in to the CX Contact UI (use URL from the Helm output above) using the tenant's administrator credentials. If you can log in successfully, that confirms that CX Contact works with the Redis cluster: