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

WikiSysop at 13:31, March 10, 2023

2023-03-10T13:31:28Z

WikiSysop at 03:45, September 30, 2022

2022-09-30T03:45:44Z

WikiSysop at 17:01, September 29, 2022

2022-09-29T17:01:42Z

Show changes

WikiSysop at 16:46, September 2, 2022

2022-09-02T16:46:08Z

Show changes

WikiSysop at 16:16, September 2, 2022

2022-09-02T16:16:08Z

Show changes

WikiSysop at 19:53, March 30, 2022

2022-03-30T19:53:03Z

Show changes

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

2021-11-09T20:28:30Z

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

Jose.druker@genesys.com: Published

2021-09-15T22:31:27Z

Published

Jose.druker@genesys.com: Published

2021-09-15T13:31:48Z

Published

Jose.druker@genesys.com: Published

2021-07-01T03:02:06Z

Published

New page

{{Article
|Standalone=No
|DisplayName=Configure GCA
|Context=Learn how to configure GIM Config Adapter (GCA).
|ComingSoon=No
|Section={{Section
|sectionHeading=Override Helm chart values
|alignment=Vertical
|structuredtext=Download the gca and gca-monitor Helm charts from JFrog using your credentials. You must override certain parameters in the '''gca-values.yaml''' file to provide deployment-specific values for certain parameters.

For general information about overriding Helm chart values, see {{SuiteLevelLink|helmoverride}} in the ''{{Link-AnywhereElse|product=PrivateEdition|version=Current|manual=PEGuide|display text=Genesys Engage Cloud Private Edition Guide}}''.

Override the following key entries in the '''gca-values.yaml''' file:

*<tt>tag</tt> - the container image version
* <tt>tenant_id</tt> - the TenantID of the tenant in use
* <tt>tenant_uuid</tt> - the TenantUUID that matches the TenantID.
* <tt>cfgdb</tt> - the tenant configuration database
* <tt>bootstrap</tt> - the Kafka address to align with the infrastructure Kafka
* <tt>NODE_EXTRA_CA_CERTS</tt> - points to the self-signed OpenShift service CA. This is the default path.
*<tt>s3</tt> - the applicable s3 details defined with the OBC for GSP (see {{Link-SomewhereInThisVersion|manual=GIMPEGuide|topic=ConfigureGSP|anchor=S3Data|display text=Get S3 data}}).
====The gca-values.yaml file====
<source lang="bash">log_level: INFO
tenant_id: shared
tenant_uuid: 9350e2fc-a1dd-4c65-8d40-1f75a2e080dd
image:
registry: pureengage-docker-staging.jfrog.io
repository: gim/gca
pullPolicy: IfNotPresent
tag: <image-version>
imagePullSecrets:
pureengage-docker-dev: {}
pureengage-docker-staging: {}
jfrog-stage-credentials: {}

cfgdb:
name: '<tenant-db-name>'
engine: postgre
port: 5432
host: 'postgres-rw.infra.svc.cluster.local'
username: '<db-user>'
password: '<db-password>'
kafka:
bootstrap: 'infra-kafka-cp-kafka.infra.svc.cluster.local:9092'
security:
protocol: plaintext
sasl:
mechanism: PLAIN
extraEnv: |
- name: SNAPSHOT_STORAGE_PATH
value: "/tmp"
- name: NODE_EXTRA_CA_CERTS
value: "/var/run/secrets/kubernetes.io/serviceaccount/service-ca.crt"
#extraVolumeMounts: ''
volumes: |
- name: kafka-secrets
secret:
secretName: {{.Release.Name}}-kafka-secrets
- name: cfg-db-secrets
secret:
secretName: {{.Release.Name}}-cfgdb-secrets
- name: storage-account-secrets
secret:
secretName: {{ .Release.Name }}-storage-secret
ssl_db_connection: false
dnsConfig:
options:
- name: ndots
value: '3'
csi_enabled: false
tolerations: []
resources:
requests:
memory: 64Mi
cpu: '0.01'
limits:
memory: 4000Mi
cpu: '1'
storage:
wasb:
url: ''
account_name: ''
access_key: ''
s3:
bucket: '<bucket-name>'
gcaSnapshots: '/gca'
accessKey: '<access-key>'
secretKey: '<secret-key>'
useSSL: true
endPoint: '<bucket-host>'
port: <bucket-port></source>
|Status=No
}}{{Section
|sectionHeading=Configure Kubernetes
|alignment=Vertical
|structuredtext={{Notices|Notice=PEComingSoon}}
|Status=No
}}{{Section
|sectionHeading=Configure security
|alignment=Vertical
|structuredtext=Not applicable.
|Status=No
}}
|PEPageType=9c3ae89b-4f75-495b-85f8-d8c4afcb3f97
}}

@@ Line 89: / Line 89: @@
 |anchor=Storage
 |alignment=Vertical
-|structuredtext=If you are using S3-compatible object storage on OpenShift or GCP to store the GCA snapshot, modify the following <code>storage: s3</code> entries in the '''values.yaml''' file:
+|structuredtext=If you are using S3-compatible object storage on GCP to store the GCA snapshot, modify the following <code>storage: s3</code> entries in the '''values.yaml''' file:
 <source lang="bash">
