Difference between revisions of "PEC-REP/Current/GIMPEGuide/PlanningGSP"
| Line 6: | Line 6: | ||
|LimitationsStatus=No | |LimitationsStatus=No | ||
|HelmStatus=No | |HelmStatus=No | ||
| − | |HelmText= | + | |HelmText=GIM Stream Processor (GSP) is the only service that runs in the GSP Docker container. The Helm charts included with the GSP release provision GSP and any Kubernetes infrastructure necessary for GSP to run. |
| − | + | See {{Link-AnywhereElse|product=ReleaseNotes|version=Current|manual=GenesysEngage-cloud|topic=GIMHelm}} for the Helm chart version you must download for your release. | |
| − | For information about how to download the Helm charts, see {{SuiteLevelLink|helmchart}}. | + | For information about how to download the Helm charts, see {{SuiteLevelLink|helmchart}}. |
| + | |||
| + | {{JDNote|There are known differences between the content on pages in this GSP section and the PAT team instructions used as doc input. Some of the PAT team content (for example, details about how to create third-party storage) is intentionally excluded, while there are some corrections/additions in this doc that the PAT team may not have carried over. Before using PAT team input to update pages in this section, compare their new content against the May 10/22 version of [https://intranet.genesys.com/display/CPE/19.3.1+Deployment 19.3.1 Deployment], and only consider content added since then. Similarly for GCA and GIM.}} | ||
|ThirdPartyStatus=No | |ThirdPartyStatus=No | ||
|ThirdPartyText=For information about setting up your Genesys Multicloud CX private edition platform, see {{SuiteLevelLink|softwarereq}}. | |ThirdPartyText=For information about setting up your Genesys Multicloud CX private edition platform, see {{SuiteLevelLink|softwarereq}}. | ||
| Line 17: | Line 19: | ||
|SectionThirdPartyItem={{SectionThirdPartyItem | |SectionThirdPartyItem={{SectionThirdPartyItem | ||
|ThirdPartyItem=2f69518e-33af-4c0f-adcc-a98e5427e5e0 | |ThirdPartyItem=2f69518e-33af-4c0f-adcc-a98e5427e5e0 | ||
| − | |Notes=The Kafka topics that GSP will consume and produce must exist in the Kafka configuration. See more details [[ | + | |Notes=The Kafka topics that GSP will consume and produce must exist in the Kafka configuration. See more details [[{{FULLPAGENAME}}#Kafka|below]]. |
}}{{SectionThirdPartyItem | }}{{SectionThirdPartyItem | ||
|ThirdPartyItem=9ae24d71-5263-4a2e-8d1b-f65660f1cdc0 | |ThirdPartyItem=9ae24d71-5263-4a2e-8d1b-f65660f1cdc0 | ||
| Line 28: | Line 30: | ||
}} | }} | ||
|StorageStatus=No | |StorageStatus=No | ||
| − | |StorageText=GSP uses S3-compatible storage to store data such as GSP checkpoints, savepoints, and high availability data | + | |StorageText=Like GCA, GSP uses S3-compatible storage to store data during processing. GSP stores data such as GSP checkpoints, savepoints, and high availability data. By default, GSP is configured to use Azure Blob Storage, but you can also use S3-compatible storage provided by other cloud platforms. Genesys expects you to use the same storage account for GSP and GCA. |
| − | + | Follow the instructions provided by the storage service provider of your choice to create the S3-compatible storage. For example: | |
| − | + | *For OpenShift, see the OpenShift Data Foundation (formerly OpenShift Container Storage) documentation about creating an Object Bucket Claim (OBC). Note that you must install OpenShift container storage on your cluster and provision it with bucket storage such as NooBaa before you create an OBC.<!--(CPE-2460)--> | |
| − | + | *For GKE, see the Google Cloud Storage documentation about creating bucket storage. | |
| − | |||
| − | + | Genesys Info Mart has no special requirements for the storage buckets you create. | |
| − | |||
| − | |||
| − | To enable the S3-compatible storage object | + | To enable the Genesys Info Mart service to access your S3-compatible storage object, you need to know details such as the endpoint information, access key, and secret, in order to populate Helm chart override values for the service (see {{Link-SomewhereInThisVersion|manual=GIMPEGuide|topic=ConfigureGSP|anchor=Storage|display text=Configure S3-compatible storage}}). |
{{NoteFormat|Note and securely store the bucket details, particularly the access key and secret, when you create the storage bucket. Depending on the cloud storage service you choose, you may not be able to recover this information subsequently.}} | {{NoteFormat|Note and securely store the bucket details, particularly the access key and secret, when you create the storage bucket. Depending on the cloud storage service you choose, you may not be able to recover this information subsequently.}} | ||
| Line 51: | Line 50: | ||
There are other private edition services you must deploy before Genesys Info Mart. For detailed information about the recommended order of services deployment, see {{SuiteLevelLink|deployorder}}. | There are other private edition services you must deploy before Genesys Info Mart. For detailed information about the recommended order of services deployment, see {{SuiteLevelLink|deployorder}}. | ||
|GDPRStatus=No | |GDPRStatus=No | ||
| − | |GDPRText=Not applicable, provided your Kafka retention policies have not been set to more than 30 days. GSP does not store information beyond | + | |GDPRText=Not applicable, provided your Kafka retention policies have not been set to more than 30 days. GSP does not store information beyond ephemeral data used during processing. |
| − | {{AnchorDiv| | + | {{AnchorDiv|Kafka}} |
| − | == | + | ==Kafka configuration== |
| − | + | Unless Kafka has been configured to auto-create topics, ensure that the Kafka topics GSP requires have been created in the Kafka configuration. The following table shows the topic names GSP expects to use. An entry in the '''Customizable GSP parameter''' column indicates that GSP supports using a customized topic name. If you use customized topic names, you must override the applicable values in the '''values.yaml''' file (see {{Link-SomewhereInThisVersion|manual=GIMPEGuide|topic=ConfigureGSP|anchor=OverrideValues|display text=Override Helm chart values}}). | |
| − | |||
| − | |||
| − | |||
| − | + | The topics represent various data domains. If a topic does not exist, GSP will never receive data for that domain. If the topic exists but the customizable parameter value is empty in the GSP configuration, data from that domain will be discarded. | |
| − | + | {{JDNote|Uncomment the gsp-mn row when media-neutral is supported. Add a row for designer-das when SDR is supported (see [https://genesysjira.atlassian.net/browse/GIM-14103 GIM-14103]).}} | |
{{{!}} | {{{!}} | ||
!'''Topic name''' | !'''Topic name''' | ||
Revision as of 16:46, September 2, 2022
Contents
Find out what to do before deploying GIM Stream Processor (GSP).
Limitations and assumptions
Not applicable
Download the Helm charts
GIM Stream Processor (GSP) is the only service that runs in the GSP Docker container. The Helm charts included with the GSP release provision GSP and any Kubernetes infrastructure necessary for GSP to run.
See Helm charts and containers for Genesys Info Mart for the Helm chart version you must download for your release.
For information about how to download the Helm charts, see Downloading your Genesys Multicloud CX containers.
Third-party prerequisites
For information about setting up your Genesys Multicloud CX private edition platform, see Software requirements.
The following table lists the third-party prerequisites for GSP.
| Name | Version | Purpose | Notes |
|---|---|---|---|
| Kafka | 2.x | Message bus. | The Kafka topics that GSP will consume and produce must exist in the Kafka configuration. See more details below. |
| Object storage | Persistent or shared data storage, such as Amazon S3, Azure Blob Storage, or Google Cloud Storage. | Both GSP and GCA require persistent storage to store data during processing. You can use the same storage account for both services. | |
| 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. | ||
| Command Line Interface | The command line interface tools to log in and work with the Kubernetes clusters. |
Storage requirements
Like GCA, GSP uses S3-compatible storage to store data during processing. GSP stores data such as GSP checkpoints, savepoints, and high availability data. By default, GSP is configured to use Azure Blob Storage, but you can also use S3-compatible storage provided by other cloud platforms. Genesys expects you to use the same storage account for GSP and GCA.
Follow the instructions provided by the storage service provider of your choice to create the S3-compatible storage. For example:
- For OpenShift, see the OpenShift Data Foundation (formerly OpenShift Container Storage) documentation about creating an Object Bucket Claim (OBC). Note that you must install OpenShift container storage on your cluster and provision it with bucket storage such as NooBaa before you create an OBC.
- For GKE, see the Google Cloud Storage documentation about creating bucket storage.
Genesys Info Mart has no special requirements for the storage buckets you create.
To enable the Genesys Info Mart service to access your S3-compatible storage object, you need to know details such as the endpoint information, access key, and secret, in order to populate Helm chart override values for the service (see Configure S3-compatible storage).
Network requirements
No special network requirements. Network bandwidth must be sufficient to handle the volume of data to be transferred into and out of Kafka.
Browser requirements
Not applicable
Genesys dependencies
There are no strict dependencies between the Genesys Info Mart services, but the logic of your particular pipeline might require Genesys Info Mart services to be deployed in a particular order. Depending on the order of deployment, there might be temporary data inconsistencies until all the Genesys Info Mart services are operational. For example, GSP looks for the GCA snapshot when it starts; if GCA has not yet been deployed, GSP will encounter unknown configuration objects and resources until the snapshot becomes available.
There are other private edition services you must deploy before Genesys Info Mart. For detailed information about the recommended order of services deployment, see Order of services deployment.
GDPR support
Not applicable, provided your Kafka retention policies have not been set to more than 30 days. GSP does not store information beyond ephemeral data used during processing.
Kafka configuration
Unless Kafka has been configured to auto-create topics, ensure that the Kafka topics GSP requires have been created in the Kafka configuration. The following table shows the topic names GSP expects to use. An entry in the Customizable GSP parameter column indicates that GSP supports using a customized topic name. If you use customized topic names, you must override the applicable values in the values.yaml file (see Override Helm chart values).
The topics represent various data domains. If a topic does not exist, GSP will never receive data for that domain. If the topic exists but the customizable parameter value is empty in the GSP configuration, data from that domain will be discarded.
| Topic name | Customizable GSP parameter | Description |
|---|---|---|
| GSP consumes the following topics: | ||
| voice-callthread | Name of the input topic with voice interactions | |
| voice-agentstate | Name of the input topic with voice agent states | |
| voice-outbound | Name of the input topic with outbound (CX Contact) activity associated with either voice or digital interactions | |
| digital-itx | digitalItx | Name of the input topic with digital interactions |
| digital-agentstate | digitalAgentStates | Name of the input topic with digital agent states |
| gca-cfg | cfg | Name of the input topic with configuration data |
| GSP produces the following topics: | ||
| gsp-ixn | interactions | Name of the output topic for interactions |
| gsp-sm | agentStates | Name of the output topic for agent states |
| gsp-outbound | outbound | Name of the output topic for outbound (CX Contact) activity |
| gsp-custom | custom | Name of the output topic for custom reporting |
| gsp-cfg | cfg | Name of the output topic for configuration reporting |