PEC-REP/Current/GIMPEGuide/PlanningGSP - Revision history

WikiSysop at 13:31, March 10, 2023

2023-03-10T13:31:51Z

WikiSysop at 03:00, September 30, 2022

2022-09-30T03:00:45Z

Show changes

WikiSysop at 16:46, September 2, 2022

2022-09-02T16:46:45Z

WikiSysop at 16:16, September 2, 2022

2022-09-02T16:16:52Z

WikiSysop at 13:10, August 15, 2022

2022-08-15T13:10:07Z

Show changes

WikiSysop at 19:53, March 30, 2022

2022-03-30T19:53:42Z

Show changes

Jdruker: Published

2022-02-11T20:53:21Z

Published

Jdruker: Republishing to refresh third-party data

2022-02-07T16:10:02Z

Republishing to refresh third-party data

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

2021-11-09T20:29:12Z

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

Jose.druker@genesys.com: Published

2021-07-01T03:01:59Z

Published

New page

{{PEPrerequisites
|DisplayName=Before you begin GSP deployment
|Context=Find out what to do before deploying GIM Stream Processor (GSP).
|LimitationsStatus=No
|HelmStatus=No
|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}}.
|ThirdPartyStatus=No
|ThirdPartyText=For information about setting up your Genesys Engage cloud private edition platform, see {{SuiteLevelLink|softwarereq}}.

The following table lists the third-party prerequisites for GSP.
|SectionThirdPartyItem={{SectionThirdPartyItem
|ThirdPartyItem=0d238336-2626-4954-8be3-2f1e16fdd0ce
}}{{SectionThirdPartyItem
|ThirdPartyItem=3aee73ed-68e0-4c70-8693-2421c68b86cd
|Notes=Some notes about Redis for this deployment.
}}{{SectionThirdPartyItem
|ThirdPartyItem=2afd763e-337c-47eb-8428-3bafcc89dbca
}}{{SectionThirdPartyItem
|ThirdPartyItem=2f69518e-33af-4c0f-adcc-a98e5427e5e0
}}
|StorageStatus=No
|StorageText=Genesys Info Mart uses S3 blob storage to store Info Mart data. See {{Link-SomewhereInThisVersion|manual=GIMPEGuide|topic=ConfigureGSP|anchor=S3}} for information about setting up S3 bucket storage for Genesys Info Mart.

{{Notices|Notice=PEComingSoon}}
|NetworkStatus=No
|NetworkText={{Notices|Notice=PEComingSoon}}
|BrowserStatus=No
|DependenciesStatus=No
|DependenciesText=GSP is the first Genesys Info Mart service you must deploy, and there are other Genesys Engage cloud private edition services you must deploy before GSP. For detailed information about the correct order of services deployment, see {{SuiteLevelLink|deployorder}}.
|GDPRStatus=No
|GDPRText={{Notices|Notice=PEComingSoon}}
|PEPageType=bf21dc7c-597d-4bbe-8df2-a2a64bd3f167
}}

@@ Line 37: / Line 37: @@
 Genesys Info Mart has no special requirements for the storage buckets you create. Follow the instructions provided by the storage service provider of your choice to create the S3-compatible storage.
 *For GKE, see the Google Cloud Storage documentation about creating bucket storage.
 *For AKS, see Azure Storage documentation about creating blob storage.
@@ Line 69: / Line 68: @@
 {{!}}-
 {{!}} colspan="3"{{!}}'''GSP consumes data from the following topics:'''
 {{!}}-
 {{!}}digital-agentstate
@@ Line 107: / Line 110: @@
 {{!}}interactions
 {{!}}Name of the output topic for interactions
 {{!}}-
 {{!}}gsp-outbound

@@ Line 6: / Line 6: @@
 |LimitationsStatus=No
 |HelmStatus=No
-|HelmText=To configure and deploy the GIM Stream Processor (GSP), you must obtain the Helm charts included with the GSP release. These Helm charts provision GSP plus any Kubernetes infrastructure GSP requires to run.
+|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.
-GSP is the only service that runs in the GSP container.
+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}}. To find the correct Helm chart version for your release, 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}}.
 |ThirdPartyStatus=No
 |ThirdPartyText=For information about setting up your Genesys Multicloud CX private edition platform, see {{SuiteLevelLink|softwarereq}}.
@@ Line 17: / Line 19: @@
 |SectionThirdPartyItem={{SectionThirdPartyItem
 |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 [[Draft:PEC-REP/Current/GIMPEGuide/PlanningGSP#GSP KafkaTopics|below]].
+|Notes=The Kafka topics that GSP will consume and produce must exist in the Kafka configuration. See more details [[{{FULLPAGENAME}}#Kafka|below]].
 }}{{SectionThirdPartyItem
 |ThirdPartyItem=9ae24d71-5263-4a2e-8d1b-f65660f1cdc0
@@ Line 28: / Line 30: @@
 }}
 |StorageStatus=No
-|StorageText=GSP uses S3-compatible storage to store data such as GSP checkpoints, savepoints, and high availability data during processing. You must provision this S3-compatible storage in your environment.
+|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.
-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:
-{{AnchorDiv|GSP_Plan_CreateS3Storage}}
+*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)-->
-===Create S3-compatible storage===
+*For GKE, see the Google Cloud Storage documentation about creating bucket storage.
-*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.
+Genesys Info Mart has no special requirements for the storage buckets you create.
-To enable the S3-compatible storage object, you populate Helm chart override values for the service (see ). To do this, you need to know details such as the endpoint information, access key, and secret.
+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.}}
@@ 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}}.
 |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 the ephemeral data used during processing.
