PEC-REP/Current/GCXIPEGuide/DeployRAA - Revision history

WikiSysop at 18:45, April 22, 2022

2022-04-22T18:45:36Z

WikiSysop at 18:30, April 8, 2022

2022-04-08T18:30:47Z

WikiSysop at 18:15, April 8, 2022

2022-04-08T18:15:45Z

WikiSysop at 19:52, March 30, 2022

2022-03-30T19:52:48Z

Show changes

Tony.gilchrist@genesys.com: Published

2021-09-01T18:29:51Z

Published

New page

{{Article
|Standalone=No
|DisplayName=Deploy RAA
|Context=Learn how to deploy Reporting and Analytics Aggregates (RAA).
|ComingSoon=No
|Section={{Section
|alignment=Vertical
|structuredtext=The following example illustrates the minimal values needed for a simple RAA deployment:
<source lang="bash">raa:

deployment:
targetPlatform: "local"
environment: "lab"

env:
# echo '{"jdbc_url":"jdbc:postgresql://<host>:5432/<gim_database>", "db_username":"<user>", "db_password":"<password>"}' | base64
GCXI_GIM_DB__JSON: |-
eyJqZGJjX3VybCI6ImpkYmM6cG9zdGdyZXNxbDovLzxob3N0Pjo1NDMyLzxnaW1fZGF0YWJhc2U+IiwgImRiX3VzZXJuYW1lIjoiPHVzZXI+IiwgImRiX3Bhc3N3b3JkIjoiPHBhc3N3b3JkPiJ9Cg==

image:
# It is not recommended to pull into production environment directly from the registry.
# The container images should be cached in the customer's own local repository with help of CI/CD pipelines or manually.
registry: "pureengage-docker-staging.jfrog.io"
pullSecrets:
- "mysecret"

volume:
config:
storageClassName: "hostpath"
pv:
vendorSpec:
hostPath:
type: Directory
path: "/local/genesys/raa/"
health:
storageClassName: "hostpath"
pv:
vendorSpec:
hostPath:
type: Directory
path: "/local/genesys/raa/"</source>

The following bash script deploys RAA with the values above:
<source lang="bash">if ! kubectl get namespace gcxi; then
kubectl create namespace gcxi
fi

kubectl create secret docker-registry mysecret \
--namespace gcxi \
--docker-server="pureengage-docker-staging.jfrog.io" \
--docker-username="<regisry-user>" \
--docker-password="<regisry-password>" \
--docker-email=user@email.com

helm repo add helmrepo \
"https://pureengage.jfrog.io/pureengage/helm-dev/" \
--username "<regisry-user>" \
--password "<regisry-password>" \
--force-update

helm repo update

helm upgrade gcxi-raa-lab helmrepo/gcxi-raa \
--install \
--values myvalues.yaml</source>
{{NoteFormat|Review {{Link-SomewhereInThisVersion|topic=Planning}} for the full list of prerequisites required to deploy RAA. For information about the cloud platform, see {{SuiteLevelLink|openshift}}.}}

|Status=No
}}{{Section
|sectionHeading=Deploy in OpenShift
|alignment=Vertical
|structuredtext=Configure the following resources to support the RAA pod:

*Database connection details specified as <code class="yml variable">raa.env.GCXI_GIM_DB__JSON</code> value, or as a Kubernetes or '''vendor specific''' secret. See {{Link-SomewhereInThisVersion|manual=RAAPEGuide|topic=Planning|anchor=StorageRequirements|display text=Genesys info Mart secret volume}} for details.
*{{Link-SomewhereInThisVersion|manual=RAAPEGuide|topic=Planning|anchor=StorageRequirementsConfig|display text=Config volume}} mounted. Specific storage should be provisioned and be available for mounting to the POD containers via specific helm values or separately from RAA helm chart with help k8s or '''vendor specific''' tools.
*{{Link-SomewhereInThisVersion|manual=RAAPEGuide|topic=Planning|anchor=StorageRequirementsHealth|display text=Health volume}} mounted. Specific storage should be provisioned and be available for mounting to the POD containers via specific helm values or separately from RAA helm chart with help k8s or '''vendor specific''' tools.
|Status=No
}}{{Section
|sectionHeading=Validate the deployment in OpenShift
|alignment=Vertical
|structuredtext=The '''testRun''' init container activates validation testing. Helm test command runs all the test containers: one of the test containers tests execution results, while a second performs a healthCheck.<source lang="bash"> containers:

## optional
## enables config delivery init container.
## container delivers required xml configuration and *.ss files to RAA work dir
## those files delivered from gzip archive encoded as base64 and specified via {{ .Values.raa.deplyment.configTar }} helm value
## default conf.xml and user-data-map.ss are supplied with chart
## they are copied to work dir when absent and helm value above is not specified
configDelivery: {}

# ## container name template
# ## should be uncommented when configDelivery is enabled
# name: "{{ $.Chart.Name }}-conf-delivery"

## optional
## enables test run init container (GCXI-3463).
## it performs running of all the aggregates on empty data
## to test the correctness of configrugation and customization
testRun:

## container name template
name: "{{ $.Chart.Name }}-test-run"

## main aggregation container
aggregation:

## container name template
name: "{{ $.Chart.Name }}"

## optional
## enable side car container for monitoring and processing of:
## - new tool command requests from a file in work dir
## - new prometheus scrape requests
monitor: {}

# ## container name template
# name: "{{ $.Chart.Name }}-monitor"

# ## optional
# ## enables command processing from file placed into work dir (GCXI-4052)
# ## it is helpful when kubect exec is forbidden by environment restrictions.
# toolcmd:

# ## interval of checking for a new file with command
# intervalSec: "20"

# ## optional
# ## enables raa metrics scraping in Prometheus format via http
# metrics:

# ## k8s port name
# portName: "metrics"

# ## port number
# containerPort: "9100"

# ## optional
# ## enables raa health metric scraping in Prometheus format via http
# health:

# ## k8s port name
# portName: "health"

# ## port number
# containerPort: "9101"

## optional
## defines if any test pod will be declared for helm release testing
## see links:
## - https://helm.sh/docs/topics/chart_tests/
## - https://helm.sh/docs/helm/helm_test/
testPods:

## optional
## checks the result of test run init container execution
## actual when {{ .Values.raa.statefulset.containers.testRun }} is specified.
testRunCheck:

## pod name template
name: "{{ tpl .Values.raa.serviceName . }}-test-run-check"

container:
## container name template
name: "{{ $.Chart.Name }}-test-run-check"

## optional
## test pod specific labels are adjusted to common labels
labels: {}

## test pod specific annotations are adjusted to common annotations
annotations:
"helm.sh/hook-weight": "100"
"helm.sh/hook": "test-success"
"helm.sh/hook-delete-policy": "before-hook-creation"

## optional
## performs RAA health check
healthCheck:
## pod name template
name: "{{ tpl .Values.raa.serviceName . }}-health-check"

container:
## container name template
name: "{{ $.Chart.Name }}-health-check"

## optional
## test pod specific labels are adjusted to common labels
labels: {}

## test pod specific annotations are adjusted to common annotations
annotations:
"helm.sh/hook-weight": "200"
"helm.sh/hook": "test-success"
"helm.sh/hook-delete-policy": "before-hook-creation" </source>
|Status=No
}}
|PEPageType=45d1441f-dc69-4a17-bd47-af5d811ce167
}}

