UCS/Current/UCSPEGuide/Configure - Revision history

WikiSysop at 12:45, February 20, 2023

2023-02-20T12:45:46Z

WikiSysop at 15:46, September 21, 2022

2022-09-21T15:46:09Z

Xavier: Published

2021-12-23T03:41:39Z

Published

Xavier.roy@genesys.com: Published

2021-07-01T07:31:30Z

Published

Xavier.roy@genesys.com: Published

2021-06-30T09:48:36Z

Published

New page

{{Article
|Standalone=No
|DisplayName=Configure UCS
|Context=Learn how to configure Universal Contact Service (UCS).
|ComingSoon=No
|Section={{Section
|sectionHeading=Override Helm chart values
|alignment=Vertical
|structuredtext=Create a file named '''values.yaml''' and set the following values depending on your environment.

*Set the number of running PODs:
<source lang="yaml">
replicaCount: 1
</source>

*Set the repository for the images:
<source lang="yaml">
image:
registry: base address of UCSX image in artifactory.
repository: ucsx/ucsx
pullPolicy: IfNotPresent
pullSecrets: if needed, set to the appropriate value for your environment.
</source>

*Set the ElasticSearch url, for example, http://ucsx-es-client-service.ucsx.svc.cluster.local:9200:
<source lang="yaml">
elasticsearch:
url: Set URL to the ElasticSearch for data
</source>

*Set the Authentication service information
<source lang="yaml">
gauth:
auth:
url: URL to GWS Auth service
env:
url: URL to GWS Environment service
</source>

*Set the memory and CPU limits to the values required for your deployment:
<source lang="yaml">
resources:
requests:
memory: "500Mi"
cpu: "300m"
limits:
memory: "1000Mi"
cpu: "2000m"
</source>

*Modify the DNS Configuration to match your environment:
<source lang="yaml">
dnsConfig:
options:
- name: ndots
value: "3"
</source>

*UCS requires stickiness for some scenarios (from GWS/WWE). You can enable this on the Service level or create ingress rules to enable and configure them.
*The Ingress configuration requires the sticky sessions. You can enable this on the Service level or create ingress rules to enable and configure them. The cookie name should be set to ''UCS_SESSIONID''.
|Status=No
}}{{Section
|sectionHeading=Configure Kubernetes
|alignment=Vertical
|structuredtext=Create a Kubernetes ConfigMap named '''ucsx-config''' and save the database parameters under the following keys:

*<code>CMX_MASTER_DB_HOST</code> - the FQDN of the host where PostgresDB server is running
*<code>CMX_MASTER_DB_NAME</code> - the database name
*<code>CMX_MASTER_DB_PORT</code> - The port number of the PostgresDB server
*<code>CMX_MASTER_DB_USER</code> - the database user

Create a Kubernetes Secret named '''ucsx-secret''' and save the following secrets under the following keys:

*<code>CMX_MASTER_DB_PASSWORD</code> - the password for the database user to access the database
*<code>CMX_GWS_SERVICE_CREDENTIALS_CLIENT_ID</code> - the Client ID for GWS Auth
*<code>CMX_GWS_SERVICE_CREDENTIALS_CLIENT_SECRET</code> - the Client Secret for GWS Auth

The ConfigMap and Secret can also be created automatically from Helm Chart if the following values are empty:

*<code>existingSecret</code> - to create the Secret
*<code>existingConfig</code> - to create the ConfigMap

The following values will be added to the Secret:

*<code>db.password</code>
*<code>gauth.auth.clientId</code>
*<code>gauth.auth.clientSecret</code>

The following values will be added to the ConfigMap:

*<code>db.host</code>
*<code>db.name</code>
*<code>db.port</code>
*<code>db.user</code>
|Status=No
}}{{Section
|sectionHeading=Configure security
|alignment=Vertical
|structuredtext=Universal Contact Service (UCS) requires '''clientId''' and '''clientSecret''' registered in the Auth Service. These have to be provided during helmchart deployment.
|Status=No
}}
|PEPageType=9c3ae89b-4f75-495b-85f8-d8c4afcb3f97
}}

@@ Line 66: / Line 66: @@
 *UCS requires stickiness for some scenarios (from GWS/WWE). You can enable this on the Service level or create ingress rules  to enable and configure them.
 *The Ingress configuration requires the sticky sessions. You can enable this on the Service level or create ingress rules  to enable and configure them. The cookie name should be set to ''UCS_SESSIONID''.
+<!--
 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-AnywhereElse|product=PrivateEdition|version=Current|manual=PEGuide|topic=ConfigSecurity}}.
 |Status=No
 }}{{Section
@@ Line 107: / Line 108: @@
 |alignment=Vertical
 |structuredtext=Universal Contact Service (UCS) requires '''clientId''' and '''clientSecret''' registered in the Auth Service. These have to be provided during helmchart deployment.
 ===Arbitrary UIDs in OpenShift===
 If you want to use arbitrary UIDs in your OpenShift deployment, you must override the '''securityContext''' settings, so that you do not define any specific IDs.<source lang="yaml">
@@ Line 117: / Line 119: @@
 containerSecurityContext: {}
 </source>
 |Status=No
 }}{{Section

@@ Line 12: / Line 12: @@
 }}{{Section
 |sectionHeading=Override Helm chart values
 |alignment=Vertical
 |structuredtext=Create a file named '''values.yaml''' and set the following values depending on your environment.
@@ Line 29: / Line 30: @@
 </source>
-*Set the ElasticSearch url, for example, http://ucsx-es-client-service.ucsx.svc.cluster.local:9200:
+*Set the ElasticSearch url, for example, <nowiki>http://ucsx-es-client-service.ucsx.svc.cluster.local:9200</nowiki>:
 <source lang="yaml">
 elasticsearch:

@@ Line 11: / Line 11: @@
 *Set the number of running PODs:
 <source lang="yaml">
-replicaCount: 1
+replicaCount: 2
 </source>
@@ Line 17: / Line 17: @@
 <source lang="yaml">
 image:
-   registry: base address of UCSX image in artifactory.
+   registry: base address of UCS image in artifactory.
    repository: ucsx/ucsx
    pullPolicy: IfNotPresent
@@ Line 33: / Line 33: @@
 gauth:
    auth:
-     url: URL to GWS Auth service
+     url: URL to Genesys Auth service
    env:
      url: URL to GWS Environment service