Difference between revisions of "PEC-REP/Current/GCXIPEGuide/Configure"

Revision as of 18:29, September 1, 2021

This topic is part of the manual Genesys Customer Experience Insights Private Edition Guide for version Current of Reporting.

Override Helm chart values

Before you begin, download the latest yaml files from the repository, or examine the attached files: Sample GCXI yaml files . Helm values are described in values.yaml. See the comments accompanying each Helm value.

You can override values in the Helm charts to configure Private Edition. For more information, see the "suite-level" documentation about how to override Helm chart values: Overriding Helm chart values.

Configure Kubernetes

This section provides information about Kubernetes configuration.

ConfigMaps

Configuration information is stored in ConfigMap.

See the gcxi-worker-statefulset.yaml file:

envFrom:
        - configMapRef:
            name: gcxi-config{{ template "deploymentCode" . }}
            optional: true
        - configMapRef:
            name: gcxi-config-ext{{ template "deploymentCode" . }}
            optional: true
        {{- range $cm := .Values.gcxi.configMaps }}
        - configMapRef:
            name: {{ tpl $cm.name $ }}
            optional: true

Secrets

GCXI supports the following methods of secret injection:

CSI driver
Kubernetes secrets
Environment Variables

See the values.yaml file:

secrets:
  - name: gcxi-secret-pg

See the gcxi-worker-statefulset.yaml file:

- name: gcxi-var
        projected:
          sources:
          - secret:
              name: gcxi-secret{{ template "deploymentCode" . }}
              optional: true
          - secret:
              name: gcxi-secret-ext{{ template "deploymentCode" . }}
              optional: true
          {{- range $secret := .Values.gcxi.secrets }}
          - secret:
              name: {{ tpl $secret.name $ }}
              {{- with $secret.items }}
              items:
              {{- range $item := $secret.items }}
              - key: {{ tpl $item.key $ }}
                path: {{ tpl $item.path $ }}
              {{- end }}
              {{- end }}
              optional: true
          {{- end }}

Configure security

GCXI is based on a 3rd-party product (MicroStrategy), and as result has some special considerations:

The main container is about 12 GB.

GCXI requires specific hostIPC configuration at the node level:

echo "kernel.sem = 250 1024000 250 4096" >> /etc/sysctl.conf
echo "vm.max_map_count = 5242880" >> /etc/sysctl.conf
sysctl -p

In most deployments, GCXI requires that hostIPC be set:
```
hostIPC: true
```

Arbitrary UID

An arbitrary user ID (UID) and group ID is assigned to pods during deployment (file ownership is assigned as genesys:root (500:0)).

If your OpenShift deployment uses arbitrary UIDs, you must override the securityContext settings in the values.yaml file (see line 456) as follows:

secrets:
  securityContext:
    control:
      fsGroup: null
      runAsUser: null
      runAsGroup: null
    worker:
      fsGroup: null
      runAsUser: null
      runAsGroup: null

The default values (user ID = 500) are suitable for many other deployment scenarios:

secrets:
  securityContext:
    control:
      fsGroup: null
      runAsUser: 500
      runAsGroup: 500
    worker:
      fsGroup: null
      runAsUser: 500
      runAsGroup: 500

@@ Line 7: / Line 7: @@
 |sectionHeading=Override Helm chart values
 |alignment=Vertical
-|structuredtext=Before you begin, download the latest yaml files from the repository, or examine the attached files: {{Repository|GCXIyamlExamples.zip|| Sample GCXI yaml files}}. Helm values are described in '''values.yaml'''. See the comments accompanying each Helm value.
+|structuredtext=Before you begin, download the latest yaml files from the repository, or examine the attached files:  {{Repository|GCXIYaml.zip|| Sample GCXI yaml files }}. Helm values are described in '''values.yaml'''. See the comments accompanying each Helm value.
 You can override values in the Helm charts to configure Private Edition. For more information, see the "suite-level" documentation about how to override Helm chart values: {{SuiteLevelLink|helmoverride}}.
@@ Line 24: / Line 24: @@
 {{!}}}
 -->
 |Status=No
 }}{{Section
@@ Line 85: / Line 86: @@
 *The main container is about 12 GB.
-*The Openshift-specific <nowiki>''</nowiki>arbitrary user id<nowiki>''</nowiki> requirement cannot be satisfied. GCXI requires anyuid SCC.
 *GCXI requires specific hostIPC configuration at the node level:
 *:<source lang="bash">echo "kernel.sem = 250 1024000 250 4096" >> /etc/sysctl.conf
@@ Line 92: / Line 92: @@
 *In most deployments, GCXI requires that hostIPC be set:
 *:<source lang="bash">hostIPC: true</source>
+===Arbitrary UID===
+*An arbitrary user ID (UID) and group ID is assigned to pods during deployment (file ownership is assigned as genesys:root (500:0)).
+*If your OpenShift deployment uses arbitrary UIDs, you must override the securityContext settings in the '''values.yaml''' file (see line 456) as follows:
+*: <source lang="text">secrets:
+  securityContext:
+    control:
+      fsGroup: null
+      runAsUser: null
+      runAsGroup: null
+    worker:
+      fsGroup: null
+      runAsUser: null
+      runAsGroup: null</source>
+*:The default values (user ID = 500) are suitable for many other deployment scenarios:
+*:<source lang="text">secrets:
+  securityContext:
+    control:
+      fsGroup: null
+      runAsUser: 500
+      runAsGroup: 500
+    worker:
+      fsGroup: null
+      runAsUser: 500
+      runAsGroup: 500</source>
 |Status=No
 }}
 |PEPageType=9c3ae89b-4f75-495b-85f8-d8c4afcb3f97
 }}

Genesys Customer Experience Insights Private Edition Guide

Overview

Configure and deploy RAA

Configure and deploy GCXI

Observability