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

WikiSysop at 08:00, February 21, 2023

2023-02-21T08:00:52Z

WikiSysop at 14:45, June 17, 2022

2022-06-17T14:45:48Z

WikiSysop at 14:30, June 17, 2022

2022-06-17T14:30:47Z

WikiSysop at 15:30, March 31, 2022

2022-03-31T15:30:44Z

Mary.hachey@genesys.com: Published

2021-11-30T13:25:53Z

Published

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

2021-11-09T20:29:50Z

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

Mary.hachey@genesys.com: Published

2021-10-29T18:03:58Z

Published

New page

{{PEPrerequisites
|DisplayName=Before you begin
|Context=Find out what to do before deploying CX Contact.
|LimitationsStatus=No
|LimitationsText=There are no limitations. Before you begin deploying the CX Contact service, it is assumed that the following prerequisites and optional task, if needed, are completed:

===Prerequisites===

*A Kubernetes or OpenShift cluster is ready for deployment of CX Contact.
*The Kubectl and Helm command line tools are on your computer.
*You have connectivity to target cluster, the proper kubectl context to work with the cluster, and your user has administrative permissions to deploy CX Contact to the defined namespace.

===Optional tasks===

*'''SFTP Server'''—Install an SFTP Server with basic authentication for optional input and output data. SFTP Server is used when automation capabilities are required.
*'''CDP NG access credentials'''—As of CX Contact 9.0.025, Compliance Data Provider Next Generation (CDP NG) is used as a CDP by default. Before attempting to connect to CDP NG, obtain the necessary access credentials (ID and Secret) from Genesys Customer Care.
*'''Bitnami repository'''—If you choose to deploy dedicated Redis and Elasticsearch for CX Contact, add the Bitnami repository to install Redis and Elasticsearch using the following command:
*;<code>helm repo add bitnami <nowiki>https://charts.bitnami.com/bitnami</nowiki></code>

After you've completed the mandatory tasks, check the {{Link-SomewhereInThisVersion|manual=CXCPEGuide|topic=Planning|anchor=ThirdParty|display text=Third-party prerequisites}}.
|HelmStatus=No
|HelmText=For information about how to download the Helm charts, see {{SuiteLevelLink|helmchart}}.

See {{Link-AnywhereElse|product=ReleaseNotes|version=Current|manual=GenesysEngage-cloud|topic=|display text=Helm charts and containers for CX Contact}} for the Helm chart version you must download for your release.

CX Contact is the only service that runs in the CX Contact Docker container. The Helm charts included with the CX Contact release provision CX Contact and any Kubernetes infrastructure necessary for CX Contact to run.
|ThirdPartyStatus=No
|ThirdPartyText=Set up Elasticsearch and Redis services as standalone services or installed in a single OpenShift cluster. See {{Link-SomewhereInThisVersion|manual=CXCPEGuide|topic=Deploy|anchor=InstTPPrereqs|display text=Install third-party prerequisites in OpenShift}}. You can also install them as shared services, deployed in an "infra" namespace in OpenShift.

For information about setting up your Genesys Engage cloud private edition platform, see {{SuiteLevelLink|softwarereq}}.
|SectionThirdPartyItem={{SectionThirdPartyItem
|ThirdPartyItem=0d238336-2626-4954-8be3-2f1e16fdd0ce
|Notes=CX Contact supports Elasticsearch 6.3 and later releases.
}}{{SectionThirdPartyItem
|ThirdPartyItem=3aee73ed-68e0-4c70-8693-2421c68b86cd
|Notes=CX Contact supports Redis 4.0 (5.0 and later releases recommended), clustered with persistence in Production.
}}
|StorageStatus=No
|StorageText=CX Contact requires shared persistent storage and an associated storage class created by the cluster administrator. The Helm chart creates the ReadWriteMany (RWX) Persistent Volume Claim (PVC) that is used to store and share data with multiple CX Contact components.

The minimal recommended PVC size is 100GB.
|NetworkStatus=No
|NetworkText=This topic describes network requirements and recommendations for CX Contact in private edition deployments:

===External connections===
For information about external connections from the Kubernetes cluster to other systems, see {{Link-SomewhereInThisVersion|manual=CXCPEGuide|topic=Architecture|display text=Architecture}}. External connections also include:

*Compliance Data Provider (AWS)
*SFTP Servers

===Ingress===
The CX Contact UI requires Session Stickiness. Use '''ingress-nginx''' as the ingress controller (see [https://github.com/kubernetes/ingress-nginx github.com]).

{{NoteFormat|The CX Contact Helm chart contains default annotations for session stickiness only for '''ingress-nginx'''. If you are using a different ingress controller, refer to its documentation for session stickiness configuration.|}}

===Ingress SSL===
If you are using Chrome 80 or later, the '''SameSite''' cookie must have the '''Secure''' flag (see [https://blog.chromium.org/2020/02/samesite-cookie-changes-in-february.html Chromium Blog]). Therefore, Genesys recommends that you configure a valid SSL certificate on ingress.

===Logging===
Log rotation is required so that logs do not consume all of the available storage on the node.

Kubernetes is currently not responsible for rotating logs. Log rotation can be handled by the '''docker json-file log driver''' by setting the '''max-file''' and '''max-size''' options.

For effective troubleshooting, the engineering team should provide '''stdout logs''' of the pods (using the command '''kubectl logs'''). As a result, log retention is not very aggressive (see [https://docs.docker.com/config/containers/logging/json-file/#examples JSON file logging driver]). For example:
<source>
{
“log-driver”: “json-file”,
“log-opts”: {
“max-size”: “100m”,
“max-file”: “3”
}
}
</source>
For on-site debugging purposes, CX Contact logs can be collected and stored in Elasticsearch. (For example, EFK stack. See [https://medium.com/avmconsulting-blog/how-to-deploy-an-efk-stack-to-kubernetes-ebc1b539d063 medium.com]).

For more information about logging, see {{Link-SomewhereInThisVersion|manual=CXCPEGuide|topic=Logging}}.

===Monitoring===
CX Contact provides metrics that can be consumed by Prometheus and Grafana. It is recommended to have the '''Prometheus Operator''' (see [https://github.com/prometheus-operator/prometheus-operator githum.com]) installed in the cluster. CX Contact Helm chart supports the creation of '''CustomResourceDefinitions''' that can be consumed by the Prometheus Operator.

For more information about monitoring, see {{Link-SomewhereInThisVersion|manual=CXCPEGuide|topic=Observability}}.
|BrowserStatus=No
|SectionBrowser={{SectionBrowser
|Browser=4f7728b3-945a-440d-8003-5a2f4043240c
|Notes=The latest version of Chrome must be used as the CX Contact UI browser.
}}{{SectionBrowser
|Browser=a19c4594-2cac-422e-9f58-0123de3fa7c8
|Notes=Starting from CX Contact release 9.0.026.04, Edge Chromium browser 2020
}}
|DependenciesStatus=No
|DependenciesText=CX Contact components operate with Genesys core services (v8.5 or v8.1) in the back end. All voice-processing components (Voice Microservice and shared services, such as GVP), and the GWS and Genesys Authentication services (mentioned below) must deployed and running before deploying the CX Contact service. See {{SuiteLevelLink|deployorder}}.

The following Genesys services and components are required:

*GWS
*Genesys Authentication Service
*Tenant Service
*Voice Microservice
*Multi-tenant Configuration Server

Nexus is optional.

|GDPRStatus=No
|GDPRText=CX Contact does not support GDPR.

|PEPageType=bf21dc7c-597d-4bbe-8df2-a2a64bd3f167
}}

@@ Line 40: / Line 40: @@
 |ThirdPartyItem=1a407778-58fe-4acd-8ca7-5af8eac31283
 |Notes=Relational database.
 }}
 |StorageStatus=No

@@ Line 7: / Line 7: @@
 ===Prerequisites===
-*A Kubernetes or OpenShift cluster is ready for deployment of CX Contact.
+*A Kubernetes cluster is ready for deployment of CX Contact.
 *The Kubectl and Helm command line tools are on your computer.
 *You have connectivity to target cluster, the proper kubectl context to work with the cluster, and your user has administrative permissions to deploy CX Contact to the defined namespace.
@@ Line 26: / Line 26: @@
 CX Contact is the only service that runs in the CX Contact Docker container. The Helm charts included with the CX Contact release provision CX Contact and any Kubernetes infrastructure necessary for CX Contact to run.
 |ThirdPartyStatus=No
-|ThirdPartyText=Set up Elasticsearch and Redis services as standalone services or installed in a single OpenShift cluster. You can also install them as shared services, deployed in an "infra" namespace in OpenShift.
+|ThirdPartyText=Set up Elasticsearch and Redis services as standalone services or installed in a single Kubernetes cluster.
 For information about setting up your Genesys Multicloud CX private edition platform, see {{SuiteLevelLink|softwarereq}}.

@@ Line 84: / Line 84: @@
 </source>
 For on-site debugging purposes, CX Contact logs can be collected and stored in Elasticsearch. (For example, EFK stack. See [https://medium.com/avmconsulting-blog/how-to-deploy-an-efk-stack-to-kubernetes-ebc1b539d063 medium.com]).
 ===Monitoring===

@@ Line 22: / Line 22: @@
 |HelmText=For information about how to download the Helm charts, see {{SuiteLevelLink|helmchart}}.
-See {{Link-AnywhereElse|product=ReleaseNotes|version=Current|manual=GenesysEngage-cloud|topic=|display text=Helm charts and containers for CX Contact}} for the Helm chart version you must download for your release.
+See {{Link-AnywhereElse|product=ReleaseNotes|version=Current|manual=GenesysEngage-cloud|topic=CX_ContactHelm|display text=Helm charts and containers for CX Contact}} for the Helm chart version you must download for your release.
 CX Contact is the only service that runs in the CX Contact Docker container. The Helm charts included with the CX Contact release provision CX Contact and any Kubernetes infrastructure necessary for CX Contact to run.
 |ThirdPartyStatus=No
-|ThirdPartyText=Set up Elasticsearch and Redis services as standalone services or installed in a single OpenShift cluster. See {{Link-SomewhereInThisVersion|manual=CXCPEGuide|topic=Deploy|anchor=InstTPPrereqs|display text=Install third-party prerequisites in OpenShift}}. You can also install them as shared services, deployed in an "infra" namespace in OpenShift.
+|ThirdPartyText=Set up Elasticsearch and Redis services as standalone services or installed in a single OpenShift cluster. You can also install them as shared services, deployed in an "infra" namespace in OpenShift.
 For information about setting up your Genesys Multicloud CX private edition platform, see {{SuiteLevelLink|softwarereq}}.
@@ Line 35: / Line 35: @@
 |ThirdPartyItem=3aee73ed-68e0-4c70-8693-2421c68b86cd
 |Notes=CX Contact supports Redis 4.0 (5.0 and later releases recommended), clustered with persistence in Production.
 }}
 |StorageStatus=No

@@ Line 42: / Line 42: @@
 |NetworkStatus=No
 |NetworkText=This topic describes network requirements and recommendations for CX Contact in private edition deployments:
 ===External connections===

@@ Line 28: / Line 28: @@
 |ThirdPartyText=Set up Elasticsearch and Redis services as standalone services or installed in a single OpenShift cluster. See {{Link-SomewhereInThisVersion|manual=CXCPEGuide|topic=Deploy|anchor=InstTPPrereqs|display text=Install third-party prerequisites in OpenShift}}. You can also install them as shared services, deployed in an "infra" namespace in OpenShift.
-For information about setting up your Genesys Engage cloud private edition platform, see {{SuiteLevelLink|softwarereq}}.
+For information about setting up your Genesys Multicloud CX private edition platform, see {{SuiteLevelLink|softwarereq}}.
 |SectionThirdPartyItem={{SectionThirdPartyItem
 |ThirdPartyItem=0d238336-2626-4954-8be3-2f1e16fdd0ce