PEC-AD/Current/WWEPEGuide/Configure - Revision history

WikiSysop at 08:01, March 28, 2023

2023-03-28T08:01:35Z

WikiSysop at 16:45, November 17, 2022

2022-11-17T16:45:39Z

WikiSysop at 14:45, May 20, 2022

2022-05-20T14:45:40Z

WikiSysop at 13:30, March 31, 2022

2022-03-31T13:30:57Z

Matthew.west@genesys.com: Published

2021-09-17T20:19:59Z

Published

Julie.munn@genesys.com: Published

2021-06-29T14:24:56Z

Published

New page

{{Article
|Standalone=No
|DisplayName=Configure Workspace Web Edition
|TocName=Configure WWE
|Context=Learn how to configure Workspace Web Edition.
|ComingSoon=No
|Section={{Section
|sectionHeading=Override Helm chart values
|anchor=Override
|alignment=Vertical
|structuredtext=You can override values in the Helm charts to configure Workspace Web Edition (WWE) by using the <code>--set</code> flag or by {{Link-SomewhereInThisVersion|manual=WWEPEGuide|topic=Configure|anchor=yaml|display text=creating the values.yaml file}}. For more information about how to override Helm chart values, see {{SuiteLevelLink|helmoverride}}.

Refer to the '''Parameters''' table for a full list of overridable values for WWE.
{{{!}} class="wikitable"
{{!}}+Parameters
! align="left"{{!}}Parameter
! align="left"{{!}}Description
! align="left"{{!}}Default
!Valid Values
{{!}}-
{{!}} align="left"{{!}}wwe.image.registry
{{!}} align="left"{{!}}docker registry
{{!}} align="left"{{!}}pureengage-docker-staging.jfrog.io
{{!}}A valid registry
{{!}}-
{{!}} align="left"{{!}}wwe.image.repository
{{!}} align="left"{{!}}docker repository
{{!}} align="left"{{!}}wwe
{{!}}Valid repository in the registry
{{!}}-
{{!}} align="left"{{!}}wwe.image.tag
{{!}} align="left"{{!}}WWE image version
{{!}} align="left"{{!}}9.0.000.81.10348
{{!}}Valid version of the WWE image
{{!}}-
{{!}} align="left"{{!}}wwe.image.pullPolicy
{{!}} align="left"{{!}}Image pull policy
{{!}} align="left"{{!}}IfNotPresent
{{!}}Kubernetes pullpolicy: IfNotPresent/Always
{{!}}-
{{!}} align="left"{{!}}wwe.image.imagePullSecrets
{{!}} align="left"{{!}}Image pull secrets
{{!}} align="left"{{!}}[]
{{!}}Array of pull secrets to use to pull from registry
{{!}}-
{{!}} align="left"{{!}}wwe.service.enabled
{{!}} align="left"{{!}}Create k8s service
{{!}} align="left"{{!}}true
{{!}}Boolean
{{!}}-
{{!}} align="left"{{!}}wwe.service.type
{{!}} align="left"{{!}}k8s service type
{{!}} align="left"{{!}}ClusterIP
{{!}}Kubernetes Service Type value
{{!}}-
{{!}} align="left"{{!}}wwe.service.port
{{!}} align="left"{{!}}k8s service port
{{!}} align="left"{{!}}80
{{!}}Valid port number
{{!}}-
{{!}} align="left"{{!}}wwe.ingress.enabled
{{!}} align="left"{{!}}enabling ingress
{{!}} align="left"{{!}}false
{{!}}Boolean
{{!}}-
{{!}} align="left"{{!}}wwe.ingress.annotations
{{!}} align="left"{{!}}ingress annotations
{{!}} align="left"{{!}}{}
{{!}}Key/value map of annotations
{{!}}-
{{!}} align="left"{{!}}wwe.ingress.hosts
{{!}} align="left"{{!}}host configurations
{{!}} align="left"{{!}}{}
{{!}}Valid host kubernetes Ingress mapping
{{!}}-
{{!}} align="left"{{!}}wwe.ingress.tls
{{!}} align="left"{{!}}TLS based security enabling
{{!}} align="left"{{!}}{}
{{!}}Valid tls kubernetes Ingress mapping
{{!}}-
{{!}} align="left"{{!}}wwe.resources.limits.cpu
{{!}} align="left"{{!}}Maximum amount of CPU K8s allocates for container
{{!}} align="left"{{!}}500m
{{!}}Number of milicpu. See k8s doc
{{!}}-
{{!}} align="left"{{!}}wwe.resources.limits.memory
{{!}} align="left"{{!}}Maximum amount of Memory K8s allocates for container
{{!}} align="left"{{!}}4Gi
{{!}}Bytes allocation
{{!}}-
{{!}} align="left"{{!}}wwe.resources.requests.cpu
{{!}} align="left"{{!}}Guaranteed CPU allocation for container
{{!}} align="left"{{!}}4
{{!}}Number
{{!}}-
{{!}} align="left"{{!}}wwe.resources.requests.memory
{{!}} align="left"{{!}}Guaranteed Memory allocation for container
{{!}} align="left"{{!}}6Gi
{{!}}Bytes allocation
{{!}}-
{{!}} align="left"{{!}}wwe.deployment.strategy
{{!}} align="left"{{!}}k8s deployment strategy
{{!}} align="left"{{!}}{}
{{!}}Kubernetes deployment strategy map
{{!}}-
{{!}} align="left"{{!}}wwe.livenessProbe.httpGet.path
{{!}} align="left"{{!}}liveness prob path
{{!}} align="left"{{!}}/index.html
{{!}}Valid internal pass
{{!}}-
{{!}} align="left"{{!}}wwe.livenessProbe.httpGet.port
{{!}} align="left"{{!}}liveness prob port to use
{{!}} align="left"{{!}}http
{{!}}http
{{!}}-
{{!}} align="left"{{!}}wwe.livenessProbe.initialDelaySeconds
{{!}} align="left"{{!}}liveness prob startup delay
{{!}} align="left"{{!}}10
{{!}}Number
{{!}}-
{{!}} align="left"{{!}}wwe.livenessProbe.periodSeconds
{{!}} align="left"{{!}}liveness prob check interval
{{!}} align="left"{{!}}5
{{!}}Number
{{!}}-
{{!}} align="left"{{!}}wwe.livenessProbe.failureThreshold
{{!}} align="left"{{!}}liveness prob failure count
{{!}} align="left"{{!}}3
{{!}}Number
{{!}}-
{{!}} align="left"{{!}}wwe.livenessProbe.timeoutSeconds
{{!}} align="left"{{!}}liveness prob timeout seconds
{{!}} align="left"{{!}}5
{{!}}Number
{{!}}-
{{!}} align="left"{{!}}wwe.readinessProbe.httpGet.path
{{!}} align="left"{{!}}readiness prob path
{{!}} align="left"{{!}}/index.html
{{!}}Valid internal pass
{{!}}-
{{!}} align="left"{{!}}wwe.readinessProbe.httpGet.port
{{!}} align="left"{{!}}readiness prob port to use
{{!}} align="left"{{!}}http
{{!}}http
{{!}}-
{{!}} align="left"{{!}}wwe.readinessProbe.initialDelaySeconds
{{!}} align="left"{{!}}readiness prob startup delay in seconds
{{!}} align="left"{{!}}10
{{!}}Number
{{!}}-
{{!}} align="left"{{!}}wwe.readinessProbe.periodSeconds
{{!}} align="left"{{!}}readiness prob check interval in seconds
{{!}} align="left"{{!}}5
{{!}}Number
{{!}}-
{{!}} align="left"{{!}}wwe.readinessProbe.failureThreshold
{{!}} align="left"{{!}}readiness prob failure count
{{!}} align="left"{{!}}3
{{!}}Number
{{!}}-
{{!}} align="left"{{!}}wwe.readinessProbe.timeoutSeconds
{{!}} align="left"{{!}}readiness prob timeout seconds
{{!}} align="left"{{!}}5
{{!}}Number
{{!}}-
{{!}} align="left"{{!}}wwe.priorityClassName
{{!}} align="left"{{!}}k8s priority class name
{{!}} align="left"{{!}}genesysengage-high-priority
{{!}}Valid priority class
{{!}}-
{{!}} align="left"{{!}}wwe.affinity
{{!}} align="left"{{!}}pod affinity
{{!}} align="left"{{!}}{}
{{!}}Kubernetes Pod affinity map
{{!}}-
{{!}} align="left"{{!}}wwe.nodeselector
{{!}} align="left"{{!}}k8s node selector map
{{!}} align="left"{{!}}{ genesysengage.com/nodepool: general }
{{!}}Kubernetes node selector map
{{!}}-
{{!}} align="left"{{!}}wwe.tolerations
{{!}} align="left"{{!}}pod toleration
{{!}} align="left"{{!}}[]
{{!}}Kubernetes pod tolerations list
{{!}}-
{{!}} align="left"{{!}}wwe.autoscaling.enabled
{{!}} align="left"{{!}}activate auto scaling
{{!}} align="left"{{!}}true
{{!}}Boolean
{{!}}-
{{!}} align="left"{{!}}wwe.autoscaling.targetCPUUtilizationPercentage
{{!}} align="left"{{!}}CPU percentage autoscaling trigger
{{!}} align="left"{{!}}40
{{!}}Number
{{!}}-
{{!}} align="left"{{!}}wwe.autoscaling.targetMemoryUtilizationPercentage
{{!}} align="left"{{!}}Memory percentage autoscaling trigger
{{!}} align="left"{{!}}80
{{!}}Number
{{!}}-
{{!}} align="left"{{!}}wwe.context.envs.optimizedConfig
{{!}} align="left"{{!}}Activate WWE optimized config
{{!}} align="left"{{!}}false
{{!}}Boolean
{{!}}-
{{!}} align="left"{{!}}wwe.context.envs.gwsUrl
{{!}} align="left"{{!}}Url of GWS API
{{!}} align="left"{{!}}``
{{!}}Valid GWS API url
{{!}}-
{{!}} align="left"{{!}}grafanaDashboard.enabled
{{!}} align="left"{{!}}Deploy the grafana Dashboard
{{!}} align="left"{{!}}false
{{!}}Boolean
{{!}}}
<br />
|Status=No
}}{{Section
|sectionHeading=Create the values.yaml file
|anchor=yaml
|alignment=Vertical
|structuredtext=From the following sample file, create the '''values.yaml''' file with appropriate overrides for a sample deployment.

'''Note''': '''ingress''' should be enabled and set with an appropriate hostname and the value for '''gwsUrl''' must be set with the external GWS URL:
<source lang="yaml">
context:
envs:
optimizedConfig: false
gwsUrl: 'https://<gws-external-url>'
</source>

For example:
<source lang="yaml">
namespace: wwe
nameOverride: ""
fullnameOverride: ""

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

podLabels: {}
podAnnotations: {}

wwe:
image:
registry: <docker-repo>
repository: wwe
tag: "9.0.000.82.10461"
pullPolicy: IfNotPresent
imagePullSecrets: []
service:
enabled: true
type: ClusterIP
port: 80
ingress:
enabled: true
hosts:
# Example
- host: wwe.apps.vce-c0.eps.genesys.com
paths:
- path: '/'
port: 443
annotations: {}
# Example
# cert-manager.io/cluster-issuer: letsencrypt-prod-nginx
# nginx.ingress.kubernetes.io/ssl-redirect: "false"
# kubernetes.io/ingress.class: nginx01-internal
# nginx.ingress.kubernetes.io/proxy-body-size: "0"
tls:
# Example
- secretName: ""
hosts:
- wwe.apps.vce-c0.eps.genesys.com
serviceName: wwe
deployment:
type: Deployment
replicaCount: 3
minReplicas: 1
maxReplicas: 10
strategy: {}
annotations: {}
livenessProbe:
httpGet:
path: /index.html
port: http
initialDelaySeconds: 10
periodSeconds: 5
failureThreshold: 3
timeoutSeconds: 5
readinessProbe:
httpGet:
path: /index.html
port: http
initialDelaySeconds: 10
periodSeconds: 5
failureThreshold: 3
timeoutSeconds: 5
context:
envs:
optimizedConfig: false
gwsUrl: 'https://<g
ws-external-url>'
resources:
requests:
cpu: 500m
memory: 2Gi
limits:
cpu: "1"
memory: 6Gi
priorityClassName:
affinity: {}
nodeSelector:
genesysengage.com/nodepool:
tolerations: []
labels: {}
autoscaling:
enabled: true
targetCPUUtilizationPercentage: 40
targetMemoryUtilizationPercentage: 80
</source>
|Status=No
}}{{Section
|sectionHeading=Configure Kubernetes
|anchor=Kubernetes
|alignment=Vertical
|structuredtext=There is no specific Kubernetes configuration required for Workspace Web Edition.
|Status=No
}}{{Section
|sectionHeading=Configure security
|anchor=Security
|alignment=Vertical
|structuredtext=There is no specific security configuration required for Workspace Web Edition.
|Status=No
}}
|PEPageType=9c3ae89b-4f75-495b-85f8-d8c4afcb3f97
}}