@@ Line 101: / Line 101: @@
      endPoint: <host> # The bucket host
 </source>
 ====GKE example====
@@ Line 157: / Line 143: @@
    password: <password> # The password for the user account
 </source>
 |Status=No
 }}{{Section

@@ Line 10: / Line 10: @@
 |structuredtext=The GCA requires some configuration for deployment that must be done by modifying the GCA's default Helm chart. You do this by creating override entries in the GCA's '''values.yaml''' file.
-Download the '''gca''' and '''gca-monitoring''' Helm charts from the JFrog registry, using the appropriate credentials.
+Download the '''gca''' and '''gca-monitoring''' Helm charts from your image registry, using the appropriate credentials.
 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 general information about Helm chart overrides, see {{SuiteLevelLink|helmoverride}} in the ''{{Link-AnywhereElse|product=PrivateEdition|version=Current|manual=PEGuide|display text=Genesys Multicloud CX Private Edition Guide}}''.

@@ Line 9: / Line 9: @@
 |structuredtext=Download the gca and gca-monitor Helm charts from JFrog using your credentials. You must override certain parameters in the '''values.yaml''' file to provide deployment-specific values for certain parameters.
-For general information about overriding Helm chart values, see {{SuiteLevelLink|helmoverride}} in the ''{{Link-AnywhereElse|product=PrivateEdition|version=Current|manual=PEGuide|display text=Genesys Engage Cloud Private Edition Guide}}''.
+For general information about overriding Helm chart values, see {{SuiteLevelLink|helmoverride}} in the ''{{Link-AnywhereElse|product=PrivateEdition|version=Current|manual=PEGuide|display text=Genesys Multicloud CX Private Edition Guide}}''.
 If you want to use arbitrary UIDs in your OpenShift deployment, you must override the '''securityContext''' settings in the GCA '''values.yaml''' file, so that no user or group IDs are specified. For details, see [[{{FULLPAGENAME}}#Security|Configure security]], below.

@@ Line 7: / Line 7: @@
 |sectionHeading=Override Helm chart values
 |alignment=Vertical
-|structuredtext=Download the gca and gca-monitor Helm charts from JFrog using your credentials. You must override certain parameters in the '''values.yaml''' file (referred to on this page as the '''gca-values.yaml''' file) to provide deployment-specific values for certain parameters.
+|structuredtext=Download the gca and gca-monitor Helm charts from JFrog using your credentials. You must override certain parameters in the '''values.yaml''' file to provide deployment-specific values for certain parameters.
 For general information about overriding Helm chart values, see {{SuiteLevelLink|helmoverride}} in the ''{{Link-AnywhereElse|product=PrivateEdition|version=Current|manual=PEGuide|display text=Genesys Engage Cloud Private Edition Guide}}''.
-If you want to use arbitrary UIDs in your OpenShift deployment, you must override the '''securityContext''' settings in the '''gca-values.yaml''' file, so that no user or group IDs are specified. For details, see [[{{FULLPAGENAME}}#Security|Configure security]], below.
+If you want to use arbitrary UIDs in your OpenShift deployment, you must override the '''securityContext''' settings in the GCA '''values.yaml''' file, so that no user or group IDs are specified. For details, see [[{{FULLPAGENAME}}#Security|Configure security]], below.
-At a minimum, you must override the following key entries in the '''gca-values.yaml''' file:
+At a minimum, you must override the following key entries in the GCA '''values.yaml''' file:
 *<tt>tag</tt> - the container image version
@@ Line 22: / Line 22: @@
 * <tt>NODE_EXTRA_CA_CERTS</tt> - points to the self-signed OpenShift service CA. This is the default path.
 *<tt>s3</tt> - the applicable s3 details defined with the OBC for GSP (see {{Link-SomewhereInThisVersion|manual=GIMPEGuide|topic=ConfigureGSP|anchor=S3Data|display text=Get S3 data}}).
-====The gca-values.yaml file====
+====The GCA '''values.yaml''' file====
-The following sample '''gca-values.yaml''' file, which may not be completely up to date, shows the key parameter values you must override.
+The following sample GCA '''values.yaml''' file, which may not be completely up to date, shows the key parameter values you must override.
 <source lang="bash">log_level: INFO
 tenant_id: shared
@@ Line 105: / Line 105: @@
 |structuredtext=The security context settings define the privilege and access control settings for pods and containers.
-By default, the user and group IDs are set in the '''gca-values.yaml''' file as <tt>500:500:500</tt>, meaning the '''genesys''' user.
+By default, the user and group IDs are set in the GCA '''values.yaml''' file as <tt>500:500:500</tt>, meaning the '''genesys''' user.
 <source lang="bash">
 securityContext:
@@ Line 116: / Line 116: @@
 </source>
 ===Arbitrary UIDs in OpenShift===
-If you want to use arbitrary UIDs in your OpenShift deployment, you must override the '''securityContext''' settings in the '''gca-values.yaml''' file, so that you do not define any specific IDs.
+If you want to use arbitrary UIDs in your OpenShift deployment, you must override the '''securityContext''' settings in the GCA '''values.yaml''' file, so that you do not define any specific IDs.
 <source lang="bash">
 securityContext: