Draft:PEC-REP/Current/RAAPEGuide/Planning - Revision history

Tgilchri: Replaced content with "This page has moved to {{Link-AnywhereElse|product=PEC-REP|version=Current|manual=GCXIPEGuide|topic=PlanningRAA}}."

2022-06-21T12:10:55Z

Replaced content with "This page has moved to {{Link-AnywhereElse|product=PEC-REP|version=Current|manual=GCXIPEGuide|topic=PlanningRAA}}."

Show changes

Tony.gilchrist@genesys.com at 12:47, July 13, 2021

2021-07-13T12:47:56Z

Julie.munn@genesys.com at 18:05, June 28, 2021

2021-06-28T18:05:16Z

Tony.gilchrist@genesys.com at 18:28, June 25, 2021

2021-06-25T18:28:11Z

Tony.gilchrist@genesys.com at 18:18, June 25, 2021

2021-06-25T18:18:34Z

Tony.gilchrist@genesys.com at 19:14, June 23, 2021

2021-06-23T19:14:59Z

Tony.gilchrist@genesys.com at 18:48, June 23, 2021

2021-06-23T18:48:04Z

Tony.gilchrist@genesys.com at 18:45, June 23, 2021

2021-06-23T18:45:13Z

Tony.gilchrist@genesys.com at 18:29, June 23, 2021

2021-06-23T18:29:55Z

Tony.gilchrist@genesys.com at 18:29, June 23, 2021

2021-06-23T18:29:11Z

@@ Line 14: / Line 14: @@
 |HelmStatus=No
 |HelmText=For general information about downloading containers, see: {{SuiteLevelLink|helmchart}}.
 ==Init containers==

@@ Line 2: / Line 2: @@
 |DisplayName=Before you begin
 |Context=Find out what to do before deploying Reporting and Analytics Aggregates (RAA).
 |LimitationsText=RAA container works with the Genesys Info Mart database. The Genesys Info Mart database scheme must correspond to a compatible Genesys Info Mart version. Execute the following command to discover the required Genesys Info Mart release:
   docker run -it --entrypoint /bin/java gcxi/raa:<IMAGE_VERSION> -jar GIMAgg.jar -version
