PEC-CAB/Current/CABPEGuide/Configure - Revision history

WikiSysop at 11:01, February 23, 2023

2023-02-23T11:01:14Z

WikiSysop at 14:31, September 23, 2022

2022-09-23T14:31:13Z

WikiSysop at 16:46, August 4, 2022

2022-08-04T16:46:11Z

Corinneh: Published

2021-12-22T17:07:55Z

Published

Ed.jamer@genesys.com: Text replacement - "Genesys Multicloud CX on Azure" to "Genesys CX on Azure"

2021-11-09T21:42:23Z

Text replacement - "Genesys Multicloud CX on Azure" to "Genesys CX on Azure"

Ed.jamer@genesys.com: Text replacement - "Genesys Multicloud CXment" to "Genesys Engagement"

2021-11-09T21:14:48Z

Text replacement - "Genesys Multicloud CXment" to "Genesys Engagement"

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

2021-11-09T21:12:54Z

Text replacement - "Genesys Engage" to "Genesys Multicloud CX"

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

2021-11-09T20:29:39Z

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

Corinne.hicks@genesys.com: Published

2021-09-15T22:13:01Z

Published

Corinne.hicks@genesys.com: Published

2021-09-10T15:50:16Z

Published

@@ Line 9: / Line 9: @@
 |alignment=Vertical
 |structuredtext=For additional information about overriding Helm chart values, see {{Link-AnywhereElse|product=PrivateEdition|version=Current|manual=PEGuide|topic=HelmOverrides|display text=Overriding Helm Chart values}} in the ''{{Link-AnywhereElse|product=PrivateEdition|version=Current|manual=PEGuide|display text=Genesys Multicloud CX Private Edition Guide}}''.
 Genesys Engagement Service (GES) has a Helm value layout similar to other Engage services, however the use of environment variables as the primary way to configure GES means that setting up the Helm values is particularly important. Below is a section-by-section description of the Helm chart parameters, what they influence, and any other information that you might find helpful to know when provisioning GES within Private Edition.