@@ Line 10: / Line 10: @@
 |alignment=Vertical
 |structuredtext=You can override values in the Helm charts to configure Workspace Web Edition (WWE) by using the  <code>--set</code> flag or by {{Link-SomewhereInThisVersion|manual=WWEPEGuide|topic=Configure|anchor=yaml|display text=creating the values.yaml file}}. For more information about how to override Helm chart values, see {{SuiteLevelLink|helmoverride}}.
 Refer to the '''Parameters''' table for a full list of overridable values for WWE.
@@ Line 356: / Line 354: @@
    runAsGroup: 500
    fsGroup: 500
 </source>
 |Status=No

@@ Line 28: / Line 28: @@
 {{!}} align="left"{{!}}wwe.image.repository
 {{!}} align="left"{{!}}docker repository
-{{!}} align="left"{{!}}gws
+{{!}} align="left"{{!}}wwe
 {{!}}Valid repository in the registry
 {{!}}-
 {{!}} align="left"{{!}}wwe.image.tag
 {{!}} align="left"{{!}}WWE image version
-{{!}} align="left"{{!}}9.0.000.93
+{{!}} align="left"{{!}}100.0.000.50
 {{!}}Valid version of the WWE image
 {{!}}-
-{{!}} align="left"{{!}}wwe.image.pullPolicy
+{{!}} align="left"{{!}}wwe.image.imagePullSecrets
-{{!}} align="left"{{!}}Image pull policy
+{{!}} align="left"{{!}}Image pull secrets
-{{!}} align="left"{{!}}IfNotPresent
+{{!}} align="left"{{!}}[]
-{{!}}Kubernetes pullpolicy: IfNotPresent/Always
+{{!}}Array of pull secrets to use to pull from registry
 {{!}}-
 {{!}} align="left"{{!}}wwe.image.imagePullSecrets

