AUTH/Current/AuthPEGuide/Configure - Revision history

WikiSysop at 13:00, May 22, 2026

2026-05-22T13:00:43Z

WikiSysop at 13:00, May 19, 2026

2026-05-19T13:00:43Z

WikiSysop at 07:00, December 19, 2023

2023-12-19T07:00:25Z

WikiSysop at 12:00, March 22, 2023

2023-03-22T12:00:42Z

WikiSysop at 14:00, September 29, 2022

2022-09-29T14:00:36Z

Jumunn: Published

2022-05-27T19:43:04Z

Published

Julie.munn@genesys.com: Published

2021-12-17T13:52:47Z

Published

Julie.munn@genesys.com: Published

2021-12-16T14:25:25Z

Published

Julie.munn@genesys.com: Published

2021-12-16T14:23:36Z

Published

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

2021-11-09T20:29:23Z

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

@@ Line 70: / Line 70: @@
 {{!}}gws-ui-auth
 {{!}}The gws-ui-auth image version tag. For example, 100.0.003.1328.
 {{!}}A valid image version
 {{!}}""
@@ Line 843: / Line 848: @@
 {{!}}-
 {{!}}services.service_auth.env.GWS_AUTH_common_configService
-{{!}}The URL of the GWS Service Configuration service (config server cache). Used by the authentication service to read user details, validate credentials, and manage passwords.This is a mandatory setting
+{{!}}The URL of the GWS Service Configuration service (config server cache). Used by the authentication service to read user details, validate credentials, and manage passwords.'''This is a mandatory setting'''
-{{!}}A valid HTTP URL pointing to the configuration service (e.g., <nowiki>http://gws-service-configuration:8892</nowiki> or an internal load balancer URL)
+{{!}}A valid HTTP URL pointing to the configuration service (e.g., <nowiki>http://gws-platform-configuration:8092</nowiki> or <nowiki>http://gws-service-configuration:8892</nowiki> or an internal load balancer URL)
 {{!}}None (must be set)
 {{!}}-
@@ Line 960: / Line 965: @@
 |Status=No
 }}
 }}

@@ Line 589: / Line 589: @@
   failureThreshold: 3
 </syntaxhighlight>
 {{!}}-
 {{!}}services.auth.readinessProbe
@@ Line 629: / Line 639: @@
 {{!}}A valid set of annotations as "name: value"
 {{!}}{}
 {{!}}-
 {{!}}services.auth_ui.env.GWS_NGINX_ENABLE_MAPPING
@@ Line 706: / Line 721: @@
   failureThreshold: 3
 </syntaxhighlight>
 {{!}}-
 {{!}}services.environment.readinessProbe
@@ Line 719: / Line 739: @@
   periodSeconds: 10
 </syntaxhighlight>
 {{!}}-
 {{!}}services.environment.replicas
