Difference between revisions of "DES/Current/DESPEGuide/Architecture"

From Genesys Documentation
Jump to: navigation, search
(Published)
 
 
(5 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{PEArchitecture
+
{{ArticlePEServiceArchitecture
 +
|ServiceId=7e3f500e-c7d5-4f0e-a62d-f7a002178a90
 +
|IntroductionText=The architecture diagram in this topic illustrates a sample deployment of Designer and DAS.
 +
 
 +
For more information on the Genesys Multicloud CX private edition architecture, refer to the {{SuiteLevelLink|architecture}} topic in the ''Setting up Genesys Multicloud CX private edition'' document.
 +
|Image=Pe_designer_architecture.png
 +
|AltText=Designer Private Edition architecture diagram.
 +
|PEConnections={{PEConnections
 +
|Connection=1
 +
|SourceType=UI
 +
|SourceUI=Customer browser
 +
|DestinationType=Service
 +
|DestinationService=6f7f1a8d-4e60-4b8d-a6f0-8cafdbdf0a3e
 +
|Protocol=16adca31-3f73-4a2d-a261-f79c05be6cf2
 +
|Port=8095
 +
|Purpose=Designer queries the Genesys Authentication Service to validate the user’s identity.
 +
|Classification=f12b7433-c91c-4da4-bd6e-445684e38560
 +
}}{{PEConnections
 +
|Connection=2
 +
|SourceType=UI
 +
|DestinationType=Other
 +
|DestinationOther=Designer ingress
 +
|Protocol=53fca8fe-9174-417f-bff9-416ea8119f9e
 +
|Port=443
 +
|Purpose=Web browser used to access the Designer UI.
 +
|Classification=b2dff270-19d6-4258-a380-da06305a143c
 +
}}{{PEConnections
 +
|Connection=3
 +
|SourceType=Other
 +
|SourceOther=Designer ingress
 +
|DestinationType=Service
 +
|DestinationService=7e3f500e-c7d5-4f0e-a62d-f7a002178a90
 +
|Protocol=53fca8fe-9174-417f-bff9-416ea8119f9e
 +
|Port=8888
 +
|Purpose=Incoming web traffic from the UI.
 +
|Classification=2fb71bb4-3a8f-43ce-9b16-9045d3af916f
 +
}}{{PEConnections
 +
|Connection=4
 +
|SourceType=Other
 +
|SourceOther=Designer
 +
|DestinationType=Other
 +
|DestinationOther=Logging
 +
|Protocol=53fca8fe-9174-417f-bff9-416ea8119f9e
 +
|Purpose=Centralized logging.
 +
|Classification=2fb71bb4-3a8f-43ce-9b16-9045d3af916f
 +
}}{{PEConnections
 +
|Connection=5
 +
|SourceType=Service
 +
|SourceService=7e3f500e-c7d5-4f0e-a62d-f7a002178a90
 +
|DestinationType=Other
 +
|DestinationOther=Redis
 +
|Protocol=53fca8fe-9174-417f-bff9-416ea8119f9e
 +
|Port=6380
 +
|Purpose=Resource index caching and multi-user collaboration locks on Designer resources.
 +
|Classification=2fb71bb4-3a8f-43ce-9b16-9045d3af916f
 +
}}{{PEConnections
 +
|Connection=6
 +
|SourceType=Other
 +
|SourceOther=Prometheus
 +
|DestinationType=Service
 +
|DestinationService=7e3f500e-c7d5-4f0e-a62d-f7a002178a90
 +
|Protocol=53fca8fe-9174-417f-bff9-416ea8119f9e
 +
|Port=8888
 +
|Purpose=Metrics for monitoring and alerting with Prometheus.
 +
|Classification=b2dff270-19d6-4258-a380-da06305a143c
 +
}}{{PEConnections
 +
|Connection=7
 +
|SourceType=Included Service
 +
|SourceIncluded=1fc73d24-f1e5-45e1-a5ef-b642bbd83c9e
 +
|DestinationType=Service
 +
|DestinationService=58e238b9-a7f6-4af9-8050-0fe1b7cb1c39
 +
|Protocol=53fca8fe-9174-417f-bff9-416ea8119f9e
 +
|Port=80
 +
|Purpose=Publish callback services.
 +
}}{{PEConnections
 +
|Connection=8
 +
|SourceType=Other
 +
|SourceOther=Designer
 +
|DestinationType=Service
 +
|DestinationService=11ff3d39-ae2b-4526-b7e5-7dcdf781ef01
 +
|Protocol=53fca8fe-9174-417f-bff9-416ea8119f9e
 +
|Port=80
 +
|Purpose=Authentication of Designer and configuration data access.
 +
}}{{PEConnections
 +
|Connection=9
 +
|SourceType=Other
 +
|SourceOther=Designer replica set
 +
|DestinationType=Included Service
 +
|DestinationIncludedService=97cb0c1a-75f7-41e3-8bbc-e29690825503
 +
|Protocol=b3f7f755-b303-4d97-b8ed-02531a897c2f
 +
|Port=80
 +
|Purpose=Fetch Designer Bot registry information.
 +
|Classification=b2dff270-19d6-4258-a380-da06305a143c
 +
}}{{PEConnections
 +
|Connection=10
 +
|SourceType=Other
 +
|SourceOther=Shared file system (NFS)
 +
|DestinationType=Other
 +
|DestinationOther=Persistent volume
 +
|Purpose=NFS for workspace storage.
 +
}}{{PEConnections
 +
|Connection=11
 +
|SourceType=Other
 +
|SourceOther=Persistent volume
 +
|DestinationType=Other
 +
|DestinationOther=Designer Persistent Volume Claim (PVC)
 +
|Purpose=Data for workspace storage.
 +
}}{{PEConnections
 +
|Connection=12
 +
|SourceType=Other
 +
|SourceOther=Designer Persistent Volume Claim (PVC)
 +
|DestinationType=Other
 +
|DestinationOther=Designer replica set persistent volume
 +
|Purpose=Data for workspace storage.
 +
}}{{PEConnections
 +
|Connection=13
 +
|SourceType=Other
 +
|SourceOther=Designer Persistent Volume Claim (PVC)
 +
|DestinationType=Other
 +
|DestinationOther=DAS replica set persistent volume
 +
|Purpose=Data for workspace storage.
 +
}}{{PEConnections
 +
|Connection=14
 +
|SourceType=Included Service
 +
|SourceIncluded=1fc73d24-f1e5-45e1-a5ef-b642bbd83c9e
 +
|DestinationType=Third Party
 +
|DestinationThirdParty=0d238336-2626-4954-8be3-2f1e16fdd0ce
 +
|Protocol=53fca8fe-9174-417f-bff9-416ea8119f9e
 +
|Port=9205
 +
|Purpose=Query Designer Analytics data (Session Detail Records).
 +
|Classification=2fb71bb4-3a8f-43ce-9b16-9045d3af916f
 +
}}{{PEConnections
 +
|Connection=15
 +
|SourceType=Included Service
 +
|SourceIncluded=e8818b81-a976-498c-bac3-3293d0b93b73
 +
|DestinationType=Third Party
 +
|DestinationThirdParty=0d238336-2626-4954-8be3-2f1e16fdd0ce
 +
|Protocol=53fca8fe-9174-417f-bff9-416ea8119f9e
 +
|Port=9205
 +
|Purpose=Store Designer Analytics data (Session Detail Records).
 +
|Classification=2fb71bb4-3a8f-43ce-9b16-9045d3af916f
 +
}}{{PEConnections
 +
|Connection=16
 +
|SourceType=Service
 +
|SourceService=4d384b74-f61d-48f7-bace-30048213bf99
 +
|DestinationType=Other
 +
|DestinationOther=DAS ingress
 +
|Protocol=53fca8fe-9174-417f-bff9-416ea8119f9e
 +
|Port=80
 +
|Purpose=Fetch Designer application pages (VXML, SCXML), JSON files, and so on.
 +
|Classification=b2dff270-19d6-4258-a380-da06305a143c
 +
}}{{PEConnections
 +
|Connection=17
 +
|SourceType=Other
 +
|SourceOther=DAS ingress
 +
|DestinationType=Included Service
 +
|DestinationIncludedService=e8818b81-a976-498c-bac3-3293d0b93b73
 +
|Protocol=53fca8fe-9174-417f-bff9-416ea8119f9e
 +
|Port=8080
 +
|Purpose=HTTP traffic from DAS ingress.
 +
|Classification=b2dff270-19d6-4258-a380-da06305a143c
 +
}}{{PEConnections
 +
|Connection=18
 +
|SourceType=API
 +
|SourceAPI=External/Customer
 +
|DestinationType=Included Service
 +
|DestinationIncludedService=e8818b81-a976-498c-bac3-3293d0b93b73
 +
|Protocol=16adca31-3f73-4a2d-a261-f79c05be6cf2
 +
|Port=443
 +
|Purpose=External customer API requests.
 +
|Classification=2fb71bb4-3a8f-43ce-9b16-9045d3af916f
 +
}}{{PEConnections
 +
|Connection=19
 +
|SourceType=Service
 +
|SourceService=512b7e2b-c4f0-4ba9-ab15-e6a4d3180b45
 +
|DestinationType=Other
 +
|DestinationOther=DAS ingress
 +
|Protocol=53fca8fe-9174-417f-bff9-416ea8119f9e
 +
|Port=80
 +
|Purpose=Fetch Designer audio resources.
 +
|Classification=b2dff270-19d6-4258-a380-da06305a143c
 +
}}{{PEConnections
 +
|Connection=20
 +
|SourceType=Included Service
 +
|SourceIncluded=e8818b81-a976-498c-bac3-3293d0b93b73
 +
|DestinationType=Included Service
 +
|DestinationIncludedService=97cb0c1a-75f7-41e3-8bbc-e29690825503
 +
|Protocol=b3f7f755-b303-4d97-b8ed-02531a897c2f
 +
|Port=80
 +
|Purpose=Fetch GES APIs for callback processing.
 +
|Classification=b2dff270-19d6-4258-a380-da06305a143c
 +
}}
 
|DisplayName=Architecture
 
|DisplayName=Architecture
 
|Context=Learn about Designer's architecture.
 
|Context=Learn about Designer's architecture.
|IntroductionText=The architecture diagram in this topic illustrates a sample premise deployment of Designer and DAS.
 
 
For more information on the Genesys Engage cloud private edition architecture, refer to the {{SuiteLevelLink|architecture}} topic in the ''Setting up Genesys Engage cloud private edition'' document.
 
|Image=Premise-Designer-DAS-architecture.png
 
 
|Section={{Section
 
|Section={{Section
 
|sectionHeading=High Availability (HA), Disaster Recovery (DR), and Scalability
 
|sectionHeading=High Availability (HA), Disaster Recovery (DR), and Scalability
Line 12: Line 199:
 
|structuredtext=Designer and DAS must be deployed as highly available in order to avoid single points of failure. A minimum of 2 replicas of each service must be deployed to achieve HA.
 
|structuredtext=Designer and DAS must be deployed as highly available in order to avoid single points of failure. A minimum of 2 replicas of each service must be deployed to achieve HA.
  
The Designer and DAS service pods can be automatically scaled up or down based on metrics such as CPU and memory utilization. The ''Deployment configuration settings'' section provides more information on configuring HA and auto-scaling.
+
The Designer and DAS service pods can be automatically scaled up or down based on metrics such as CPU and memory utilization. The {{Link-AnywhereElse|product=DES|version=Current|manual=DESPEGuide|topic=Configure|display text=Deployment configuration settings}} section provides more information on configuring HA and auto-scaling.
  
 
Refer to the [https://docs.genesys.com/Documentation/System/8.5.x/DDG/HAandDRNotes Genesys Docker Deployment Guide] for more information on general HA recommendation for Kubernetes.
 
Refer to the [https://docs.genesys.com/Documentation/System/8.5.x/DDG/HAandDRNotes Genesys Docker Deployment Guide] for more information on general HA recommendation for Kubernetes.
 +
|Status=No
 +
}}{{Section
 +
|alignment=Vertical
 
|Status=No
 
|Status=No
 
}}
 
}}

Latest revision as of 01:15, October 8, 2022

This topic is part of the manual Designer Private Edition Guide for version Current of Designer.

Learn about Designer architecture

Introduction

The architecture diagram in this topic illustrates a sample deployment of Designer and DAS.

For more information on the Genesys Multicloud CX private edition architecture, refer to the Architecture topic in the Setting up Genesys Multicloud CX private edition document.

For information about the overall architecture of Genesys Multicloud CX private edition, see the high-level Architecture page.

See also High availability and disaster recovery for information about high availability/disaster recovery architecture.

Architecture diagram — Connections

The numbers on the connection lines refer to the connection numbers in the table that follows the diagram. The direction of the arrows indicates where the connection is initiated (the source) and where an initiated connection connects to (the destination), from the point of view of Designer as a service in the network.

Pe designer architecture.png

Connections table

The connection numbers refer to the numbers on the connection lines in the diagram. The Source, Destination, and Connection Classification columns in the table relate to the direction of the arrows in the Connections diagram above: The source is where the connection is initiated, and the destination is where an initiated connection connects to, from the point of view of Designer as a service in the network. Egress means the Designer service is the source, and Ingress means the Designer service is the destination. Intra-cluster means the connection is between services in the cluster.

Connection Source Destination Protocol Port Classification Data that travels on this connection
1 Customer browser Genesys Authentication HTTPS 8095 Intra-cluster Designer queries the Genesys Authentication Service to validate the user’s identity.
2 Designer ingress HTTP 443 Ingress Web browser used to access the Designer UI.
3 Designer ingress Designer HTTP 8888 Egress Incoming web traffic from the UI.
4 Designer Logging HTTP Egress Centralized logging.
5 Designer Redis HTTP 6380 Egress Resource index caching and multi-user collaboration locks on Designer resources.
6 Prometheus Designer HTTP 8888 Ingress Metrics for monitoring and alerting with Prometheus.
7 Designer Genesys Engagement Service HTTP 80 Publish callback services.
8 Designer Genesys Web Services and Applications HTTP 80 Authentication of Designer and configuration data access.
9 Designer replica set Nexus HTTP/HTTPS 80 Ingress Fetch Designer Bot registry information.
10 Shared file system (NFS) Persistent volume NFS for workspace storage.
11 Persistent volume Designer Persistent Volume Claim (PVC) Data for workspace storage.
12 Designer Persistent Volume Claim (PVC) Designer replica set persistent volume Data for workspace storage.
13 Designer Persistent Volume Claim (PVC) DAS replica set persistent volume Data for workspace storage.
14 Designer Elasticsearch HTTP 9205 Egress Query Designer Analytics data (Session Detail Records).
15 Designer Application Server Elasticsearch HTTP 9205 Egress Store Designer Analytics data (Session Detail Records).
16 Voice Microservices DAS ingress HTTP 80 Ingress Fetch Designer application pages (VXML, SCXML), JSON files, and so on.
17 DAS ingress Designer Application Server HTTP 8080 Ingress HTTP traffic from DAS ingress.
18 External/Customer Designer Application Server HTTPS 443 Egress External customer API requests.
19 Genesys Voice Platform DAS ingress HTTP 80 Ingress Fetch Designer audio resources.
20 Designer Application Server Nexus HTTP/HTTPS 80 Ingress Fetch GES APIs for callback processing.
Comments or questions about this documentation? Contact us for support!