@@ Line 1: / Line 1: @@
-{{Article
+{{ArticlePEServiceDeploy
-|Standalone=No
+|ServiceId=1f419ea4-5e6e-4052-abc1-c56ff55106e2
-|DisplayName=Deploy RAA
+|IncludedServiceId=5462861b-e347-4eaa-b621-9795838ee431
-|Context=Learn how to deploy Reporting and Analytics Aggregates (RAA).
+|IncludeAssumptions=Yes
 |Section={{Section
 |sectionHeading=Prepare to deploy RAA

@@ Line 9: / Line 9: @@
 |structuredtext=Configure the following resources to support the RAA pod:
-*Database connection details specified as <code class="yml variable">raa.env.GCXI_GIM_DB__JSON</code> value, or as a Kubernetes or '''vendor specific''' secret. See {{Link-SomewhereInThisVersion|manual=GCXIPEGuide|topic=PlanningRAA|anchor=StorageRequirements|display text=Genesys info Mart secret volume}} for details.
+*Database connection details specified as <code class="yml variable">raa.env.GCXI_GIM_DB__JSON</code> value, or as a Kubernetes or vendor-specific secret. For more information, see Genesys Info Mart{{Link-SomewhereInThisVersion|manual=GCXIPEGuide|topic=PlanningRAA|anchor=JDBCDrivers|display text=Genesys info Mart secret volume}}.
-*{{Link-SomewhereInThisVersion|manual=GCXIPEGuide|topic=PlanningRAA|anchor=StorageRequirementsConfig|display text=Config volume}} mounted. Ensure that storage is provisioned and available for mounting to the POD containers using specific helm values, or separately from RAA helm chart with help k8s or '''vendor specific''' tools.
+*{{Link-SomewhereInThisVersion|manual=GCXIPEGuide|topic=PlanningRAA|anchor=StorageRequirementsConfig|display text=Config volume}} &mdash; Ensure that space is provisioned and available for RAA to mount the Config Volume to the POD containers (using specific helm values, or separately from the RAA helm chart, with the help of Kubernetes or vendor-specific tools).
-*{{Link-SomewhereInThisVersion|manual=GCXIPEGuide|topic=PlanningRAA|anchor=StorageRequirementsHealth|display text=Health volume}} mounted. Ensure that storage is provisioned and available for mounting to the POD containers using specific helm values, or separately from RAA helm chart with help k8s or '''vendor specific''' tools.
+*{{Link-SomewhereInThisVersion|manual=GCXIPEGuide|topic=PlanningRAA|anchor=StorageRequirementsHealth|display text=Health volume}} &mdash; Ensure that space is provisioned and available for RAA to mount the Health Volume mounting to the POD containers (using specific helm values, or separately from the RAA helm chart, with the help of Kubernetes or vendor-specific tools).
 Configure at least the following values in '''values-raa.yaml''':

@@ Line 7: / Line 7: @@
 |sectionHeading=Prepare to deploy RAA
 |alignment=Vertical
-|structuredtext=
+|structuredtext=Configure the following resources to support the RAA pod:
-Configure the following resources to support the RAA pod:
+*Database connection details specified as <code class="yml variable">raa.env.GCXI_GIM_DB__JSON</code> value, or as a Kubernetes or '''vendor specific''' secret. See {{Link-SomewhereInThisVersion|manual=GCXIPEGuide|topic=PlanningRAA|anchor=StorageRequirements|display text=Genesys info Mart secret volume}} for details.
-*Database connection details specified as <code class="yml variable">raa.env.GCXI_GIM_DB__JSON</code> value, or as a Kubernetes or '''vendor specific''' secret. See {{Link-SomewhereInThisVersion|manual=RAAPEGuide|topic=Planning|anchor=StorageRequirements|display text=Genesys info Mart secret volume}} for details.
+*{{Link-SomewhereInThisVersion|manual=GCXIPEGuide|topic=PlanningRAA|anchor=StorageRequirementsConfig|display text=Config volume}} mounted. Ensure that storage is provisioned and available for mounting to the POD containers using specific helm values, or separately from RAA helm chart with help k8s or '''vendor specific''' tools.
-*{{Link-SomewhereInThisVersion|manual=RAAPEGuide|topic=Planning|anchor=StorageRequirementsConfig|display text=Config volume}} mounted. Specific storage should be provisioned and be available for mounting to the POD containers via specific helm values or separately from RAA helm chart with help k8s or '''vendor specific''' tools.
+*{{Link-SomewhereInThisVersion|manual=GCXIPEGuide|topic=PlanningRAA|anchor=StorageRequirementsHealth|display text=Health volume}} mounted. Ensure that storage is provisioned and available for mounting to the POD containers using specific helm values, or separately from RAA helm chart with help k8s or '''vendor specific''' tools.
 Configure at least the following values in '''values-raa.yaml''':
@@ Line 68: / Line 67: @@
        - service
        - servicename</source>
 |Status=No
 }}{{Section
 |sectionHeading=Install RAA
 |alignment=Vertical
-|structuredtext=
+|structuredtext=Using the values you configured in '''values-raa.yaml''', install RAA:
 Using the values you configured in '''values-raa.yaml''', install RAA:
-#Execute the following bash script to deploy RAA:
+#To deploy RAA, run the following bash script :
 #:<source lang="bash">helm install -n gcxi gcxi-raa ./gcxi-raa-0.1.364.tgz -f values-raa.yaml</source>
-#Execute the following bash script to check the installed Helm release:
+#To check the installed Helm release, run the following bash script:
 #:<source lang="bash">helm list -n gcxi</source>
-#:The output should show RAA deployment details, similar to the following:
+#:Release information appears, similar to the following:
 #:<source lang="bash">NAME     NAMESPACE       REVISION        UPDATED                                 STATUS          CHART           APP VERSION
 gcxi-raa      gcxi                                  1                     2021-06-22 18:08:30.5041926 +0300 +0300                       deployed               gcxi-raa-0.1.364 </source>
-#Execute the following bash script to check the RAA project status:
+#To check the RAA project status, run the following bash script:
 #:<source lang="bash">helm status gcxi-raa -n gcxi</source>
-#:The output should show STATUS: deployed, similar to the following:
+#:Status information appears, similar to the following (with STATUS: deployed):
 #:<source lang="bash">NAME: gcxi-raa
 LAST DEPLOYED: Tue Jun 22 18:08:30 2021