@@ Line 28: / Line 28: @@
 {{!}} align="left"{{!}}wwe.image.repository
 {{!}} align="left"{{!}}docker repository
-{{!}} align="left"{{!}}wwe
+{{!}} align="left"{{!}}gws
 {{!}}Valid repository in the registry
 {{!}}-
 {{!}} align="left"{{!}}wwe.image.tag
 {{!}} align="left"{{!}}WWE image version
-{{!}} align="left"{{!}}9.0.000.81.10348
+{{!}} align="left"{{!}}9.0.000.93
 {{!}}Valid version of the WWE image
 {{!}}-
@@ Line 83: / Line 83: @@
 {{!}} align="left"{{!}}wwe.resources.limits.cpu
 {{!}} align="left"{{!}}Maximum amount of CPU K8s allocates for container
-{{!}} align="left"{{!}}500m
+{{!}} align="left"{{!}}"4"
 {{!}}Number of milicpu. See k8s doc
 {{!}}-
 {{!}} align="left"{{!}}wwe.resources.limits.memory
 {{!}} align="left"{{!}}Maximum amount of Memory K8s allocates for container
-{{!}} align="left"{{!}}4Gi
+{{!}} align="left"{{!}}6Gi
 {{!}}Bytes allocation
 {{!}}-
 {{!}} align="left"{{!}}wwe.resources.requests.cpu
 {{!}} align="left"{{!}}Guaranteed CPU allocation for container
