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

From Genesys Documentation
Jump to: navigation, search
(Published)
(Published)
Line 6: Line 6:
 
|ComingSoon=No
 
|ComingSoon=No
 
|Section={{Section
 
|Section={{Section
−
|sectionHeading=Prerequisites
+
|sectionHeading=Create API clients
 +
|anchor=api
 
|alignment=Vertical
 
|alignment=Vertical
−
|structuredtext====Deploy Genesys Authentication===
+
|structuredtext=Use the Genesys Authentication operations API to {{Link-AnywhereElse|product=AUTH|version=Current|manual=AuthPEGuide|topic=Provision|anchor=CreateAPI|display text=create API clients}} for the GWS services. Refer to the '''API clients''' table for the '''name''' and '''client_id''' values you must use in the API request. Make note of '''encrypted_client_secret''' in the responses - you need this value to set the related parameter in {{Link-SomewhereInThisVersion|manual=GWSPEGuide|topic=Configure|anchor=override|display text=Override Helm chart values}}.
−
The common Authentication Service must be deployed first.
+
{{{!}} class="wikitable"
−
===Secret Configuration for Pulling Image===
+
{{!}}+API clients
−
You might already have you secret created.
+
!Service
 +
!name
 +
!client_id
 +
!Helm chart parameter
 +
{{!}}-
 +
{{!}}Provisioning Service
 +
{{!}}gws-app-provisioning
 +
{{!}}gws-app-provisioning
 +
{{!}}secrets.gws-app-provisioning-client-secret
 +
{{!}}-
 +
{{!}}Workspace Service
 +
{{!}}gws-app-workspace
 +
{{!}}gws-app-workspace
 +
{{!}}secrets.gws-app-workspace-client-secret
 +
{{!}}-
 +
{{!}}Configuration Service
 +
{{!}}gws-platform-configuration
 +
{{!}}gws-platform-configuration
 +
{{!}}secrets.gws-platform-configuration-client-secret
 +
{{!}}-
 +
{{!}}Data Collector Service
 +
{{!}}gws-platform-datacollector
 +
{{!}}gws-platform-datacollector
 +
{{!}}secrets.gws-platform-datacollector-client-secret
 +
{{!}}-
 +
{{!}}Interaction Service
 +
{{!}}gws-platform-ixn
 +
{{!}}gws-platform-ixn
 +
{{!}}secrets.gws-platform-ixn-client-secret
 +
{{!}}-
 +
{{!}}OCS Service
 +
{{!}}gws-platform-ocs
 +
{{!}}gws-platform-ocs
 +
{{!}}secrets.gws-platform-ocs-client-secret
 +
{{!}}-
 +
{{!}}Setting Service
 +
{{!}}gws-platform-setting
 +
{{!}}gws-platform-setting
 +
{{!}}secrets.gws-platform-setting-client-secret
 +
{{!}}-
 +
{{!}}Statistics Service
 +
{{!}}gws-platform-statistics
 +
{{!}}gws-platform-statistics
 +
{{!}}secrets.gws-platform-statistics-client-secret
 +
{{!}}-
 +
{{!}}Voice Service
 +
{{!}}gws-platform-voice
 +
{{!}}gws-platform-voice
 +
{{!}}secrets.gws-platform-voice-client-secret
 +
{{!}}}
 +
<br />
 +
|Status=No
 +
}}{{Section
 +
|sectionHeading=Configure a secret to access JFrog
 +
|anchor=Secret
 +
|alignment=Vertical
 +
|structuredtext=If you haven't done so already, create a secret for accessing the JFrog registry:
 +
<source lang="text">kubectl create secret docker-registry <credential-name> --docker-server=<docker repo> --docker-username=<username> --docker-password=<password> --docker-email=<emailid></source>
  
−
One of the way to do it is by using the following command:
+
Now map the secret to the default service account:
−
oc create secret docker-registry <credential-name> --docker-server=<docker repo> --docker-username=<username> --docker-password=<password> --docker-email=<emailid>
+
<source lang="text">kubectl secrets link default <credential-name> --for=pull</source>
−
You have to execute the following command to map the secret to the default service account:
 
−
oc secrets link default <credential-name> --for=pull
 
 
|Status=No
 
|Status=No
 
}}{{Section
 
}}{{Section
−
|sectionHeading=Prepare your environment
+
|sectionHeading=Override Helm chart values
 +
|anchor=override
 
|alignment=Vertical
 
|alignment=Vertical
−
|structuredtext====Check the Cluster===
+
|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 Web Services and Applications (GWS).
−
Run the following command to get the version of the cluster:
 
−
oc get clusterversion
 
  
−
===Create a New Project===
+
For more information about how to override Helm chart values, see {{SuiteLevelLink|helmoverride}} in the ''Setting up Genesys Engage Cloud Private Edition'' guide.
−
Use the following command to create a new project:
 
−
oc new -project gws
 
  
−
===Enable Security Context===
+
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=Configure|anchor=security|display text=Configure security}} below.
−
Use the following command to enable the security context to the default service account:
+
{{AnchorDiv|globalP}}
−
oc adm policy add-scc-to-user genesys-restricted -z default -n gws
+
{{{!}} class="wikitable" style="table-layout: fixed; overflow-wrap: break-word;" {{!}}
 +
{{!}}+Global parameters
 +
!Parameter
 +
!Description
 +
!Valid values
 +
!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 labels as "name: value"
 +
{{!}}{}
 +
{{!}}-
 +
{{!}}imageGlobals.registry
 +
{{!}}The Docker registry from which Kubernetes pulls images.
 +
{{!}}A valid registry URL
 +
{{!}}""
 +
{{!}}-
 +
{{!}}imageGlobals.pullPolicy
 +
{{!}}Specifies when Kubernetes pulls images from the registry on start up.
 +
{{!}}IfNotPresent or Always
 +
{{!}}"Always"
 +
{{!}}-
 +
{{!}}imageGlobals.imagePullSecrets
 +
{{!}}The secret Kubernetes uses to get credentials to pull images from the registry.
 +
{{!}}A valid secret
 +
{{!}}[]
 +
{{!}}-
 +
{{!}}deploymentGlobals.deploymentTag
 +
{{!}}A suffix for the names of Kubernetes objects created by the Helm chart.
 +
{{!}}{{Editgrn open}}JM: What are the valid values?{{Editgrn close}}
 +
{{!}}"live"
 +
{{!}}-
 +
{{!}}deploymentGlobals.strategy
 +
{{!}}The strategy GWS uses to upgrade its containers.
 +
{{!}}RollingUpdate or Recreate
 +
{{!}}"RollingUpdate"
 +
{{!}}-
 +
{{!}}deploymentGlobals.location
 +
{{!}}Location of the deployment.
 +
{{!}}A valid location
 +
{{!}}"/USW1"
 +
{{!}}-
 +
{{!}}deploymentGlobals.securityContext.runAsNonRoot
 +
{{!}}Specifies whether the container must run as a non-root user.
 +
{{!}}true or false
 +
{{!}}true
 +
{{!}}-
 +
{{!}}deploymentGlobals.securityContext.runAsUser
 +
{{!}}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.
 +
{{!}}A valid user ID or null
 +
{{!}}500
 +
{{!}}-
 +
{{!}}deploymentGlobals.securityContext.runAsGroup
 +
{{!}}The group ID to run the entry point of the container process. In OpenShift, if your deployment uses arbitrary UIDs set this value to 0.
 +
{{!}}A valid group ID or null
 +
{{!}}500
 +
{{!}}-
 +
{{!}}deploymentGlobals.securityContext.fsGroup
 +
{{!}}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.
 +
{{!}}A valid group ID or null
 +
{{!}}500
 +
{{!}}-
 +
{{!}}serviceGlobals.type
 +
{{!}}The service type for all services.
 +
{{!}}ClusterIP, NodePort, or LoadBalancer
 +
{{!}}"ClusterIP"
 +
{{!}}-
 +
{{!}}serviceGlobals.labels
 +
{{!}}Custom labels to be added for all services.
 +
{{!}}A valid set of labels as "name: value"
 +
{{!}}{}
 +
{{!}}-
 +
{{!}}serviceGlobals.annotations
 +
{{!}}Custom annotations to be added for all services.
 +
{{!}}A valid set of annotations as "name: value"
 +
{{!}}{}
 +
{{!}}-
 +
{{!}}nodeSelector
 +
{{!}}The labels Kubernetes uses to assign pods to nodes.
 +
{{!}}Valid nodeSelector settings. See the [https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/#nodeselector Kubernetes documentation] for details.
 +
{{!}}{}
 +
{{!}}-
 +
{{!}}tolerations
 +
{{!}}The tolerations Kubernetes uses for advanced pod scheduling.
 +
{{!}}Valid tolerations settings. See the [https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/ Kubernetes documentation] for details.
 +
{{!}}{}
 +
{{!}}-
 +
{{!}}dnsConfig
 +
{{!}}The DNS configuration for pods.
 +
{{!}}Valid DNS configuration settings. See the [https://kubernetes.io/docs/concepts/services-networking/dns-pod-service/ Kubernetes documentation] for details.
 +
{{!}}{}
 +
{{!}}-
 +
{{!}}elasticSearch.address
 +
{{!}}The fully qualified domain name or IP of the Elasticsearch cluster.
 +
{{!}}A valid address
 +
{{!}}""
 +
{{!}}-
 +
{{!}}elasticSearch.port
 +
{{!}}The Elasticsearch port.
 +
{{!}}A valid port
 +
{{!}}9200
 +
{{!}}-
 +
{{!}}elasticSearch.enableTls
 +
{{!}}Enable or disable TLS connection to the Elasticsearch cluster.
 +
{{!}}true or false
 +
{{!}}false
 +
{{!}}-
 +
{{!}}postgres.address
 +
{{!}}The fully qualified domain name or IP of the PostgreSQL server.
 +
{{!}}A valid address
 +
{{!}}""
 +
{{!}}-
 +
{{!}}postgres.db
 +
{{!}}The name of the PostgreSQL database.
 +
{{!}}A valid database name
 +
{{!}}""
 +
{{!}}-
 +
{{!}}redis.address
 +
{{!}}The Redis cluster host name.
 +
{{!}}A valid address
 +
{{!}}""
 +
{{!}}-
 +
{{!}}redis.port
 +
{{!}}The Redis port.
 +
{{!}}A valid port
 +
{{!}}6379
 +
{{!}}-
 +
{{!}}redis.enableTls
 +
{{!}}Enable or disable a TLS connection to the Redis cluster.
 +
{{!}}true or false
 +
{{!}}false
 +
{{!}}-
 +
{{!}}consul.port
 +
{{!}}The port of the local Consul agent.
 +
{{!}}A valid port
 +
{{!}}8500
 +
{{!}}-
 +
{{!}}consul.kv_prefix
 +
{{!}}The prefix used to locate GWS data in the Consul KV datastore.
 +
{{!}}String
 +
{{!}}"gws"
 +
{{!}}-
 +
{{!}}prometheus.metricServer.enabled
 +
{{!}}Enable annotation-based discovery to scrape metrics.
 +
{{!}}true or false
 +
{{!}}false
 +
{{!}}-
 +
{{!}}secrets.gws-redis-password
 +
{{!}}The password to access the Redis cluster.
 +
{{!}}A valid password
 +
{{!}}""
 +
{{!}}-
 +
{{!}}secrets.gws-consul-token
 +
{{!}}The API token to access Consul.
 +
{{!}}A valid API token
 +
{{!}}""
 +
{{!}}-
 +
{{!}}secrets.gws-postgres-username
 +
{{!}}The username to access the PostgreSQL database.
 +
{{!}}A valid username
 +
{{!}}""
 +
{{!}}-
 +
{{!}}secrets.gws-postgres-password
 +
{{!}}The password to access the PostgreSQL database
 +
{{!}}A valid password
 +
{{!}}""
 +
{{!}}-
 +
{{!}}secrets.agentsetup-postgres-username
 +
{{!}}The username to access the PostgreSQL database for Agent Setup.
 +
{{!}}A valid username
 +
{{!}}""
 +
{{!}}-
 +
{{!}}secrets.agentsetup-postgres-password
 +
{{!}}The password to access the PostgreSQL database for Agent Setup.
 +
{{!}}A valid password
 +
{{!}}""
 +
{{!}}-
 +
{{!}}secrets.gws-app-provisioning-client-secret
 +
{{!}}The encrypted client secret generated by Genesys Authentication for the gws-app-provisioning component. See {{Link-SomewhereInThisVersion|manual=GWSPEGuide|topic=Configure|anchor=api|display text=Create API clients}}.
 +
{{!}}A valid client secret
 +
{{!}}""
 +
{{!}}-
 +
{{!}}secrets.gws-app-workspace-client-secret
 +
{{!}}The encrypted client secret generated by Genesys Authentication for the gws-app-workspace component. See {{Link-SomewhereInThisVersion|manual=GWSPEGuide|topic=Configure|anchor=api|display text=Create API clients}}.
 +
{{!}}A valid client secret
 +
{{!}}""
 +
{{!}}-
 +
{{!}}secrets.gws-platform-configuration-client-secret
 +
{{!}}The encrypted client secret generated by Genesys Authentication for the gws-platform-configuration component.
 +
{{!}}A valid client secret
 +
{{!}}""
 +
{{!}}-
 +
{{!}}secrets.gws-platform-datacollector-client-secret
 +
{{!}}The encrypted client secret generated by Genesys Authentication for the gws-platform-datacollector component.
 +
{{!}}A valid client secret
 +
{{!}}""
 +
{{!}}-
 +
{{!}}secrets.gws-platform-ixn-client-secret
 +
{{!}}The encrypted client secret generated by Genesys Authentication for the gws-platform-ixn component.
 +
{{!}}A valid client secret
 +
{{!}}""
 +
{{!}}-
 +
{{!}}secrets.gws-platform-ocs-client-secret
 +
{{!}}The encrypted client secret generated by Genesys Authentication for the gws-platform-ocs component.
 +
{{!}}A valid client secret
 +
{{!}}""
 +
{{!}}-
 +
{{!}}secrets.gws-platform-setting-client-secret
 +
{{!}}The encrypted client secret generated by Genesys Authentication for the gws-platform-setting component.
 +
{{!}}A valid client secret
 +
{{!}}""
 +
{{!}}-
 +
{{!}}secrets.gws-platform-statistics-client-secret
 +
{{!}}The encrypted client secret generated by Genesys Authentication for the gws-platform-statistics component.
 +
{{!}}A valid client secret
 +
{{!}}""
 +
{{!}}-
 +
{{!}}secrets.gws-platform-voice-client-secret
 +
{{!}}The encrypted client secret generated by Genesys Authentication for the gws-platform-voice component.
 +
{{!}}A valid client secret
 +
{{!}}""
 +
{{!}}-
 +
{{!}}secrets.ops-username
 +
{{!}}The username of an operational user.
 +
{{!}}A valid username
 +
{{!}}""
 +
{{!}}-
 +
{{!}}secrets.ops-password
 +
{{!}}The encrypted password of the operational user.
 +
{{!}}A valid password
 +
{{!}}""
 +
<!--{{!}}-
 +
{{!}}secrets.gws-screen-recording-public-secret
 +
{{!}}{{Editgrn open}}JM: What is the description?{{Editgrn close}}
 +
{{!}}{{Editgrn open}}JM: What are the valid values?{{Editgrn close}}
 +
{{!}}""
 +
{{!}}-
 +
{{!}}secrets.gws-screen-recording-private-secret
 +
{{!}}{{Editgrn open}}JM: What is the description?{{Editgrn close}}
 +
{{!}}{{Editgrn open}}JM: What are the valid values?{{Editgrn close}}
 +
{{!}}""-->
 +
{{!}}}
 +
{{AnchorDiv|provisioningP}}
 +
{{{!}} class="wikitable" style="table-layout: fixed; overflow-wrap: break-word;" {{!}}
 +
{{!}}+Provisioning Service parameters
 +
!Parameter
 +
!Description
 +
!Valid values
 +
!Default
 +
{{!}}-
 +
{{!}}gwsServices.gws-app-provisioning.name
 +
{{!}}The name of the container deployment.
 +
{{!}}String
 +
{{!}}"gws-app-provisioning"
 +
{{!}}-
 +
{{!}}gwsServices.gws-app-provisioning.appType
 +
{{!}}The type of application in this container.
 +
{{!}}nodejs, java, or frontend
 +
{{!}}"nodejs"
 +
{{!}}-
 +
{{!}}gwsServices.gws-app-provisioning.doLivenessProbe
 +
{{!}}Specifies whether to do a Kubernetes liveness probe to test if the container is running. The probe is configured with a delay of 120 seconds and a period of 10 seconds.
 +
{{!}}true or false
 +
{{!}}true
 +
{{!}}-
 +
{{!}}gwsServices.gws-app-provisioning.clientId
 +
{{!}}The ID of an encrypted client secret generated by {{Link-AnywhereElse|product=AUTH|version=Current|manual=AuthPEGuide|display text=Genesys Authentication}} for this component.
 +
{{!}}A valid ID
 +
{{!}}"gws-app-provisioning"
 +
{{!}}-
 +
{{!}}gwsServices.gws-app-provisioning.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
 +
{{!}}""
 +
{{!}}-
 +
{{!}}gwsServices.gws-app-provisioning.deployment.replicaCount
 +
{{!}}The number of pod replicas in this container deployment.
 +
{{!}}A number greater than 0
 +
{{!}}2
 +
{{!}}-
 +
{{!}}gwsServices.gws-app-provisioning.deployment.postfix
 +
{{!}}{{Editgrn open}}JM: What is the description for this parameter?{{Editgrn close}}
 +
{{!}}{{Editgrn open}}JM: What are the valid values?{{Editgrn close}}
 +
{{!}}"GWS_PROVISIONING"
 +
{{!}}-
 +
{{!}}gwsServices.gws-app-provisioning.resources.limits.cpu
 +
{{!}}The maximum amount of CPU Kubernetes allocates for the container. See the [https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ Kubernetes documentation] for details.
 +
{{!}}Units of Kubernetes CPU
 +
{{!}}4
 +
{{!}}-
 +
{{!}}gwsServices.gws-app-provisioning.resources.limits.memory
 +
{{!}}The maximum amount of memory Kubernetes allocates for the container. See the [https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ Kubernetes documentation] for details.
 +
{{!}}Units of bytes
 +
{{!}}"5Gi"
 +
{{!}}-
 +
{{!}}gwsServices.gws-app-provisioning.resources.requests.cpu
 +
{{!}}The guaranteed amount of CPU Kubernetes allocates for the container. See the [https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ Kubernetes documentation] for details.
 +
{{!}}Units of Kubernetes CPU
 +
{{!}}0.5
 +
{{!}}-
 +
{{!}}gwsServices.gws-app-provisioning.resources.requests.memory
 +
{{!}}The guaranteed amount of memory Kubernetes allocates for the container. See the [https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ Kubernetes documentation] for details.
 +
{{!}}Units of bytes
 +
{{!}}"5Gi"
 +
{{!}}-
 +
{{!}}gwsServices.gws-app-provisioning.postgres.address
 +
{{!}}The fully qualified domain name or IP of the PostgreSQL server for gws-app-provisioning.
 +
{{!}}A valid address
 +
{{!}}""
 +
{{!}}-
 +
{{!}}gwsServices.gws-app-provisioning.postgres.port
 +
{{!}}The port of the PostgreSQL server for gws-app-provisioning.
 +
{{!}}A valid port
 +
{{!}}""
 +
{{!}}-
 +
{{!}}gwsServices.gws-app-provisioning.postgres.db
 +
{{!}}The name of the PostgreSQL database for gws-app-provisioning.
 +
{{!}}A valid database name
 +
{{!}}""
 +
{{!}}-
 +
{{!}}gwsServices.gws-app-provisioning.context.ports.server
 +
{{!}}The port for this container.
 +
{{!}}A valid port
 +
{{!}}48060
 +
{{!}}-
 +
{{!}}gwsServices.gws-app-provisioning.context.ports.management
 +
{{!}}The management port for this container.
 +
{{!}}A valid port
 +
{{!}}48061
 +
{{!}}-
 +
{{!}}gwsServices.gws-app-provisioning.context.loggingLevel
 +
{{!}}Specifies the logging level for this container.
 +
{{!}}ERROR, WARN, INFO, DEBUG, or TRACE
 +
{{!}}""
 +
{{!}}-
 +
{{!}}gwsServices.gws-app-provisioning.context.env.GWS_PROVISIONING_ASYNC_IO_ENABLED
 +
{{!}}{{Editgrn open}}JM: What is the description for this env var?{{Editgrn close}}
 +
{{!}}true or false
 +
{{!}}true
 +
{{!}}-
 +
{{!}}gwsServices.gws-app-provisioning.context.env.GWS_PROVISIONING_COMET_ENGINE
 +
{{!}}{{Editgrn open}}JM: What is the description for this env var?{{Editgrn close}}
 +
{{!}}{{Editgrn open}}JM: What are the valid values?{{Editgrn close}}
 +
{{!}}"cometd"
 +
{{!}}-
 +
{{!}}gwsServices.gws-app-provisioning.context.env.GWS_PROVISIONING_CONSUL_DISCOVERY_CONFIGSERVICE_NAME
 +
{{!}}{{Editgrn open}}JM: What is the description for this env var?{{Editgrn close}}
 +
{{!}}{{Editgrn open}}JM: What are the valid values?{{Editgrn close}}
 +
{{!}}"gws-platform-configuration"
 +
{{!}}-
 +
{{!}}gwsServices.gws-app-provisioning.context.env.GWS_SERVICE_AUTH_URL
 +
{{!}}The internal service URI of the Genesys Authentication service. For example: <nowiki>http://gauth-auth.gauth.svc.cluster.local.:80</nowiki>
 +
{{!}}A valid URL
 +
{{!}}""
 +
{{!}}-
 +
{{!}}gwsServices.gws-app-provisioning.context.env.GWS_SERVICE_CONF_URL
 +
{{!}}The internal service URI of the configuration service (part of GWS). For example: <nowiki>http://gws-service-proxy.gws.svc.cluster.local:80</nowiki>
 +
{{!}}A valid URL
 +
{{!}}""
 +
{{!}}-
 +
{{!}}gwsServices.gws-app-provisioning.context.env.GWS_SERVICE_ENV_URL
 +
{{!}}The internal service URI of the environment service (part of Genesys Authentication). For example: <nowiki>http://gauth-environment.gauth.svc.cluster.local.:80</nowiki>
 +
{{!}}A valid URL
 +
{{!}}""
 +
{{!}}-
 +
{{!}}gwsServices.gws-app-provisioning.context.env.GWS_SERVICE_VOICEMAIL_URL
 +
{{!}}The URL of the voicemail server.
 +
{{!}}A valid URL
 +
{{!}}""
 +
{{!}}-
 +
{{!}}gwsServices.gws-app-provisioning.context.env.PGSSLMODE
 +
{{!}}Enables or disables the SSL connection to PostgreSQL. See the [https://www.postgresql.org/docs/9.0/libpq-ssl.html PostgreSQL documentation] for details about SSL modes.
 +
{{!}}disable, prefer, require, verify-ca, or verify-full
 +
{{!}}"require"
 +
{{!}}-
 +
{{!}}gwsServices.gws-app-provisioning.service.ports.server
 +
{{!}}The port for this server.
 +
{{!}}A valid port
 +
{{!}}80
 +
{{!}}-
 +
{{!}}gwsServices.gws-app-provisioning.service.ports.management
 +
{{!}}The management port for this server.
 +
{{!}}A valid port
 +
{{!}}81
 +
{{!}}-
 +
{{!}}gwsServices.gws-app-provisioning.labels
 +
{{!}}Custom labels to be added for the container.
 +
{{!}}A valid set of labels as "name: value"
 +
{{!}}{}
 +
{{!}}-
 +
{{!}}gwsServices.gws-app-provisioning.annotations
 +
{{!}}Custom annotations to be added for the container.
 +
{{!}}A valid set of annotations as "name: value"
 +
{{!}}{}
 +
{{!}}}
 +
{{AnchorDiv|workspaceP}}
 +
{{{!}} class="wikitable" style="table-layout: fixed; overflow-wrap: break-word;" {{!}}
 +
{{!}}+Workspace Service parameters
 +
!Parameter
 +
!Description
 +
!Valid values
 +
!Default
 +
{{!}}-
 +
{{!}}gwsServices.gws-app-workspace.name
 +
{{!}}The name of the container deployment.
 +
{{!}}String
 +
{{!}}"gws-app-workspace"
 +
{{!}}-
 +
{{!}}gwsServices.gws-app-workspace.appType
 +
{{!}}The type of application in this container.
 +
{{!}}nodejs, java, or frontend
 +
{{!}}"nodejs"
 +
{{!}}-
 +
{{!}}gwsServices.gws-app-workspace.doLivenessProbe
 +
{{!}}Specifies whether to do a Kubernetes liveness probe to test if the container is running. The probe is configured with a delay of 120 seconds and a period of 10 seconds.
 +
{{!}}true or false
 +
{{!}}true
 +
{{!}}-
 +
{{!}}gwsServices.gws-app-workspace.clientId
 +
{{!}}The ID of an encrypted client secret generated by {{Link-AnywhereElse|product=AUTH|version=Current|manual=AuthPEGuide|display text=Genesys Authentication}} for this component.
 +
{{!}}A valid ID
 +
{{!}}"gws-app-workspace"
 +
{{!}}-
 +
{{!}}gwsServices.gws-app-workspace.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
 +
{{!}}""
 +
{{!}}-
 +
{{!}}gwsServices.gws-app-workspace.deployment.replicaCount
 +
{{!}}The number of pod replicas in this container deployment.
 +
{{!}}A number greater than 0
 +
{{!}}2
 +
{{!}}-
 +
{{!}}gwsServices.gws-app-workspace.deployment.postfix
 +
{{!}}{{Editgrn open}}JM: What is the description for this parameter?{{Editgrn close}}
 +
{{!}}{{Editgrn open}}JM: What are the valid values?{{Editgrn close}}
 +
{{!}}"GWS_WORKSPACE"
 +
{{!}}-
 +
{{!}}gwsServices.gws-app-workspace.resources.limits.cpu
 +
{{!}}The maximum amount of CPU Kubernetes allocates for the container. See the [https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ Kubernetes documentation] for details.
 +
{{!}}Units of Kubernetes CPU
 +
{{!}}4
 +
{{!}}-
 +
{{!}}gwsServices.gws-app-workspace.resources.limits.memory
 +
{{!}}The maximum amount of memory Kubernetes allocates for the container. See the [https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ Kubernetes documentation] for details.
 +
{{!}}Units of bytes
 +
{{!}}"5Gi"
 +
{{!}}-
 +
{{!}}gwsServices.gws-app-workspace.resources.requests.cpu
 +
{{!}}The guaranteed amount of CPU Kubernetes allocates for the container. See the [https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ Kubernetes documentation] for details.
 +
{{!}}Units of Kubernetes CPU
 +
{{!}}0.2
 +
{{!}}-
 +
{{!}}gwsServices.gws-app-workspace.resources.requests.memory
 +
{{!}}The guaranteed amount of memory Kubernetes allocates for the container. See the [https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ Kubernetes documentation] for details.
 +
{{!}}Units of bytes
 +
{{!}}"5Gi"
 +
{{!}}-
 +
{{!}}gwsServices.gws-app-workspace.context.ports.server
 +
{{!}}The port for this container.
 +
{{!}}A valid port
 +
{{!}}48050
 +
{{!}}-
 +
{{!}}gwsServices.gws-app-workspace.context.ports.management
 +
{{!}}The management port for this container.
 +
{{!}}A valid port
 +
{{!}}48051
 +
{{!}}-
 +
{{!}}gwsServices.gws-app-workspace.context.loggingLevel
 +
{{!}}Specifies the logging level for this container.
 +
{{!}}ERROR, WARN, INFO, DEBUG, or TRACE
 +
{{!}}""
 +
{{!}}-
 +
{{!}}gwsServices.gws-app-workspace.context.env.GWS_WORKSPACE_CONSUL_CACHE_TTL
 +
{{!}}The length of time, in milliseconds, that the Workspace Service keeps service locations in cache locally.
 +
{{!}}Number
 +
{{!}}60000
 +
{{!}}-
 +
{{!}}gwsServices.gws-app-workspace.context.env.GWS_WORKSPACE_ENABLE_CHANGE_PASSWORD
 +
{{!}}{{Editgrn open}}JM: What is the description for this env var?{{Editgrn close}}
 +
{{!}}true or false
 +
{{!}}true
 +
{{!}}-
 +
{{!}}gwsServices.gws-app-workspace.context.env.GWS_WORKSPACE_MEMORY_CACHE_ENABLED
 +
{{!}}Specifies whether the Workspace Service should cache configuration data (such as agent groups) in memory.
 +
{{!}}true or false
 +
{{!}}true
 +
{{!}}-
 +
{{!}}gwsServices.gws-app-workspace.service.ports.server
 +
{{!}}The port for this server.
 +
{{!}}A valid port
 +
{{!}}80
 +
{{!}}-
 +
{{!}}gwsServices.gws-app-workspace.service.ports.management
 +
{{!}}The management port for this server.
 +
{{!}}A valid port
 +
{{!}}81
 +
{{!}}-
 +
{{!}}gwsServices.gws-app-workspace.labels
 +
{{!}}Custom labels to be added for the container.
 +
{{!}}A valid set of labels as "name: value"
 +
{{!}}{}
 +
{{!}}-
 +
{{!}}gwsServices.gws-app-workspace.annotations
 +
{{!}}Custom annotations to be added for the container.
 +
{{!}}A valid set of annotations as "name: value"
 +
{{!}}{}
 +
{{!}}}
 +
{{AnchorDiv|configurationP}}
 +
{{{!}} class="wikitable" style="table-layout: fixed; overflow-wrap: break-word;" {{!}}
 +
{{!}}+Configuration Service parameters
 +
!Parameter
 +
!Description
 +
!Valid values
 +
!Default
 +
{{!}}-
 +
{{!}}gwsServices.gws-platform-configuration.name
 +
{{!}}The name of the container deployment.
 +
{{!}}String
 +
{{!}}"gws-platform-configuration"
 +
{{!}}-
 +
{{!}}gwsServices.gws-platform-configuration.appType
 +
{{!}}The type of application in this container.
 +
{{!}}nodejs, java, or frontend
 +
{{!}}"java"
 +
{{!}}-
 +
{{!}}gwsServices.gws-platform-configuration.doLivenessProbe
 +
{{!}}Specifies whether to do a Kubernetes liveness probe to test if the container is running. The probe is configured with a delay of 120 seconds and a period of 10 seconds.
 +
{{!}}true or false
 +
{{!}}true
 +
{{!}}-
 +
{{!}}gwsServices.gws-platform-configuration.clientId
 +
{{!}}The ID of an encrypted client secret generated by {{Link-AnywhereElse|product=AUTH|version=Current|manual=AuthPEGuide|display text=Genesys Authentication}} for this component.
 +
{{!}}A valid ID
 +
{{!}}"gws-platform-configuration"
 +
{{!}}-
 +
{{!}}gwsServices.gws-platform-configuration.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
 +
{{!}}""
 +
{{!}}-
 +
{{!}}gwsServices.gws-platform-configuration.deployment.replicaCount
 +
{{!}}The number of pod replicas in this container deployment.
 +
{{!}}A number greater than 0
 +
{{!}}2
 +
{{!}}-
 +
{{!}}gwsServices.gws-platform-configuration.deployment.postfix
 +
{{!}}{{Editgrn open}}JM: What is the description for this parameter?{{Editgrn close}}
 +
{{!}}{{Editgrn open}}JM: What are the valid values?{{Editgrn close}}
 +
{{!}}"GWS_CONFIGURATION"
 +
{{!}}-
 +
{{!}}gwsServices.gws-platform-configuration.resources.limits.cpu
 +
{{!}}The maximum amount of CPU Kubernetes allocates for the container. See the [https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ Kubernetes documentation] for details.
 +
{{!}}Units of Kubernetes CPU
 +
{{!}}4
 +
{{!}}-
 +
{{!}}gwsServices.gws-platform-configuration.resources.limits.memory
 +
{{!}}The maximum amount of memory Kubernetes allocates for the container. See the [https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ Kubernetes documentation] for details.
 +
{{!}}Units of bytes
 +
{{!}}"4Gi"
 +
{{!}}-
 +
{{!}}gwsServices.gws-platform-configuration.resources.requests.cpu
 +
{{!}}The guaranteed amount of CPU Kubernetes allocates for the container. See the [https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ Kubernetes documentation] for details.
 +
{{!}}Units of Kubernetes CPU
 +
{{!}}0.2
 +
{{!}}-
 +
{{!}}gwsServices.gws-platform-configuration.resources.requests.memory
 +
{{!}}The guaranteed amount of memory Kubernetes allocates for the container. See the [https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ Kubernetes documentation] for details.
 +
{{!}}Units of bytes
 +
{{!}}"4Gi"
 +
{{!}}-
 +
{{!}}gwsServices.gws-platform-configuration.context.ports.server
 +
{{!}}The port for this container.
 +
{{!}}A valid port
 +
{{!}}48030
 +
{{!}}-
 +
{{!}}gwsServices.gws-platform-configuration.context.ports.management
 +
{{!}}The management port for this container.
 +
{{!}}A valid port
 +
{{!}}48031
 +
{{!}}-
 +
{{!}}gwsServices.gws-platform-configuration.context.loggingLevel
 +
{{!}}Specifies the logging level for this container.
 +
{{!}}ERROR, WARN, INFO, DEBUG, or TRACE
 +
{{!}}""
 +
{{!}}-
 +
{{!}}gwsServices.gws-platform-configuration.context.env.GWS_CONFIGURATION_COMMON_DISCOVERY_TENANTS
 +
{{!}}{{Editgrn open}}JM: What is the description for this env var?{{Editgrn close}}
 +
{{!}}true or false
 +
{{!}}true
 +
{{!}}-
 +
{{!}}gwsServices.gws-platform-configuration.service.ports.server
 +
{{!}}The port for this server.
 +
{{!}}A valid port
 +
{{!}}80
 +
{{!}}-
 +
{{!}}gwsServices.gws-platform-configuration.service.ports.management
 +
{{!}}The management port for this server.
 +
{{!}}A valid port
 +
{{!}}81
 +
{{!}}-
 +
{{!}}gwsServices.gws-platform-configuration.labels
 +
{{!}}Custom labels to be added for the container.
 +
{{!}}A valid set of labels as "name: value"
 +
{{!}}{}
 +
{{!}}-
 +
{{!}}gwsServices.gws-platform-configuration.annotations
 +
{{!}}Custom annotations to be added for the container.
 +
{{!}}A valid set of annotations as "name: value"
 +
{{!}}{}
 +
{{!}}}
 +
{{AnchorDiv|dataP}}
 +
{{{!}} class="wikitable" style="table-layout: fixed; overflow-wrap: break-word;" {{!}}
 +
{{!}}+Data Collector Service parameters
 +
!Parameter
 +
!Description
 +
!Valid values
 +
!Default
 +
{{!}}-
 +
{{!}}gwsServices.gws-platform-datacollector.name
 +
{{!}}The name of the container deployment.
 +
{{!}}String
 +
{{!}}"gws-platform-datacollector"
 +
{{!}}-
 +
{{!}}gwsServices.gws-platform-datacollector.appType
 +
{{!}}The type of application in this container.
 +
{{!}}nodejs, java, or frontend
 +
{{!}}"java"
 +
{{!}}-
 +
{{!}}gwsServices.gws-platform-datacollector.doLivenessProbe
 +
{{!}}Specifies whether to do a Kubernetes liveness probe to test if the container is running. The probe is configured with a delay of 120 seconds and a period of 10 seconds.
 +
{{!}}true or false
 +
{{!}}true
 +
{{!}}-
 +
{{!}}gwsServices.gws-platform-datacollector.clientId
 +
{{!}}The ID of an encrypted client secret generated by {{Link-AnywhereElse|product=AUTH|version=Current|manual=AuthPEGuide|display text=Genesys Authentication}} for this component.
 +
{{!}}A valid ID
 +
{{!}}"gws-platform-datacollector"
 +
{{!}}-
 +
{{!}}gwsServices.gws-platform-datacollector.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
 +
{{!}}""
 +
{{!}}-
 +
{{!}}gwsServices.gws-platform-datacollector.deployment.replicaCount
 +
{{!}}The number of pod replicas in this container deployment.
 +
{{!}}A number greater than 0
 +
{{!}}2
 +
{{!}}-
 +
{{!}}gwsServices.gws-platform-datacollector.deployment.postfix
 +
{{!}}{{Editgrn open}}JM: What is the description for this parameter?{{Editgrn close}}
 +
{{!}}{{Editgrn open}}JM: What are the valid values?{{Editgrn close}}
 +
{{!}}"GWS_DATACOLLECTOR"
 +
{{!}}-
 +
{{!}}gwsServices.gws-platform-datacollector.resources.limits.cpu
 +
{{!}}The maximum amount of CPU Kubernetes allocates for the container. See the [https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ Kubernetes documentation] for details.
 +
{{!}}Units of Kubernetes CPU
 +
{{!}}4
 +
{{!}}-
 +
{{!}}gwsServices.gws-platform-datacollector.resources.limits.memory
 +
{{!}}The maximum amount of memory Kubernetes allocates for the container. See the [https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ Kubernetes documentation] for details.
 +
{{!}}Units of bytes
 +
{{!}}"5Gi"
 +
{{!}}-
 +
{{!}}gwsServices.gws-platform-datacollector.resources.requests.cpu
 +
{{!}}The guaranteed amount of CPU Kubernetes allocates for the container. See the [https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ Kubernetes documentation] for details.
 +
{{!}}Units of Kubernetes CPU
 +
{{!}}0.2
 +
{{!}}-
 +
{{!}}gwsServices.gws-platform-datacollector.resources.requests.memory
 +
{{!}}The guaranteed amount of memory Kubernetes allocates for the container. See the [https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ Kubernetes documentation] for details.
 +
{{!}}Units of bytes
 +
{{!}}"4Gi"
 +
{{!}}-
 +
{{!}}gwsServices.gws-platform-datacollector.context.ports.server
 +
{{!}}The port for this container.
 +
{{!}}A valid port
 +
{{!}}48180
 +
{{!}}-
 +
{{!}}gwsServices.gws-platform-datacollector.context.ports.management
 +
{{!}}The management port for this container.
 +
{{!}}A valid port
 +
{{!}}48181
 +
{{!}}-
 +
{{!}}gwsServices.gws-platform-datacollector.context.loggingLevel
 +
{{!}}Specifies the logging level for this container.
 +
{{!}}ERROR, WARN, INFO, DEBUG, or TRACE
 +
{{!}}""
 +
{{!}}-
 +
{{!}}gwsServices.gws-platform-datacollector.context.env.gws_datacollector_services_datacollector_distribution_enabled
 +
{{!}}Enables task distribution for the data collector.
 +
{{!}}true or false
 +
{{!}}true
 +
{{!}}-
 +
{{!}}gwsServices.gws-platform-datacollector.context.env.GWS_DATACOLLECTOR_SERVICES_DATACOLLECTOR_REINDEX_ENABLED
 +
{{!}}Enables background service for reindexing data.
 +
{{!}}true or false
 +
{{!}}true
 +
{{!}}-
 +
{{!}}gwsServices.gws-platform-datacollector.context.env.gws_datacollector_services_datacollector_reindex_onStart
 +
{{!}}Specifies whether to perform a reindex on start.
 +
{{!}}true or false
 +
{{!}}true
 +
{{!}}-
 +
{{!}}gwsServices.gws-platform-datacollector.context.env.GWS_DATACOLLECTOR_SERVICES_DATACOLLECTOR_REINDEX_PERIOD
 +
{{!}}The period in minutes between scheduled reindex attempts.
 +
{{!}}A time in minutes
 +
{{!}}30
 +
{{!}}-
 +
{{!}}gwsServices.gws-platform-datacollector.context.env.GWS_DATACOLLECTOR_SERVICES_DATACOLLECTOR_STATISTICS_ENABLED
 +
{{!}}Enables statistics monitoring.
 +
{{!}}true or false
 +
{{!}}true
 +
{{!}}-
 +
{{!}}gwsServices.gws-platform-datacollector.context.env.GWS_DATACOLLECTOR_services_datacollector_statistics_period
 +
{{!}}Period in minutes between statistics checks.
 +
{{!}}A time in minutes
 +
{{!}}5
 +
{{!}}-
 +
{{!}}gwsServices.gws-platform-datacollector.service.ports.server
 +
{{!}}The port for this server.
 +
{{!}}A valid port
 +
{{!}}80
 +
{{!}}-
 +
{{!}}gwsServices.gws-platform-datacollector.service.ports.management
 +
{{!}}The management port for this server.
 +
{{!}}A valid port
 +
{{!}}81
 +
{{!}}-
 +
{{!}}gwsServices.gws-platform-datacollector.labels
 +
{{!}}Custom labels to be added for the container.
 +
{{!}}A valid set of labels as "name: value"
 +
{{!}}{}
 +
{{!}}-
 +
{{!}}gwsServices.gws-platform-datacollector.annotations
 +
{{!}}Custom annotations to be added for the container.
 +
{{!}}A valid set of annotations as "name: value"
 +
{{!}}{}
 +
{{!}}}
 +
{{AnchorDiv|interactionP}}
 +
{{{!}} class="wikitable" style="table-layout: fixed; overflow-wrap: break-word;" {{!}}
 +
{{!}}+Interaction Service parameters
 +
!Parameter
 +
!Description
 +
!Valid values
 +
!Default
 +
{{!}}-
 +
{{!}}gwsServices.gws-platform-ixn.name
 +
{{!}}The name of the container deployment.
 +
{{!}}String
 +
{{!}}"gws-platform-ixn"
 +
{{!}}-
 +
{{!}}gwsServices.gws-platform-ixn.appType
 +
{{!}}The type of application in this container.
 +
{{!}}nodejs, java, or frontend
 +
{{!}}"java"
 +
{{!}}-
 +
{{!}}gwsServices.gws-platform-ixn.doLivenessProbe
 +
{{!}}Specifies whether to do a Kubernetes liveness probe to test if the container is running. The probe is configured with a delay of 120 seconds and a period of 10 seconds.
 +
{{!}}true or false
 +
{{!}}true
 +
{{!}}-
 +
{{!}}gwsServices.gws-platform-ixn.clientId
 +
{{!}}The ID of an encrypted client secret generated by {{Link-AnywhereElse|product=AUTH|version=Current|manual=AuthPEGuide|display text=Genesys Authentication}} for this component.
 +
{{!}}A valid ID
 +
{{!}}"gws-platform-ixn"
 +
{{!}}-
 +
{{!}}gwsServices.gws-platform-ixn.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
 +
{{!}}""
 +
{{!}}-
 +
{{!}}gwsServices.gws-platform-ixn.deployment.replicaCount
 +
{{!}}The number of pod replicas in this container deployment.
 +
{{!}}A number greater than 0
 +
{{!}}2
 +
{{!}}-
 +
{{!}}gwsServices.gws-platform-ixn.deployment.postfix
 +
{{!}}{{Editgrn open}}JM: What is the description for this parameter?{{Editgrn close}}
 +
{{!}}{{Editgrn open}}JM: What are the valid values?{{Editgrn close}}
 +
{{!}}"GWS_IXN"
 +
{{!}}-
 +
{{!}}gwsServices.gws-platform-ixn.resources.limits.cpu
 +
{{!}}The maximum amount of CPU Kubernetes allocates for the container. See the [https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ Kubernetes documentation] for details.
 +
{{!}}Units of Kubernetes CPU
 +
{{!}}4
 +
{{!}}-
 +
{{!}}gwsServices.gws-platform-ixn.resources.limits.memory
 +
{{!}}The maximum amount of memory Kubernetes allocates for the container. See the [https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ Kubernetes documentation] for details.
 +
{{!}}Units of bytes
 +
{{!}}"4Gi"
 +
{{!}}-
 +
{{!}}gwsServices.gws-platform-ixn.resources.requests.cpu
 +
{{!}}The guaranteed amount of CPU Kubernetes allocates for the container. See the [https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ Kubernetes documentation] for details.
 +
{{!}}Units of Kubernetes CPU
 +
{{!}}0.2
 +
{{!}}-
 +
{{!}}gwsServices.gws-platform-ixn.resources.requests.memory
 +
{{!}}The guaranteed amount of memory Kubernetes allocates for the container. See the [https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ Kubernetes documentation] for details.
 +
{{!}}Units of bytes
 +
{{!}}"4Gi"
 +
{{!}}-
 +
{{!}}gwsServices.gws-platform-ixn.context.ports.server
 +
{{!}}The port for this container.
 +
{{!}}A valid port
 +
{{!}}48170
 +
{{!}}-
 +
{{!}}gwsServices.gws-platform-ixn.context.ports.management
 +
{{!}}The management port for this container.
 +
{{!}}A valid port
 +
{{!}}48171
 +
{{!}}-
 +
{{!}}gwsServices.gws-platform-ixn.context.loggingLevel
 +
{{!}}Specifies the logging level for this container.
 +
{{!}}ERROR, WARN, INFO, DEBUG, or TRACE
 +
{{!}}""
 +
{{!}}-
 +
{{!}}gwsServices.gws-platform-ixn.context.env
 +
{{!}}Environment variables for this container.
 +
{{!}}
 +
{{!}}{}
 +
{{!}}-
 +
{{!}}gwsServices.gws-platform-ixn.service.ports.server
 +
{{!}}The port for this server.
 +
{{!}}A valid port
 +
{{!}}80
 +
{{!}}-
 +
{{!}}gwsServices.gws-platform-ixn.service.ports.management
 +
{{!}}The management port for this server.
 +
{{!}}A valid port
 +
{{!}}81
 +
{{!}}-
 +
{{!}}gwsServices.gws-platform-ixn.labels
 +
{{!}}Custom labels to be added for the container.
 +
{{!}}A valid set of labels as "name: value"
 +
{{!}}{}
 +
{{!}}-
 +
{{!}}gwsServices.gws-platform-ixn.annotations
 +
{{!}}Custom annotations to be added for the container.
 +
{{!}}A valid set of annotations as "name: value"
 +
{{!}}{}
 +
{{!}}}
 +
{{AnchorDiv|ocsP}}
 +
{{{!}} class="wikitable" style="table-layout: fixed; overflow-wrap: break-word;" {{!}}
 +
{{!}}+OCS Service parameters
 +
!Parameter
 +
!Description
 +
!Valid values
 +
!Default
 +
{{!}}-
 +
{{!}}gwsServices.gws-platform-ocs.name
 +
{{!}}The name of the container deployment.
 +
{{!}}String
 +
{{!}}"gws-platform-ocs"
 +
{{!}}-
 +
{{!}}gwsServices.gws-platform-ocs.appType
 +
{{!}}The type of application in this container.
 +
{{!}}nodejs, java, or frontend
 +
{{!}}"java"
 +
{{!}}-
 +
{{!}}gwsServices.gws-platform-ocs.doLivenessProbe
 +
{{!}}Specifies whether to do a Kubernetes liveness probe to test if the container is running. The probe is configured with a delay of 120 seconds and a period of 10 seconds.
 +
{{!}}true or false
 +
{{!}}true
 +
{{!}}-
 +
{{!}}gwsServices.gws-platform-ocs.clientId
 +
{{!}}The ID of an encrypted client secret generated by {{Link-AnywhereElse|product=AUTH|version=Current|manual=AuthPEGuide|display text=Genesys Authentication}} for this component.
 +
{{!}}A valid ID
 +
{{!}}"gws-platform-ocs"
 +
{{!}}-
 +
{{!}}gwsServices.gws-platform-ocs.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
 +
{{!}}""
 +
{{!}}-
 +
{{!}}gwsServices.gws-platform-ocs.deployment.replicaCount
 +
{{!}}The number of pod replicas in this container deployment.
 +
{{!}}A number greater than 0
 +
{{!}}2
 +
{{!}}-
 +
{{!}}gwsServices.gws-platform-ocs.deployment.postfix
 +
{{!}}{{Editgrn open}}JM: What is the description for this parameter?{{Editgrn close}}
 +
{{!}}{{Editgrn open}}JM: What are the valid values?{{Editgrn close}}
 +
{{!}}"GWS_OCS"
 +
{{!}}-
 +
{{!}}gwsServices.gws-platform-ocs.resources.limits.cpu
 +
{{!}}The maximum amount of CPU Kubernetes allocates for the container. See the [https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ Kubernetes documentation] for details.
 +
{{!}}Units of Kubernetes CPU
 +
{{!}}4
 +
{{!}}-
 +
{{!}}gwsServices.gws-platform-ocs.resources.limits.memory
 +
{{!}}The maximum amount of memory Kubernetes allocates for the container. See the [https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ Kubernetes documentation] for details.
 +
{{!}}Units of bytes
 +
{{!}}"4Gi"
 +
{{!}}-
 +
{{!}}gwsServices.gws-platform-ocs.resources.requests.cpu
 +
{{!}}The guaranteed amount of CPU Kubernetes allocates for the container. See the [https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ Kubernetes documentation] for details.
 +
{{!}}Units of Kubernetes CPU
 +
{{!}}0.2
 +
{{!}}-
 +
{{!}}gwsServices.gws-platform-ocs.resources.requests.memory
 +
{{!}}The guaranteed amount of memory Kubernetes allocates for the container. See the [https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ Kubernetes documentation] for details.
 +
{{!}}Units of bytes
 +
{{!}}"4Gi"
 +
{{!}}-
 +
{{!}}gwsServices.gws-platform-ocs.context.ports.server
 +
{{!}}The port for this container.
 +
{{!}}A valid port
 +
{{!}}48090
 +
{{!}}-
 +
{{!}}gwsServices.gws-platform-ocs.context.ports.management
 +
{{!}}The management port for this container.
 +
{{!}}A valid port
 +
{{!}}48091
 +
{{!}}-
 +
{{!}}gwsServices.gws-platform-ocs.context.loggingLevel
 +
{{!}}Specifies the logging level for this container.
 +
{{!}}ERROR, WARN, INFO, DEBUG, or TRACE
 +
{{!}}""
 +
{{!}}-
 +
{{!}}gwsServices.gws-platform-ocs.context.env.GWS_OCS_timeouts_requestTimeoutMs
 +
{{!}}{{Editgrn open}}JM: What is the description for this env var?{{Editgrn close}}
 +
{{!}}A time in milliseconds
 +
{{!}}5000
 +
{{!}}-
 +
{{!}}gwsServices.gws-platform-ocs.service.ports.server
 +
{{!}}The port for this server.
 +
{{!}}A valid port
 +
{{!}}80
 +
{{!}}-
 +
{{!}}gwsServices.gws-platform-ocs.service.ports.management
 +
{{!}}The management port for this server.
 +
{{!}}A valid port
 +
{{!}}81
 +
{{!}}-
 +
{{!}}gwsServices.gws-platform-ocs.labels
 +
{{!}}Custom labels to be added for the container.
 +
{{!}}A valid set of labels as "name: value"
 +
{{!}}{}
 +
{{!}}-
 +
{{!}}gwsServices.gws-platform-ocs.annotations
 +
{{!}}Custom annotations to be added for the container.
 +
{{!}}A valid set of annotations as "name: value"
 +
{{!}}{}
 +
{{!}}}
 +
{{AnchorDiv|settingP}}
 +
{{{!}} class="wikitable" style="table-layout: fixed; overflow-wrap: break-word;" {{!}}
 +
{{!}}+Setting Service parameters
 +
!Parameter
 +
!Description
 +
!Valid values
 +
!Default
 +
{{!}}-
 +
{{!}}gwsServices.gws-platform-setting.name
 +
{{!}}The name of the container deployment.
 +
{{!}}String
 +
{{!}}"gws-platform-configuration"
 +
{{!}}-
 +
{{!}}gwsServices.gws-platform-setting.appType
 +
{{!}}The type of application in this container.
 +
{{!}}nodejs, java, or frontend
 +
{{!}}"java"
 +
{{!}}-
 +
{{!}}gwsServices.gws-platform-setting.doLivenessProbe
 +
{{!}}Specifies whether to do a Kubernetes liveness probe to test if the container is running. The probe is configured with a delay of 120 seconds and a period of 10 seconds.
 +
{{!}}true or false
 +
{{!}}true
 +
{{!}}-
 +
{{!}}gwsServices.gws-platform-setting.clientId
 +
{{!}}The ID of an encrypted client secret generated by {{Link-AnywhereElse|product=AUTH|version=Current|manual=AuthPEGuide|display text=Genesys Authentication}} for this component.
 +
{{!}}A valid ID
 +
{{!}}"gws-platform-setting"
 +
{{!}}-
 +
{{!}}gwsServices.gws-platform-setting.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
 +
{{!}}""
 +
{{!}}-
 +
{{!}}gwsServices.gws-platform-setting.deployment.replicaCount
 +
{{!}}The number of pod replicas in this container deployment.
 +
{{!}}A number greater than 0
 +
{{!}}2
 +
{{!}}-
 +
{{!}}gwsServices.gws-platform-setting.deployment.postfix
 +
{{!}}{{Editgrn open}}JM: What is the description for this parameter?{{Editgrn close}}
 +
{{!}}{{Editgrn open}}JM: What are the valid values?{{Editgrn close}}
 +
{{!}}"GWS_SETTING"
 +
{{!}}-
 +
{{!}}gwsServices.gws-platform-setting.resources.limits.cpu
 +
{{!}}The maximum amount of CPU Kubernetes allocates for the container. See the [https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ Kubernetes documentation] for details.
 +
{{!}}Units of Kubernetes CPU
 +
{{!}}4
 +
{{!}}-
 +
{{!}}gwsServices.gws-platform-setting.resources.limits.memory
 +
{{!}}The maximum amount of memory Kubernetes allocates for the container. See the [https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ Kubernetes documentation] for details.
 +
{{!}}Units of bytes
 +
{{!}}"4Gi"
 +
{{!}}-
 +
{{!}}gwsServices.gws-platform-setting.resources.requests.cpu
 +
{{!}}The guaranteed amount of CPU Kubernetes allocates for the container. See the [https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ Kubernetes documentation] for details.
 +
{{!}}Units of Kubernetes CPU
 +
{{!}}0.2
 +
{{!}}-
 +
{{!}}gwsServices.gws-platform-setting.resources.requests.memory
 +
{{!}}The guaranteed amount of memory Kubernetes allocates for the container. See the [https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ Kubernetes documentation] for details.
 +
{{!}}Units of bytes
 +
{{!}}"4Gi"
 +
{{!}}-
 +
{{!}}gwsServices.gws-platform-setting.context.ports.server
 +
{{!}}The port for this container.
 +
{{!}}A valid port
 +
{{!}}48140
 +
{{!}}-
 +
{{!}}gwsServices.gws-platform-setting.context.ports.management
 +
{{!}}The management port for this container.
 +
{{!}}A valid port
 +
{{!}}48141
 +
{{!}}-
 +
{{!}}gwsServices.gws-platform-setting.context.loggingLevel
 +
{{!}}Specifies the logging level for this container.
 +
{{!}}ERROR, WARN, INFO, DEBUG, or TRACE
 +
{{!}}""
 +
{{!}}-
 +
{{!}}gwsServices.gws-platform-setting.context.env.GWS_SETTING_DB_INIT_DB
 +
{{!}}{{Editgrn open}}JM: What is the description for this env var?{{Editgrn close}}
 +
{{!}}true or false
 +
{{!}}true
 +
{{!}}-
 +
{{!}}gwsServices.gws-platform-setting.service.ports.server
 +
{{!}}The port for this server.
 +
{{!}}A valid port
 +
{{!}}80
 +
{{!}}-
 +
{{!}}gwsServices.gws-platform-setting.service.ports.management
 +
{{!}}The management port for this server.
 +
{{!}}A valid port
 +
{{!}}81
 +
{{!}}-
 +
{{!}}gwsServices.gws-platform-setting.labels
 +
{{!}}Custom labels to be added for the container.
 +
{{!}}A valid set of labels as "name: value"
 +
{{!}}{}
 +
{{!}}-
 +
{{!}}gwsServices.gws-platform-setting.annotations
 +
{{!}}Custom annotations to be added for the container.
 +
{{!}}A valid set of annotations as "name: value"
 +
{{!}}{}
 +
{{!}}}
 +
{{AnchorDiv|statisticsP}}
 +
{{{!}} class="wikitable" style="table-layout: fixed; overflow-wrap: break-word;" {{!}}
 +
{{!}}+Statistics Service parameters
 +
!Parameter
 +
!Description
 +
!Valid values
 +
!Default
 +
{{!}}-
 +
{{!}}gwsServices.gws-platform-statistics.name
 +
{{!}}The name of the container deployment.
 +
{{!}}String
 +
{{!}}"gws-platform-statistics"
 +
{{!}}-
 +
{{!}}gwsServices.gws-platform-statistics.appType
 +
{{!}}The type of application in this container.
 +
{{!}}nodejs, java, or frontend
 +
{{!}}"java"
 +
{{!}}-
 +
{{!}}gwsServices.gws-platform-statistics.doLivenessProbe
 +
{{!}}Specifies whether to do a Kubernetes liveness probe to test if the container is running. The probe is configured with a delay of 120 seconds and a period of 10 seconds.
 +
{{!}}true or false
 +
{{!}}true
 +
{{!}}-
 +
{{!}}gwsServices.gws-platform-statistics.clientId
 +
{{!}}The ID of an encrypted client secret generated by {{Link-AnywhereElse|product=AUTH|version=Current|manual=AuthPEGuide|display text=Genesys Authentication}} for this component.
 +
{{!}}A valid ID
 +
{{!}}"gws-platform-statistics"
 +
{{!}}-
 +
{{!}}gwsServices.gws-platform-statistics.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
 +
{{!}}""
 +
{{!}}-
 +
{{!}}gwsServices.gws-platform-statistics.deployment.replicaCount
 +
{{!}}The number of pod replicas in this container deployment.
 +
{{!}}A number greater than 0
 +
{{!}}2
 +
{{!}}-
 +
{{!}}gwsServices.gws-platform-statistics.deployment.postfix
 +
{{!}}{{Editgrn open}}JM: What is the description for this parameter?{{Editgrn close}}
 +
{{!}}{{Editgrn open}}JM: What are the valid values?{{Editgrn close}}
 +
{{!}}"GWS_STATISTICS"
 +
{{!}}-
 +
{{!}}gwsServices.gws-platform-statistics.resources.limits.cpu
 +
{{!}}The maximum amount of CPU Kubernetes allocates for the container. See the [https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ Kubernetes documentation] for details.
 +
{{!}}Units of Kubernetes CPU
 +
{{!}}4
 +
{{!}}-
 +
{{!}}gwsServices.gws-platform-statistics.resources.limits.memory
 +
{{!}}The maximum amount of memory Kubernetes allocates for the container. See the [https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ Kubernetes documentation] for details.
 +
{{!}}Units of bytes
 +
{{!}}"4Gi"
 +
{{!}}-
 +
{{!}}gwsServices.gws-platform-statistics.resources.requests.cpu
 +
{{!}}The guaranteed amount of CPU Kubernetes allocates for the container. See the [https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ Kubernetes documentation] for details.
 +
{{!}}Units of Kubernetes CPU
 +
{{!}}0.2
 +
{{!}}-
 +
{{!}}gwsServices.gws-platform-statistics.resources.requests.memory
 +
{{!}}The guaranteed amount of memory Kubernetes allocates for the container. See the [https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ Kubernetes documentation] for details.
 +
{{!}}Units of bytes
 +
{{!}}"4Gi"
 +
{{!}}-
 +
{{!}}gwsServices.gws-platform-statistics.context.ports.server
 +
{{!}}The port for this container.
 +
{{!}}A valid port
 +
{{!}}48070
 +
{{!}}-
 +
{{!}}gwsServices.gws-platform-statistics.context.ports.management
 +
{{!}}The management port for this container.
 +
{{!}}A valid port
 +
{{!}}48071
 +
{{!}}-
 +
{{!}}gwsServices.gws-platform-statistics.context.loggingLevel
 +
{{!}}Specifies the logging level for this container.
 +
{{!}}ERROR, WARN, INFO, DEBUG, or TRACE
 +
{{!}}""
 +
{{!}}-
 +
{{!}}gwsServices.gws-platform-statistics.context.env
 +
{{!}}Environment variables for this container.
 +
{{!}}
 +
{{!}}{}
 +
{{!}}-
 +
{{!}}gwsServices.gws-platform-statistics.service.ports.server
 +
{{!}}The port for this server.
 +
{{!}}A valid port
 +
{{!}}80
 +
{{!}}-
 +
{{!}}gwsServices.gws-platform-statistics.service.ports.management
 +
{{!}}The management port for this server.
 +
{{!}}A valid port
 +
{{!}}81
 +
{{!}}-
 +
{{!}}gwsServices.gws-platform-statistics.labels
 +
{{!}}Custom labels to be added for the container.
 +
{{!}}A valid set of labels as "name: value"
 +
{{!}}{}
 +
{{!}}-
 +
{{!}}gwsServices.gws-platform-statistics.annotations
 +
{{!}}Custom annotations to be added for the container.
 +
{{!}}A valid set of annotations as "name: value"
 +
{{!}}{}
 +
{{!}}}
 +
{{AnchorDiv|voiceP}}
 +
{{{!}} class="wikitable" style="table-layout: fixed; overflow-wrap: break-word;" {{!}}
 +
{{!}}+Voice Service parameters
 +
!Parameter
 +
!Description
 +
!Valid values
 +
!Default
 +
{{!}}-
 +
{{!}}gwsServices.gws-platform-voice.name
 +
{{!}}The name of the container deployment.
 +
{{!}}String
 +
{{!}}"gws-platform-voice"
 +
{{!}}-
 +
{{!}}gwsServices.gws-platform-voice.appType
 +
{{!}}The type of application in this container.
 +
{{!}}nodejs, java, or frontend
 +
{{!}}"java"
 +
{{!}}-
 +
{{!}}gwsServices.gws-platform-voice.doLivenessProbe
 +
{{!}}Specifies whether to do a Kubernetes liveness probe to test if the container is running. The probe is configured with a delay of 120 seconds and a period of 10 seconds.
 +
{{!}}true or false
 +
{{!}}true
 +
{{!}}-
 +
{{!}}gwsServices.gws-platform-voice.clientId
 +
{{!}}The ID of an encrypted client secret generated by {{Link-AnywhereElse|product=AUTH|version=Current|manual=AuthPEGuide|display text=Genesys Authentication}} for this component.
 +
{{!}}A valid ID
 +
{{!}}"gws-platform-voice"
 +
{{!}}-
 +
{{!}}gwsServices.gws-platform-voice.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
 +
{{!}}""
 +
{{!}}-
 +
{{!}}gwsServices.gws-platform-voice.deployment.replicaCount
 +
{{!}}The number of pod replicas in this container deployment.
 +
{{!}}A number greater than 0
 +
{{!}}2
 +
{{!}}-
 +
{{!}}gwsServices.gws-platform-voice.deployment.postfix
 +
{{!}}{{Editgrn open}}JM: What is the description for this parameter?{{Editgrn close}}
 +
{{!}}{{Editgrn open}}JM: What are the valid values?{{Editgrn close}}
 +
{{!}}"GWS_VOICE"
 +
{{!}}-
 +
{{!}}gwsServices.gws-platform-voice.resources.limits.cpu
 +
{{!}}The maximum amount of CPU Kubernetes allocates for the container. See the [https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ Kubernetes documentation] for details.
 +
{{!}}Units of Kubernetes CPU
 +
{{!}}4
 +
{{!}}-
 +
{{!}}gwsServices.gws-platform-voice.resources.limits.memory
 +
{{!}}The maximum amount of memory Kubernetes allocates for the container. See the [https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ Kubernetes documentation] for details.
 +
{{!}}Units of bytes
 +
{{!}}"4Gi"
 +
{{!}}-
 +
{{!}}gwsServices.gws-platform-voice.resources.requests.cpu
 +
{{!}}The guaranteed amount of CPU Kubernetes allocates for the container. See the [https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ Kubernetes documentation] for details.
 +
{{!}}Units of Kubernetes CPU
 +
{{!}}0.2
 +
{{!}}-
 +
{{!}}gwsServices.gws-platform-voice.resources.requests.memory
 +
{{!}}The guaranteed amount of memory Kubernetes allocates for the container. See the [https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ Kubernetes documentation] for details.
 +
{{!}}Units of bytes
 +
{{!}}"4Gi"
 +
{{!}}-
 +
{{!}}gwsServices.gws-platform-voice.context.ports.server
 +
{{!}}The port for this container.
 +
{{!}}A valid port
 +
{{!}}48040
 +
{{!}}-
 +
{{!}}gwsServices.gws-platform-voice.context.ports.management
 +
{{!}}The management port for this container.
 +
{{!}}A valid port
 +
{{!}}48041
 +
{{!}}-
 +
{{!}}gwsServices.gws-platform-voice.context.loggingLevel
 +
{{!}}Specifies the logging level for this container.
 +
{{!}}ERROR, WARN, INFO, DEBUG, or TRACE
 +
{{!}}""
 +
{{!}}-
 +
{{!}}gwsServices.gws-platform-voice.context.env
 +
{{!}}Environment variables for this container.
 +
{{!}}
 +
{{!}}{}
 +
{{!}}-
 +
{{!}}gwsServices.gws-platform-voice.service.ports.server
 +
{{!}}The port for this server.
 +
{{!}}A valid port
 +
{{!}}80
 +
{{!}}-
 +
{{!}}gwsServices.gws-platform-voice.service.ports.management
 +
{{!}}The management port for this server.
 +
{{!}}A valid port
 +
{{!}}81
 +
{{!}}-
 +
{{!}}gwsServices.gws-platform-voice.labels
 +
{{!}}Custom labels to be added for the container.
 +
{{!}}A valid set of labels as "name: value"
 +
{{!}}{}
 +
{{!}}-
 +
{{!}}gwsServices.gws-platform-voice.annotations
 +
{{!}}Custom annotations to be added for the container.
 +
{{!}}A valid set of annotations as "name: value"
 +
{{!}}{}
 +
{{!}}}
 +
{{AnchorDiv|gplusP}}
 +
{{{!}} class="wikitable" style="table-layout: fixed; overflow-wrap: break-word;" {{!}}
 +
{{!}}+Gplus Adapter for Salesforce parameters
 +
!Parameter
 +
!Description
 +
!Valid values
 +
!Default
 +
{{!}}-
 +
{{!}}gwsServices.gws-ui-crmworkspace.name
 +
{{!}}The name of the container deployment.
 +
{{!}}String
 +
{{!}}"gws-ui-crmworkspace"
 +
{{!}}-
 +
{{!}}gwsServices.gws-ui-crmworkspace.appType
 +
{{!}}The type of application in this container.
 +
{{!}}nodejs, java, or frontend
 +
{{!}}"frontend"
 +
{{!}}-
 +
{{!}}gwsServices.gws-ui-crmworkspace.doLivenessProbe
 +
{{!}}Specifies whether to do a Kubernetes liveness probe to test if the container is running. The probe is configured with a delay of 120 seconds and a period of 10 seconds.
 +
{{!}}true or false
 +
{{!}}false
 +
{{!}}-
 +
{{!}}gwsServices.gws-ui-crmworkspace.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
 +
{{!}}""
 +
{{!}}-
 +
{{!}}gwsServices.gws-ui-crmworkspace.deployment.replicaCount
 +
{{!}}The number of pod replicas in this container deployment.
 +
{{!}}A number greater than 0
 +
{{!}}2
 +
{{!}}-
 +
{{!}}gwsServices.gws-ui-crmworkspace.deployment.postfix
 +
{{!}}{{Editgrn open}}JM: What is the description for this parameter?{{Editgrn close}}
 +
{{!}}{{Editgrn open}}JM: What are the valid values?{{Editgrn close}}
 +
{{!}}"GWS_UI_CRM_WORKSPACE"
 +
{{!}}-
 +
{{!}}gwsServices.gws-ui-crmworkspace.resources.limits.cpu
 +
{{!}}The maximum amount of CPU Kubernetes allocates for the container. See the [https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ Kubernetes documentation] for details.
 +
{{!}}Units of Kubernetes CPU
 +
{{!}}1
 +
{{!}}-
 +
{{!}}gwsServices.gws-ui-crmworkspace.resources.limits.memory
 +
{{!}}The maximum amount of memory Kubernetes allocates for the container. See the [https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ Kubernetes documentation] for details.
 +
{{!}}Units of bytes
 +
{{!}}"0.5Gi"
 +
{{!}}-
 +
{{!}}gwsServices.gws-ui-crmworkspace.resources.requests.cpu
 +
{{!}}The guaranteed amount of CPU Kubernetes allocates for the container. See the [https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ Kubernetes documentation] for details.
 +
{{!}}Units of Kubernetes CPU
 +
{{!}}0.1
 +
{{!}}-
 +
{{!}}gwsServices.gws-ui-crmworkspace.resources.requests.memory
 +
{{!}}The guaranteed amount of memory Kubernetes allocates for the container. See the [https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ Kubernetes documentation] for details.
 +
{{!}}Units of bytes
 +
{{!}}"0.5Gi"
 +
{{!}}-
 +
{{!}}gwsServices.gws-ui-crmworkspace.context.ports.server
 +
{{!}}The port for this container.
 +
{{!}}A valid port
 +
{{!}}50070
 +
{{!}}-
 +
{{!}}gwsServices.gws-ui-crmworkspace.context.ports.management
 +
{{!}}The management port for this container.
 +
{{!}}A valid port
 +
{{!}}50070
 +
{{!}}-
 +
{{!}}gwsServices.gws-ui-crmworkspace.context.env
 +
{{!}}Environment variables for this container.
 +
{{!}}
 +
{{!}}{}
 +
{{!}}-
 +
{{!}}gwsServices.gws-ui-crmworkspace.service.ports.server
 +
{{!}}The port for this server.
 +
{{!}}A valid port
 +
{{!}}80
 +
{{!}}-
 +
{{!}}gwsServices.gws-ui-crmworkspace.service.ports.management
 +
{{!}}The management port for this server.
 +
{{!}}A valid port
 +
{{!}}81
 +
{{!}}-
 +
{{!}}gwsServices.gws-ui-crmworkspace.labels
 +
{{!}}Custom labels to be added for the container.
 +
{{!}}A valid set of labels as "name: value"
 +
{{!}}{}
 +
{{!}}-
 +
{{!}}gwsServices.gws-ui-crmworkspace.annotations
 +
{{!}}Custom annotations to be added for the container.
 +
{{!}}A valid set of annotations as "name: value"
 +
{{!}}{}
 +
{{!}}}
 +
{{AnchorDiv|agentP}}
 +
{{{!}} class="wikitable" style="table-layout: fixed; overflow-wrap: break-word;" {{!}}
 +
{{!}}+Agent Setup parameters
 +
!Parameter
 +
!Description
 +
!Valid values
 +
!Default
 +
{{!}}-
 +
{{!}}gwsServices.gws-ui-provisioning.name
 +
{{!}}The name of the container deployment.
 +
{{!}}String
 +
{{!}}"gws-ui-provisioning"
 +
{{!}}-
 +
{{!}}gwsServices.gws-ui-provisioning.appType
 +
{{!}}The type of application in this container.
 +
{{!}}nodejs, java, or frontend
 +
{{!}}"frontend"
 +
{{!}}-
 +
{{!}}gwsServices.gws-ui-provisioning.doLivenessProbe
 +
{{!}}Specifies whether to do a Kubernetes liveness probe to test if the container is running. The probe is configured with a delay of 120 seconds and a period of 10 seconds.
 +
{{!}}true or false
 +
{{!}}false
 +
{{!}}-
 +
{{!}}gwsServices.gws-ui-provisioning.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
 +
{{!}}""
 +
{{!}}-
 +
{{!}}gwsServices.gws-ui-provisioning.deployment.replicaCount
 +
{{!}}The number of pod replicas in this container deployment.
 +
{{!}}A number greater than 0
 +
{{!}}2
 +
{{!}}-
 +
{{!}}gwsServices.gws-ui-provisioning.deployment.postfix
 +
{{!}}{{Editgrn open}}JM: What is the description for this parameter?{{Editgrn close}}
 +
{{!}}{{Editgrn open}}JM: What are the valid values?{{Editgrn close}}
 +
{{!}}"GWS_UI_PROVISIONING"
 +
{{!}}-
 +
{{!}}gwsServices.gws-ui-provisioning.resources.limits.cpu
 +
{{!}}The maximum amount of CPU Kubernetes allocates for the container. See the [https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ Kubernetes documentation] for details.
 +
{{!}}Units of Kubernetes CPU
 +
{{!}}1
 +
{{!}}-
 +
{{!}}gwsServices.gws-ui-provisioning.resources.limits.memory
 +
{{!}}The maximum amount of memory Kubernetes allocates for the container. See the [https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ Kubernetes documentation] for details.
 +
{{!}}Units of bytes
 +
{{!}}"0.5Gi"
 +
{{!}}-
 +
{{!}}gwsServices.gws-ui-provisioning.resources.requests.cpu
 +
{{!}}The guaranteed amount of CPU Kubernetes allocates for the container. See the [https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ Kubernetes documentation] for details.
 +
{{!}}Units of Kubernetes CPU
 +
{{!}}0.5
 +
{{!}}-
 +
{{!}}gwsServices.gws-ui-provisioning.resources.requests.memory
 +
{{!}}The guaranteed amount of memory Kubernetes allocates for the container. See the [https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ Kubernetes documentation] for details.
 +
{{!}}Units of bytes
 +
{{!}}"0.5Gi"
 +
{{!}}-
 +
{{!}}gwsServices.gws-ui-provisioning.context.ports.server
 +
{{!}}The port for this container.
 +
{{!}}A valid port
 +
{{!}}50040
 +
{{!}}-
 +
{{!}}gwsServices.gws-ui-provisioning.context.ports.management
 +
{{!}}The management port for this container.
 +
{{!}}A valid port
 +
{{!}}50040
 +
{{!}}-
 +
{{!}}gwsServices.gws-ui-provisioning.service.ports.server
 +
{{!}}The port for this server.
 +
{{!}}A valid port
 +
{{!}}80
 +
{{!}}-
 +
{{!}}gwsServices.gws-ui-provisioning.service.ports.management
 +
{{!}}The management port for this server.
 +
{{!}}A valid port
 +
{{!}}81
 +
{{!}}-
 +
{{!}}gwsServices.gws-ui-provisioning.labels
 +
{{!}}Custom labels to be added for the container.
 +
{{!}}A valid set of labels as "name: value"
 +
{{!}}{}
 +
{{!}}-
 +
{{!}}gwsServices.gws-ui-provisioning.annotations
 +
{{!}}Custom annotations to be added for the container.
 +
{{!}}A valid set of annotations as "name: value"
 +
{{!}}{}
 +
{{!}}}
 +
{{AnchorDiv|wweP}}
 +
{{{!}} class="wikitable" style="table-layout: fixed; overflow-wrap: break-word;" {{!}}
 +
{{!}}+Workspace Web Edition parameters
 +
!Parameter
 +
!Description
 +
!Valid values
 +
!Default
 +
{{!}}-
 +
{{!}}gwsServices.gws-ui-workspace.name
 +
{{!}}The name of the container deployment.
 +
{{!}}String
 +
{{!}}"gws-ui-workspace"
 +
{{!}}-
 +
{{!}}gwsServices.gws-ui-workspace.appType
 +
{{!}}The type of application in this container.
 +
{{!}}nodejs, java, or frontend
 +
{{!}}"frontend"
 +
{{!}}-
 +
{{!}}gwsServices.gws-ui-workspace.doLivenessProbe
 +
{{!}}Specifies whether to do a Kubernetes liveness probe to test if the container is running. The probe is configured with a delay of 120 seconds and a period of 10 seconds.
 +
{{!}}true or false
 +
{{!}}false
 +
{{!}}-
 +
{{!}}gwsServices.gws-ui-workspace.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
 +
{{!}}""
 +
{{!}}-
 +
{{!}}gwsServices.gws-ui-workspace.deployment.replicaCount
 +
{{!}}The number of pod replicas in this container deployment.
 +
{{!}}A number greater than 0
 +
{{!}}2
 +
{{!}}-
 +
{{!}}gwsServices.gws-ui-workspace.deployment.postfix
 +
{{!}}{{Editgrn open}}JM: What is the description for this parameter?{{Editgrn close}}
 +
{{!}}{{Editgrn open}}JM: What are the valid values?{{Editgrn close}}
 +
{{!}}"GWS_UI_WORKSPACE"
 +
{{!}}-
 +
{{!}}gwsServices.gws-ui-workspace.resources.limits.cpu
 +
{{!}}The maximum amount of CPU Kubernetes allocates for the container. See the [https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ Kubernetes documentation] for details.
 +
{{!}}Units of Kubernetes CPU
 +
{{!}}1
 +
{{!}}-
 +
{{!}}gwsServices.gws-ui-workspace.resources.limits.memory
 +
{{!}}The maximum amount of memory Kubernetes allocates for the container. See the [https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ Kubernetes documentation] for details.
 +
{{!}}Units of bytes
 +
{{!}}"0.5Gi"
 +
{{!}}-
 +
{{!}}gwsServices.gws-ui-workspace.resources.requests.cpu
 +
{{!}}The guaranteed amount of CPU Kubernetes allocates for the container. See the [https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ Kubernetes documentation] for details.
 +
{{!}}Units of Kubernetes CPU
 +
{{!}}0.1
 +
{{!}}-
 +
{{!}}gwsServices.gws-ui-workspace.resources.requests.memory
 +
{{!}}The guaranteed amount of memory Kubernetes allocates for the container. See the [https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ Kubernetes documentation] for details.
 +
{{!}}Units of bytes
 +
{{!}}"0.5Gi"
 +
{{!}}-
 +
{{!}}gwsServices.gws-ui-workspace.context.ports.server
 +
{{!}}The port for this container.
 +
{{!}}A valid port
 +
{{!}}50020
 +
{{!}}-
 +
{{!}}gwsServices.gws-ui-workspace.context.ports.management
 +
{{!}}The management port for this container.
 +
{{!}}A valid port
 +
{{!}}50020
 +
{{!}}-
 +
{{!}}gwsServices.gws-ui-workspace.context.env
 +
{{!}}Environment variables for this container.
 +
{{!}}
 +
{{!}}{}
 +
{{!}}-
 +
{{!}}gwsServices.gws-ui-workspace.service.ports.server
 +
{{!}}The port for this server.
 +
{{!}}A valid port
 +
{{!}}80
 +
{{!}}-
 +
{{!}}gwsServices.gws-ui-workspace.service.ports.management
 +
{{!}}The management port for this server.
 +
{{!}}A valid port
 +
{{!}}81
 +
{{!}}-
 +
{{!}}gwsServices.gws-ui-workspace.labels
 +
{{!}}Custom labels to be added for the container.
 +
{{!}}A valid set of labels as "name: value"
 +
{{!}}{}
 +
{{!}}-
 +
{{!}}gwsServices.gws-ui-workspace.annotations
 +
{{!}}Custom annotations to be added for the container.
 +
{{!}}A valid set of annotations as "name: value"
 +
{{!}}{}
 +
{{!}}}
 +
|Status=No
 +
}}{{Section
 +
|sectionHeading=Create or update the versions file
 +
|anchor=versions
 +
|alignment=Vertical
 +
|structuredtext=Create or update the '''versions.yaml''' file with the latest container versions for your deployment. See {{Link-AnywhereElse|product=ReleaseNotes|version=Current|manual=GenesysEngage-cloud|topic=GWSHelm|display text=Updated Helm Charts and Containers}} for Web Services and Applications for the full list of versions.
  
−
===Download GWS Helm Charts===
+
For example:<syntaxhighlight>
−
Download the GWS helm charts from JFrog using your credentials.
+
gws-app-provisioning:9.0.000.93
 +
gws-app-workspace:9.0.000.90
 +
gws-platform-configuration:9.0.000.79
 +
gws-platform-datacollector:9.0.000.50
 +
gws-platform-ixn:9.0.000.43
 +
gws-platform-ocs:9.0.000.46
 +
gws-platform-setting:9.0.000.52
 +
gws-platform-statistics:9.0.000.61
 +
gws-platform-voice:9.0.000.66
 +
gws-system-nginx:9.0.000.16
 +
gws-ui-crmworkspace:9.0.000.62
 +
gws-ui-provisioning:9.0.000.84
 +
gws-ui-workspace:9.0.000.82
 +
</syntaxhighlight><br />
 +
|Status=No
 +
}}{{Section
 +
|sectionHeading=Configure Kubernetes
 +
|anchor=kubernetes
 +
|alignment=Vertical
 +
|structuredtext=GWS stores the following sensitive data as Kubernetes secrets. See the '''secrets.*''' parameters in the {{Link-SomewhereInThisVersion|manual=GWSPEGuide|topic=Configure|anchor=globalP|display text=Global parameters}} table in the "Override Helm chart values" section for details.
  
−
===Create Two API Clients===
+
*Redis password (gws-redis-password)
−
+
*Consul API token (gws-consul-token)
−
Create two API clients on Genesys Authentication using the following procedure:
+
*PostgreSQL database credentials for GWS (gws-postgres-username and gws-postgres-password)
−
curl --location --request POST '<gauth-url>/auth/v3/ops/clients' \
+
*PostgreSQL database credentials for Agent Setup (agentsetup-postgres-username and agentsetup-postgres-password)
−
--header 'Content-Type: application/json' \
+
*Client secret for the Provisioning Service (gws-app-provisioning-client-secret)
−
--user ops:ops \ ---------------------------- Cloud ops credentials (<username:password>) from values_gauth.yaml. The default value is ops:ops
+
*Client secret for the Workspace Service (gws-app-workspace-client-secret )
−
--data-raw '{"data": {
+
*Client secret for the Configuration Service (gws-platform-configuration-client-secret)
−
  "name": "external_api_client", ----------------- <Client Name>
+
*Client secret for the Data Collector Service (gws-platform-datacollector-client-secret)
−
  "clientType": "CONFIDENTIAL",
+
*Client secret for the Interaction Service (gws-platform-ixn-client-secret)
−
  "refreshTokenExpirationTimeout": 43200,
+
*Client secret for the OCS Service (gws-platform-ocs-client-secret)
−
  "client_id": "external_api_client", ----------------- <Client ID>
+
*Client secret for the Setting Service (gws-platform-setting-client-secret)
−
  "client_secret": "", --------------------------<Client Password>
+
*Client secret for the Statistics Service (gws-platform-statistics-client-secret)
−
  "authorities": ["ROLE_INTERNAL_CLIENT"],
+
*Client secret for the Voice Service (gws-platform-voice-client-secret)
−
  "scope": ["*"],
+
*Credentials for the operational user (ops-username and ops-password)
−
  "authorizedGrantTypes": ["client_credentials", "authorization_code", "refresh_token", "password"],
+
*{{Editgrn open}}JM: Missing description{{Editgrn close}} (gws-screen-recording-public-secret)
−
  "redirectURIs": ["<nowiki>https://gauth</nowiki>.<yourcluster.com>","<nowiki>https://wwe</nowiki>.<yourcluster.com>","<nowiki>https://gws</nowiki>.<yourcluster.com>","<nowiki>https://pro</nowiki>[https://prov v].<yourcluster.com>"], -----> should add gws/prov external URLS here
+
*{{Editgrn open}}JM: Missing description{{Editgrn close}} (gws-screen-recording-private-secret)
−
  "accessTokenExpirationTimeout": 43200,
+
|Status=No
−
  "contactCenterIds": [
+
}}{{Section
−
  "*" ------------------ <CCID or *>
+
|sectionHeading=Configure security
−
  ]   
+
|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 Engage Cloud Private Edition'' guide.
−
Result:
 
−
"status": {
 
−
  "code": 0
 
−
  },
 
−
  "data": {
 
−
  "clientType": "CONFIDENTIAL",
 
−
  "scope": [
 
−
    "*"
 
−
  ],
 
−
  "internalClient": false,
 
−
  "authorizedGrantTypes": [
 
−
    "refresh_token",
 
−
    "client_credentials",
 
−
    "password",
 
−
    "authorization_code",
 
−
    "urn:ietf:params:oauth:grant-type:token-exchange",
 
−
    "urn:ietf:params:oauth:grant-type:jwt-bearer"
 
−
  ],
 
−
  "authorities": [
 
−
    "ROLE_INTERNAL_CLIENT"
 
−
  ],
 
−
  "redirectURIs": [
 
−
    "<nowiki>https://gauth</nowiki>.<yourcluster.com>",
 
−
    "<nowiki>https://gws</nowiki>.<yourcluster.com>",
 
−
    "<nowiki>https://prov</nowiki>.<yourcluster.com>",       
 
−
    ],
 
−
  "contactCenterIds": [
 
−
    "9350e2fc-a1dd-4c65-8d40-1f75a2e080dd"
 
−
  ],
 
−
  "accessTokenExpirationTimeout": 43200,
 
−
  "refreshTokenExpirationTimeout": 43200,
 
−
  "createdAt": 1619796576236,
 
−
  "name": "external_api_client",
 
−
  "client_id": "external_api_client",
 
−
  "client_secret": "secret",
 
−
  "encrypted_client_secret": "A34BOmXDedZwbTKrwmd4eA=="
 
−
  }
 
−
}
 
  
−
====1. API Client for gws====
+
The security context settings define the privilege and access control settings for pods and containers.
  
−
*'''name''': gws-app-workspace (Note: Name should not be changed)
+
By default, the user and group IDs are set in the '''values.yaml''' file as <tt>500:500:500</tt>, meaning the '''genesys''' user.
−
*'''client_Id''': gws-app-workspace (Note: Client ID should not be changed)
+
<syntaxhighlight>
−
*'''client_secret''': <Your password> - default password is 'secret'
+
deploymentGlobals:
 +
  securityContext:
 +
    runAsUser: 500
 +
    runAsGroup: 500
 +
    fsGroup: 500
 +
    runAsNonRoot: true
 +
</syntaxhighlight>
  
−
Record the 'encrypted_client_secret' as it is used to create your secret.
+
===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.
 +
<syntaxhighlight>
 +
deploymentGlobals:
 +
  securityContext:
 +
    runAsUser: null
 +
    runAsGroup: 0
 +
    fsGroup: null
 +
    runAsNonRoot: true
 +
</syntaxhighlight>
 +
For details about these parameters and possible values, see '''deploymentGlobals.securityContext.*''' in the {{Link-SomewhereInThisVersion|manual=GWSPEGuide|topic=Configure|anchor=globalP|display text=Global parameters}} table above.
 +
|Status=No
 +
}}{{Section
 +
|sectionHeading=Pod priority
 +
|anchor=priority
 +
|alignment=Vertical
 +
|structuredtext=You can configure pod priority by overriding the '''priorityClassName''' option for each of the Web Services and Applications components - see {{Link-SomewhereInThisVersion|manual=GWSPEGuide|topic=Configure|anchor=override|display text=Override Helm chart values}}. For example:<syntaxhighlight>
 +
gwsServices:
 +
  gws-platform-configuration:
 +
    priorityClassName: genesysengage-high-priority
 +
</syntaxhighlight>
  
−
====2. API Client for provisioning (Agent-setup)====
+
Genesys recommends the following priority for GWS pods:
  
−
*'''name''': gws-app-provisioning (Note: Name should not be changed)
+
'''Critical priority pods'''
−
*'''client_Id''': gws-app-provisioning (Note: Client ID should not be changed)
 
−
*'''client_secret''': <secret>
 
  
−
Record the 'encrypted_client_secret' as it is used to create your secret.
+
*gws-app-provisioning
 +
*gws-app-workspace
 +
*gws-platform-voice
  
−
===Create Secrets===
+
'''High priority pods'''
−
Add the following lines to the value override file to have Helm create secrets during deployment:
 
−
secrets:
 
−
  gws-consul-token: <token-from consul>
 
−
  gws-postgres-username: <gws postgres DB username>
 
−
  gws-postgres-password: <gws postgres DB password>
 
−
  ops-user: <ops user>
 
−
  ops-pass-encr: <ops password>
 
−
  agentsetup-postgres-username: <prov postgres username>
 
−
  agentsetup-postgres-password: <prov postgres password>
 
−
  gws-app-workspace-encrypted: <secret(encrypted) for gws-app-workspace client>
 
−
  gws-app-provisioning-encrypted: <secret(encrypted) for gws-app-provisioning client>
 
  
−
===Update Parameters in values.yaml===
+
*gws-platform-configuration
−
In the values.yaml file provided by Genesys, update following parameters:
+
*gws-platform-datacollector
−
Image repo details:
+
*gws-platform-ixn
−
  REGISTRY: <docker-repo>
+
*gws-platform-ocs
−
Postgres:
+
*gws-platform-setting
−
  POSTGRES_ADDR: Postgres service DB URL
+
*gws-platform-statistics
−
  POSTGRES_DB: Postgres DB name for gws service
+
*gws-system-nginx
−
  POSTGRES_USER: Postgres user to access gws DB
+
*gws-ui-crmworkspace
−
  POSTGRES_PASS: Postgres Password
+
*gws-ui-provisioning
−
Redis:
+
*gws-ui-workspace
−
  REDIS_ADDR: Address of the Redis cluster
+
|Status=No
−
  REDIS_PORT: Redis Port
+
}}{{Section
−
elastic:
+
|sectionHeading=Next steps
−
  ELASTICSEARCH_ADDR: Elastic search service master address
+
|anchor=next
−
  ELASTICSEARCH_PORT: Port of ES service
+
|alignment=Vertical
−
Authentication service configurations:
+
|structuredtext=*{{Link-SomewhereInThisVersion|manual=GWSPEGuide|topic=Deploy}}
−
  Add/update below variables in env section of all services under 'gwsServices'
+
*{{Link-SomewhereInThisVersion|manual=GWSPEGuide|topic=ConfigureIngress}}
−
  GWS_SERVICE_AUTH_URL: <nowiki>http://gauth-auth.gauth.svc.cluster.local.:80</nowiki> // Genesys Authentication variable - pointes to internal auth service URL from gauth namesapce, Example: <nowiki>http://gauth-auth.gauth.svc.cluster.local.:80</nowiki>
+
*{{Link-SomewhereInThisVersion|manual=GWSPEGuide|topic=DeployIngress}}
−
  GWS_SERVICE_ENV_URL: <nowiki>http://gauth-environment.gauth.svc.cluster.local.:80</nowiki> // Environment variable pointes to internal environment service URL from gauth namesapce, Example: <nowiki>http://gauth-environment.gauth.svc.cluster.local.:80</nowiki>
+
*{{Link-SomewhereInThisVersion|manual=GWSPEGuide|topic=ProvisionAS}}
−
  GWS_WORKSPACE_SERVICES_ENV: <nowiki>http://gauth-environment.gauth.svc.cluster.local.:80</nowiki> // Environment variable - pointes to internal environment service URL from gauth namesapce, Example: <nowiki>http://gauth-environment.gauth.svc.cluster.local.:80</nowiki>
 
−
  GWS_WORKSPACE_SERVICES_AUTH: <nowiki>http://gauth-auth.gauth.svc.cluster.local.:80</nowiki> // Genesys Authentication variable - should be pointed to internal auth service URL from gauth namesapce, Example: <nowiki>http://gauth-auth.gauth.svc.cluster.local.:80</nowiki>
 
−
  GWS_WORKSPACE_SERVICES_AUTH_FOR_REDIRECT: <nowiki>https://gauth</nowiki>.<yourclusterdomain>.com //Genesys Authentication redirect variable - pointes to external https ingress URL from gauth namesapce, Example: <nowiki>https://gauth.apps</nowiki>.<yourclusterdomain>.com
 
−
 
 
−
===Update the Value Overrides for Agent Setup===
 
−
Agent Setup is part of the GWS deployment. It needs to be configured before the GWS deployment.
 
−
 
 
−
From the gws-services helm charts, update the following lines in the value overrides under the <code>gwsServices</code> > <code>appProvisioning</code> > <code>context</code> > <code>env</code> section before installing GWS:
 
−
 
 
−
*GWS_SERVICE_AUTH_URL: Auth internal service URI from gauth namespace (for example, <nowiki>http://gauth-auth.gauth.svc.cluster.local.:80</nowiki>)
 
−
*GWS_SERVICE_ENV_URL: Environment internal service URI from gauth namespace (for example, <nowiki>http://gauth-environment.gauth.svc.cluster.local.:80</nowiki>)
 
−
*GWS_SERVICE_CONF_URL: gws internal service URI from gws namespace (for example, <nowiki>http://gws-service-proxy.gws.svc.cluster.local:80</nowiki>)
 
−
*GWS_PROVISIONING_SERVICES_AUTH_FOR_REDIRECT : External https ingress URLS from gauth service(ex: <nowiki>https://gauth</nowiki>.<yourclusterdomain.com>)
 
−
*GWS_PROVISIONING_OBJECTCACHE_POSTGRES_USER: <Postgres DB user for provisioning service>
 
−
*GWS_PROVISIONING_OBJECTCACHE_POSTGRES_PASSWORD:  <Postgres DB password for provisioning service>
 
−
*GWS_PROVISIONING_OBJECTCACHE_POSTGRES_HOST:  <Postgres DB host for provisioning>
 
−
*GWS_PROVISIONING_OBJECTCACHE_POSTGRES_PORT:  <Postgres DB Port for provisioning >
 
−
 
 
−
===Create or Update versions.yaml===
 
−
Create/update the versions.yaml file with the latest docker versions. See {{Link-AnywhereElse|product=ReleaseNotes|version=Current|manual=GenesysEngage-cloud|topic=GWSHelm|display text=Updated Helm Charts and Containers}}.<span class="aui-icon aui-icon-small aui-iconfont-info confluence-information-macro-icon"></span>
 
 
|Status=No
 
|Status=No
 
}}
 
}}
 
|PEPageType=9c3ae89b-4f75-495b-85f8-d8c4afcb3f97
 
|PEPageType=9c3ae89b-4f75-495b-85f8-d8c4afcb3f97
 
}}
 
}}

