Difference between revisions of "PEC-REP/Current/PulsePEGuide/Planning"

From Genesys Documentation
Jump to: navigation, search
m (Text replacement - "Genesys Engage" to "Genesys Multicloud CX")
(Published)
Line 4: Line 4:
 
|LimitationsStatus=No
 
|LimitationsStatus=No
 
|LimitationsText=There are no known limitations.
 
|LimitationsText=There are no known limitations.
−
 
−
===Tools===
 
−
 
−
*Install Helm CLI
 
−
*Install Openchift CLI
 
  
 
<br />
 
<br />
Line 102: Line 97:
 
{{!}}}
 
{{!}}}
 
|ThirdPartyStatus=No
 
|ThirdPartyStatus=No
−
|ThirdPartyText=*Install Postgres 11
+
|ThirdPartyText=OpenShift CLI must be installed.
−
*Install Redis 6 or later (Note: Redis Cluster is not supported at this time)
 
−
*Install Tenant Service:
 
−
**Tenant UUID (v4) should be provisioned, example: "9350e2fc-a1dd-4c65-8d40-1f75a2e080dd"
 
−
**Tenant service should be exposed as host: "tenant-<tenant-uuid>.voice.svc.cluster.local." port: 8888
 
−
*Install Voice MicroService:
 
−
**Voice service should be exposed as host: "tenant-<tenant-uuid>.voice.svc.cluster.local." port: 8000
 
−
*Install GWS/Auth/Agent Setup
 
−
**Auth client secret should be provisioned with following properties (see {{Link-AnywhereElse|product=AUTH|version=Current|manual=AuthPEGuide|topic=Provision|anchor=CreateAPI}}):
 
−
***Client ID: "pulse_client"
 
−
***Grant Types: "authorization_code"
 
−
***RedirectURIs: "https://<pulse-endpoint>"
 
−
**CORS should be allowed for https://<pulse-endpoint> (see {{Link-AnywhereElse|product=AUTH|version=Current|manual=AuthPEGuide|topic=Provision|anchor=UpdateCORS}})
 
  
−
{{NoteFormat|All services listed above should be accessible from the same OpenShift cluster where Genesys Pulse will be deployed.|}}
+
For information about setting up your Genesys Multicloud CX private edition platform, see {{SuiteLevelLink|softwarereq}}.
 +
|SectionThirdPartyItem={{SectionThirdPartyItem
 +
|ThirdPartyItem=1a407778-58fe-4acd-8ca7-5af8eac31283
 +
}}{{SectionThirdPartyItem
 +
|ThirdPartyItem=3aee73ed-68e0-4c70-8693-2421c68b86cd
 +
|Notes=Note: Redis Cluster is not supported at this time.
 +
}}{{SectionThirdPartyItem
 +
|ThirdPartyItem=3e732261-b78e-4921-b6a6-08ee0a322ca1
 +
}}
 
|StorageStatus=No
 
|StorageStatus=No
 
|StorageText====Logs Volume===
 
|StorageText====Logs Volume===
Line 165: Line 156:
 
{{!}} class="confluenceTd"{{!}}Y
 
{{!}} class="confluenceTd"{{!}}Y
 
{{!}}}
 
{{!}}}
−
The logs volume is used to store log files. If the log.volumeType is set to the pvc, the persistent volume is used. If the log.volumeType is set to the hostpath, the local storage is used.
+
The logs volume stores log files. If the log.volumeType is set to the pvc, the persistent volume is used. If the log.volumeType is set to the hostpath, the local storage is used.
  
 
===Genesys Pulse Collector Health Volume===
 
===Genesys Pulse Collector Health Volume===
Line 177: Line 168:
 
{{!}} class="confluenceTd"{{!}}collector, monitor-sidecar
 
{{!}} class="confluenceTd"{{!}}collector, monitor-sidecar
 
{{!}}}
 
{{!}}}
−
Genesys Pulse Collector health volume is a non-persistent storage for collector health data used to store Genesys Pulse Collector health state files for monitoring.
+
Genesys Pulse Collector health volume provides non-persistent storage for store Genesys Pulse Collector health state files for monitoring.
  
 
===Stat Server Backup Volume===
 
