Configure GWS Ingress

Learn how to configure GWS Ingress.

Related documentation:

• Suite-level guide
• All services
• Genesys Web Services and Applications Release Notes

RSS:

• For private edition

Warning

If you are deploying Genesys Web Services and Applications in a single namespace with other private edition services, then you do not need to deploy GWS ingress.

Override Helm chart values

You can specify parameters for the deployment by overriding Helm chart values in the values.yaml file. See the tables below for a full list of overridable values available for each container in GWS ingress.

For more information about how to override Helm chart values, see Overriding Helm chart values.

Parameters

Parameter	Description	Valid values	Default
deploymentGlobals.deploymentTag	The deployment tag used as a suffix for the names of Kubernetes objects created by the chart. The value must be the same as the value in the GWS Helm chart.	Any lowercase alphanumeric value up to 8 characters long.	"live"
sessionCookieName	The cookie name for sticky sessions.	A valid cookie name	"GWSSESSIONID"
entryPoints.internal.ingress.enabled	Specifies whether internal ingress is enabled. Set this value to false if you are deploying Genesys Web Services and Applications in a single namespace.	true or false	true
entryPoints.internal.ingress.ingressClassName	Defines which controller implements the Ingress resource. The value is directly propagated to the ingressClassName field of the Kubernetes Ingress object. See Ingress and Ingress class in the Kubernetes documentation for details.	A valid IngressClass	""
entryPoints.internal.ingress.annotations	Custom annotations for internal ingress.	A valid set of annotations as "name: value"	{}
entryPoints.internal.ingress.hosts	List of internal ingress hostnames.	Valid hostnames	["gws-int.genesys.com"]
entryPoints.internal.ingress.tls	List of TLS configurations for internal ingress. See Network requirements for an example configuration.	Valid TLS configurations	[]
entryPoints.external.ingress.enabled	Specifies whether external ingress is enabled. Set this value to false if you are deploying Genesys Web Services and Applications in a single namespace.	true or false	true
entryPoints.external.ingress.ingressClassName	Defines which controller implements the Ingress resource. The value is directly propagated to the ingressClassName field of the Kubernetes Ingress object. See Ingress and Ingress class in the Kubernetes documentation for details.	A valid IngressClass	""
entryPoints.external.ingress.annotations	Custom annotations for external ingress.	A valid set of annotations as "name: value"	{}
entryPoints.external.ingress.hosts	List of external ingress hostnames.	Valid hostnames	["gws.genesys.com"]
entryPoints.external.ingress.tls	List of TLS configurations for external ingress. See Network requirements for an example configuration.	Valid TLS configurations	[]
gwsServices.gwsAppProvisioning.name	Specifies the name of the GWS Provisioning Service deployment.	Value of the gwsServices.gwsAppProvisioning.name parameter as described in Configure GWS Services.	"gws-app-provisioning"
gwsServices.gwsAppProvisioning.enabled	Specifies whether ingress is enabled for the component.	true or false	true
gwsServices.gwsAppProvisioning.service.ports.server	Specifies the service port of the component.	Value of the gwsServices.gwsAppProvisioning.service.ports.server parameter as described in Configure GWS Services.	80
gwsServices.gwsAppWorkspace.name	Specifies the name of the GWS Workspace Service deployment.	Value of the gwsServices.gwsAppWorkspace.name parameter as described in Configure GWS Services.	"gws-app-workspace"
gwsServices.gwsAppWorkspace.enabled	Specifies whether ingress is enabled for the component.	true or false	true
gwsServices.gwsAppWorkspace.service.ports.server	Specifies the service port of the component.	Value of the gwsServices.gwsAppWorkspace.service.ports.server parameter as described in Configure GWS Services.	80
gwsServices.gwsPlatformChat.name	Specifies the name of the GWS Chat Service deployment.	Value of the gwsServices.gwsPlatformChat.name parameter as described in Configure GWS Services.	gws-platform-chat
gwsServices.gwsPlatformChat.enabled	Specifies whether ingress is enabled for the component.	true or false	false
gwsServices.gwsPlatformChat.service.ports.server	Specifies the service port of the component.	Value of the gwsServices.gwsPlatformChat.service.ports.server parameter as described in Configure GWS Services.	80
gwsServices.gwsPlatformConfiguration.name	Specifies the name of the GWS Configuration Service deployment.	Value of the gwsServices.gwsPlatformConfiguration.name parameter as described in Configure GWS Services.	"gws-platform-configuration"
gwsServices.gwsPlatformConfiguration.enabled	Specifies whether ingress is enabled for the component.	true or false	true
gwsServices.gwsPlatformConfiguration.service.ports.server	Specifies the service port of the component.	Value of the gwsServices.gwsPlatformConfiguration.service.ports.server parameter as described in Configure GWS Services.	80
gwsServices.gwsPlatformDatacollector.name	Specifies the name of the GWS Data Collector Service deployment.	Value of the gwsServices.gwsPlatformDatacollector.name parameter as described in Configure GWS Services.	"gws-platform-datacollector"
gwsServices.gwsPlatformDatacollector.enabled	Specifies whether ingress is enabled for the component.	true or false	true
gwsServices.gwsPlatformDatacollector.service.ports.server	Specifies the service port of the component.	Value of the gwsServices.gwsPlatformDatacollector.service.ports.server parameter as described in Configure GWS Services.	80
gwsServices.gwsPlatformIxn.name	Specifies the name of the GWS Interaction Service deployment.	Value of the gwsServices.gwsPlatformIxn.name parameter as described in Configure GWS Services.	"gws-platform-ixn"
gwsServices.gwsPlatformIxn.enabled	Specifies whether ingress is enabled for the component.	true or false	true
gwsServices.gwsPlatformIxn.service.ports.server	Specifies the service port of the component.	Value of the gwsServices.gwsPlatformIxn.service.ports.server parameter as described in Configure GWS Services.	80
gwsServices.gwsPlatformOcs.name	Specifies the name of the GWS OCS Service deployment.	Value of the gwsServices.gwsPlatformOcs.name parameter as described in Configure GWS Services.	"gws-platform-ocs"
gwsServices.gwsPlatformOcs.enabled	Specifies whether ingress is enabled for the component.	true or false	true
gwsServices.gwsPlatformOcs.service.ports.server	Specifies the service port of the component.	Value of the gwsServices.gwsPlatformOcs.service.ports.server parameter as described in Configure GWS Services.	80
gwsServices.gwsPlatformSetting.name	Specifies the name of the GWS Setting Service deployment.	Value of the gwsServices.gwsPlatformSetting.name parameter as described in Configure GWS Services.	"gws-platform-setting"
gwsServices.gwsPlatformSetting.enabled	Specifies whether ingress is enabled for the component.	true or false	true
gwsServices.gwsPlatformSetting.service.ports.server	Specifies the service port of the component.	Value of the gwsServices.gwsPlatformSetting.service.ports.server as parameter described in Configure GWS Services.	80
gwsServices.gwsPlatformStatistics.name	Specifies the name of the GWS Statistics Service deployment.	Value of the gwsServices.gwsPlatformStatistics.name parameter as described in Configure GWS Services.	"gws-platform-statistics"
gwsServices.gwsPlatformStatistics.enabled	Specifies whether ingress is enabled for the component.	true or false	true
gwsServices.gwsPlatformStatistics.service.ports.server	Specifies the service port of the component.	Value of the gwsServices.gwsPlatformStatistics.service.ports.server parameter as described in Configure GWS Services.	80
gwsServices.gwsPlatformUcs.name	Specifies the name of the GWS UCS Service deployment.	Value of the gwsServices.gwsPlatformUcs.name parameter as described in Configure GWS Services.	"gws-platform-ucs"
gwsServices.gwsPlatformUcs.enabled	Specifies whether ingress is enabled for the component.	true or false	false
gwsServices.gwsPlatformUcs.service.ports.server	Specifies the service port of the component.	Value of the gwsServices.gwsPlatformUcs.service.ports.server parameter as described in Configure GWS Services.	80
gwsServices.gwsPlatformVoice.name	Specifies the name of the GWS Voice Service deployment.	Value of the gwsServices.gwsPlatformVoice.name parameter as described in Configure GWS Services.	"gws-platform-voice"
gwsServices.gwsPlatformVoice.enabled	Specifies whether ingress is enabled for the component.	true or false	true
gwsServices.gwsPlatformVoice.service.ports.server	Specifies the service port of the component.	Value of the gwsServices.gwsPlatformVoice.service.ports.server parameter as described in Configure GWS Services.	80

Configure Kubernetes

Create a Kubernetes secret for your API token from Consul. For more information about this token, see Consul's access control documentation.

kubectl create secret generic gws-secrets-green -n gws --from-literal='gws-consul-token=<token-from-consul>'

Configure security

To learn more about how security is configured for private edition, be sure to read Permissions and OpenShift security settings.

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 values.yaml file as 500:500:500, meaning the genesys user.

deploymentGlobals:
  securityContext:
    runAsUser: 500
    runAsGroup: 500
    fsGroup: 500
    runAsNonRoot: true

For details about these parameters and possible values, see deploymentGlobals.securityContext.* in the Parameters table above.

Next steps

• Deploy GWS Ingress
• Provision Genesys Web Services and Applications