Revision as of 20:42, October 29, 2021

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 Genesys Web Services and Applications.

Create API clients

Use the Genesys Authentication operations API to create API clients for the GWS services. Refer to the API clients table for the name and client_id values you must use in the API request. Make note of encrypted_client_secret in the responses - you need this value to set the related parameter in Override Helm chart values.

API clients
Service name client_id Helm chart parameter
Provisioning Service gws-app-provisioning gws-app-provisioning secrets.gws-app-provisioning-client-secret
Workspace Service gws-app-workspace gws-app-workspace secrets.gws-app-workspace-client-secret
Configuration Service gws-platform-configuration gws-platform-configuration secrets.gws-platform-configuration-client-secret
Data Collector Service gws-platform-datacollector gws-platform-datacollector secrets.gws-platform-datacollector-client-secret
Interaction Service gws-platform-ixn gws-platform-ixn secrets.gws-platform-ixn-client-secret
OCS Service gws-platform-ocs gws-platform-ocs secrets.gws-platform-ocs-client-secret
Setting Service gws-platform-setting gws-platform-setting secrets.gws-platform-setting-client-secret
Statistics Service gws-platform-statistics gws-platform-statistics secrets.gws-platform-statistics-client-secret
Voice Service gws-platform-voice gws-platform-voice secrets.gws-platform-voice-client-secret