===Stat Server Backup Volume===
Line 199: Line 190:
 
{{!}} class="confluenceTd"{{!}}N
 
{{!}} class="confluenceTd"{{!}}N
 
{{!}}}
 
{{!}}}
−
Stat Server backup volume is a storage for Stat Server's state backup. It stores the server's state between restarts of the container.
+
Stat Server backup volume provides storage for Stat Server's state backup. The Stat Server backup volume stores the server state between restarts of the container.
 
|NetworkStatus=No
 
|NetworkStatus=No
 
|NetworkText=No special requirements.
 
|NetworkText=No special requirements.
 
|BrowserStatus=Yes
 
|BrowserStatus=Yes
 
|DependenciesStatus=No
 
|DependenciesStatus=No
−
|DependenciesText=The following services must be deployed and running before deploying Genesys Pulse:
+
|DependenciesText=Ensure that the following services are deployed and running before you deploy Genesys Pulse:
  
−
*Genesys Authentication
+
*Genesys Authentication:
 +
**Auth client secret must be provisioned with following properties (see {{Link-AnywhereElse|product=AUTH|version=Current|manual=AuthPEGuide|topic=Provision|anchor=CreateAPI}}):
 +
***Client ID: "pulse_client"
 +
***Grant Types: "authorization_code"
 +
***RedirectURIs: "https://<pulse-endpoint>"
 +
**CORS must be allowed for https://<pulse-endpoint> (see {{Link-AnywhereElse|product=AUTH|version=Current|manual=AuthPEGuide|topic=Provision|anchor=UpdateCORS}})
 
*Genesys Web Services and Applications
 
*Genesys Web Services and Applications
 
*Agent Setup
 
*Agent Setup
−
*Tenant Service
+
*Tenant Service:
−
*Voice MicroService
+
**Tenant UUID (v4) must be provisioned, example: "9350e2fc-a1dd-4c65-8d40-1f75a2e080dd"
 +
**Tenant service must be exposed as host: "tenant-<tenant-uuid>.voice.svc.cluster.local." port: 8888
 +
*Voice MicroService:
 +
**Voice service must be exposed as host: "tenant-<tenant-uuid>.voice.svc.cluster.local." port: 8000
 +
{{NoteFormat|All services listed above must be accessible from the same OpenShift cluster where Genesys Pulse will be deployed.|}}
 +
 
  
−
See also {{Link-AnywhereElse|product=PrivateEdition|version=Current|manual=PEGuide|topic=ContDepOrder|display text=Order of services deployment}}.
+
For more information, see {{Link-AnywhereElse|product=PrivateEdition|version=Current|manual=PEGuide|topic=ContDepOrder|display text=Order of services deployment}}.
 
|GDPRStatus=No
 
|GDPRStatus=No
 
|GDPRText=Genesys Pulse supports the General Data Protection Regulation (GDPR). See [https://docs.genesys.com/Documentation/System/8.5.x/SDG/GDPR-Pulse Genesys Pulse Support for GDPR] for details.
 
|GDPRText=Genesys Pulse supports the General Data Protection Regulation (GDPR). See [https://docs.genesys.com/Documentation/System/8.5.x/SDG/GDPR-Pulse Genesys Pulse Support for GDPR] for details.
 
|PEPageType=bf21dc7c-597d-4bbe-8df2-a2a64bd3f167
 
|PEPageType=bf21dc7c-597d-4bbe-8df2-a2a64bd3f167
 
}}
 
}}

Revision as of 19:46, November 25, 2021

This topic is part of the manual Genesys Pulse Private Edition Guide for version Current of Reporting.

Find out what to do before deploying Genesys Pulse.

Limitations and assumptions

There are no known limitations.


Download the Helm charts

For information about how to download the Helm charts in Jfrog Edge, see the suite-level documentation: Downloading your Genesys Multicloud CX containers

To learn what Helm chart version you must download for your release, see Helm charts and containers for Genesys Pulse

Genesys Pulse Containers