-{{!}} align="left"{{!}}4
+{{!}} align="left"{{!}}500m
 {{!}}Number
 {{!}}-
 {{!}} align="left"{{!}}wwe.resources.requests.memory
 {{!}} align="left"{{!}}Guaranteed Memory allocation for container
-{{!}} align="left"{{!}}6Gi
+{{!}} align="left"{{!}}4Gi
 {{!}}Bytes allocation
 {{!}}-
@@ Line 168: / Line 168: @@
 {{!}} align="left"{{!}}wwe.priorityClassName
 {{!}} align="left"{{!}}k8s priority class name
-{{!}} align="left"{{!}}genesysengage-high-priority
+{{!}} align="left"{{!}}<nowiki>''</nowiki>
 {{!}}Valid priority class
 {{!}}-
@@ Line 178: / Line 178: @@
 {{!}} align="left"{{!}}wwe.nodeselector
 {{!}} align="left"{{!}}k8s node selector map
-{{!}} align="left"{{!}}{ genesysengage.com/nodepool: general }
+{{!}} align="left"{{!}}{}
 {{!}}Kubernetes node selector map
 {{!}}-
@@ Line 218: / Line 218: @@
 {{!}}securityContext
 {{!}}Pod security context
-{{!}}Unknown macro: {runAsNonRoot}
+{{!}}{runAsNonRoot:true,runAsUser:500,runAsGroup:500,fsGroup:500}
 {{!}}A Security Context map
 {{!}}}