Configure a secret to access JFrog

If you haven't done so already, create a secret for accessing the JFrog registry: 

kubectl create secret docker-registry <credential-name> --docker-server=<docker repo> --docker-username=<username> --docker-password=<password> --docker-email=<emailid>

Now map the secret to the default service account: 

kubectl secrets link default <credential-name> --for=pull

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 Web Services and Applications (GWS).

For more information about how to override Helm chart values, see Overriding Helm chart values in the Setting up Genesys Engage Cloud 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 Configure security below.

Global parameters
Parameter Description Valid values 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 labels as "name: value" {}
imageGlobals.registry The Docker registry from which Kubernetes pulls images. A valid registry URL ""
imageGlobals.pullPolicy Specifies when Kubernetes pulls images from the registry on start up. IfNotPresent or Always "Always"
imageGlobals.imagePullSecrets The secret Kubernetes uses to get credentials to pull images from the registry. A valid secret []
deploymentGlobals.deploymentTag A suffix for the names of Kubernetes objects created by the Helm chart. JM: What are the valid values? "live"
deploymentGlobals.strategy The strategy GWS uses to upgrade its containers. RollingUpdate or Recreate "RollingUpdate"
deploymentGlobals.location Location of the deployment. A valid location "/USW1"
deploymentGlobals.securityContext.runAsNonRoot Specifies whether the container must run as a non-root user. true or false true
deploymentGlobals.securityContext.runAsUser 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. A valid user ID or null 500
deploymentGlobals.securityContext.runAsGroup The group ID to run the entry point of the container process. In OpenShift, if your deployment uses arbitrary UIDs set this value to 0. A valid group ID or null 500
deploymentGlobals.securityContext.fsGroup 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. A valid group ID or null 500
serviceGlobals.type The service type for all services. ClusterIP, NodePort, or LoadBalancer "ClusterIP"
serviceGlobals.labels Custom labels to be added for all services. A valid set of labels as "name: value" {}
serviceGlobals.annotations Custom annotations to be added for all services. A valid set of annotations as "name: value" {}
nodeSelector The labels Kubernetes uses to assign pods to nodes. Valid nodeSelector settings. See the Kubernetes documentation for details. {}
tolerations The tolerations Kubernetes uses for advanced pod scheduling. Valid tolerations settings. See the Kubernetes documentation for details. {}
dnsConfig The DNS configuration for pods. Valid DNS configuration settings. See the Kubernetes documentation for details. {}
elasticSearch.address The fully qualified domain name or IP of the Elasticsearch cluster. A valid address ""
elasticSearch.port The Elasticsearch port. A valid port 9200
elasticSearch.enableTls Enable or disable TLS connection to the Elasticsearch cluster. true or false false
postgres.address The fully qualified domain name or IP of the PostgreSQL server. A valid address ""
postgres.db The name of the PostgreSQL database. A valid database name ""
redis.address The Redis cluster host name. A valid address ""
redis.port The Redis port. A valid port 6379
redis.enableTls Enable or disable a TLS connection to the Redis cluster. true or false false
consul.port The port of the local Consul agent. A valid port 8500
consul.kv_prefix The prefix used to locate GWS data in the Consul KV datastore. String "gws"
prometheus.metricServer.enabled Enable annotation-based discovery to scrape metrics. true or false false
secrets.gws-redis-password The password to access the Redis cluster. A valid password ""
secrets.gws-consul-token The API token to access Consul. A valid API token ""
secrets.gws-postgres-username The username to access the PostgreSQL database. A valid username ""
secrets.gws-postgres-password The password to access the PostgreSQL database A valid password ""
secrets.agentsetup-postgres-username The username to access the PostgreSQL database for Agent Setup. A valid username ""
secrets.agentsetup-postgres-password The password to access the PostgreSQL database for Agent Setup. A valid password ""
secrets.gws-app-provisioning-client-secret The encrypted client secret generated by Genesys Authentication for the gws-app-provisioning component. See Create API clients. A valid client secret ""
secrets.gws-app-workspace-client-secret The encrypted client secret generated by Genesys Authentication for the gws-app-workspace component. See Create API clients. A valid client secret ""
secrets.gws-platform-configuration-client-secret The encrypted client secret generated by Genesys Authentication for the gws-platform-configuration component. A valid client secret ""
secrets.gws-platform-datacollector-client-secret The encrypted client secret generated by Genesys Authentication for the gws-platform-datacollector component. A valid client secret ""
secrets.gws-platform-ixn-client-secret The encrypted client secret generated by Genesys Authentication for the gws-platform-ixn component. A valid client secret ""
secrets.gws-platform-ocs-client-secret The encrypted client secret generated by Genesys Authentication for the gws-platform-ocs component. A valid client secret ""
secrets.gws-platform-setting-client-secret The encrypted client secret generated by Genesys Authentication for the gws-platform-setting component. A valid client secret ""
secrets.gws-platform-statistics-client-secret The encrypted client secret generated by Genesys Authentication for the gws-platform-statistics component. A valid client secret ""
secrets.gws-platform-voice-client-secret The encrypted client secret generated by Genesys Authentication for the gws-platform-voice component. A valid client secret ""
secrets.ops-username The username of an operational user. A valid username ""
secrets.ops-password The encrypted password of the operational user. A valid password ""
Provisioning Service parameters
Parameter Description Valid values Default
gwsServices.gws-app-provisioning.name The name of the container deployment. String "gws-app-provisioning"
gwsServices.gws-app-provisioning.appType The type of application in this container. nodejs, java, or frontend "nodejs"
gwsServices.gws-app-provisioning.doLivenessProbe Specifies whether to do a Kubernetes liveness probe to test if the container is running. The probe is configured with a delay of 120 seconds and a period of 10 seconds. true or false true
gwsServices.gws-app-provisioning.clientId The ID of an encrypted client secret generated by Genesys Authentication for this component. A valid ID "gws-app-provisioning"
gwsServices.gws-app-provisioning.priorityClassName The class name Kubernetes uses to determine the priority of the pods for this container deployment relative to other pods. See the Kubernetes documentation for details. A valid priority class name ""
gwsServices.gws-app-provisioning.deployment.replicaCount The number of pod replicas in this container deployment. A number greater than 0 2
gwsServices.gws-app-provisioning.deployment.postfix JM: What is the description for this parameter? JM: What are the valid values? "GWS_PROVISIONING"
gwsServices.gws-app-provisioning.resources.limits.cpu The maximum amount of CPU Kubernetes allocates for the container. See the Kubernetes documentation for details. Units of Kubernetes CPU 4
gwsServices.gws-app-provisioning.resources.limits.memory The maximum amount of memory Kubernetes allocates for the container. See the Kubernetes documentation for details. Units of bytes "5Gi"
gwsServices.gws-app-provisioning.resources.requests.cpu The guaranteed amount of CPU Kubernetes allocates for the container. See the Kubernetes documentation for details. Units of Kubernetes CPU 0.5
gwsServices.gws-app-provisioning.resources.requests.memory The guaranteed amount of memory Kubernetes allocates for the container. See the Kubernetes documentation for details. Units of bytes "5Gi"
gwsServices.gws-app-provisioning.postgres.address The fully qualified domain name or IP of the PostgreSQL server for gws-app-provisioning. A valid address ""
gwsServices.gws-app-provisioning.postgres.port The port of the PostgreSQL server for gws-app-provisioning. A valid port ""
gwsServices.gws-app-provisioning.postgres.db The name of the PostgreSQL database for gws-app-provisioning. A valid database name ""
gwsServices.gws-app-provisioning.context.ports.server The port for this container. A valid port 48060
gwsServices.gws-app-provisioning.context.ports.management The management port for this container. A valid port 48061
gwsServices.gws-app-provisioning.context.loggingLevel Specifies the logging level for this container. ERROR, WARN, INFO, DEBUG, or TRACE ""
gwsServices.gws-app-provisioning.context.env.GWS_PROVISIONING_ASYNC_IO_ENABLED JM: What is the description for this env var? true or false true
gwsServices.gws-app-provisioning.context.env.GWS_PROVISIONING_COMET_ENGINE JM: What is the description for this env var? JM: What are the valid values? "cometd"
gwsServices.gws-app-provisioning.context.env.GWS_PROVISIONING_CONSUL_DISCOVERY_CONFIGSERVICE_NAME JM: What is the description for this env var? JM: What are the valid values? "gws-platform-configuration"
gwsServices.gws-app-provisioning.context.env.GWS_SERVICE_AUTH_URL The internal service URI of the Genesys Authentication service. For example: http://gauth-auth.gauth.svc.cluster.local.:80 A valid URL ""
gwsServices.gws-app-provisioning.context.env.GWS_SERVICE_CONF_URL The internal service URI of the configuration service (part of GWS). For example: http://gws-service-proxy.gws.svc.cluster.local:80 A valid URL ""
gwsServices.gws-app-provisioning.context.env.GWS_SERVICE_ENV_URL The internal service URI of the environment service (part of Genesys Authentication). For example: http://gauth-environment.gauth.svc.cluster.local.:80 A valid URL ""
gwsServices.gws-app-provisioning.context.env.GWS_SERVICE_VOICEMAIL_URL The URL of the voicemail server. A valid URL ""
gwsServices.gws-app-provisioning.context.env.PGSSLMODE Enables or disables the SSL connection to PostgreSQL. See the PostgreSQL documentation for details about SSL modes. disable, prefer, require, verify-ca, or verify-full "require"
gwsServices.gws-app-provisioning.service.ports.server The port for this server. A valid port 80
gwsServices.gws-app-provisioning.service.ports.management The management port for this server. A valid port 81
gwsServices.gws-app-provisioning.labels Custom labels to be added for the container. A valid set of labels as "name: value" {}
gwsServices.gws-app-provisioning.annotations Custom annotations to be added for the container. A valid set of annotations as "name: value" {}
Workspace Service parameters
Parameter Description Valid values Default
gwsServices.gws-app-workspace.name The name of the container deployment. String "gws-app-workspace"
gwsServices.gws-app-workspace.appType The type of application in this container. nodejs, java, or frontend "nodejs"
gwsServices.gws-app-workspace.doLivenessProbe Specifies whether to do a Kubernetes liveness probe to test if the container is running. The probe is configured with a delay of 120 seconds and a period of 10 seconds. true or false true
gwsServices.gws-app-workspace.clientId The ID of an encrypted client secret generated by Genesys Authentication for this component. A valid ID "gws-app-workspace"
gwsServices.gws-app-workspace.priorityClassName The class name Kubernetes uses to determine the priority of the pods for this container deployment relative to other pods. See the Kubernetes documentation for details. A valid priority class name ""
gwsServices.gws-app-workspace.deployment.replicaCount The number of pod replicas in this container deployment. A number greater than 0 2
gwsServices.gws-app-workspace.deployment.postfix JM: What is the description for this parameter? JM: What are the valid values? "GWS_WORKSPACE"
gwsServices.gws-app-workspace.resources.limits.cpu The maximum amount of CPU Kubernetes allocates for the container. See the Kubernetes documentation for details. Units of Kubernetes CPU 4
gwsServices.gws-app-workspace.resources.limits.memory The maximum amount of memory Kubernetes allocates for the container. See the Kubernetes documentation for details. Units of bytes "5Gi"
gwsServices.gws-app-workspace.resources.requests.cpu The guaranteed amount of CPU Kubernetes allocates for the container. See the Kubernetes documentation for details. Units of Kubernetes CPU 0.2
gwsServices.gws-app-workspace.resources.requests.memory The guaranteed amount of memory Kubernetes allocates for the container. See the Kubernetes documentation for details. Units of bytes "5Gi"
gwsServices.gws-app-workspace.context.ports.server The port for this container. A valid port 48050
gwsServices.gws-app-workspace.context.ports.management The management port for this container. A valid port 48051
gwsServices.gws-app-workspace.context.loggingLevel Specifies the logging level for this container. ERROR, WARN, INFO, DEBUG, or TRACE ""
gwsServices.gws-app-workspace.context.env.GWS_WORKSPACE_CONSUL_CACHE_TTL The length of time, in milliseconds, that the Workspace Service keeps service locations in cache locally. Number 60000
gwsServices.gws-app-workspace.context.env.GWS_WORKSPACE_ENABLE_CHANGE_PASSWORD JM: What is the description for this env var? true or false true
gwsServices.gws-app-workspace.context.env.GWS_WORKSPACE_MEMORY_CACHE_ENABLED Specifies whether the Workspace Service should cache configuration data (such as agent groups) in memory. true or false true
gwsServices.gws-app-workspace.service.ports.server The port for this server. A valid port 80
gwsServices.gws-app-workspace.service.ports.management The management port for this server. A valid port 81
gwsServices.gws-app-workspace.labels Custom labels to be added for the container. A valid set of labels as "name: value" {}
gwsServices.gws-app-workspace.annotations Custom annotations to be added for the container. A valid set of annotations as "name: value" {}
Configuration Service parameters
Parameter Description Valid values Default
gwsServices.gws-platform-configuration.name The name of the container deployment. String "gws-platform-configuration"
gwsServices.gws-platform-configuration.appType The type of application in this container. nodejs, java, or frontend "java"
gwsServices.gws-platform-configuration.doLivenessProbe Specifies whether to do a Kubernetes liveness probe to test if the container is running. The probe is configured with a delay of 120 seconds and a period of 10 seconds. true or false true
gwsServices.gws-platform-configuration.clientId The ID of an encrypted client secret generated by Genesys Authentication for this component. A valid ID "gws-platform-configuration"
gwsServices.gws-platform-configuration.priorityClassName The class name Kubernetes uses to determine the priority of the pods for this container deployment relative to other pods. See the Kubernetes documentation for details. A valid priority class name ""
gwsServices.gws-platform-configuration.deployment.replicaCount The number of pod replicas in this container deployment. A number greater than 0 2
gwsServices.gws-platform-configuration.deployment.postfix JM: What is the description for this parameter? JM: What are the valid values? "GWS_CONFIGURATION"
gwsServices.gws-platform-configuration.resources.limits.cpu The maximum amount of CPU Kubernetes allocates for the container. See the Kubernetes documentation for details. Units of Kubernetes CPU 4
gwsServices.gws-platform-configuration.resources.limits.memory The maximum amount of memory Kubernetes allocates for the container. See the Kubernetes documentation for details. Units of bytes "4Gi"
gwsServices.gws-platform-configuration.resources.requests.cpu The guaranteed amount of CPU Kubernetes allocates for the container. See the Kubernetes documentation for details. Units of Kubernetes CPU 0.2
gwsServices.gws-platform-configuration.resources.requests.memory The guaranteed amount of memory Kubernetes allocates for the container. See the Kubernetes documentation for details. Units of bytes "4Gi"
gwsServices.gws-platform-configuration.context.ports.server The port for this container. A valid port 48030
gwsServices.gws-platform-configuration.context.ports.management The management port for this container. A valid port 48031
gwsServices.gws-platform-configuration.context.loggingLevel Specifies the logging level for this container. ERROR, WARN, INFO, DEBUG, or TRACE ""
gwsServices.gws-platform-configuration.context.env.GWS_CONFIGURATION_COMMON_DISCOVERY_TENANTS JM: What is the description for this env var? true or false true
gwsServices.gws-platform-configuration.service.ports.server The port for this server. A valid port 80
gwsServices.gws-platform-configuration.service.ports.management The management port for this server. A valid port 81
gwsServices.gws-platform-configuration.labels Custom labels to be added for the container. A valid set of labels as "name: value" {}
gwsServices.gws-platform-configuration.annotations Custom annotations to be added for the container. A valid set of annotations as "name: value" {}
Data Collector Service parameters
Parameter Description Valid values Default
gwsServices.gws-platform-datacollector.name The name of the container deployment. String "gws-platform-datacollector"
gwsServices.gws-platform-datacollector.appType The type of application in this container. nodejs, java, or frontend "java"
gwsServices.gws-platform-datacollector.doLivenessProbe Specifies whether to do a Kubernetes liveness probe to test if the container is running. The probe is configured with a delay of 120 seconds and a period of 10 seconds. true or false true
gwsServices.gws-platform-datacollector.clientId The ID of an encrypted client secret generated by Genesys Authentication for this component. A valid ID "gws-platform-datacollector"
gwsServices.gws-platform-datacollector.priorityClassName The class name Kubernetes uses to determine the priority of the pods for this container deployment relative to other pods. See the Kubernetes documentation for details. A valid priority class name ""
gwsServices.gws-platform-datacollector.deployment.replicaCount The number of pod replicas in this container deployment. A number greater than 0 2
gwsServices.gws-platform-datacollector.deployment.postfix JM: What is the description for this parameter? JM: What are the valid values? "GWS_DATACOLLECTOR"
gwsServices.gws-platform-datacollector.resources.limits.cpu The maximum amount of CPU Kubernetes allocates for the container. See the Kubernetes documentation for details. Units of Kubernetes CPU 4
gwsServices.gws-platform-datacollector.resources.limits.memory The maximum amount of memory Kubernetes allocates for the container. See the Kubernetes documentation for details. Units of bytes "5Gi"
gwsServices.gws-platform-datacollector.resources.requests.cpu The guaranteed amount of CPU Kubernetes allocates for the container. See the Kubernetes documentation for details. Units of Kubernetes CPU 0.2
gwsServices.gws-platform-datacollector.resources.requests.memory The guaranteed amount of memory Kubernetes allocates for the container. See the Kubernetes documentation for details. Units of bytes "4Gi"
gwsServices.gws-platform-datacollector.context.ports.server The port for this container. A valid port 48180
gwsServices.gws-platform-datacollector.context.ports.management The management port for this container. A valid port 48181
gwsServices.gws-platform-datacollector.context.loggingLevel Specifies the logging level for this container. ERROR, WARN, INFO, DEBUG, or TRACE ""
gwsServices.gws-platform-datacollector.context.env.gws_datacollector_services_datacollector_distribution_enabled Enables task distribution for the data collector. true or false true
gwsServices.gws-platform-datacollector.context.env.GWS_DATACOLLECTOR_SERVICES_DATACOLLECTOR_REINDEX_ENABLED Enables background service for reindexing data. true or false true
gwsServices.gws-platform-datacollector.context.env.gws_datacollector_services_datacollector_reindex_onStart Specifies whether to perform a reindex on start. true or false true
gwsServices.gws-platform-datacollector.context.env.GWS_DATACOLLECTOR_SERVICES_DATACOLLECTOR_REINDEX_PERIOD The period in minutes between scheduled reindex attempts. A time in minutes 30
gwsServices.gws-platform-datacollector.context.env.GWS_DATACOLLECTOR_SERVICES_DATACOLLECTOR_STATISTICS_ENABLED Enables statistics monitoring. true or false true
gwsServices.gws-platform-datacollector.context.env.GWS_DATACOLLECTOR_services_datacollector_statistics_period Period in minutes between statistics checks. A time in minutes 5
gwsServices.gws-platform-datacollector.service.ports.server The port for this server. A valid port 80
gwsServices.gws-platform-datacollector.service.ports.management The management port for this server. A valid port 81
gwsServices.gws-platform-datacollector.labels Custom labels to be added for the container. A valid set of labels as "name: value" {}
gwsServices.gws-platform-datacollector.annotations Custom annotations to be added for the container. A valid set of annotations as "name: value" {}
Interaction Service parameters
Parameter Description Valid values Default
gwsServices.gws-platform-ixn.name The name of the container deployment. String "gws-platform-ixn"
gwsServices.gws-platform-ixn.appType The type of application in this container. nodejs, java, or frontend "java"
gwsServices.gws-platform-ixn.doLivenessProbe Specifies whether to do a Kubernetes liveness probe to test if the container is running. The probe is configured with a delay of 120 seconds and a period of 10 seconds. true or false true
gwsServices.gws-platform-ixn.clientId The ID of an encrypted client secret generated by Genesys Authentication for this component. A valid ID "gws-platform-ixn"
gwsServices.gws-platform-ixn.priorityClassName The class name Kubernetes uses to determine the priority of the pods for this container deployment relative to other pods. See the Kubernetes documentation for details. A valid priority class name ""
gwsServices.gws-platform-ixn.deployment.replicaCount The number of pod replicas in this container deployment. A number greater than 0 2
gwsServices.gws-platform-ixn.deployment.postfix JM: What is the description for this parameter? JM: What are the valid values? "GWS_IXN"
gwsServices.gws-platform-ixn.resources.limits.cpu The maximum amount of CPU Kubernetes allocates for the container. See the Kubernetes documentation for details. Units of Kubernetes CPU 4
gwsServices.gws-platform-ixn.resources.limits.memory The maximum amount of memory Kubernetes allocates for the container. See the Kubernetes documentation for details. Units of bytes "4Gi"
gwsServices.gws-platform-ixn.resources.requests.cpu The guaranteed amount of CPU Kubernetes allocates for the container. See the Kubernetes documentation for details. Units of Kubernetes CPU 0.2
gwsServices.gws-platform-ixn.resources.requests.memory The guaranteed amount of memory Kubernetes allocates for the container. See the Kubernetes documentation for details. Units of bytes "4Gi"
gwsServices.gws-platform-ixn.context.ports.server The port for this container. A valid port 48170
gwsServices.gws-platform-ixn.context.ports.management The management port for this container. A valid port 48171
gwsServices.gws-platform-ixn.context.loggingLevel Specifies the logging level for this container. ERROR, WARN, INFO, DEBUG, or TRACE ""
gwsServices.gws-platform-ixn.context.env Environment variables for this container. {}
gwsServices.gws-platform-ixn.service.ports.server The port for this server. A valid port 80
gwsServices.gws-platform-ixn.service.ports.management The management port for this server. A valid port 81
gwsServices.gws-platform-ixn.labels Custom labels to be added for the container. A valid set of labels as "name: value" {}
gwsServices.gws-platform-ixn.annotations Custom annotations to be added for the container. A valid set of annotations as "name: value" {}
OCS Service parameters
Parameter Description Valid values Default
gwsServices.gws-platform-ocs.name The name of the container deployment. String "gws-platform-ocs"
gwsServices.gws-platform-ocs.appType The type of application in this container. nodejs, java, or frontend "java"
gwsServices.gws-platform-ocs.doLivenessProbe Specifies whether to do a Kubernetes liveness probe to test if the container is running. The probe is configured with a delay of 120 seconds and a period of 10 seconds. true or false true
gwsServices.gws-platform-ocs.clientId The ID of an encrypted client secret generated by Genesys Authentication for this component. A valid ID "gws-platform-ocs"
gwsServices.gws-platform-ocs.priorityClassName The class name Kubernetes uses to determine the priority of the pods for this container deployment relative to other pods. See the Kubernetes documentation for details. A valid priority class name ""
gwsServices.gws-platform-ocs.deployment.replicaCount The number of pod replicas in this container deployment. A number greater than 0 2
gwsServices.gws-platform-ocs.deployment.postfix JM: What is the description for this parameter? JM: What are the valid values? "GWS_OCS"
gwsServices.gws-platform-ocs.resources.limits.cpu The maximum amount of CPU Kubernetes allocates for the container. See the Kubernetes documentation for details. Units of Kubernetes CPU 4
gwsServices.gws-platform-ocs.resources.limits.memory The maximum amount of memory Kubernetes allocates for the container. See the Kubernetes documentation for details. Units of bytes "4Gi"
gwsServices.gws-platform-ocs.resources.requests.cpu The guaranteed amount of CPU Kubernetes allocates for the container. See the Kubernetes documentation for details. Units of Kubernetes CPU 0.2
gwsServices.gws-platform-ocs.resources.requests.memory The guaranteed amount of memory Kubernetes allocates for the container. See the Kubernetes documentation for details. Units of bytes "4Gi"
gwsServices.gws-platform-ocs.context.ports.server The port for this container. A valid port 48090
gwsServices.gws-platform-ocs.context.ports.management The management port for this container. A valid port 48091
gwsServices.gws-platform-ocs.context.loggingLevel Specifies the logging level for this container. ERROR, WARN, INFO, DEBUG, or TRACE ""
gwsServices.gws-platform-ocs.context.env.GWS_OCS_timeouts_requestTimeoutMs JM: What is the description for this env var? A time in milliseconds 5000
gwsServices.gws-platform-ocs.service.ports.server The port for this server. A valid port 80
gwsServices.gws-platform-ocs.service.ports.management The management port for this server. A valid port 81
gwsServices.gws-platform-ocs.labels Custom labels to be added for the container. A valid set of labels as "name: value" {}
gwsServices.gws-platform-ocs.annotations Custom annotations to be added for the container. A valid set of annotations as "name: value" {}
Setting Service parameters
Parameter Description Valid values Default
gwsServices.gws-platform-setting.name The name of the container deployment. String "gws-platform-configuration"
gwsServices.gws-platform-setting.appType The type of application in this container. nodejs, java, or frontend "java"
gwsServices.gws-platform-setting.doLivenessProbe Specifies whether to do a Kubernetes liveness probe to test if the container is running. The probe is configured with a delay of 120 seconds and a period of 10 seconds. true or false true
gwsServices.gws-platform-setting.clientId The ID of an encrypted client secret generated by Genesys Authentication for this component. A valid ID "gws-platform-setting"
gwsServices.gws-platform-setting.priorityClassName The class name Kubernetes uses to determine the priority of the pods for this container deployment relative to other pods. See the Kubernetes documentation for details. A valid priority class name ""
gwsServices.gws-platform-setting.deployment.replicaCount The number of pod replicas in this container deployment. A number greater than 0 2
gwsServices.gws-platform-setting.deployment.postfix JM: What is the description for this parameter? JM: What are the valid values? "GWS_SETTING"
gwsServices.gws-platform-setting.resources.limits.cpu The maximum amount of CPU Kubernetes allocates for the container. See the Kubernetes documentation for details. Units of Kubernetes CPU 4
gwsServices.gws-platform-setting.resources.limits.memory The maximum amount of memory Kubernetes allocates for the container. See the Kubernetes documentation for details. Units of bytes "4Gi"
gwsServices.gws-platform-setting.resources.requests.cpu The guaranteed amount of CPU Kubernetes allocates for the container. See the Kubernetes documentation for details. Units of Kubernetes CPU 0.2
gwsServices.gws-platform-setting.resources.requests.memory The guaranteed amount of memory Kubernetes allocates for the container. See the Kubernetes documentation for details. Units of bytes "4Gi"
gwsServices.gws-platform-setting.context.ports.server The port for this container. A valid port 48140
gwsServices.gws-platform-setting.context.ports.management The management port for this container. A valid port 48141
gwsServices.gws-platform-setting.context.loggingLevel Specifies the logging level for this container. ERROR, WARN, INFO, DEBUG, or TRACE ""
gwsServices.gws-platform-setting.context.env.GWS_SETTING_DB_INIT_DB JM: What is the description for this env var? true or false true
gwsServices.gws-platform-setting.service.ports.server The port for this server. A valid port 80
gwsServices.gws-platform-setting.service.ports.management The management port for this server. A valid port 81
gwsServices.gws-platform-setting.labels Custom labels to be added for the container. A valid set of labels as "name: value" {}
gwsServices.gws-platform-setting.annotations Custom annotations to be added for the container. A valid set of annotations as "name: value" {}
Statistics Service parameters
Parameter Description Valid values Default
gwsServices.gws-platform-statistics.name The name of the container deployment. String "gws-platform-statistics"
gwsServices.gws-platform-statistics.appType The type of application in this container. nodejs, java, or frontend "java"
gwsServices.gws-platform-statistics.doLivenessProbe Specifies whether to do a Kubernetes liveness probe to test if the container is running. The probe is configured with a delay of 120 seconds and a period of 10 seconds. true or false true
gwsServices.gws-platform-statistics.clientId The ID of an encrypted client secret generated by Genesys Authentication for this component. A valid ID "gws-platform-statistics"
gwsServices.gws-platform-statistics.priorityClassName The class name Kubernetes uses to determine the priority of the pods for this container deployment relative to other pods. See the Kubernetes documentation for details. A valid priority class name ""
gwsServices.gws-platform-statistics.deployment.replicaCount The number of pod replicas in this container deployment. A number greater than 0 2
gwsServices.gws-platform-statistics.deployment.postfix JM: What is the description for this parameter? JM: What are the valid values? "GWS_STATISTICS"
gwsServices.gws-platform-statistics.resources.limits.cpu The maximum amount of CPU Kubernetes allocates for the container. See the Kubernetes documentation for details. Units of Kubernetes CPU 4
gwsServices.gws-platform-statistics.resources.limits.memory The maximum amount of memory Kubernetes allocates for the container. See the Kubernetes documentation for details. Units of bytes "4Gi"
gwsServices.gws-platform-statistics.resources.requests.cpu The guaranteed amount of CPU Kubernetes allocates for the container. See the Kubernetes documentation for details. Units of Kubernetes CPU 0.2
gwsServices.gws-platform-statistics.resources.requests.memory The guaranteed amount of memory Kubernetes allocates for the container. See the Kubernetes documentation for details. Units of bytes "4Gi"
gwsServices.gws-platform-statistics.context.ports.server The port for this container. A valid port 48070
gwsServices.gws-platform-statistics.context.ports.management The management port for this container. A valid port 48071
gwsServices.gws-platform-statistics.context.loggingLevel Specifies the logging level for this container. ERROR, WARN, INFO, DEBUG, or TRACE ""
gwsServices.gws-platform-statistics.context.env Environment variables for this container. {}
gwsServices.gws-platform-statistics.service.ports.server The port for this server. A valid port 80
gwsServices.gws-platform-statistics.service.ports.management The management port for this server. A valid port 81
gwsServices.gws-platform-statistics.labels Custom labels to be added for the container. A valid set of labels as "name: value" {}
gwsServices.gws-platform-statistics.annotations Custom annotations to be added for the container. A valid set of annotations as "name: value" {}
Voice Service parameters
Parameter Description Valid values Default
gwsServices.gws-platform-voice.name The name of the container deployment. String "gws-platform-voice"
gwsServices.gws-platform-voice.appType The type of application in this container. nodejs, java, or frontend "java"
gwsServices.gws-platform-voice.doLivenessProbe Specifies whether to do a Kubernetes liveness probe to test if the container is running. The probe is configured with a delay of 120 seconds and a period of 10 seconds. true or false true
gwsServices.gws-platform-voice.clientId The ID of an encrypted client secret generated by Genesys Authentication for this component. A valid ID "gws-platform-voice"
gwsServices.gws-platform-voice.priorityClassName The class name Kubernetes uses to determine the priority of the pods for this container deployment relative to other pods. See the Kubernetes documentation for details. A valid priority class name ""
gwsServices.gws-platform-voice.deployment.replicaCount The number of pod replicas in this container deployment. A number greater than 0 2
gwsServices.gws-platform-voice.deployment.postfix JM: What is the description for this parameter? JM: What are the valid values? "GWS_VOICE"
gwsServices.gws-platform-voice.resources.limits.cpu The maximum amount of CPU Kubernetes allocates for the container. See the Kubernetes documentation for details. Units of Kubernetes CPU 4
gwsServices.gws-platform-voice.resources.limits.memory The maximum amount of memory Kubernetes allocates for the container. See the Kubernetes documentation for details. Units of bytes "4Gi"
gwsServices.gws-platform-voice.resources.requests.cpu The guaranteed amount of CPU Kubernetes allocates for the container. See the Kubernetes documentation for details. Units of Kubernetes CPU 0.2
gwsServices.gws-platform-voice.resources.requests.memory The guaranteed amount of memory Kubernetes allocates for the container. See the Kubernetes documentation for details. Units of bytes "4Gi"
gwsServices.gws-platform-voice.context.ports.server The port for this container. A valid port 48040
gwsServices.gws-platform-voice.context.ports.management The management port for this container. A valid port 48041
gwsServices.gws-platform-voice.context.loggingLevel Specifies the logging level for this container. ERROR, WARN, INFO, DEBUG, or TRACE ""
gwsServices.gws-platform-voice.context.env Environment variables for this container. {}
gwsServices.gws-platform-voice.service.ports.server The port for this server. A valid port 80
gwsServices.gws-platform-voice.service.ports.management The management port for this server. A valid port 81
gwsServices.gws-platform-voice.labels Custom labels to be added for the container. A valid set of labels as "name: value" {}
gwsServices.gws-platform-voice.annotations Custom annotations to be added for the container. A valid set of annotations as "name: value" {}
Gplus Adapter for Salesforce parameters
Parameter Description Valid values Default
gwsServices.gws-ui-crmworkspace.name The name of the container deployment. String "gws-ui-crmworkspace"
gwsServices.gws-ui-crmworkspace.appType The type of application in this container. nodejs, java, or frontend "frontend"
gwsServices.gws-ui-crmworkspace.doLivenessProbe Specifies whether to do a Kubernetes liveness probe to test if the container is running. The probe is configured with a delay of 120 seconds and a period of 10 seconds. true or false false
gwsServices.gws-ui-crmworkspace.priorityClassName The class name Kubernetes uses to determine the priority of the pods for this container deployment relative to other pods. See the Kubernetes documentation for details. A valid priority class name ""
gwsServices.gws-ui-crmworkspace.deployment.replicaCount The number of pod replicas in this container deployment. A number greater than 0 2
gwsServices.gws-ui-crmworkspace.deployment.postfix JM: What is the description for this parameter? JM: What are the valid values? "GWS_UI_CRM_WORKSPACE"
gwsServices.gws-ui-crmworkspace.resources.limits.cpu The maximum amount of CPU Kubernetes allocates for the container. See the Kubernetes documentation for details. Units of Kubernetes CPU 1
gwsServices.gws-ui-crmworkspace.resources.limits.memory The maximum amount of memory Kubernetes allocates for the container. See the Kubernetes documentation for details. Units of bytes "0.5Gi"
gwsServices.gws-ui-crmworkspace.resources.requests.cpu The guaranteed amount of CPU Kubernetes allocates for the container. See the Kubernetes documentation for details. Units of Kubernetes CPU 0.1
gwsServices.gws-ui-crmworkspace.resources.requests.memory The guaranteed amount of memory Kubernetes allocates for the container. See the Kubernetes documentation for details. Units of bytes "0.5Gi"
gwsServices.gws-ui-crmworkspace.context.ports.server The port for this container. A valid port 50070
gwsServices.gws-ui-crmworkspace.context.ports.management The management port for this container. A valid port 50070
gwsServices.gws-ui-crmworkspace.context.env Environment variables for this container. {}
gwsServices.gws-ui-crmworkspace.service.ports.server The port for this server. A valid port 80
gwsServices.gws-ui-crmworkspace.service.ports.management The management port for this server. A valid port 81
gwsServices.gws-ui-crmworkspace.labels Custom labels to be added for the container. A valid set of labels as "name: value" {}
gwsServices.gws-ui-crmworkspace.annotations Custom annotations to be added for the container. A valid set of annotations as "name: value" {}
Agent Setup parameters
Parameter Description Valid values Default
gwsServices.gws-ui-provisioning.name The name of the container deployment. String "gws-ui-provisioning"
gwsServices.gws-ui-provisioning.appType The type of application in this container. nodejs, java, or frontend "frontend"
gwsServices.gws-ui-provisioning.doLivenessProbe Specifies whether to do a Kubernetes liveness probe to test if the container is running. The probe is configured with a delay of 120 seconds and a period of 10 seconds. true or false false
gwsServices.gws-ui-provisioning.priorityClassName The class name Kubernetes uses to determine the priority of the pods for this container deployment relative to other pods. See the Kubernetes documentation for details. A valid priority class name ""
gwsServices.gws-ui-provisioning.deployment.replicaCount The number of pod replicas in this container deployment. A number greater than 0 2
gwsServices.gws-ui-provisioning.deployment.postfix JM: What is the description for this parameter? JM: What are the valid values? "GWS_UI_PROVISIONING"
gwsServices.gws-ui-provisioning.resources.limits.cpu The maximum amount of CPU Kubernetes allocates for the container. See the Kubernetes documentation for details. Units of Kubernetes CPU 1
gwsServices.gws-ui-provisioning.resources.limits.memory The maximum amount of memory Kubernetes allocates for the container. See the Kubernetes documentation for details. Units of bytes "0.5Gi"
gwsServices.gws-ui-provisioning.resources.requests.cpu The guaranteed amount of CPU Kubernetes allocates for the container. See the Kubernetes documentation for details. Units of Kubernetes CPU 0.5
gwsServices.gws-ui-provisioning.resources.requests.memory The guaranteed amount of memory Kubernetes allocates for the container. See the Kubernetes documentation for details. Units of bytes "0.5Gi"
gwsServices.gws-ui-provisioning.context.ports.server The port for this container. A valid port 50040
gwsServices.gws-ui-provisioning.context.ports.management The management port for this container. A valid port 50040
gwsServices.gws-ui-provisioning.service.ports.server The port for this server. A valid port 80
gwsServices.gws-ui-provisioning.service.ports.management The management port for this server. A valid port 81
gwsServices.gws-ui-provisioning.labels Custom labels to be added for the container. A valid set of labels as "name: value" {}
gwsServices.gws-ui-provisioning.annotations Custom annotations to be added for the container. A valid set of annotations as "name: value" {}
Workspace Web Edition parameters
Parameter Description Valid values Default
gwsServices.gws-ui-workspace.name The name of the container deployment. String "gws-ui-workspace"
gwsServices.gws-ui-workspace.appType The type of application in this container. nodejs, java, or frontend "frontend"
gwsServices.gws-ui-workspace.doLivenessProbe Specifies whether to do a Kubernetes liveness probe to test if the container is running. The probe is configured with a delay of 120 seconds and a period of 10 seconds. true or false false
gwsServices.gws-ui-workspace.priorityClassName The class name Kubernetes uses to determine the priority of the pods for this container deployment relative to other pods. See the Kubernetes documentation for details. A valid priority class name ""
gwsServices.gws-ui-workspace.deployment.replicaCount The number of pod replicas in this container deployment. A number greater than 0 2
gwsServices.gws-ui-workspace.deployment.postfix JM: What is the description for this parameter? JM: What are the valid values? "GWS_UI_WORKSPACE"
gwsServices.gws-ui-workspace.resources.limits.cpu The maximum amount of CPU Kubernetes allocates for the container. See the Kubernetes documentation for details. Units of Kubernetes CPU 1
gwsServices.gws-ui-workspace.resources.limits.memory The maximum amount of memory Kubernetes allocates for the container. See the Kubernetes documentation for details. Units of bytes "0.5Gi"
gwsServices.gws-ui-workspace.resources.requests.cpu The guaranteed amount of CPU Kubernetes allocates for the container. See the Kubernetes documentation for details. Units of Kubernetes CPU 0.1
gwsServices.gws-ui-workspace.resources.requests.memory The guaranteed amount of memory Kubernetes allocates for the container. See the Kubernetes documentation for details. Units of bytes "0.5Gi"
gwsServices.gws-ui-workspace.context.ports.server The port for this container. A valid port 50020
gwsServices.gws-ui-workspace.context.ports.management The management port for this container. A valid port 50020
gwsServices.gws-ui-workspace.context.env Environment variables for this container. {}
gwsServices.gws-ui-workspace.service.ports.server The port for this server. A valid port 80
gwsServices.gws-ui-workspace.service.ports.management The management port for this server. A valid port 81
gwsServices.gws-ui-workspace.labels Custom labels to be added for the container. A valid set of labels as "name: value" {}
gwsServices.gws-ui-workspace.annotations Custom annotations to be added for the container. A valid set of annotations as "name: value" {}