@@ Line 636: / Line 634: @@
 |alignment=Vertical
 |structuredtext====Security context configuration===
 The security context settings define the privilege and access control settings for pods and containers. For more information, see the [https://kubernetes.io/docs/tasks/configure-pod-container/security-context/ Kubernetes documentation].
 |Status=No
 }}{{Section

@@ Line 134: / Line 134: @@
 {{!}}String
 {{!}}}<br />
 ====integrations====
 {{{!}} class="wikitable"
@@ Line 155: / Line 156: @@
 This is required.
-{{!}}
+{{!}}6379
 {{!}}Number
 {{!}}-
@@ Line 165: / Line 166: @@
 {{!}}false
 {{!}}Boolean
 {{!}}}
 {{{!}} class="wikitable"
@@ Line 655: / Line 661: @@
 |alignment=Vertical
 |structuredtext====Configuring a JFrog secret===
-For the GES pod to pull the docker image from the Genesys artifactory, your JFrog credentials must be available to the pod. This is done using a two-step process:
+For a full description of downloading Genesys Multicloud CX containers and accessing repositories, see {{Link-AnywhereElse|product=PrivateEdition|version=Current|manual=PEGuide|topic=ManageServices|display text=Downloading your Genesys Multicloud CX containers}} in ''Setting up Genesys Multicloud CX Private Edition''.
-#Create a secret in the GES namespace containing the username and password associated with your JFrog credentials.
+If you're creating a secret containing JFrog account details, the secret must be of type <tt>kubernetes/dockerconfigjson</tt>. You can find more information on this topic in the [https://kubernetes.io/docs/concepts/configuration/secret/#docker-config-secrets Kubernetes documentation]. Regardless of platform, you create the secret using the following <tt>kubectl</tt> command: <source lang="yml">
 kubectl create secret docker-registry <JFROG_SECRET_NAME> \
    --docker-server=<JFROG_ARTIFACTORY_URL> \
    --docker-username=<JFROG_USERNAME> \
-   --docker-password=<JFROG_PASSWORD> \
+   --docker-password=<API key from JFROG> \
    --docker-email=<JFROG_EMAIL>
 </source>
 ====Updating the Values.yaml file====
-In your Values.yaml file, update the value of <tt>.Values.ges.deployment.image.imagePullSecrets</tt>. For example:<br />
+In your '''Values.yaml''' file, update the value of <tt>.Values.ges.deployment.image.imagePullSecrets</tt>. For example:<br />
 <tt>imagePullSecrets:  - name: <JFROG_SECRET_NAME></tt>
 |Status=No

@@ Line 10: / Line 10: @@
 |structuredtext=For additional information about overriding Helm chart values, see {{Link-AnywhereElse|product=PrivateEdition|version=Current|manual=PEGuide|topic=HelmOverrides|display text=Overriding Helm Chart values}} 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 '''values.yaml''' file, so that no user or group IDs are specified. For details, see {{Link-SomewhereInThisVersion|manual=CABPEGuide|topic=Configure|anchor=securityContext|display text=Security context configuration}}, below.
+If you want to use arbitrary UIDs in your OpenShift deployment, you must override the '''securityContext''' settings in the '''values.yaml''' file, to ensure that no user or group IDs are specified. For details, see {{Link-SomewhereInThisVersion|manual=CABPEGuide|topic=Configure|anchor=securityContext|display text=Security context configuration}}, below.
-Genesys Engagement Service (GES) has a Helm value layout inline with other Engage services, however, the use of environment variables as the primary way to configure GES means that setting up the helm values is something that one will need to pay particular attention to. Below is a "section by section" description of the different helm chart parameters, what they influence and anything else an operator might find important to know when provisioning GES within Private Edition.
+Genesys Engagement Service (GES) has a Helm value layout similar to other Engage services, however the use of environment variables as the primary way to configure GES means that setting up the Helm values is particularly important. Below is a section-by-section description of the Helm chart parameters, what they influence, and any other information that you might find helpful to know when provisioning GES within Private Edition.
 All values to configure GES are within the <tt>.ges</tt> subsection of the <tt>.Values.yaml</tt> file. For example, to set affinity, you reference <tt>.Values.ges.affinity</tt>. For those values listed in a <tt>misc</tt> section, omit that from the path when referencing an environment variable.
@@ Line 272: / Line 272: @@
 {{!}}}<br />
 ===deployment===
 {{{!}} class="wikitable"
 {{!}}+image

@@ Line 163: / Line 163: @@
 This is required.
-{{!}}ges.ges
+{{!}}false
 {{!}}Boolean
 {{!}}}
@@ Line 636: / Line 636: @@
     runAsNonRoot: true
     runAsUser: null
-    runAsGroup: 0
+    runAsGroup: null
     fsGroup: null
 </source>
 |Status=No
 }}{{Section
 |alignment=Vertical
 |structuredtext====Configuring a JFrog secret===
@@ Line 649: / Line 650: @@
 ====JFrog secret layout====
-While instructions on how best to create the secret will vary between Kubernetes providers, what is consistent is that the secret containing the JFrog account details must be in a secret of type <code>kubernetes/dockerconfigjson</code>. You can find more information on this topic in the [https://kubernetes.io/docs/concepts/configuration/secret/#docker-config-secrets Kubernetes documentation]. Regardless of platform, you can create the secret using the following <code>kubect</code> command:
+While instructions on how best to create the secret will vary between Kubernetes providers, what is consistent is that the secret containing the JFrog account details must be in a secret of type <tt>kubernetes/dockerconfigjson</tt>. You can find more information on this topic in the [https://kubernetes.io/docs/concepts/configuration/secret/#docker-config-secrets Kubernetes documentation]. Regardless of platform, you can create the secret using the following <tt>kubectl</tt> command:
 <source lang="text">
 kubectl create secret docker-registry <JFROG_SECRET_NAME> \
    --docker-username=<JFROG_USERNAME> \
    --docker-password=<JFROG_PASSWORD> \
    --docker-email=<JFROG_EMAIL>
 </source>
-{{AnchorDiv|jfrogsecret}}
 ====Updating the Values.yaml file====
-In your Values.yaml file, update the value of <code>.Values.ges.deployment.image.imagePullSecrets</code>. For example:
+In your Values.yaml file, update the value of <tt>.Values.ges.deployment.image.imagePullSecrets</tt>. For example:<br />
+<tt>imagePullSecrets:  - name: <JFROG_SECRET_NAME></tt>
 |Status=No
 }}{{Section
@@ Line 670: / Line 671: @@
 GES incorporates secrets through the use of [https://kubernetes.io/docs/concepts/storage/volumes/ Volumes] that are mounted to the GES Kubernetes pod. There are a number of ways in which you can define the secrets in the Kubernetes deployment, including manually defining secrets that are deployed along with the GES template, using tools such as Terraform, and so on. Instructions about how to leverage the different tools is outside the scope of this documentation. What's important is that you turn the secret into a volume.
-To enable volumes, set the value <code>.Values.ges.secrets.volumes.enabled</code> to '''true''', and then – for each secret that you want to make available – fill out a list entry. For example:
+To enable volumes, set the value <tt>.Values.ges.secrets.volumes.enabled</tt> to '''true''', and then – for each secret that you want to make available – fill out a list entry. For example:
 <source lang="text">
 volumes:
@@ Line 681: / Line 682: @@
-You can then mount the volume to GES. Set <code>.Values.ges.secrets.volumeMounts.enabled</code> to '''true''' and fill out a list entry. For example:
+You can then mount the volume to GES. Set <tt>.Values.ges.secrets.volumeMounts.enabled</tt> to '''true''' and fill out a list entry. For example:
 <source lang="text">
 volumeMounts:
@@ Line 692: / Line 693: @@
-Finally, you must specify the folders that contain the configuration information for GES. To do this, enter the list of <Mount Path>s in the form of a comma-separated string as the value for <code>.Values.ges.secrets.configFolders</code>.
+Finally, you must specify the folders that contain the configuration information for GES. To do this, enter the list of <Mount Path>s in the form of a comma-separated string as the value for <tt>.Values.ges.secrets.configFolders</tt>.
 While the examples here demonstrate how to provide secrets as typical Kubernetes secrets, GES also supports mounting secrets using the [https://learn.hashicorp.com/tutorials/vault/kubernetes-secret-store-driver?in=vault/kubernetes Container Storage Interface]. Provided the CSI is configured correctly in the Kubernetes environment, you should be able to set this up with only some minor changes in the Helmvalues files.
 |Status=No
 }}{{Section
 |alignment=Vertical
 |structuredtext====Using secrets to integrate with other software===
@@ Line 708: / Line 710: @@
 ====GWS====
-The AUTHENTICATION-CLIENT-ID and AUTHENTICATION-CLIENT-PASSWORD needed to authenticate with GWS must be supplied as an opaque secret. GES supports both encrypted and unencrypted client grants. However, if using an unencrypted grant, it is important that you encode the AUTHENTICATION-CLIENT-PASSWORD using the aes-128-ecb algorithm and an encryption key supplied by the password defined in the Helm value <code>.Values.ges.configMap.env.decrypt_password</code>.
+The AUTHENTICATION-CLIENT-ID and AUTHENTICATION-CLIENT-PASSWORD needed to authenticate with GWS must be supplied as an opaque secret. GES supports both encrypted and unencrypted client grants. However, if using an unencrypted grant, it is important that you encode the AUTHENTICATION-CLIENT-PASSWORD using the aes-128-ecb algorithm and an encryption key supplied by the password defined in the Helm value <tt>.Values.ges.configMap.env.decrypt_password</tt>.
 ====ORS====
-The password to the ORS Redis instance must be supplied to GES through the use of an opaque secret. Unlike other secrets, which can be set up as simple key-value pairs, ORS REDIS information must be supplied to GES in a key-value pair where the key is <code>voice-redis-ors-stream</code> and the value is a JSON string with the following configuration:
+The password to the ORS Redis instance must be supplied to GES through the use of an opaque secret. Unlike other secrets, which can be set up as simple key-value pairs, ORS REDIS information must be supplied to GES in a key-value pair where the key is <tt>voice-redis-ors-stream</tt> and the value is a JSON string with the following configuration:
 <source lang="text">
+{

@@ Line 281: / Line 281: @@
 {{!}}imagePullSecrets
 {{!}}A secret needed to authenticate with the docker registry.
-Might not be required; implementation is based on how you have set up your cloud. For example, in Genesys Multicloud CX on Azure, the Pod ID is used to authenticate with the Azure Container Registry.
+Might not be required; implementation is based on how you have set up your cloud. For example, in Genesys CX on Azure, the Pod ID is used to authenticate with the Azure Container Registry.
 {{!}}[ ]
 {{!}}List
@@ Line 312: / Line 312: @@
 {{!}}enabled
 {{!}}True when horizontal pod auto-scaling is enabled.
-Might not be required; implementation is based on how you have set up your cloud. For example, in Genesys Multicloud CX on Azure, the Pod ID is used to authenticate with the Azure Container Registry.
+Might not be required; implementation is based on how you have set up your cloud. For example, in Genesys CX on Azure, the Pod ID is used to authenticate with the Azure Container Registry.
 {{!}}True
 {{!}}Boolean

@@ Line 1: / Line 1: @@
 {{Article
 |Standalone=No
-|DisplayName=Configure Genesys Multicloud CXment Service
+|DisplayName=Configure Genesys Engagement Service
 |Context=Learn how to configure Genesys Callback.
 |ComingSoon=No
@@ Line 12: / Line 12: @@
 If you want to use arbitrary UIDs in your OpenShift deployment, you must override the '''securityContext''' settings in the '''values.yaml''' file, so that no user or group IDs are specified. For details, see {{Link-SomewhereInThisVersion|manual=CABPEGuide|topic=Configure|anchor=securityContext|display text=Security context configuration}}, below.
-Genesys Multicloud CXment Service (GES) has a Helm value layout inline with other Engage services, however, the use of environment variables as the primary way to configure GES means that setting up the helm values is something that one will need to pay particular attention to. Below is a "section by section" description of the different helm chart parameters, what they influence and anything else an operator might find important to know when provisioning GES within Private Edition.
+Genesys Engagement Service (GES) has a Helm value layout inline with other Engage services, however, the use of environment variables as the primary way to configure GES means that setting up the helm values is something that one will need to pay particular attention to. Below is a "section by section" description of the different helm chart parameters, what they influence and anything else an operator might find important to know when provisioning GES within Private Edition.
 All values to configure GES are within the <tt>.ges</tt> subsection of the <tt>.Values.yaml</tt> file. For example, to set affinity, you reference <tt>.Values.ges.affinity</tt>. For those values listed in a <tt>misc</tt> section, omit that from the path when referencing an environment variable.