Difference between revisions of "GWS/Current/GWSPEGuide/ConfigureIngress"

From Genesys Documentation
Jump to: navigation, search
 
(3 intermediate revisions by the same user not shown)
Line 6: Line 6:
 
|Section={{Section
 
|Section={{Section
 
|alignment=Vertical
 
|alignment=Vertical
−
|structuredtext={{NoteFormat|If you are deploying Web Services and Applications in a single namespace with other private edition services, then you do not need to deploy GWS ingress.|3}}
+
|structuredtext={{NoteFormat|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.|3}}
 
|Status=No
 
|Status=No
 
}}{{Section
 
}}{{Section
Line 12: Line 12:
 
|anchor=override
 
|anchor=override
 
|alignment=Vertical
 
|alignment=Vertical
−
|structuredtext=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.
+
|structuredtext=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 {{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}}.
 +
<!--
 
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=GWSPEGuide|topic=ConfigureIngress|anchor=security|display text=Configure security}} below.
 
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=GWSPEGuide|topic=ConfigureIngress|anchor=security|display text=Configure security}} below.
 +
-->
 
{{{!}} class="wikitable"
 
{{{!}} class="wikitable"
 
{{!}}+Parameters
 
{{!}}+Parameters
Line 23: Line 24:
 
!Valid values
 
!Valid values
 
!Default
 
!Default
−
{{!}}-
 
−
{{!}}podLabels
 
−
{{!}}Custom labels for each pod.
 
−
{{!}}A valid set of labels as "name: value"
 
−
{{!}}{}
 
−
{{!}}-
 
−
{{!}}podAnnotations
 
−
{{!}}Custom annotations for each pod.
 
−
{{!}}A valid set of annotations as "name: value"
 
−
{{!}}{}
 
−
{{!}}-
 
−
{{!}}priorityClassName
 
−
{{!}}The class name Kubernetes uses to determine the priority of the pods for this container deployment relative to other pods. See the [https://kubernetes.io/docs/concepts/scheduling-eviction/pod-priority-preemption/ Kubernetes documentation] for details.
 
−
{{!}}A valid priority class name
 
−
{{!}}""
 
 
{{!}}-
 
{{!}}-
 
{{!}}deploymentGlobals.deploymentTag
 
{{!}}deploymentGlobals.deploymentTag
Line 44: Line 30:
 
{{!}}"live"
 
{{!}}"live"
 
{{!}}-
 
{{!}}-
−
{{!}}deploymentGlobals.strategy
+
{{!}}sessionCookieName
−
{{!}}The strategy GWS Ingress uses to upgrade its containers.
+
{{!}}The cookie name for sticky sessions.
−
{{!}}RollingUpdate or Recreate
+
{{!}}A valid cookie name
−
{{!}}"RollingUpdate"
+
{{!}}"GWSSESSIONID"
 
{{!}}-
 
{{!}}-
−
{{!}}deploymentGlobals.securityContext.runAsNonRoot
+
{{!}}entryPoints.internal.ingress.enabled
−
{{!}}Specifies whether the container must run as a non-root user.
+
{{!}}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 or false
 
{{!}}true
 
{{!}}true
 
{{!}}-
 
{{!}}-
−
{{!}}deploymentGlobals.securityContext.runAsUser
+
{{!}}{{AnchorDiv|entrypoints.internal.ingress.ingressClassName}}entryPoints.internal.ingress.ingressClassName
−
{{!}}The user ID to run the entry point of the container process. In OpenShift, if your deployment uses arbitrary UIDs set this value to null.
+
{{!}}Defines which controller implements the Ingress resource. The value is directly propagated to the ingressClassName field of the Kubernetes Ingress object. See [https://kubernetes.io/docs/concepts/services-networking/ingress/#the-ingress-resource Ingress] and [https://kubernetes.io/docs/concepts/services-networking/ingress/#ingress-class Ingress class] in the Kubernetes documentation for details.
−
{{!}}A valid user ID or null
+
{{!}}A valid IngressClass
−
{{!}}500
+
{{!}}""
 
{{!}}-
 
{{!}}-
−
{{!}}deploymentGlobals.securityContext.runAsGroup
+
{{!}}entryPoints.internal.ingress.annotations
−
{{!}}The group ID to run the entry point of the container process. In OpenShift, if your deployment uses arbitrary UIDs set this value to null.
+
{{!}}Custom annotations for internal ingress.
−
{{!}}A valid group ID or null
+
{{!}}A valid set of annotations as "name: value"
−
{{!}}500
+
{{!}}{}
 
{{!}}-
 
{{!}}-
−
{{!}}deploymentGlobals.securityContext.fsGroup
+
{{!}}entryPoints.internal.ingress.hosts
−
{{!}}A supplemental group ID that applies to all containers in a pod. In OpenShift, if your deployment uses arbitrary UIDs set this value to null.
+
{{!}}List of internal ingress hostnames.
−
{{!}}A valid group ID or null
+
{{!}}Valid hostnames
−
{{!}}500
+
{{!}}["gws-int.genesys.com"]
 
{{!}}-
 
{{!}}-
−
{{!}}nodeSelector
+
{{!}}entryPoints.internal.ingress.tls
−
{{!}}The labels Kubernetes uses to assign pods to nodes. See the [https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/#nodeselector Kubernetes documentation] for details.
+
{{!}}List of TLS configurations for internal ingress. See {{Link-SomewhereInThisVersion|manual=GWSPEGuide|topic=Planning|anchor=Network|display text=Network requirements}} for an example configuration.
−
{{!}}Valid nodeSelector settings.
+
{{!}}Valid TLS configurations
−
{{!}}{}
+
{{!}}[]
 
{{!}}-
 
{{!}}-
−
{{!}}gwsServiceProxy.deployment.replicaCount
+
{{!}}entryPoints.external.ingress.enabled
−
{{!}}The number of pod replicas in this deployment.
+
{{!}}Specifies whether external ingress is enabled. Set this value to false if you are deploying Genesys Web Services and Applications in a single namespace.
−
{{!}}A number greater than 0
+
{{!}}true or false
−
{{!}}2
+
{{!}}true
 
{{!}}-
 
{{!}}-
−
{{!}}gwsServiceProxy.image.registry
+
{{!}}{{AnchorDiv|entryPoints.external.ingress.ingressClassName}}entryPoints.external.ingress.ingressClassName
−
{{!}}The Docker registry from which Kubernetes pulls images.
+
{{!}}Defines which controller implements the Ingress resource. The value is directly propagated to the ingressClassName field of the Kubernetes Ingress object. See [https://kubernetes.io/docs/concepts/services-networking/ingress/#the-ingress-resource Ingress] and [https://kubernetes.io/docs/concepts/services-networking/ingress/#ingress-class Ingress class] in the Kubernetes documentation for details.
−
{{!}}A valid registry URL
+
{{!}}A valid IngressClass
 
{{!}}""
 
{{!}}""
 
{{!}}-
 
{{!}}-
−
{{!}}gwsServiceProxy.image.repository
+
{{!}}entryPoints.external.ingress.annotations
−
{{!}}The name of the Docker registry repository.
+
{{!}}Custom annotations for external ingress.
−
{{!}}A valid repository name
+
{{!}}A valid set of annotations as "name: value"
−
{{!}}"gws-system-nginx"
+
{{!}}{}
 
{{!}}-
 
{{!}}-
−
{{!}}gwsServiceProxy.image.pullPolicy
+
{{!}}entryPoints.external.ingress.hosts
−
{{!}}Specifies when Kubernetes pulls images from the registry on start up.
+
{{!}}List of external ingress hostnames.
−
{{!}}IfNotPresent or Always
+
{{!}}Valid hostnames
−
{{!}}"Always"
+
{{!}}["gws.genesys.com"]
 
{{!}}-
 
{{!}}-
−
{{!}}gwsServiceProxy.image.imagePullSecrets
+
{{!}}entryPoints.external.ingress.tls
−
{{!}}The secret Kubernetes uses to get credentials to pull images from the registry.
+
{{!}}List of TLS configurations for external ingress. See {{Link-SomewhereInThisVersion|manual=GWSPEGuide|topic=Planning|anchor=Network|display text=Network requirements}} for an example configuration.
−
{{!}}A valid secret
+
{{!}}Valid TLS configurations
 
{{!}}[]
 
{{!}}[]
 
{{!}}-
 
{{!}}-
−
{{!}}gwsServiceProxy.context.sessionCookieName
+
{{!}}gwsServices.gwsAppProvisioning.name
−
{{!}}The cookie name for sticky sessions.
+
{{!}}Specifies the name of the '''GWS Provisioning Service''' deployment.
−
{{!}}A valid cookie name
+
{{!}}Value of the '''gwsServices.gwsAppProvisioning.name''' parameter as described in {{Link-AnywhereElse|product=GWS|version=Current|manual=GWSPEGuide|topic=Configure|display text=Configure GWS Services}}.
−
{{!}}"GWSSESSIONID"
+
{{!}}"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 {{Link-AnywhereElse|product=GWS|version=Current|manual=GWSPEGuide|topic=Configure|display text=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 {{Link-AnywhereElse|product=GWS|version=Current|manual=GWSPEGuide|topic=Configure|display text=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 {{Link-AnywhereElse|product=GWS|version=Current|manual=GWSPEGuide|topic=Configure|display text=Configure GWS Services}}.
 +
{{!}}80
 
{{!}}-
 
{{!}}-
−
{{!}}gwsServiceProxy.context.env.CONSUL_PORT
+
{{!}}gwsServices.gwsPlatformChat.name
−
{{!}}The port of the local Consul agent.
+
{{!}}Specifies the name of the '''GWS Chat Service''' deployment.
−
{{!}}A valid port
+
{{!}}Value of the '''gwsServices.gwsPlatformChat.name''' parameter as described in {{Link-AnywhereElse|product=GWS|version=Current|manual=GWSPEGuide|topic=Configure|display text=Configure GWS Services}}.
−
{{!}}8500
+
{{!}}gws-platform-chat
 
{{!}}-
 
{{!}}-
−
{{!}}gwsServiceProxy.context.env.GWS_NGINX_ENABLE_MAPPING
+
{{!}}gwsServices.gwsPlatformChat.enabled
−
{{!}}Specifies whether mapping is enabled in Nginx.
+
{{!}}Specifies whether ingress is enabled for the component.
 
{{!}}true or false
 
{{!}}true or false
 
{{!}}false
 
{{!}}false
 
{{!}}-
 
{{!}}-
−
{{!}}gwsServiceProxy.context.env.GWS_NGINX_CONSUL_SERVICE
+
{{!}}gwsServices.gwsPlatformChat.service.ports.server
−
{{!}}The name of the service to register in Consul.
+
{{!}}Specifies the service port of the component.
−
{{!}}A valid name
+
{{!}}Value of the '''gwsServices.gwsPlatformChat.service.ports.server''' parameter as described in {{Link-AnywhereElse|product=GWS|version=Current|manual=GWSPEGuide|topic=Configure|display text=Configure GWS Services}}.
−
{{!}}"system-nginx"
+
{{!}}80
 
{{!}}-
 
{{!}}-
−
{{!}}gwsServiceProxy.context.env.GWS_CONSUL_KV_PREFIX
+
{{!}}gwsServices.gwsPlatformConfiguration.name
−
{{!}}The prefix used to locate GWS Ingress data in the Consul KV datastore.
+
{{!}}Specifies the name of the '''GWS Configuration Service''' deployment.
−
{{!}}String
+
{{!}}Value of the '''gwsServices.gwsPlatformConfiguration.name''' parameter as described in {{Link-AnywhereElse|product=GWS|version=Current|manual=GWSPEGuide|topic=Configure|display text=Configure GWS Services}}.
−
{{!}}"gws"
+
{{!}}"gws-platform-configuration"
 
{{!}}-
 
{{!}}-
−
{{!}}gwsServiceProxy.livenessProbe.startupDelay
+
{{!}}gwsServices.gwsPlatformConfiguration.enabled
−
{{!}}Specifies the time in seconds to wait before performing the first liveness probe.
+
{{!}}Specifies whether ingress is enabled for the component.
−
{{!}}Number
+
{{!}}true or false
−
{{!}}5
+
{{!}}true
 
{{!}}-
 
{{!}}-
−
{{!}}gwsServiceProxy.livenessProbe.checkInterval
+
{{!}}gwsServices.gwsPlatformConfiguration.service.ports.server
−
{{!}}Specifies the interval in seconds between liveness probes.
+
{{!}}Specifies the service port of the component.
−
{{!}}Number
+
{{!}}Value of the '''gwsServices.gwsPlatformConfiguration.service.ports.server''' parameter as described in {{Link-AnywhereElse|product=GWS|version=Current|manual=GWSPEGuide|topic=Configure|display text=Configure GWS Services}}.
−
{{!}}10
+
{{!}}80
 
{{!}}-
 
{{!}}-
−
{{!}}gwsServiceProxy.readinessProbe.startupDelay
+
{{!}}gwsServices.gwsPlatformDatacollector.name
−
{{!}}Specifies the time in seconds to wait before performing the first readiness probe.
+
{{!}}Specifies the name of the '''GWS Data Collector Service''' deployment.
−
{{!}}Number
+
{{!}}Value of the '''gwsServices.gwsPlatformDatacollector.name''' parameter as described in {{Link-AnywhereElse|product=GWS|version=Current|manual=GWSPEGuide|topic=Configure|display text=Configure GWS Services}}.
−
{{!}}15
+
{{!}}"gws-platform-datacollector"
 
{{!}}-
 
{{!}}-
−
{{!}}gwsServiceProxy.readinessProbe.checkInterval
+
{{!}}gwsServices.gwsPlatformDatacollector.enabled
−
{{!}}Specifies the interval in seconds between readiness probes.
+
{{!}}Specifies whether ingress is enabled for the component.
−
{{!}}Number
+
{{!}}true or false
−
{{!}}20
+
{{!}}true
 
{{!}}-
 
{{!}}-
−
{{!}}gwsServiceProxy.service.ports
+
{{!}}gwsServices.gwsPlatformDatacollector.service.ports.server
−
{{!}}The HTTP ports used by service.
+
{{!}}Specifies the service port of the component.
−
{{!}}A valid set of ports as "name: value","port: value"
+
{{!}}Value of the '''gwsServices.gwsPlatformDatacollector.service.ports.server''' parameter as described in {{Link-AnywhereElse|product=GWS|version=Current|manual=GWSPEGuide|topic=Configure|display text=Configure GWS Services}}.
−
{{!}}[{"name": "gws-service-proxy", "port": 80, "targetPort": 8080}, {"name": "gws-service-proxy-ext", "port": 81, "targetPort": 8081}]
+
{{!}}80
 
{{!}}-
 
{{!}}-
−
{{!}}entryPoints.internal.service.annotations
+
{{!}}gwsServices.gwsPlatformIxn.name
−
{{!}}Custom annotations for the service.
+
{{!}}Specifies the name of the '''GWS Interaction Service''' deployment.
−
{{!}}A valid set of annotations as "name: value"
+
{{!}}Value of the '''gwsServices.gwsPlatformIxn.name''' parameter as described in {{Link-AnywhereElse|product=GWS|version=Current|manual=GWSPEGuide|topic=Configure|display text=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 {{Link-AnywhereElse|product=GWS|version=Current|manual=GWSPEGuide|topic=Configure|display text=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 {{Link-AnywhereElse|product=GWS|version=Current|manual=GWSPEGuide|topic=Configure|display text=Configure GWS Services}}.
 +
{{!}}"gws-platform-ocs"
 
{{!}}-
 
{{!}}-
−
{{!}}entryPoints.internal.ingress.enabled
+
{{!}}gwsServices.gwsPlatformOcs.enabled
−
{{!}}Specifies whether internal ingress is enabled. Set this value to false if you are deploying Web Services and Applications in a single namespace.
+
{{!}}Specifies whether ingress is enabled for the component.
 
{{!}}true or false
 
{{!}}true or false
 
{{!}}true
 
{{!}}true
 
{{!}}-
 
{{!}}-
−
{{!}}entryPoints.internal.ingress.annotations
+
{{!}}gwsServices.gwsPlatformOcs.service.ports.server
−
{{!}}Custom annotations for internal ingress.
+
{{!}}Specifies the service port of the component.
−
{{!}}A valid set of annotations as "name: value"
+
{{!}}Value of the '''gwsServices.gwsPlatformOcs.service.ports.server''' parameter as described in {{Link-AnywhereElse|product=GWS|version=Current|manual=GWSPEGuide|topic=Configure|display text=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 {{Link-AnywhereElse|product=GWS|version=Current|manual=GWSPEGuide|topic=Configure|display text=Configure GWS Services}}.
 +
{{!}}"gws-platform-setting"
 
{{!}}-
 
{{!}}-
−
{{!}}entryPoints.internal.ingress.paths
+
{{!}}gwsServices.gwsPlatformSetting.enabled
−
{{!}}Paths to internal ingress, relative to the hostnames.
+
{{!}}Specifies whether ingress is enabled for the component.
−
{{!}}Valid paths
+
{{!}}true or false
−
{{!}}["/"]
+
{{!}}true
 
{{!}}-
 
{{!}}-
−
{{!}}entryPoints.internal.ingress.hosts
+
{{!}}gwsServices.gwsPlatformSetting.service.ports.server
−
{{!}}List of internal ingress hostnames.
+
{{!}}Specifies the service port of the component.
−
{{!}}Valid hostnames
+
{{!}}Value of the '''gwsServices.gwsPlatformSetting.service.ports.server''' as parameter described in {{Link-AnywhereElse|product=GWS|version=Current|manual=GWSPEGuide|topic=Configure|display text=Configure GWS Services}}.
−
{{!}}["gws-int.genesys.com"]
+
{{!}}80
 
{{!}}-
 
{{!}}-
−
{{!}}entryPoints.internal.ingress.tls
+
{{!}}gwsServices.gwsPlatformStatistics.name
−
{{!}}List of TLS configurations for internal ingress. See {{Link-SomewhereInThisVersion|manual=GWSPEGuide|topic=Planning|anchor=Network|display text=Network requirements}} for an example configuration.
+
{{!}}Specifies the name of the '''GWS Statistics Service''' deployment.
−
{{!}}Valid TLS configurations
+
{{!}}Value of the '''gwsServices.gwsPlatformStatistics.name''' parameter as described in {{Link-AnywhereElse|product=GWS|version=Current|manual=GWSPEGuide|topic=Configure|display text=Configure GWS Services}}.
−
{{!}}[]
+
{{!}}"gws-platform-statistics"
 
{{!}}-
 
{{!}}-
−
{{!}}entryPoints.external.ingress.enabled
+
{{!}}gwsServices.gwsPlatformStatistics.enabled
−
{{!}}Specifies whether external ingress is enabled. Set this value to false if you are deploying Web Services and Applications in a single namespace.
+
{{!}}Specifies whether ingress is enabled for the component.
 
{{!}}true or false
 
{{!}}true or false
 
{{!}}true
 
{{!}}true
 
{{!}}-
 
{{!}}-
−
{{!}}entryPoints.external.ingress.annotations
+
{{!}}gwsServices.gwsPlatformStatistics.service.ports.server
−
{{!}}Custom annotations for external ingress.
+
{{!}}Specifies the service port of the component.
−
{{!}}A valid set of annotations as "name: value"
+
{{!}}Value of the '''gwsServices.gwsPlatformStatistics.service.ports.server''' parameter as described in {{Link-AnywhereElse|product=GWS|version=Current|manual=GWSPEGuide|topic=Configure|display text=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 {{Link-AnywhereElse|product=GWS|version=Current|manual=GWSPEGuide|topic=Configure|display text=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 {{Link-AnywhereElse|product=GWS|version=Current|manual=GWSPEGuide|topic=Configure|display text=Configure GWS Services}}.
 +
{{!}}80
 
{{!}}-
 
{{!}}-
−
{{!}}entryPoints.external.ingress.paths
+
{{!}}gwsServices.gwsPlatformVoice.name
−
{{!}}Paths to external ingress, relative to the hostnames.
+
{{!}}Specifies the name of the '''GWS Voice Service''' deployment.
−
{{!}}Valid paths
+
{{!}}Value of the '''gwsServices.gwsPlatformVoice.name''' parameter as described in {{Link-AnywhereElse|product=GWS|version=Current|manual=GWSPEGuide|topic=Configure|display text=Configure GWS Services}}.
−
{{!}}["/"]
+
{{!}}"gws-platform-voice"
 
{{!}}-
 
{{!}}-
−
{{!}}entryPoints.external.ingress.hosts
+
{{!}}gwsServices.gwsPlatformVoice.enabled
−
{{!}}List of external ingress hostnames.
+
{{!}}Specifies whether ingress is enabled for the component.
−
{{!}}Valid hostnames
+
{{!}}true or false
−
{{!}}["gws.genesys.com"]
+
{{!}}true
 
{{!}}-
 
{{!}}-
−
{{!}}entryPoints.external.ingress.tls
+
{{!}}gwsServices.gwsPlatformVoice.service.ports.server
−
{{!}}List of TLS configurations for external ingress. See {{Link-SomewhereInThisVersion|manual=GWSPEGuide|topic=Planning|anchor=Network|display text=Network requirements}} for an example configuration.
+
{{!}}Specifies the service port of the component.
−
{{!}}Valid TLS configurations
+
{{!}}Value of the '''gwsServices.gwsPlatformVoice.service.ports.server''' parameter as described in {{Link-AnywhereElse|product=GWS|version=Current|manual=GWSPEGuide|topic=Configure|display text=Configure GWS Services}}.
−
{{!}}[]
+
{{!}}80
 
{{!}}}
 
{{!}}}
 
|Status=No
 
|Status=No
Line 213: Line 259:
 
kubectl create secret generic gws-secrets-green -n gws --from-literal='gws-consul-token=<token-from-consul>'
 
kubectl create secret generic gws-secrets-green -n gws --from-literal='gws-consul-token=<token-from-consul>'
 
</syntaxhighlight>
 
</syntaxhighlight>
−
|Status=No
+
|Status=Yes
 
}}{{Section
 
}}{{Section
 
|sectionHeading=Configure security
 
|sectionHeading=Configure security
 
|anchor=security
 
|anchor=security
 
|alignment=Vertical
 
|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 {{Link-AnywhereElse|product=PrivateEdition|version=Current|manual=PEGuide|topic=Prerequisites|display text=Permissions}} and {{Link-AnywhereElse|product=PrivateEdition|version=Current|manual=PEGuide|topic=ConfigSecurity}}.
  
 
The security context settings define the privilege and access control settings for pods and containers.
 
The security context settings define the privilege and access control settings for pods and containers.
Line 231: Line 277:
 
     runAsNonRoot: true
 
     runAsNonRoot: true
 
</syntaxhighlight>
 
</syntaxhighlight>
−
 
+
<!--
 
===Arbitrary UIDs in OpenShift===
 
===Arbitrary UIDs in OpenShift===
 
If you want to use arbitrary UIDs in your OpenShift deployment, you must override the '''securityContext''' settings in the '''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 '''values.yaml''' file, so that you do not define any specific IDs.
Line 241: Line 287:
 
     fsGroup: null
 
     fsGroup: null
 
     runAsNonRoot: true
 
     runAsNonRoot: true
−
</syntaxhighlight>For details about these parameters and possible values, see '''deploymentGlobals.securityContext.*''' in the {{Link-SomewhereInThisVersion|manual=GWSPEGuide|topic=ConfigureIngress|anchor=override|display text=Parameters}} table above.
+
</syntaxhighlight>
−
|Status=No
+
-->
 +
For details about these parameters and possible values, see '''deploymentGlobals.securityContext.*''' in the {{Link-SomewhereInThisVersion|manual=GWSPEGuide|topic=ConfigureIngress|anchor=override|display text=Parameters}} table above.
 +
|Status=Yes
 
}}{{Section
 
}}{{Section
 
|sectionHeading=Next steps
 
|sectionHeading=Next steps
Line 249: Line 297:
 
|structuredtext=*{{Link-SomewhereInThisVersion|manual=GWSPEGuide|topic=DeployIngress}}
 
|structuredtext=*{{Link-SomewhereInThisVersion|manual=GWSPEGuide|topic=DeployIngress}}
 
*{{Link-SomewhereInThisVersion|manual=GWSPEGuide|topic=Provision}}
 
*{{Link-SomewhereInThisVersion|manual=GWSPEGuide|topic=Provision}}
−
*{{Link-SomewhereInThisVersion|manual=GWSPEGuide|topic=ProvisionAS}}
 
 
|Status=No
 
|Status=No
 
}}
 
}}
 
}}
 
}}

Latest revision as of 19:30, December 22, 2023

This topic is part of the manual Genesys Web Services and Applications Private Edition Guide for version Current of Genesys Web Services and Applications.

Learn how to configure GWS Ingress.

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

Retrieved from "https://all.docs.genesys.com/GWS/Current/GWSPEGuide/ConfigureIngress (2025-07-14 22:28:00)"
Comments or questions about this documentation? Contact us for support!