@@ Line 816: / Line 841: @@
 {{!}}Valid topology spread constraints settings. See the [https://kubernetes.io/docs/concepts/scheduling-eviction/topology-spread-constraints/ Kubernetes documentation] for details.
 {{!}}{}
 {{!}}}
 |Status=No
 }}{{Section

@@ Line 489: / Line 489: @@
 {{!}}Number
 {{!}}3
 {{!}}-
 {{!}}services.db.ssl
@@ Line 494: / Line 499: @@
 {{!}}disable, prefer, require, verify-ca, or verify-full
 {{!}}"disable"
 {{!}}-
 {{!}}services.auth.deploymentAnnotations
@@ Line 811: / Line 811: @@
 {{!}}true or false
 {{!}}false
 {{!}}}
 |Status=No
@@ Line 867: / Line 872: @@
 |anchor=Security
 |alignment=Vertical
-|structuredtext=To learn more about how security is configured for private edition, be sure to read the {{Link-AnywhereElse|product=PrivateEdition|version=Current|manual=PEGuide|topic=Prerequisites|display text=Permissions}} and {{Link-AnywhereElse|product=PrivateEdition|version=Current|manual=PEGuide|topic=ConfigSecurity}} topics in the ''Setting up Genesys Multicloud CX Private Edition'' guide.
+|structuredtext=To learn more about how security is configured for private edition, be sure to read the {{Link-AnywhereElse|product=PrivateEdition|version=Current|manual=PEGuide|topic=Prerequisites|display text=Permissions}} topic in the ''Setting up Genesys Multicloud CX Private Edition'' guide.
 The security context settings define the privilege and access control settings for pods and containers.

@@ Line 50: / Line 50: @@
 For more information about how to override Helm chart values, see {{SuiteLevelLink|helmoverride}} in the {{Link-AnywhereElse|product=PrivateEdition|version=Current|manual=PEGuide}} guide.
 {{{!}} class="wikitable" style="table-layout: fixed; overflow-wrap: break-word;" {{!}}
 {{!}}+
@@ Line 362: / Line 360: @@
 {{!}}nil
 {{!}}-
-{{!}}postgres.db
+{{!}}{{AnchorDiv|postgres}}postgres.db
-{{!}}The name of Genesys Authentication's PostgreSQL database.
+{{!}}The name of the PostgreSQL database from {{Link-SomewhereInThisVersion|manual=AuthPEGuide|topic=Planning|anchor=create|display text=Create a PostgreSQL database and user}}.
 {{!}}A valid database name
 {{!}}nil
@@ Line 378: / Line 376: @@
 {{!}}-
 {{!}}postgres.username
-{{!}}The username to access Genesys Authentication's PostgreSQL database.
+{{!}}The username to access the PostgreSQL database from {{Link-SomewhereInThisVersion|manual=AuthPEGuide|topic=Planning|anchor=create|display text=Create a PostgreSQL database and user}}.
 {{!}}A valid username
 {{!}}nil
 {{!}}-
 {{!}}postgres.password
-{{!}}The password to access Genesys Authentication's PostgreSQL database.
+{{!}}The password to access the PostgreSQL database from {{Link-SomewhereInThisVersion|manual=AuthPEGuide|topic=Planning|anchor=create|display text=Create a PostgreSQL database and user}}.
 {{!}}A valid password
 {{!}}nil
@@ Line 881: / Line 879: @@
      fsGroup: 500
      runAsNonRoot: true
-</syntaxhighlight>
+</syntaxhighlight><br />
 |Status=No
 }}
 |PEPageType=9c3ae89b-4f75-495b-85f8-d8c4afcb3f97
 }}

@@ Line 16: / Line 16: @@
 Create a keystore file:
-<source lang="text">keytool -keystore idp_keystore.jks -genkey -alias gws-auth-key -storepass <password> -keypass <password> -keyalg RSA</source>
+<source lang="text">keytool -keystore jksStorage.jks -genkey -alias gws-auth-key -storepass <password> -keypass <password> -keyalg RSA</source>
 Get the Base64 encoded key:
-<source lang="text">cat ./idp_keystore.jks | base64</source>
+<source lang="text">cat ./jksStorage.jks | base64</source>
 The result looks like this:

@@ Line 49: / Line 49: @@
 |structuredtext=You can specify parameters for the deployment by overriding Helm chart values in the '''values.yaml''' file. See the '''Parameters''' table for a full list of overridable values.
-For more information about how to override Helm chart values, see {{SuiteLevelLink|helmoverride}} in the ''Setting up Genesys Multicloud CX Private Edition'' guide.
+For more information about how to override Helm chart values, see {{SuiteLevelLink|helmoverride}} in the {{Link-AnywhereElse|product=PrivateEdition|version=Current|manual=PEGuide}} 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=AuthPEGuide|topic=Configure|anchor=Security|display text=Configure security}} below.
@@ Line 90: / Line 90: @@
 {{!}}""
 {{!}}-
-{{!}}consul.discovery_register
+{{!}}{{AnchorDiv|consul}}consul.discovery_register
 {{!}}Specifies whether services are registered in Consul.
 {{!}}true or false
@@ Line 140: / Line 140: @@
 {{!}}true
 {{!}}-
-{{!}}ingress.frontend
+{{!}}{{AnchorDiv|ingress.frontend}}ingress.frontend
 {{!}}The host that is used by external ingress.
 {{!}}A valid host
@@ Line 169: / Line 169: @@
 {{!}}true
 {{!}}-
-{{!}}internal_ingress.frontend
+{{!}}{{AnchorDiv|internal_ingress.frontend}}internal_ingress.frontend
 {{!}}The host that is used by internal ingress.
 {{!}}A valid host
@@ Line 179: / Line 179: @@
 {{!}}nginx.ingress.kubernetes.io/proxy-body-size: "0"
 {{!}}-
-{{!}}internal_ingress.tls_enabled
+{{!}}{{AnchorDiv|internal_ingress.tls_enabled}}internal_ingress.tls_enabled
 {{!}}Enables Transport Layer Security (TLS) on internal ingress.
 {{!}}true or false
@@ Line 442: / Line 442: @@
 {{!}}nil
 {{!}}-
-{{!}}redis.use_tls
+{{!}}{{AnchorDiv|redis.use_tls}}redis.use_tls
 {{!}}Enable or disable a TLS connection to the Redis cluster.
 {{!}}true or false
