Genesys Documentation - User contributions [en]

Template:JDNote

2022-06-17T17:45:31Z

Jdruker:

<noinclude>Short-term template to provide in-context notes for the writer replacing Jose Druker. The note switches on namespace, so that nothing displays on published pages.</noinclude>

<onlyinclude>{{#switch:{{NAMESPACENUMBER}}|620={{Editgrn_open}}<font color=red>'''Note for new writer:'''</font>{{Editgrn_close}} <font color="#B24DE7">''{{{1}}}''</font>|#default=}}</onlyinclude>

<noinclude>[[Category:Macros]]</noinclude>

Template:ArticlePEServiceUpgrade

2022-05-20T11:45:59Z

Jdruker: Resaving to prompt Cargo update

<noinclude>
This is the "ArticlePEServiceUpgrade" template.

It should be called in the following format:
<pre>
{{ArticlePEServiceUpgrade
|ServiceId=
|UpgradeStrategy=
|AddIncluded=
|Notes=
|OptionalServiceIntro=
}}
</pre>
Edit the page to see the template text.

{{#cargo_declare:_table=ArticlePEServiceUpgrade
|ServiceId=String
|UpgradeStrategy=String
|AddIncluded=String
|Notes=Wikitext(size=1000)
|OptionalServiceIntro=Wikitext(size=5000)
}}

{{#cargo_attach:_table=Article}}

</noinclude>
<includeonly>{{#css: .MintyDocsTopicDesc {display:none} }}{{#default_form:ArticlePEServiceUpgrade}}
[[Category:ArticlePEServiceUpgrade]]__TOC__ 
__NOEDITSECTION__ 
{{#cargo_store:_table=ArticlePEServiceUpgrade
|ServiceId={{{ServiceId|}}}
|UpgradeStrategy={{{UpgradeStrategy|}}}
|AddIncluded={{{AddIncluded|}}}
|Notes={{{Notes|}}}
}}{{#cargo_store:_table=Article
|productshort={{#explode:{{FULLPAGENAME}}|/|0}}
|ComingSoon={{{ComingSoon|}}}
|DisplayName=Upgrade, roll back, or uninstall {{#cargo_query:tables=ArticlePEServiceUpgrade,Service
|join on=ArticlePEServiceUpgrade.ServiceId=Service.Id|fields=IF(Service.ShortName IS NULL, Service.Name, Service.ShortName)|no html|where=ArticlePEServiceUpgrade._pageName="{{FULLPAGENAME}}"|default=}}
|TocName={{{TocName|}}}
|Dimension={{{Dimension|}}}
|Context=Learn how to upgrade, roll back, or uninstall {{#cargo_query:tables=ArticlePEServiceUpgrade,Service
|join on=ArticlePEServiceUpgrade.ServiceId=Service.Id|fields=IF(Service.ShortName IS NULL, Service.Name, Service.ShortName)|no html|where=ArticlePEServiceUpgrade._pageName="{{FULLPAGENAME}}"|default=}}.
|Product={{MINTYDOCSPRODUCT}}
|Manual={{#explode:{{FULLPAGENAME}}|/|2}}
}}{{#mintydocs_topic:
|display name=Upgrade, roll back, or uninstall {{#cargo_query:tables=ArticlePEServiceUpgrade,Service
|join on=ArticlePEServiceUpgrade.ServiceId=Service.Id|fields=IF(Service.ShortName IS NULL, Service.Name, Service.ShortName)|no html|where=ArticlePEServiceUpgrade._pageName="{{FULLPAGENAME}}"|default=}}
|toc name=Upgrade, roll back, or uninstall {{#cargo_query:tables=ArticlePEServiceUpgrade,Service
|join on=ArticlePEServiceUpgrade.ServiceId=Service.Id|fields=IF(Service.ShortName IS NULL, Service.Name, Service.ShortName)|no html|where=ArticlePEServiceUpgrade._pageName="{{FULLPAGENAME}}"|default=}}
}}{{EPPOHead|Role={{{Role|}}}|ComingSoon={{{ComingSoon|}}}|Dimension={{{Dimension|}}}|Context=Learn how to upgrade, roll back, or uninstall {{#cargo_query:tables=ArticlePEServiceUpgrade,Service
|join on=ArticlePEServiceUpgrade.ServiceId=Service.Id|fields=IF(Service.ShortName IS NULL, Service.Name, Service.ShortName)|no html|where=ArticlePEServiceUpgrade._pageName="{{FULLPAGENAME}}"|default=}}.|PageType=Article}}
{{PEUpgradeBoilerplate|BoilerplateSection=UpgradeIntro|AddIncluded={{{AddIncluded|}}}|ServiceId={{{ServiceId|}}}|UpgradeStrategy={{{UpgradeStrategy|}}}|IncludedServiceUpgradeStrategy={{{IncludedServiceUpgradeStrategy|}}}}}{{#if:{{{OptionalServiceIntro|}}}|<nowiki/>

{{{OptionalServiceIntro}}}|}}{{PEUpgradeBoilerplate|BoilerplateSection=Timing}}{{#if:{{{SchedulingConsiderations|}}}|<nowiki/>

{{{SchedulingConsiderations}}}|}}{{PEUpgradeBoilerplate|BoilerplateSection=Monitoring}}{{#if:{{{MonitoringExt|}}}|<nowiki/>

{{{MonitoringExt}}}|}}
{{PEUpgradeBoilerplate|BoilerplateSection=PrepSteps}}{{#if:{{{OptionalPreparatorySteps|}}}|{{#switch:{{#sub:{{{OptionalPreparatorySteps}}}|0|1}}|#={{{OptionalPreparatorySteps}}}|#default=<nowiki/>
{{{OptionalPreparatorySteps}}}}}|}}{{#if:{{{RollUpdUpgradeExt|}}}|{{PEUpgradeBoilerplate|BoilerplateSection=RollUpdUpgrade}}
{{{RollUpdUpgradeExt|}}}
{{PEUpgradeBoilerplate|BoilerplateSection=RollUpdVerify}}{{#if:{{{RollUpdVerifyExt|}}}|<nowiki/>

{{{RollUpdVerifyExt}}}|}}
{{PEUpgradeBoilerplate|BoilerplateSection=RollUpdRollback}}
{{{RollUpdRollbackExt|}}}
{{PEUpgradeBoilerplate|BoilerplateSection=RollUpdVerifyRollback}}{{#if:{{{OptRollUpdVerifyRollbackExt|}}}|<nowiki/>

{{{OptRollUpdVerifyRollbackExt|}}}|}}
|}}

{{#if:{{{PEBlueGreenUpgrade|}}}|
{{AnchorDiv|BlueGreen}}
==Blue/Green==
{{{PEBlueGreenUpgrade|}}}|}}{{#if:{{{Canary|}}}|<nowiki/>
{{AnchorDiv|Canary}}
==Canary==
{{{Canary|}}}|}}
{{#if:{{{OptPostUpgradeProc|}}}|
{{AnchorDiv|OptPostUpgradeProc}}
==Post-upgrade procedures==
{{{OptPostUpgradeProc|}}}|}}
{{PEUpgradeBoilerplate|BoilerplateSection=Uninstall}}
{{{UninstallExt|}}}

</includeonly><noinclude>[[Category:MintyDocs_Cargo]][[Category:PrivateEdition]]</noinclude>

PEC-REP/Current/GIMPEGuide/Architecture

2022-04-07T20:14:57Z

Jdruker: Redirecting to ArchitectureMain

#REDIRECT [[PEC-REP/Current/GIMPEGuide/ArchitectureMain]]

User:Jose.druker@genesys.com/TestRNMarkup

2022-03-16T16:48:35Z

Jdruker: Created page with "{{subst:ArticleCloudRN |DisplayName=Genesys Info Mart Release Notes |ServiceId=3b2bdfd2-9eb1-4a99-a181-356f2704bc02 |ComponentId=5c6029d5-9639-4dc0-921a-f4f8a48f525b, 67cc0ee9..."

{{#css: .MintyDocsTopicDesc {display:none} }}[[Category:ArticleCloudRN]]__TOC__
__NOEDITSECTION__{{#cargo_store:_table=Article|Standalone={{{Standalone}}}|Dimension={{#explode:{{FULLPAGENAME}}|/|3}}Helm|productshort={{#explode:{{FULLPAGENAME}}|/|0}}|DisplayName=Genesys Info Mart Release Notes|Context=}}{{#cargo_store:_table=ArticleCloudRN
|ServiceId=3b2bdfd2-9eb1-4a99-a181-356f2704bc02
|ComponentId=5c6029d5-9639-4dc0-921a-f4f8a48f525b, 67cc0ee9-f716-4371-8b81-a41fbe7f6b96, 456eb773-9bac-427c-8780-b59c203173e4
|DeploymentTypeId=8b480b3c-2733-433a-9166-eab2c2d0663a
|ReleaseTypeId=
|Footer=
}}{{#switch:|Manual=|#default={{#mintydocs_topic:
|display name=Genesys Info Mart Release Notes
|toc name=
}}}}{{EPPOHead|Role=|ComingSoon=|Dimension={{#explode:{{FULLPAGENAME}}|/|3}}Helm|Context=Not all releases or changes listed below may pertain to your deployment. Check the table below to see which releases apply to you.
|UseCase=|Application=|Platform=|PageType=Article|ServiceId=3b2bdfd2-9eb1-4a99-a181-356f2704bc02}}{{PrerequisitesHead|Prereq=}}{{NoteFormat|The Release table lists the initial availability date for each release and the deployment environments for which a release is made available. Except when otherwise stated in the description for a specific release, each release includes all of the features and resolved issues that were introduced on earlier dates, regardless of the deployment environment. The features and resolved issues that apply only to a specific deployment environment are noted as such.}}{{#cargo_query:
tables=ArticleCloudRN__ComponentId,ArticleCloudRN,Component,ComponentRN__ComponentId,ComponentRN,DeploymentType
|join on=ArticleCloudRN__ComponentId._value=Component.Id,ArticleCloudRN__ComponentId._rowID=ArticleCloudRN._ID,ArticleCloudRN__ComponentId._value = ComponentRN__ComponentId._value,ComponentRN__ComponentId._rowID=ComponentRN._ID,ComponentRN.DeploymentTypeId HOLDS DeploymentType.Id
|fields=Component.Name=Service,CONCAT('[[#',Component.Name,'-',ReleaseNumber,'|',DATE_FORMAT(ReleaseDate,'%M %d, %Y'),']]')=Release Date,CONCAT('[[File:',Image,'|80px]]')=Supported Cloud,Highlight=Highlights,ComponentId=ComponentId,ReleaseDate=ReleaseDate,PrivateEditionReleaseDate,ReleaseNumber
|where=(ComponentRN__ComponentId._value IN ({{#arraymap:5c6029d5-9639-4dc0-921a-f4f8a48f525b, 67cc0ee9-f716-4371-8b81-a41fbe7f6b96, 456eb773-9bac-427c-8780-b59c203173e4|,|x|'x'}})) AND (ComponentRN__DeploymentTypeId._value IN ({{#arraymap:8b480b3c-2733-433a-9166-eab2c2d0663a|,|x|'x'}})) AND ComponentRN._pageNamespace="{{NAMESPACENUMBER}}"
|intro=<table class="sortable"><tr>{{#ifeq:{{#cargo_query:tables=ArticleCloudRN,ArticleCloudRN__ComponentId|join on=ArticleCloudRN._ID=ArticleCloudRN__ComponentId._rowID|fields=COUNT(*)|where=ArticleCloudRN._pageName="{{FULLPAGENAME}}" AND ArticleCloudRN._pageNamespace="{{NAMESPACENUMBER}}"|no html}}|1||<th>Service</th>}}
<th style="width:12% !important;">First availability</th><th style="width:20% !important;">Released for</th><th>Highlights</th><th>Release number</th></tr>
|outro=</table>
|format=template
|template=PrintTopRN
|named args=yes
|group by=ComponentRN._pageName
|order by=ComponentRN.ReleaseDate DESC
}}


{{#cargo_query:
tables=Issue,ComponentRN,ComponentRN__ComponentId,ComponentRN__DeploymentTypeId,Component
|join on=Issue._pageName=ComponentRN._pageName,ComponentRN._ID=ComponentRN__ComponentId._rowID,ComponentRN._ID=ComponentRN__DeploymentTypeId._rowID,ComponentRN.ComponentId HOLDS Component.Id
|fields=ComponentId=Component,ComponentRN.ReleaseNumber=ReleaseNumber,ComponentRN.ReleaseDate=ReleaseDate,PrivateEditionReleaseDate,ComponentRN._pageName=Page,Component.Name=ComponentName
|format=template
|template=RNPrint
|where=(ComponentRN__ComponentId._value IN ({{#arraymap:5c6029d5-9639-4dc0-921a-f4f8a48f525b, 67cc0ee9-f716-4371-8b81-a41fbe7f6b96, 456eb773-9bac-427c-8780-b59c203173e4|,|x|'x'}})) AND (ComponentRN__DeploymentTypeId._value IN ({{#arraymap:8b480b3c-2733-433a-9166-eab2c2d0663a|,|x|'x'}})) AND ComponentRN._pageNamespace="{{NAMESPACENUMBER}}"
|named args=yes
|group by=ComponentRN._pageName
|order by=ComponentRN.ReleaseDate DESC
}}

{{#if:|
==Prior Releases==

}}



{{#css:
#mw-content-text .select2-container .select2-choice { height: 34px; line-height: normal; }
.panel-title { padding: 10px; }
.panel>.panel-heading { padding: 0 }
.toggle-wrap { margin: 20px 0 25px; }
.toggle-wrap>a{ display: block; padding: 10px; color: #333; background-color: #f5f5f5; border: 1px solid #ddd; border-top-left-radius: 3px; border-top-right-radius: 3px; }
.toggle-wrap>a:before { content: '\f0d7'; float: left; font-family: FontAwesome; margin-right: 10px; text-decoration: none; }
.toggle-content { padding: 10px 20px; border: 1px solid #ddd; border-top: none; border-bottom-left-radius: 3px; border-bottom-right-radius: 3px; }
}}

{{#switch:{{{Standalone}}}|Yes={{#css:
button#version-dropdown { display: none; }
}}|#default=}}[[Category:Linkable]]<nowiki />

PEC-REP/Current/GIMPEGuide/Observability

2022-02-15T16:49:45Z

Jdruker: Published

{{ArticlePEServiceObservability
|EnableMonitoring=The Genesys Info Mart services use PodMonitor custom resource definitions (CRDs), which are defined in the Helm charts by default. No additional service-level configuration is required to enable monitoring. See {{Link-AnywhereElse|product=PrivateEdition|version=Current|manual=Operations|topic=General_instructions_on_monitoring_solution_for_services}} for information about enabling monitoring for your private edition solution.
|ConfigureMetrics=The metrics that are exposed by the Genesys Info Mart services are available by default. No further configuration is required in order to define or expose these metrics. You cannot define your own custom metrics.

The Metrics pages linked to [[{{FULLPAGENAME}}#MetricsLinks|above]] show some of the metrics the Genesys Info Mart services expose. You can also query Prometheus directly or via a dashboard to see all the metrics available from the Genesys Info Mart services.
|AlertsDefined=Yes
|ExtConfigAlertsBoilerplate=Yes
|Logging=Genesys Info Mart uses a structured logging approach and outputs logs to standard output (stdout).

You can set the log levels for the Genesys Info Mart services in the respective values.yaml files. By default, the GSP and GIM logs are at the INFO level, while GCA logs are at DEBUG level.

See {{Link-AnywhereElse|product=PrivateEdition|version=Current|manual=Operations|topic=Logging_approaches|display text=Logging overview and approaches}} and related links in the ''Operations'' guide for more information about logging in private edition, including deployment information and how you can use log collectors (such as Elasticsearch) to extract the logs and viewing tools (such as Kibana) to visualize the data.
}}

PEC-REP/Current/GIMPEGuide/GIMMetrics

2022-02-15T16:44:58Z

Jdruker: Published

{{ArticlePEServiceMetrics
|IncludedServiceId=e65e00cb-c1c8-4fb8-9614-80ac07c3a4e3
|CRD=PodMonitor
|Port=8249
|Endpoint=Endpoint: /metrics

Selector:
<source lang="bash">selector:
matchLabels:
app: {{ template "fullname" . }}</source>
where the value of <tt>fullname</tt> depends on <tt> .Values.tenant_id</tt>.
|MetricsUpdateInterval=30 seconds
|MetricsDefined=Yes
|MetricsIntro=The following metrics are defined for the GIM service.
|PEMetric={{PEMetric
|Metric=gim_server_state
|Type=Gauge
|Label=<br />

*applicationName
*gim_version
*built
*schema_version
|MetricDescription=The state of the GIM server. Valid values are:

*0 — starting
*1 — running
*-1 — failing once
*-2 — failing twice
*-3 — failing three or more times in a row
|UsedFor=Error
}}{{PEMetric
|Metric=gim_failed_jobsteps
|Type=Gauge
|MetricDescription=Number of failed job steps.
|UsedFor=Error
}}{{PEMetric
|Metric=gim_number_failed_kafkajob
|Type=Gauge
|Label=<br />

*applicationName
|MetricDescription=Number of times the KAFKA step in the transform job failed.
|UsedFor=Error
}}{{PEMetric
|Metric=gim_issues_total
|Type=Counter
|Label=<br/>

*applicationName
*issue
|MetricDescription=Number of encountered issues.
|UsedFor=Error
}}{{PEMetric
|Metric=gim_kafka_timestamp_millis
|Type=Gauge
|Unit=milliseconds
|MetricDescription=Maximum Kafka timestamp per topic per partition, in milliseconds since the Unix Epoch.
|UsedFor=Latency
}}{{PEMetric
|Metric=gim_kafka_timestamp_behind
|Type=Gauge
|Unit=milliseconds
|Label=<br />

*applicationName
*topic
*partition
|MetricDescription=Kafka latency per topic per partition, in milliseconds. Latency is calculated as (current system time) minus (maximum timestamp received). Therefore, this metric can grow if a topic or partition is idle and no records are received.
|UsedFor=Latency
}}
|AlertsDefined=No
}}

PEC-REP/Current/GIMPEGuide/PlanningGIM

2022-02-11T20:57:22Z

Jdruker: Published

{{PEPrerequisites
|DisplayName=Before you begin GIM deployment
|Context=Find out what to do before deploying GIM.
|IncludedServiceId=e65e00cb-c1c8-4fb8-9614-80ac07c3a4e3
|LimitationsStatus=No
|HelmStatus=No
|HelmText=GIM and GIM monitoring are the only services that run in the GIM Docker container. The Helm charts included with the GIM release provision GIM and any Kubernetes infrastructure necessary for GIM 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 Multicloud CX private edition platform, see {{SuiteLevelLink|softwarereq}}.

The following table lists the third-party prerequisites for GIM.
|SectionThirdPartyItem={{SectionThirdPartyItem
|ThirdPartyItem=1a407778-58fe-4acd-8ca7-5af8eac31283
|Notes=You must create the Info Mart ETL database (see {{Link-SomewhereInThisVersion|manual=GIMPEGuide|topic=PlanningGIM|anchor=CreateDB|display text=below}}).
}}{{SectionThirdPartyItem
|ThirdPartyItem=2f69518e-33af-4c0f-adcc-a98e5427e5e0
}}
|StorageStatus=No
|StorageText={{Notices|Notice=PEComingSoon}}
|NetworkStatus=No
|NetworkText={{Notices|Notice=PEComingSoon}}
|BrowserStatus=No
|DependenciesStatus=No
|DependenciesText=The following Genesys Multicloud CX microservices must be deployed before you deploy GCA:

*GIM Stream Processor (GSP)
*GIM Config Adapter (GCA)

For detailed information about the correct order of services deployment, see {{SuiteLevelLink|deployorder}}.
|GDPRStatus=No
|GDPRText={{Notices|Notice=PEComingSoon}}
|Section={{Section
|sectionHeading=Create the Info Mart database
|anchor=CreateDB
|alignment=Vertical
|structuredtext=Use any database management tool to create the Info Mart ETL database and user.

For example, using the pgadmin tool in postgres:
|Status=No
}}{{Section
|alignment=Horizontal
|Media=Image
|image=GIMPEPrereq_CreateDB.png
|AltText=The Create Database screen in the database management UI.
|structuredtext=Create the database.
|Status=No
}}{{Section
|alignment=Horizontal
|Media=Image
|image=GIMPEPrereq_CreateDBUser.png
|AltText=The Create User screen in the database management UI.
|structuredtext=Create a user and grant full permissions to the user for that database.
|Status=No
}}
|PEPageType=bf21dc7c-597d-4bbe-8df2-a2a64bd3f167
}}

PEC-REP/Current/GIMPEGuide/PlanningGSP

2022-02-11T20:53:21Z

Jdruker: Published

{{PEPrerequisites
|DisplayName=Before you begin GSP deployment
|Context=Find out what to do before deploying GIM Stream Processor (GSP).
|IncludedServiceId=c39fe496-c79e-4846-b451-1bc8bedb126b
|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 Multicloud CX private edition platform, see {{SuiteLevelLink|softwarereq}}.

The following table lists the third-party prerequisites for GSP.
|SectionThirdPartyItem={{SectionThirdPartyItem
|ThirdPartyItem=2f69518e-33af-4c0f-adcc-a98e5427e5e0
}}
|StorageStatus=No
|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}}
|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 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
}}

PEC-REP/Current/GIMPEGuide/PlanningGCA

2022-02-11T20:49:10Z

Jdruker: Published

{{PEPrerequisites
|DisplayName=Before you begin GCA deployment
|Context=Find out what to do before deploying GIM Config Adapter (GCA).
|IncludedServiceId=f05492f5-52ed-490a-b0d5-c318a4a7272b
|LimitationsStatus=No
|LimitationsText=*ARO uses OCS and S3. The S3 bucket is used to share data among the gsp, gca, and gim namespaces.
*Instructions are provided for a single-tenant deployment.

<br />
|HelmStatus=No
|HelmText=GIM Config Adapter (GCA) and GCA monitoring are the only services that run in the GCA Docker container. The Helm charts included with the GCA release provision GCA and any Kubernetes infrastructure necessary for GCA to run.

See {{Link-AnywhereElse|product=ReleaseNotes|version=Current|manual=GenesysEngage-cloud|topic=GIMHelm}} for the Helm chart versions 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}}.

The following table lists the third-party prerequisites for GCA.
|SectionThirdPartyItem={{SectionThirdPartyItem
|ThirdPartyItem=2f69518e-33af-4c0f-adcc-a98e5427e5e0
}}
|StorageStatus=No
|NetworkStatus=No
|NetworkText={{Notices|Notice=PEComingSoon}}
|BrowserStatus=No
|DependenciesStatus=No
|DependenciesText=The following Genesys Multicloud CX microservices must be deployed before you deploy GCA:

*{{Link-AnywhereElse|product=PrivateEdition|version=Current|manual=TenantPEGuide|display text=Voice Tenant Service}}, which enables GCA to access the Configuration Server database
*GIM Stream Processor (GSP)

For detailed information about the correct order of services deployment, see {{SuiteLevelLink|deployorder}}.
|GDPRStatus=No
|GDPRText=Not applicable. GCA does not store information beyond an ephemeral snapshot.
|PEPageType=bf21dc7c-597d-4bbe-8df2-a2a64bd3f167
}}

Template:GeneratePageListDPL

2022-02-09T23:25:38Z

Jdruker:

<noinclude>This template is a DPL job aid to generate lists of wiki pages based on the page name, to assist in finding stray pages that may not be part of a manual and that may not predictably use one of the Article-type templates. It can also be used to generate a list of URLs for wiki export. It requires a |pattern parameter, to enforce a baseline limit for the query so that it doesn't risk compromising performance of the entire wiki. It also accepts the following optional parameters to further control the pages to look for:
* draft — Specifies whether to look in the Draft namespace. There are three possible values for this parameter:
** yes = Looks for pages in the Draft namespace (i.e., the pagename pattern starts with Draft:)
** no = Looks for non-Draft pages (i.e., the pagename pattern does not start with Draft:)
** both = Looks for both draft and published pages. This is also the default if the parameter is not specified.
* notpattern — To specify what URL patterns to exclude.
* uses — Finds pages using a particular template. This is particularly useful if it's not a Cargo template.
* notuses — Finds pages not using a particular template.
* firstrevisionsince — Finds pages edited since a particular date in YYYY-MM-DD format.
* lastrevisionbefore — Finds pages last edited before a particular date in YYYY-MM-DD format.
* createdby — Finds pages created by the specified user.
* notcreatedby — Finds pages not created by the specified user.
* modifiedby — Finds pages edited by the specified user.
* notmodifiedby — Finds pages not edited by the specified user.

The last few parameters are most useful in combination -- for example, to find pages created by X but modified by Y before or after a specific date.

Content of the template is:
<source lang="xml">
{{#if:{{{pattern|}}}|
{{#dpl:
|{{#switch:{{{draft|}}}|yes=namespace=Draft|no=namespace=|both|#default=}}
|titlematch={{{pattern}}}
|nottitlematch={{{notpattern|}}}
|uses={{#if:{{{uses|}}}|Template:{{{uses}}}|}}
|notuses={{#if:{{{notuses|}}}|Template:{{{notuses}}}|}}
|firstrevisionsince={{{firstrevisionsince|}}}
|lastrevisionbefore={{{lastrevisionbefore|}}}
|createdby={{{createdby|}}}
|notcreatedby={{{notcreatedby|}}}
|modifiedby={{{modifiedby|}}}
|notmodifiedby={{{notmodifiedby|}}}
|resultsheader=There are %PAGES% pages
}}|You must specify a pagename pattern so the query is not unlimited.}}</source>
</noinclude>

<onlyinclude>
{{#if:{{{pattern|}}}|
{{#dpl:
|{{#switch:{{{draft|}}}|yes=namespace=Draft|no=namespace=|both|#default=}}
|titlematch={{{pattern}}}
|nottitlematch={{{notpattern|}}}
|uses={{#if:{{{uses|}}}|Template:{{{uses}}}|}}
|notuses={{#if:{{{notuses|}}}|Template:{{{notuses}}}|}}
|firstrevisionsince={{{firstrevisionsince|}}}
|lastrevisionbefore={{{lastrevisionbefore|}}}
|createdby={{{createdby|}}}
|notcreatedby={{{notcreatedby|}}}
|modifiedby={{{modifiedby|}}}
|notmodifiedby={{{notmodifiedby|}}}
|resultsheader=There are %PAGES% pages
}}|You must specify a pagename pattern so the query is not unlimited.}}
</onlyinclude>

<noinclude>[[Category:Macros]]</noinclude>

Template:GeneratePageListDPL

2022-02-09T23:23:26Z

Jdruker:

<noinclude>This template is a DPL job aid to generate lists of wiki pages based on the page name, to assist in finding stray pages that may not be part of a manual and that may not predictably use one of the Article-type templates. It can also be used to generate a list of URLs for wiki export. It requires a |pattern parameter, to enforce a baseline limit for the query so that it doesn't risk compromising performance of the entire wiki. It also accepts the following optional parameters to further control the pages to look for:
* draft — Specifies whether to look in the Draft namespace. There are three possible values for this parameter:
** yes = Looks for pages in the Draft namespace (i.e., the pagename pattern starts with Draft:)
** no = Looks for non-Draft pages (i.e., the pagename pattern does not start with Draft:)
** both = Looks for both draft and published pages. This is also the default if the parameter is not specified.
* notpattern — To specify what URL patterns to exclude.
* uses — Finds pages using a particular template. This is particularly useful if it's not a Cargo template.
* notuses — Finds pages not using a particular template.
* firstrevisionsince — Finds pages edited since a particular date in YYYY-MM-DD format.
* lastrevisionbefore — Finds pages last edited before a particular date in YYYY-MM-DD format.
* createdby — Finds pages created by the specified user.
* notcreatedby — Finds pages not created by the specified user.
* modifiedby — Finds pages edited by the specified user.
* notmodifiedby — Finds pages not edited by the specified user.

The last few parameters are most useful in combination -- for example, to find pages created by X but modified by Y before or after a specific date.

Content of the template is:
<source lang="xml">
{{#if:{{{pattern|}}}|
{{#dpl:
|{{#switch:{{{draft|}}}|yes=namespace=Draft|no=namespace=|both|#default=}}
|titlematch={{{pattern}}}
|nottitlematch={{{notpattern|}}}
|uses={{#if:{{{uses|}}}|Template:{{{uses}}}|}}
|notuses={{#if:{{{notuses|}}}|Template:{{{notuses}}}|}}
|firstrevisionsince={{{firstrevisionsince|}}}
|lastrevisionbefore={{{lastrevisionbefore|}}}
|createdby={{{createdby|}}}
|notcreatedby={{{notcreatedby|}}}
|modifiedby={{{modifiedby|}}}
|notmodifiedby={{{notmodifiedby|}}}
|resultsheader=There are %PAGES% pages
}}|You must specify a pagename pattern so the query is not unlimited.}}</source>

<onlyinclude>
{{#if:{{{pattern|}}}|
{{#dpl:
|{{#switch:{{{draft|}}}|yes=namespace=Draft|no=namespace=|both|#default=}}
|titlematch={{{pattern}}}
|nottitlematch={{{notpattern|}}}
|uses={{#if:{{{uses|}}}|Template:{{{uses}}}|}}
|notuses={{#if:{{{notuses|}}}|Template:{{{notuses}}}|}}
|firstrevisionsince={{{firstrevisionsince|}}}
|lastrevisionbefore={{{lastrevisionbefore|}}}
|createdby={{{createdby|}}}
|notcreatedby={{{notcreatedby|}}}
|modifiedby={{{modifiedby|}}}
|notmodifiedby={{{notmodifiedby|}}}
|resultsheader=There are %PAGES% pages
}}|You must specify a pagename pattern so the query is not unlimited.}}
</onlyinclude>

[[Category:Macros]]

Template:GeneratePageListDPL

2022-02-09T21:59:47Z

Jdruker: Created page with "<noinclude> This is the "GeneratePageListDPL" template. It should be called in the following format: <pre> {{GeneratePageListDPL }} </pre> Edit the page to see the template te..."

<noinclude>
This is the "GeneratePageListDPL" template.
It should be called in the following format:
<pre>
{{GeneratePageListDPL
}}
</pre>
Edit the page to see the template text.
</noinclude><includeonly>{| class="wikitable"
|}

[[Category:Macros]]
</includeonly>

RN/GIMStream Processor/100.0.100.1400

2022-02-08T15:36:07Z

Jdruker: Published

{{ComponentRN
|ComponentId=67cc0ee9-f716-4371-8b81-a41fbe7f6b96
|JQL=key = "GIM-13625" OR key = "GIM-13623" OR key = "GIM-13622"
|DeploymentTypeId=8b480b3c-2733-433a-9166-eab2c2d0663a
|ReleaseDate=2022-02-08
|PrivateEditionReleaseDate=2022-02-08
|Highlight={{PrivateEditionBoilerplate|Boilerplate=single-ns}}
}}
{{Issue
|TicketNumber=GIM-13623
|IssueCategoryId=a8930ebb-8e46-4ecd-993f-cdd2d61bc400
|LocalContent=Support for deploying the GSP service in a single namespace with other private edition services has been validated. No code changes were required to enable this alternative deployment scenario.
}}

RN/GIMConfig Adapter/100.0.100.2300

2022-02-08T15:34:31Z

Jdruker: Published

{{ComponentRN
|ComponentId=5c6029d5-9639-4dc0-921a-f4f8a48f525b
|JQL=key = "GIM-13623" OR key = "GIM-13687"
|DeploymentTypeId=8b480b3c-2733-433a-9166-eab2c2d0663a
|ReleaseDate=2022-02-08
|PrivateEditionReleaseDate=2022-02-08
|Highlight={{PrivateEditionBoilerplate|Boilerplate=single-ns}}<br />
{{SecurityBoilerplate|Boilerplate=NodeHighlight}}
}}
{{Issue
|TicketNumber=GIM-13623
|IssueCategoryId=a8930ebb-8e46-4ecd-993f-cdd2d61bc400
|LocalContent=Support for deploying the GCA service in a single namespace with other private edition services has been validated. No code changes were required to enable this alternative deployment scenario.
}}
{{Issue
|TicketNumber=GIM-13679
|IssueCategoryId=c749afa5-fd21-49e4-83d4-0e6ebd8ed618
|LocalContent={{SecurityBoilerplate|Boilerplate=NodeDescription}}
}}

RN/GenesysInfo Mart/100.0.116.2900

2022-02-08T15:32:10Z

Jdruker: Published

{{ComponentRN
|ComponentId=456eb773-9bac-427c-8780-b59c203173e4
|JQL=key = "GIM-13623" OR key = "GIM-13603"
|DeploymentTypeId=8b480b3c-2733-433a-9166-eab2c2d0663a
|ReleaseDate=2022-02-08
|PrivateEditionReleaseDate=2022-02-08
|Highlight={{PrivateEditionBoilerplate|Boilerplate=single-ns}}
}}
{{Issue
|TicketNumber=GIM-13623
|IssueCategoryId=a8930ebb-8e46-4ecd-993f-cdd2d61bc400
|LocalContent=Support for deploying the Genesys Info Mart (GIM) service in a single namespace with other private edition services has been validated. No code changes were required to enable this alternative deployment scenario.
}}

PEC-REP/Current/GIMPEGuide/PlanningGIM

2022-02-07T16:14:09Z

Jdruker: Republishing to refresh third-party data

{{PEPrerequisites
|DisplayName=Before you begin GIM deployment
|Context=Find out what to do before deploying GIM.
|IncludedServiceId=e65e00cb-c1c8-4fb8-9614-80ac07c3a4e3
|LimitationsStatus=No
|HelmStatus=No
|HelmText=GIM and GIM monitoring are the only services that run in the GIM Docker container. The Helm charts included with the GIM release provision GIM and any Kubernetes infrastructure necessary for GIM 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 Multicloud CX private edition platform, see {{SuiteLevelLink|softwarereq}}.

The following table lists the third-party prerequisites for GIM.
|SectionThirdPartyItem={{SectionThirdPartyItem
|ThirdPartyItem=1a407778-58fe-4acd-8ca7-5af8eac31283
|Notes=You must create the Info Mart ETL database (see {{Link-SomewhereInThisVersion|manual=GIMPEGuide|topic=PlanningGIM|anchor=CreateDB|display text=below}}).
}}{{SectionThirdPartyItem
|ThirdPartyItem=2f69518e-33af-4c0f-adcc-a98e5427e5e0
}}{{SectionThirdPartyItem
|ThirdPartyItem=2afd763e-337c-47eb-8428-3bafcc89dbca
}}{{SectionThirdPartyItem
|ThirdPartyItem=0d238336-2626-4954-8be3-2f1e16fdd0ce
}}{{SectionThirdPartyItem
|ThirdPartyItem=3aee73ed-68e0-4c70-8693-2421c68b86cd
}}
|StorageStatus=No
|StorageText={{Notices|Notice=PEComingSoon}}
|NetworkStatus=No
|NetworkText={{Notices|Notice=PEComingSoon}}
|BrowserStatus=No
|DependenciesStatus=No
|DependenciesText=The following Genesys Multicloud CX microservices must be deployed before you deploy GCA:

*GIM Stream Processor (GSP)
*GIM Config Adapter (GCA)

For detailed information about the correct order of services deployment, see {{SuiteLevelLink|deployorder}}.
|GDPRStatus=No
|GDPRText={{Notices|Notice=PEComingSoon}}
|Section={{Section
|sectionHeading=Create the Info Mart database
|anchor=CreateDB
|alignment=Vertical
|structuredtext=Use any database management tool to create the Info Mart ETL database and user.

For example, using the pgadmin tool in postgres:
|Status=No
}}{{Section
|alignment=Horizontal
|Media=Image
|image=GIMPEPrereq_CreateDB.png
|AltText=The Create Database screen in the database management UI.
|structuredtext=Create the database.
|Status=No
}}{{Section
|alignment=Horizontal
|Media=Image
|image=GIMPEPrereq_CreateDBUser.png
|AltText=The Create User screen in the database management UI.
|structuredtext=Create a user and grant full permissions to the user for that database.
|Status=No
}}
|PEPageType=bf21dc7c-597d-4bbe-8df2-a2a64bd3f167
}}

PEC-REP/Current/GIMPEGuide/PlanningGCA

2022-02-07T16:12:57Z

Jdruker: Republishing to refresh third-party data

{{PEPrerequisites
|DisplayName=Before you begin GCA deployment
|Context=Find out what to do before deploying GIM Config Adapter (GCA).
|IncludedServiceId=f05492f5-52ed-490a-b0d5-c318a4a7272b
|LimitationsStatus=No
|LimitationsText=*ARO uses OCS and S3. The S3 bucket is used to share data among the gsp, gca, and gim namespaces.
*Instructions are provided for a single-tenant deployment.

<br />
|HelmStatus=No
|HelmText=GIM Config Adapter (GCA) and GCA monitoring are the only services that run in the GCA Docker container. The Helm charts included with the GCA release provision GCA and any Kubernetes infrastructure necessary for GCA to run.

See {{Link-AnywhereElse|product=ReleaseNotes|version=Current|manual=GenesysEngage-cloud|topic=GIMHelm}} for the Helm chart versions 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}}.

The following table lists the third-party prerequisites for GCA.
|SectionThirdPartyItem={{SectionThirdPartyItem
|ThirdPartyItem=1a407778-58fe-4acd-8ca7-5af8eac31283
}}{{SectionThirdPartyItem
|ThirdPartyItem=2f69518e-33af-4c0f-adcc-a98e5427e5e0
}}{{SectionThirdPartyItem
|ThirdPartyItem=2afd763e-337c-47eb-8428-3bafcc89dbca
}}{{SectionThirdPartyItem
|ThirdPartyItem=0d238336-2626-4954-8be3-2f1e16fdd0ce
}}{{SectionThirdPartyItem
|ThirdPartyItem=3aee73ed-68e0-4c70-8693-2421c68b86cd
}}
|StorageStatus=No
|NetworkStatus=No
|NetworkText={{Notices|Notice=PEComingSoon}}
|BrowserStatus=No
|DependenciesStatus=No
|DependenciesText=The following Genesys Multicloud CX microservices must be deployed before you deploy GCA:

*{{Link-AnywhereElse|product=PrivateEdition|version=Current|manual=TenantPEGuide|display text=Voice Tenant Service}}, which enables GCA to access the Configuration Server database
*GIM Stream Processor (GSP)

For detailed information about the correct order of services deployment, see {{SuiteLevelLink|deployorder}}.
|GDPRStatus=No
|GDPRText=Not applicable. GCA does not store information beyond an ephemeral snapshot.
|PEPageType=bf21dc7c-597d-4bbe-8df2-a2a64bd3f167
}}

PEC-REP/Current/GIMPEGuide/PlanningGSP

2022-02-07T16:10:02Z

Jdruker: Republishing to refresh third-party data

{{PEPrerequisites
|DisplayName=Before you begin GSP deployment
|Context=Find out what to do before deploying GIM Stream Processor (GSP).
|IncludedServiceId=c39fe496-c79e-4846-b451-1bc8bedb126b
|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 Multicloud CX 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 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}}
|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 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
}}

PrivateEdition/Current/Operations/SystemMetrics

2022-01-11T18:36:02Z

Jdruker: Published

{{Article
|Standalone=No
|DisplayName=System metrics
|TocName=System metrics
|Context=Find useful metrics provided by Kubernetes and other system resources to monitor the status and performance of the cluster and nodes.
|ComingSoon=No
|Section={{Section
|sectionHeading=Kubernetes and Node metrics
|anchor=SystemMetrics
|alignment=Vertical
|structuredtext=In addition to the service-defined metrics described in the service-level guides (see links {{Link-AnywhereElse|product=PrivateEdition|version=Current|manual=Operations|topic=General_instructions_on_monitoring_solution_for_services|anchor=MonitoringSummary|display text=here}}), standard Kubernetes and other system metrics are obviously important for monitoring the status and performance of your cluster(s), nodes, and services.

*[[{{FULLPAGENAME}}#Kubernetes|Kubernetes metrics]]
*[[{{FULLPAGENAME}}#Node|Node metrics]]
|Status=No
}}{{Section
|sectionHeading=Kubernetes metrics
|anchor=Kubernetes
|alignment=Vertical
|structuredtext=For full information about all the cluster metrics Kubernetes provides, see the [https://kubernetes.io/docs/concepts/cluster-administration/system-metrics Kubernetes documentation]. Genesys recommends that you pay attention to the following cluster-related metrics in particular.
{{{!}} class="sortable"
!'''Metric'''
!'''Prometheus formula'''
!'''Indicator of'''
{{!}}-
{{PESystemMetric
|Metric=Pod Restarts
|MetricDescription=
|PrometheusFormula=increase(kube_pod_container_status_restarts_total{namespace="$namespace", pod=~"$service.*"})[1m]
|Type=Kubernetes
|UsedFor=
}}
{{PESystemMetric
|Metric=The cgroup's total memory
|MetricDescription=
|PrometheusFormula=sum(container_memory_usage_bytes{namespace="$namespace",pod=~"$service-.*", container!=""}) by (pod)
|Type=Kubernetes
|UsedFor=Memory
}}
{{PESystemMetric
|Metric=The cgroup's CPU usage
|MetricDescription=
|PrometheusFormula=sum (rate (container_cpu_usage_seconds_total{namespace="$namespace",pod=~"$service-.*", container!="POD"}[1m])) by (pod) * 100
|Type=Kubernetes
|UsedFor=CPU utilization
}}
{{PESystemMetric
|Metric=Bytes transmitted over the network by the container
|MetricDescription=
|PrometheusFormula=rate(container_network_transmit_bytes_total{namespace="$namespace",pod=~"$service-.*", container!=""}[1m])
|Type=Kubernetes
|UsedFor=
}}
{{PESystemMetric
|Metric=Bytes received over the network by the container
|MetricDescription=
|PrometheusFormula=rate(container_network_receive_bytes_total{namespace="$namespace",pod=~"$service-.*", container!=""}[1m])
|Type=Kubernetes
|UsedFor=
}}
{{!}}}
|Status=No
}}{{Section
|sectionHeading=Node metrics
|anchor=Node
|alignment=Vertical
|structuredtext=Genesys recommends that you pay attention to the following node-related metrics in particular.
{{{!}} class="sortable"
! '''Metric'''
! '''Prometheus formula'''
! '''Indicator of'''
{{PESystemMetric
|Metric=Process HEAP All
|MetricDescription=
|PrometheusFormula={SERVICE_NAME}_process_heap_bytes{pod=~"$pod",service="$service"}
|Type=Node
|UsedFor=Heap status
}}
{{PESystemMetric
|Metric=Process CPU All
|MetricDescription=
|PrometheusFormula=sum(rate({SERVICE_NAME}_process_cpu_seconds_total{pod=~"$pod",service="$service"}[30s]) * 100) by (pod)
|Type=Node
|UsedFor=CPU utilization
}}
{{PESystemMetric
|Metric=Process Memory All: resident memory
|MetricDescription=
|PrometheusFormula={SERVICE_NAME}_process_resident_memory_bytes{pod=~"$pod",service="$service"}
|Type=Node
|UsedFor=Memory
}}
{{PESystemMetric
|Metric=Process Memory All: virtual memory
|MetricDescription=
|PrometheusFormula={SERVICE_NAME}_process_virtual_memory_bytes{pod=~"$pod",service="$service"}
|Type=Node
|UsedFor=Memory
}}
{{!}}}
|Status=No
}}
}}