Create or update the versions file

Create or update the versions.yaml file with the latest container versions for your deployment. See Updated Helm Charts and Containers for Web Services and Applications for the full list of versions.

For example:
gws-app-provisioning:9.0.000.93
gws-app-workspace:9.0.000.90
gws-platform-configuration:9.0.000.79
gws-platform-datacollector:9.0.000.50
gws-platform-ixn:9.0.000.43
gws-platform-ocs:9.0.000.46
gws-platform-setting:9.0.000.52
gws-platform-statistics:9.0.000.61
gws-platform-voice:9.0.000.66
gws-system-nginx:9.0.000.16
gws-ui-crmworkspace:9.0.000.62
gws-ui-provisioning:9.0.000.84
gws-ui-workspace:9.0.000.82

Configure Kubernetes

GWS stores the following sensitive data as Kubernetes secrets. See the secrets.* parameters in the Global parameters table in the "Override Helm chart values" section for details.

  • Redis password (gws-redis-password)
  • Consul API token (gws-consul-token)
  • PostgreSQL database credentials for GWS (gws-postgres-username and gws-postgres-password)
  • PostgreSQL database credentials for Agent Setup (agentsetup-postgres-username and agentsetup-postgres-password)
  • Client secret for the Provisioning Service (gws-app-provisioning-client-secret)
  • Client secret for the Workspace Service (gws-app-workspace-client-secret )
  • Client secret for the Configuration Service (gws-platform-configuration-client-secret)
  • Client secret for the Data Collector Service (gws-platform-datacollector-client-secret)
  • Client secret for the Interaction Service (gws-platform-ixn-client-secret)
  • Client secret for the OCS Service (gws-platform-ocs-client-secret)
  • Client secret for the Setting Service (gws-platform-setting-client-secret)
  • Client secret for the Statistics Service (gws-platform-statistics-client-secret)
  • Client secret for the Voice Service (gws-platform-voice-client-secret)
  • Credentials for the operational user (ops-username and ops-password)
  • JM: Missing description (gws-screen-recording-public-secret)
  • JM: Missing description (gws-screen-recording-private-secret)

Configure security

To learn more about how security is configured for private edition, be sure to read the Permissions and OpenShift security settings topics in the Setting up Genesys Engage Cloud Private Edition guide.

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

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. 

deploymentGlobals:
  securityContext:
    runAsUser: null
    runAsGroup: 0
    fsGroup: null
    runAsNonRoot: true

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

Pod priority

You can configure pod priority by overriding the priorityClassName option for each of the Web Services and Applications components - see Override Helm chart values. For example:
gwsServices:
  gws-platform-configuration:
    priorityClassName: genesysengage-high-priority

Genesys recommends the following priority for GWS pods:

Critical priority pods

  • gws-app-provisioning
  • gws-app-workspace
  • gws-platform-voice

High priority pods

  • gws-platform-configuration
  • gws-platform-datacollector
  • gws-platform-ixn
  • gws-platform-ocs
  • gws-platform-setting
  • gws-platform-statistics
  • gws-system-nginx
  • gws-ui-crmworkspace
  • gws-ui-provisioning
  • gws-ui-workspace

Next steps

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