+|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|GSP_KafkaTopics}}
+{{AnchorDiv|Kafka}}
-==GSP Kafka topics==
+==Kafka configuration==
-For GSP, topics in Kafka represent various data domains and GSP expects certain topics to be defined.
+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}}).
-Unless Kafka has been configured to auto-create topics, you must manually ensure that all of the Kafka topics GSP requires are created in Kafka configuration.
+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.
-The following table shows the topic names GSP expects to be available. In this table, an entry in the '''Customizable GSP parameter column''' indicates support for customizing that topic name.
+{{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'''

@@ Line 6: / Line 6: @@
 |LimitationsStatus=No
 |HelmStatus=No
-|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.
+|HelmText=To configure and deploy the GIM Stream Processor (GSP), you must obtain the Helm charts included with the GSP release. These Helm charts provision GSP plus any Kubernetes infrastructure GSP requires 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.
+GSP is the only service that runs in the GSP container.
-For information about how to download the Helm charts, see {{SuiteLevelLink|helmchart}}.
+For information about how to download the Helm charts, see {{SuiteLevelLink|helmchart}}. To find the correct Helm chart version for your release, see {{Link-AnywhereElse|product=ReleaseNotes|version=Current|manual=GenesysEngage-cloud|topic=GIMHelm}} for the Helm chart version you must download for your release.
 |ThirdPartyStatus=No
 |ThirdPartyText=For information about setting up your Genesys Multicloud CX private edition platform, see {{SuiteLevelLink|softwarereq}}.
@@ Line 19: / Line 17: @@
 |SectionThirdPartyItem={{SectionThirdPartyItem
 |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 [[{{FULLPAGENAME}}#Kafka|below]].
+|Notes=The Kafka topics that GSP will consume and produce must exist in the Kafka configuration. See more details [[Draft:PEC-REP/Current/GIMPEGuide/PlanningGSP#GSP KafkaTopics|below]].
 }}{{SectionThirdPartyItem
 |ThirdPartyItem=9ae24d71-5263-4a2e-8d1b-f65660f1cdc0
@@ Line 30: / Line 28: @@
 }}
 |StorageStatus=No
-|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.
+|StorageText=GSP uses S3-compatible storage to store data such as GSP checkpoints, savepoints, and high availability data during processing. You must provision this S3-compatible storage in your environment.
-Follow the instructions provided by the storage service provider of your choice to create the S3-compatible storage. For example:
+{{AnchorDiv|GSP_Plan_CreateS3Storage}}
-*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 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 S3-compatible storage object, you populate Helm chart override values for the service (see ). To do this, you need to know details such as the endpoint information, access key, and secret.
 {{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 50: / Line 51: @@
 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
-|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.
+|GDPRText=Not applicable, provided your Kafka retention policies have not been set to more than 30 days. GSP does not store information beyond the ephemeral data used during processing.
-{{AnchorDiv|Kafka}}
+{{AnchorDiv|GSP_KafkaTopics}}
-==Kafka configuration==
+==GSP Kafka topics==
-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}}).
+For GSP, topics in Kafka represent various data domains and GSP expects certain topics to be defined.
-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.
+Unless Kafka has been configured to auto-create topics, you must manually ensure that all of the Kafka topics GSP requires are created in Kafka configuration.
-{{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]).}}
+The following table shows the topic names GSP expects to be available. In this table, an entry in the '''Customizable GSP parameter column''' indicates support for customizing that topic name.
 {{{!}}
 !'''Topic name'''

@@ Line 2: / Line 2: @@
 |DisplayName=Before you begin GSP deployment
 |Context=Find out what to do before deploying GIM Stream Processor (GSP).
 |LimitationsStatus=No
 |HelmStatus=No
@@ Line 24: / Line 25: @@
 }}
 |StorageStatus=No
-|StorageText=Genesys Info Mart uses S3 blob storage to store Info Mart data. See {{Link-SomewhereInThisVersion|manual=GIMPEGuide|topic=ConfigureGSP|anchor=S3}} for information about setting up S3 bucket storage for Genesys Info Mart.
+|StorageText=Genesys Info Mart uses S3 bucket storage to store Info Mart data during processing. See {{Link-SomewhereInThisVersion|manual=GIMPEGuide|topic=ConfigureGSP|anchor=S3}} for information about setting up S3 bucket storage for Genesys Info Mart.
 {{Notices|Notice=PEComingSoon}}

@@ Line 10: / Line 10: @@
 For information about how to download the Helm charts, see {{SuiteLevelLink|helmchart}}.
 |ThirdPartyStatus=No
-|ThirdPartyText=For information about setting up your Genesys Engage cloud private edition platform, see {{SuiteLevelLink|softwarereq}}.
+|ThirdPartyText=For information about setting up your Genesys Multicloud CX private edition platform, see {{SuiteLevelLink|softwarereq}}.
 The following table lists the third-party prerequisites for GSP.
@@ Line 31: / Line 31: @@
 |BrowserStatus=No
 |DependenciesStatus=No
-|DependenciesText=GSP is the first Genesys Info Mart service you must deploy, and there are other Genesys Engage cloud private edition services you must deploy before GSP. For detailed information about the correct order of services deployment, see {{SuiteLevelLink|deployorder}}.
+|DependenciesText=GSP is the first Genesys Info Mart service you must deploy, and there are other Genesys Multicloud CX private edition services you must deploy before GSP. For detailed information about the correct order of services deployment, see {{SuiteLevelLink|deployorder}}.
 |GDPRStatus=No
 |GDPRText={{Notices|Notice=PEComingSoon}}
 |PEPageType=bf21dc7c-597d-4bbe-8df2-a2a64bd3f167
 }}