Container Description Docker Path
collector Genesys Pulse Collector <docker>/pulse/collector:<image-version>
cs_proxy Configuration Server Proxy <docker>/pulse/cs_proxy:<image-version>
init Init container, used for DB initialization <docker>/pulse/init:<image-version>
lds Load Distribution Server (LDS) <docker>/pulse/lds:<image-version>
monitor_dcu_push_agent Provides monitoring data from Stat Server and Genesys Pulse Collector <docker>/pulse/monitor_dcu_push_agent:<image-version>
monitor_lds_push_agent Provides monitoring data from LDS <docker>/pulse/monitor_lds_push_agent:<image-version>
pulse Genesys Pulse Backend <docker>/pulse/pulse:<image-version>
ss Stat Server <docker>/pulse/ss:<image-version>
userpermissions User Permissions service <docker>/pulse/userpermissions:<image-version>

Genesys Pulse Helm Charts

Helm Chart Containers Shared Helm Path
Init init yes <helm>/init-<chart-version>.tgz
Pulse pulse yes <helm>/pulse-<chart-version>.tgz
LDS cs_proxy, lds, monitor_lds_push_agent <helm>/lds-<chart-version>.tgz
DCU cs_proxy, ss, collector, monitor_dcu_push_agent <helm>/dcu-<chart-version>.tgz
Permissions cs_proxy, userpermissions <helm>/permissions-<chart-version>.tgz
Init Tenant init <helm>/init-tenant-<chart-version>.tgz
Monitor - yes <helm>/monitor-<chart-version>.tgz

Third-party prerequisites

OpenShift CLI must be installed.

For information about setting up your Genesys Multicloud CX private edition platform, see Software requirements.

Third-party services
Name Version Purpose Notes
PostgreSQL 11.x Relational database.
Redis 6.x Used for caching. Only distributions of Redis that support Redis cluster mode are supported, however, some services may not support cluster mode.Note: Redis Cluster is not supported at this time.
A container image registry and Helm chart repository Used for downloading Genesys containers and Helm charts into the customer's repository to support a CI/CD pipeline. You can use any Docker OCI compliant registry.

Storage requirements

Logs Volume

Persistent Volume Size Type IOPS POD Containers Critical Backup needed
pulse-dcu-logs 10Gi RW high DCU csproxy, collector, statserver Y Y
pulse-lds-logs 10Gi RW high lds csproxy, lds Y Y
pulse-permissions-logs 10Gi RW high permissions csproxy, permissions Y Y
pulse-logs 10Gi RW high pulse pulse Y Y

The logs volume stores log files. If the log.volumeType is set to the pvc, the persistent volume is used. If the log.volumeType is set to the hostpath, the local storage is used.

Genesys Pulse Collector Health Volume

Local Volume POD Containers
collector-health dcu collector, monitor-sidecar

Genesys Pulse Collector health volume provides non-persistent storage for store Genesys Pulse Collector health state files for monitoring.

Stat Server Backup Volume

Persistent Volume Size Type IOPS POD Containers Critical Backup needed
statserver-backup 1Gi RWO medium dcu statserver N N

Stat Server backup volume provides storage for Stat Server's state backup. The Stat Server backup volume stores the server state between restarts of the container.

Network requirements

No special requirements.

Genesys dependencies

Ensure that the following services are deployed and running before you deploy Genesys Pulse:

  • Genesys Authentication:
  • Genesys Web Services and Applications
  • Agent Setup
  • Tenant Service:
    • Tenant UUID (v4) must be provisioned, example: "9350e2fc-a1dd-4c65-8d40-1f75a2e080dd"
    • Tenant service must be exposed as host: "tenant-<tenant-uuid>.voice.svc.cluster.local." port: 8888
  • Voice MicroService:
    • Voice service must be exposed as host: "tenant-<tenant-uuid>.voice.svc.cluster.local." port: 8000
Important
All services listed above must be accessible from the same OpenShift cluster where Genesys Pulse will be deployed.


For more information, see Order of services deployment.

GDPR support

Genesys Pulse supports the General Data Protection Regulation (GDPR). See Genesys Pulse Support for GDPR for details.

Retrieved from "https://all.docs.genesys.com/PEC-REP/Current/PulsePEGuide/Planning (2025-07-20 20:56:43)"
Comments or questions about this documentation? Contact us for support!