@@ Line 744: / Line 744: @@
 {{!}}{}
 {{!}}-
-{{!}}services.secret.admin_password
+{{!}}{{AnchorDiv|services.secret.admin_password}}services.secret.admin_password
 {{!}}Encrypted password of the operational user. The password should be encrypted with bcrypt hashing with any number of rounds. You can generate an encrypted password on the following site: https://www.javainuse.com/onlineBcrypt
 {{!}}A valid password
 {{!}}nil
 {{!}}-
-{{!}}services.secret.admin_username
+{{!}}{{AnchorDiv|services.secret.admin_username}}services.secret.admin_username
 {{!}}The username of an operational user.
-{{!}}A valid username
+{{!}}Any valid username. For example, opsAdmin, clientAdmin, ops.
 {{!}}nil
 {{!}}-
 {{!}}services.secret.client_id
 {{!}}The ID of an encrypted client secret.
-{{!}}A valid client ID
+{{!}}Any valid client ID. For example, external_api_client, nexus_client, authclient.
 {{!}}nil
 {{!}}-
 {{!}}services.secret.client_secret
-{{!}}The encrypted client secret.
+{{!}}The encrypted client secret. The client secret should be encrypted with bcrypt hashing with any number of rounds. You can generate an encrypted client secret  on the following site:https://www.javainuse.com/onlineBcrypt
 {{!}}A valid client secret
 {{!}}nil

@@ Line 530: / Line 530: @@
 {{!}}Specifies the value of the X-Frame-Options HTTP response header.
 {{!}}SAMEORIGIN, DENY, DISABLE, ALLOW
-{{!}}
+{{!}}ALLOW
 {{!}}-
 {{!}}services.auth.jks.enabled

@@ Line 498: / Line 498: @@
 {{!}}-
 {{!}}services.auth.loglevel
-{{!}}Specifies the Authentication Service log level.
+{{!}}Specifies the log level for the Authentication Service.
 {{!}}INFO, DEBUG, WARN
 {{!}}DEBUG
@@ Line 670: / Line 670: @@
 {{!}}-
 {{!}}services.environment.loglevel
-{{!}}Specifies the Environment Service log level.
+{{!}}Specifies the log level for the Environment Service.
 {{!}}INFO, DEBUG, WARN
 {{!}}INFO
@@ Line 685: / Line 685: @@
 {{!}}-
 {{!}}services.environment.env.GWS_ENVIRONMENT_logging_level_com_genesys_gws_v3
-{{!}}Specifies the logging level for the Environment Service.
+{{!}}Specifies the log level for the Environment Service.
 {{!}}INFO, DEBUG, WARN
 {{!}}INFO

@@ Line 317: / Line 317: @@
     target:
       type: Utilization
-      averageUtilization: 80
+      averageUtilization: 350%
 </syntaxhighlight>
 {{!}}-
@@ Line 339: / Line 339: @@
     target:
       type: Utilization
-      averageUtilization: 80
+      averageUtilization: 350%
 </syntaxhighlight><br />
 {{!}}-
@@ Line 496: / Line 496: @@
 {{!}}disable, prefer, require, verify-ca, or verify-full
 {{!}}"disable"
 {{!}}-
 {{!}}services.auth.deploymentAnnotations
@@ Line 516: / Line 521: @@
 {{!}}Valid JVM arguments
 {{!}}"-XX:+PrintFlagsFinal -XX:+UseG1GC -Dfile.encoding=UTF-8 -XX:+ExitOnOutOfMemoryError -XX:MaxRAMPercentage=80.0"
 {{!}}-
 {{!}}services.auth.jks.enabled
@@ Line 653: / Line 668: @@
 {{!}}A valid set of annotations as "name: value"
 {{!}}{}
 {{!}}-
 {{!}}services.environment.deploymentAnnotations
@@ Line 663: / Line 683: @@
 {{!}}Valid JVM arguments
 {{!}}"-XX:+PrintFlagsFinal -XX:+UseG1GC -Dfile.encoding=UTF-8 -XX:+ExitOnOutOfMemoryError -XX:MaxRAMPercentage=80.0"
 {{!}}-
 {{!}}services.environment.force_writable
@@ Line 720: / Line 745: @@
 {{!}}-
 {{!}}services.secret.admin_password
-{{!}}Encrypted password of the operational user
+{{!}}Encrypted password of the operational user. The password should be encrypted with bcrypt hashing with any number of rounds. You can generate an encrypted password on the following site: https://www.javainuse.com/onlineBcrypt
 {{!}}A valid password
 {{!}}nil