@@ Line 255: / Line 255: @@
    image:
      registry: <docker-repo>
-     repository: wwe
+     repository: gws
-     tag: "9.0.000.82.10461"
+    name: gws-ui-workspace
      pullPolicy: IfNotPresent
      imagePullSecrets: []
@@ Line 355: / Line 356: @@
 <source lang="yaml">
 securityContext:
    runAsNonRoot: true
    runAsUser: null
    runAsGroup: 0
 </source>
 |Status=No

@@ Line 9: / Line 9: @@
 |anchor=Override
 |alignment=Vertical
 |structuredtext=You can override values in the Helm charts to configure Workspace Web Edition (WWE) by using the  <code>--set</code> flag or by {{Link-SomewhereInThisVersion|manual=WWEPEGuide|topic=Configure|anchor=yaml|display text=creating the values.yaml file}}. For more information about how to override Helm chart values, see {{SuiteLevelLink|helmoverride}}.
 Refer to the '''Parameters''' table for a full list of overridable values for WWE.
@@ Line 213: / Line 215: @@
 {{!}} align="left"{{!}}false
 {{!}}Boolean
 {{!}}}
 <br />
@@ Line 333: / Line 340: @@
 |anchor=Security
 |alignment=Vertical
-|structuredtext=There is no specific security configuration required for Workspace Web Edition.
+|structuredtext=The security context settings define the privilege and access control settings for pods and containers.
 |Status=No
 }}
 |PEPageType=9c3ae89b-4f75-495b-85f8-d8c4afcb3f97
 }}