@@ Line 11: / Line 12: @@
 JDBC driver can be overridden by copying driver file to '''lib\jdbc_driver_<RDBMS>''' (or by making link) in a work dir. See for [https://docs.genesys.com/Documentation/RAA/9.0.0/Dep/PostInstall#JDBCDriverForRAA JDBC driver for RAA] for details.
 |HelmText=For general information about downloading containers, see: {{SuiteLevelLink|helmchart}}.
@@ Line 119: / Line 121: @@
          "helm.sh/hook-delete-policy": "before-hook-creation"
        ...</source>
 |ThirdPartyText={{Notices|Notice=PEComingSoon}}
 {{AnchorDiv|StorageRequirements}}
 |StorageText====GIM secret volume===
 RAA mounts as a volume secret with Genesys Info Mart connections details when <code class="yml variable">raa.env.GCXI_GIM_DB__JSON</code> is not specified.
@@ Line 280: / Line 284: @@
 ===Health volume===
 RAA uses health volume for the following purposes:
 *placing actual health files (see [https://docs.genesys.com/Documentation/RAA/latest/UG/AggProc#Checking_the_health_of_the_aggregate_process Checking the health of the aggregate process] for details)
 *place for prometheus file containing metrics for 2-3 scrape intervals behind
@@ Line 374: / Line 379: @@
      ...</source>
 You can also map an ephemeral storage.
 |NetworkText=RAA interacts only with the Genesys Info Mart database.
@@ Line 381: / Line 387: @@
 Genesys recommends that RAA be located in the same region as the Genesys Info Mart database.
 |BrowserText=Not applicable.
 |DependenciesText=RAA interacts with Genesys Info Mart database only.
 |GDPRText=Not applicable.
 |PEPageType=bf21dc7c-597d-4bbe-8df2-a2a64bd3f167
 }}

@@ Line 119: / Line 119: @@
          "helm.sh/hook-delete-policy": "before-hook-creation"
        ...</source>
-|ThirdPartyText=
+|ThirdPartyText={{Notices|Notice=PEComingSoon}}
 {{AnchorDiv|StorageRequirements}}
 |StorageText====GIM secret volume===

@@ Line 119: / Line 119: @@
          "helm.sh/hook-delete-policy": "before-hook-creation"
        ...</source>
-|ThirdPartyText=<div style="background-color: aliceblue; font-style: italic;">List any third-party services that are required (both common across Genesys Engage cloud private edition and specific to <service_name>).</div>
+|ThirdPartyText=
 {{AnchorDiv|StorageRequirements}}
 |StorageText====GIM secret volume===

@@ Line 360: / Line 360: @@
              path: "/usr/local/genesys/RAA/health/"
        ...</source>
-Alternatively Persistent Volume can be defined separately. Its name should be specified in values.yaml, bu the <code class="yml variable">raa.volumes.health.pvc.volumeName</code> for binding to Persistent Volume Claim:
+Alternatively, you can separatly define a Persistent Volume; define its name in '''values.yaml''', using the <code class="yml variable">raa.volumes.health.pvc.volumeName</code> for binding to Persistent Volume Claim:
 '''myvalues.yaml'''
@@ Line 372: / Line 372: @@
          volumeName: "my_raa_helath_volume"
      ...</source>
-An ephemeral storage could be also mapped.
+You can also map an ephemeral storage.
 |NetworkText=RAA interacts only with the Genesys Info Mart database.

@@ Line 377: / Line 377: @@
 RAA can expose Prometheus metrics by way of Netcat.
-The aggregation pod has it's own IP address, and can run wither one or two running containers. For Helm test, additional IP address are required -- each test pod runs one container.
+The aggregation pod has it's own IP address, and can run with one or two running containers. For Helm test, an additional IP address is required -- each test pod runs one container.
 Genesys recommends that RAA be located in the same region as the Genesys Info Mart database.

@@ Line 262: / Line 262: @@
              path: "/usr/local/genesys/RAA/config/"
        ...</source>
-Alternatively, you can define Persistent Volume separately. Its name must be specified in values.yaml, using the <code class="yml variable">raa.volumes.config.pvc.volumeName</code> for binding to Persistent Volume Claim:
+Alternatively, you can define Persistent Volume separately by defining the name must in '''values.yaml''' using the <code class="yml variable">raa.volumes.config.pvc.volumeName</code> for binding to Persistent Volume Claim:
 '''myvalues.yaml'''
@@ Line 279: / Line 279: @@
 ===Health volume===
 RAA uses health volume for the following purposes:
 *placing actual health files (see [https://docs.genesys.com/Documentation/RAA/latest/UG/AggProc#Checking_the_health_of_the_aggregate_process Checking the health of the aggregate process] for details)
 *place for prometheus file containing metrics for 2-3 scrape intervals behind
 *results of recent '''testRun''' init container execution
-Size limit is set to 50MB by default. All the purposes assumes periodic interaction with the volume at runtime. Therefore it is not recommended to choose very slow storage class for this volume.
+Size limit is set to 50MB by default. Periodic interaction with the volume at runtime is expected, so Genesys does not recommended the use of very slow storage class for this volume.
 '''myvalues.yaml'''
@@ Line 296: / Line 295: @@
        storageClassName: "<vendor storage class>"
     ...</source>
-RAA helm chart creates Persistent Volume Claim. It can also optionally create a Persistent Volume (when <code class="yml variable">raa.volumes.health.pv</code> is specified). See how Persistent Volume declared in helm chart:
+The RAA Helm chart creates a Persistent Volume Claim. It can also optionally create a Persistent Volume (when <code class="yml variable">raa.volumes.health.pv</code> is specified). See how Persistent Volume is declared in the Helm chart:
 '''raa-config-volume.yaml'''

@@ Line 162: / Line 162: @@
 {{AnchorDiv|StorageRequirementsConfig}}
 ===Config volume===
-RAA mounts a config volume folder inside the container, as <tt>/genesys/raa_config</tt>; this folder is the RAA working directory. At startup,  RAA attempts to read the following files from /genesys/raa_config:
+RAA mounts a config volume folder inside the container, as '''/genesys/raa_config'''; this folder is the RAA working directory. At startup,  RAA attempts to read the following files from /genesys/raa_config:
 *custom '''*.ss''' files &mdash; see [https://docs.genesys.com/Documentation/RAA/9.0.0/UG/CustomAgg How Do I Customize Queries and Hierarchies?] for details.

@@ Line 163: / Line 163: @@
 ===Config volume===
 RAA mounts a config volume folder inside the container, as <tt>/genesys/raa_config</tt>; this folder is the RAA working directory. At startup,  RAA attempts to read the following files from /genesys/raa_config:
-*custom '''*.ss''' files &mdash; see [https://docs.genesys.com/Documentation/RAA/9.0.0/UG/CustomAgg How Do I Customize Queries and Hierarchies?] for details).
-*JDBC driver from lib/jdbc_driver_&lt;RDBMS&gt; &mdash; see [https://docs.genesys.com/Documentation/RAA/9.0.0/Dep/PostInstall#JDBCDriverForRAA Procedure: Configuring the JDBC Driver for RAA] for details.
+*custom '''*.ss''' files &mdash; see [https://docs.genesys.com/Documentation/RAA/9.0.0/UG/CustomAgg How Do I Customize Queries and Hierarchies?] for details.
-*'''conf.xml'' &mdash; This file must be present in the working folder, or aggregation cannot start.
+*JDBC driver from '''lib/jdbc_driver_&lt;RDBMS&gt;''' &mdash; see [https://docs.genesys.com/Documentation/RAA/9.0.0/Dep/PostInstall#JDBCDriverForRAA Procedure: Configuring the JDBC Driver for RAA] for details.
 *:The default conf.xml (provided with Helm chart) has the following content:
 *:<source lang="bash"><CfgOptions>