WebRTC/Current/WebRTCPEGuide/Configure - Revision history

WikiSysop at 08:02, March 28, 2023

2023-03-28T08:02:07Z

WikiSysop at 09:30, September 28, 2022

2022-09-28T09:30:54Z

WikiSysop at 05:30, September 22, 2022

2022-09-22T05:30:46Z

WikiSysop at 09:00, September 2, 2022

2022-09-02T09:00:50Z

Show changes

Lakshmi.Krishnamurthy.IX: Published

2022-02-17T16:48:44Z

Published

Lakshmi.krishnamurthy@genesys.com: Published

2021-10-25T12:37:21Z

Published

Lakshmi.krishnamurthy@genesys.com: Published

2021-09-24T09:22:52Z

Published

Lakshmi.krishnamurthy@genesys.com: Published

2021-06-30T17:39:54Z

Published

New page

{{Article
|Standalone=No
|DisplayName=Configure WebRTC
|Context=Learn how to configure WebRTC.
|ComingSoon=No
|Section={{Section
|sectionHeading=Override Helm chart values
|alignment=Vertical
|structuredtext=You can override values in the Helm charts to configure Private Edition. For more information about overriding Helm chart values, see the "suite-level" documentation about how to override Helm chart values: {{SuiteLevelLink|helmoverride}}
{{{!}} class="wikitable"
{{!}}-
!{{!}}Option name
!{{!}}Description
!{{!}}Is mandatory
!{{!}}Default value
!{{!}}Valid value
!{{!}}Notes
!{{!}}Example

{{!}}-
{{!}}{{!}}deployment.namespace
{{!}}{{!}}Name of Kubernetes namespace for WebRTC deployment
{{!}}{{!}}mandatory
{{!}}{{!}}webrtc
{{!}}{{!}}string
{{!}}{{!}}
{{!}}{{!}}
{{!}}-
{{!}}{{!}}deployment.priorityClassName
{{!}}{{!}}Name of the priority class for pods that specify the importance of a pod relative to other pods
{{!}}{{!}}optional
{{!}}{{!}}
{{!}}{{!}}string
{{!}}{{!}}
{{!}}{{!}}
{{!}}-
{{!}}{{!}}deployment.nodeSelector
{{!}}{{!}}Node selector for Gateway and CoTurn pods
{{!}}{{!}}optional
{{!}}{{!}}
{{!}}{{!}}Specification
{{!}}{{!}}
{{!}}{{!}}<source lang="LANGUAGE">deployment:
nodeSelector:
genesysengage.com/nodepool: general</source>
{{!}}-
{{!}}{{!}}deployment.tolerations
{{!}}{{!}}If the content of toleration exist, this will be inserted in the toleration of the Gateway and CoTurn
{{!}}{{!}}optional
{{!}}{{!}}
{{!}}{{!}}Specification
{{!}}{{!}}
{{!}}{{!}}<source lang="LANGUAGE">deployment:
tolerations:
- operator: Exists
effect: NoSchedule
key: "k8s.genesysengage.com/nodepool"</source>
{{!}}-
{{!}}{{!}}deployment.ingress.domain
{{!}}{{!}}Ingress domain
{{!}}{{!}}mandatory
{{!}}{{!}}
{{!}}{{!}}string
{{!}}{{!}}
{{!}}{{!}}<source lang="LANGUAGE">deployment:
ingress:
domain: apps.vce-c0.eps.genesys.com</source>
{{!}}-
{{!}}{{!}}deployment.ingress.annotations
{{!}}{{!}}WebRTC Annotation for Ingress controller
{{!}}{{!}}mandatory
{{!}}{{!}}
{{!}}{{!}}Specification
{{!}}{{!}}
{{!}}{{!}}<source lang="LANGUAGE">deployment
ingress:
annotations:
kubernetes.io/ingress.class: nginx01-internal
nginx.ingress.kubernetes.io/affinity: cookie
nginx.ingress.kubernetes.io/affinity-mode: persistent
nginx.ingress.kubernetes.io/ssl-redirect: "false"
nginx.ingress.kubernetes.io/session-cookie-path: "/; Secure"
nginx.ingress.kubernetes.io/session-cookie-samesite: None</source>
{{!}}-
{{!}}{{!}}deployment.ingress.tls
{{!}}{{!}}If this option is defined, <tt>tls</tt> option will be declared in the Ingress specification
{{!}}{{!}}optional
{{!}}{{!}}
{{!}}{{!}}Specification
{{!}}{{!}}
{{!}}{{!}}<source lang="LANGUAGE">deployment:
ingress:
tls:
secretName: webrtc.api01-eastus2.dev.genazure.com-tls-secret</source>
{{!}}-
{{!}}{{!}}deployment.affinity
{{!}}{{!}}Pod affinity descriptions
{{!}}{{!}}optional
{{!}}{{!}}
{{!}}{{!}}Specification
{{!}}{{!}}
{{!}}{{!}}<source lang="LANGUAGE">deployment:
affinity:
podAntiAffinity:
preferredDuringSchedulingIgnoredDuringExecution:
- weight: 100
podAffinityTerm:
labelSelector:
matchExpressions:
- key: servicename
operator: In
values:
- webrtc-gateway
- webrtc-coturn
topologyKey: failure-domain.beta.kubernetes.io/zone</source>
{{!}}-
{{!}}{{!}}deployment.dnsPolicy
{{!}}{{!}}Kubernetes DNS Policy that will be applied in the Pods
{{!}}{{!}}optional
{{!}}{{!}}
{{!}}{{!}}
{{!}}{{!}}
{{!}}{{!}}<source lang="LANGUAGE">deployment:
nodeSelector:
genesysengage.com/nodepool: general</source>
{{!}}-
{{!}}{{!}}deployment.dnsConfig
{{!}}{{!}}All DNS settings should be provided using the dnsConfig field in the Pod specification
{{!}}{{!}}optional
{{!}}{{!}}
{{!}}{{!}}
{{!}}{{!}}
{{!}}{{!}}<source lang="LANGUAGE">deployment:
dnsConfig:
options:
- name: ndots
value: "3"</source>
{{!}}-
{{!}}{{!}}deployment.keda
{{!}}{{!}}Enable KEDA usage for the Gateway and CoTurn horizontal auto-scaling
{{!}}{{!}}optional
{{!}}{{!}}false
{{!}}{{!}}true/false
{{!}}{{!}}
{{!}}{{!}}
{{!}}-
{{!}}{{!}}deployment.coturnDeployment
{{!}}{{!}}Type of CoTurn deployment - <tt>internal</tt>: the internal LBs will be created and the IP addresses of that LBs should be used in the firewall or other ways to be exposed externally. <br><tt>external</tt>: the external LBs will be created with given external static IPs (IPs for the green and blue LBs should be set with <tt>lbIpBlue</tt> and <tt>lbIpGreen</tt> during the infra-color deployment.
{{!}}{{!}}mandatory
{{!}}{{!}}
{{!}}{{!}}internal/external
{{!}}{{!}}For Premise Edition - This should be set to <tt>external</tt>
{{!}}{{!}}
{{!}}-
{{!}}{{!}}deployment.coturnService.annotation
{{!}}{{!}}Annotation that will be added to Kubernetes LoadBalancer Service object
{{!}}{{!}}optional
{{!}}{{!}}
{{!}}{{!}}
{{!}}{{!}}
{{!}}{{!}}<source lang="LANGUAGE">deployment:
coturnService:
annotations:
service.beta.kubernetes.io/azure-load-balancer-resource-group: service-webrtc-westus2-dev</source>
{{!}}-
{{!}}{{!}}monitoring.enabled
{{!}}{{!}}Enable monitoring content - dashboards, alerts, metrics
{{!}}{{!}}optional
{{!}}{{!}}false
{{!}}{{!}}true/false
{{!}}{{!}}
{{!}}{{!}}
{{!}}-
{{!}}{{!}}monitoring.dashboards
{{!}}{{!}}Enable ConfigMaps deployment that contains dashboards
{{!}}{{!}}optional
{{!}}{{!}}false
{{!}}{{!}}true/false
{{!}}{{!}}
{{!}}{{!}}
{{!}}-
{{!}}{{!}}monitoring.prometheusMetrics
{{!}}{{!}}Enable prometheus metrics - causes deploy of PodMonitors
{{!}}{{!}}optional
{{!}}{{!}}false
{{!}}{{!}}true/false
{{!}}{{!}}
{{!}}{{!}}
{{!}}-
{{!}}{{!}}monitoring.prometheusAlerts
{{!}}{{!}}Enable Prometheus rules for alerts
{{!}}{{!}}optional
{{!}}{{!}}false
{{!}}{{!}}true/false
{{!}}{{!}}
{{!}}{{!}}
{{!}}-
{{!}}{{!}}image.imagePullSecrets
{{!}}{{!}}Secrets to pull image, list
{{!}}{{!}}mandatory
{{!}}{{!}}
{{!}}{{!}}
{{!}}{{!}}
{{!}}{{!}}<source lang="LANGUAGE">image:
imagePullSecrets:
- myRegistrySecret</source>
{{!}}-
{{!}}{{!}}image.pullPolicy
{{!}}{{!}}Kubernetes pull policy of all containers
{{!}}{{!}}optional
{{!}}{{!}}Always
{{!}}{{!}}Always/IfNotPresent
{{!}}{{!}}
{{!}}{{!}}
{{!}}-
{{!}}{{!}}image.initContainerImage
{{!}}{{!}}Image for initialization container - used to create log folders. If image is not specified, the init container will not be applied and the logs will be written into <tt>logPath</tt>
{{!}}{{!}}optional
{{!}}{{!}}
{{!}}{{!}}string
{{!}}{{!}}
{{!}}{{!}}
{{!}}-
{{!}}{{!}}image.webrtc
{{!}}{{!}}Repository/directory to get the Gateway image
{{!}}{{!}}mandatory
{{!}}{{!}}
{{!}}{{!}}string
{{!}}{{!}}
{{!}}{{!}}<source lang="LANGUAGE">pureengage-docker-staging.jfrog.io/webrtc</source>
{{!}}-
{{!}}{{!}}image.coturn
{{!}}{{!}}Repository/directory to get the CoTurn image
{{!}}{{!}}mandatory
{{!}}{{!}}
{{!}}{{!}}string
{{!}}{{!}}
{{!}}{{!}}<source lang="LANGUAGE">pureengage-docker-staging.jfrog.io/webrtc</source>
{{!}}-
{{!}}{{!}}image.webrtcVersion
{{!}}{{!}}Versions of the WebRTC Gateway container
{{!}}{{!}}mandatory
{{!}}{{!}}
{{!}}{{!}}string
{{!}}{{!}}
{{!}}{{!}}<source lang="LANGUAGE">9.0.000.88</source>
{{!}}-
{{!}}{{!}}image.coturnVersion
{{!}}{{!}}Versions of the CoTurn container
{{!}}{{!}}mandatory
{{!}}{{!}}
{{!}}{{!}}string
{{!}}{{!}}
{{!}}{{!}}<source lang="LANGUAGE">9.0.000.88</source>
{{!}}-
{{!}}{{!}}gateway.replicas
{{!}}{{!}}Number of Gateway pods on the deployment stage
{{!}}{{!}}optional
{{!}}{{!}}1
{{!}}{{!}}integer
{{!}}{{!}}
{{!}}{{!}}
{{!}}-
{{!}}{{!}}gateway.workersCount
{{!}}{{!}}Number of Gateway worker threads that handle calls. 1 worker handles 25 registrations/calls. CPU and Memory request depends on the number of workers.
{{!}}{{!}}optional
{{!}}{{!}}3
{{!}}{{!}}integer
{{!}}{{!}}
{{!}}{{!}}
{{!}}-
{{!}}{{!}}gateway.voiceSipProxy
{{!}}{{!}}Voice microservice - SIP proxy address
{{!}}{{!}}mandatory
{{!}}{{!}}
{{!}}{{!}}string, address
{{!}}{{!}}
{{!}}{{!}}<source lang="LANGUAGE">voice-sipproxy.voice.svc.cluster.local;transport=tcp</source>
{{!}}-
{{!}}{{!}}gateway.turnExternalUriBlue
{{!}}{{!}}FQDNs of CoTurn blue LB
{{!}}{{!}}mandatory
{{!}}{{!}}
{{!}}{{!}}string, address
{{!}}{{!}}
{{!}}{{!}}
{{!}}-
{{!}}{{!}}gateway.turnExternalUriGreen
{{!}}{{!}}FQDNs of CoTurn green LB
{{!}}{{!}}mandatory
{{!}}{{!}}
{{!}}{{!}}string, address
{{!}}{{!}}
{{!}}{{!}}
{{!}}-
{{!}}{{!}}gateway.authRedirectUri
{{!}}{{!}}GWS/WEE redirect URI for WWE authentication
{{!}}{{!}}mandatory
{{!}}{{!}}
{{!}}{{!}}string, address
{{!}}{{!}}
{{!}}{{!}}
{{!}}-
{{!}}{{!}}gateway.authService
{{!}}{{!}}GAuth service address
{{!}}{{!}}mandatory
{{!}}{{!}}
{{!}}{{!}}string, address
{{!}}{{!}}
{{!}}{{!}}
{{!}}-
{{!}}{{!}}gateway.envService
{{!}}{{!}}GWS9.x Environment service address
{{!}}{{!}}mandatory
{{!}}{{!}}
{{!}}{{!}}string, address
{{!}}{{!}}
{{!}}{{!}}
{{!}}-
{{!}}{{!}}gateway.cfgService
{{!}}{{!}}GWS9.x configuration service address
{{!}}{{!}}optional
{{!}}{{!}}
{{!}}{{!}}string, address
{{!}}{{!}}
{{!}}{{!}}
{{!}}-
{{!}}{{!}}gateway.enableTranscoding
{{!}}{{!}}Enable or disable transcoding on the Gateway side. Transcoding is enabled by default. <br>If the transcoding is disabled, the Gateway can handle more agent sessions but OPUS codec is not supported.
{{!}}{{!}}optional
{{!}}{{!}}true
{{!}}{{!}}true/false
{{!}}{{!}}
{{!}}{{!}}
{{!}}-
{{!}}{{!}}gateway.enable1pccCalls
{{!}}{{!}}Specifies if the 1pcc operations are enabled
{{!}}{{!}}optional
{{!}}{{!}}false
{{!}}{{!}}true/false
{{!}}{{!}}
{{!}}{{!}}
{{!}}-
{{!}}{{!}}gateway.arguments
{{!}}{{!}}Any additional options that will be applied to the Gateway containers
{{!}}{{!}}optional
{{!}}{{!}}
{{!}}{{!}}Array of strings
{{!}}{{!}}
{{!}}{{!}}<source lang="LANGUAGE">gateway:
arguments: [ '-codecs pcmu,pcma,opus=120', '-sip-disallowed-codecs opus,telephone-event' ]</source>
{{!}}-
{{!}}{{!}}gateway.podAnnotations
{{!}}{{!}}Any additional annotations that will be applied to the Gateway pods
{{!}}{{!}}optional
{{!}}{{!}}
{{!}}{{!}}
{{!}}{{!}}
{{!}}{{!}}<source lang="LANGUAGE">gateway:
podAnnotations:
prometheus.io/scrape: "true"
prometheus.io/port: "10052"
prometheus.io/path: "/metrics"</source>
{{!}}-
{{!}}{{!}}gateway.resources
{{!}}{{!}}Describes the resources requested for the Gateway pods. <br>{{NoteFormat|Do not specify this option, if you do not need resources requests/limits.}}
{{!}}{{!}}optional
{{!}}{{!}}
{{!}}{{!}}Section
{{!}}{{!}}
{{!}}{{!}}<source lang="LANGUAGE">gateway:
resources:
requests:
cpu: 800
memory: 150
limits:
memory: "8Gi"</source>
{{!}}-
{{!}}{{!}}gateway.resources.requests.cpu
{{!}}{{!}}Requested amount of CPU milliunits. <br>{{NoteFormat|This value is per worker and will be multiplied by the <tt>gateway.workersCount</tt> option in helm}}
{{!}}{{!}}optional
{{!}}{{!}}800
{{!}}{{!}}integer
{{!}}{{!}}
{{!}}{{!}}
{{!}}-
{{!}}{{!}}gateway.resources.requests.memory
{{!}}{{!}}Requested amount of Memory (in MB). <br>{{NoteFormat|This value is per worker and will be multiplied by the <tt>gateway.workersCount</tt> option in helm}}
{{!}}{{!}}optional
{{!}}{{!}}150
{{!}}{{!}}integer
{{!}}{{!}}
{{!}}{{!}}
{{!}}-
{{!}}{{!}}gateway.resources.limits.memory
{{!}}{{!}}Absolute value for Gateway memory usage limit
{{!}}{{!}}optional
{{!}}{{!}}"8Gi"
{{!}}{{!}}Kubernetes value for the resource limit
{{!}}{{!}}
{{!}}{{!}}
{{!}}-
{{!}}{{!}}gateway.scaling
{{!}}{{!}}Describes the auto-scaling parameters. If the <tt>deployment.keda</tt> option is set to <tt>false</tt>, you can skip this option.
{{!}}{{!}}optional
{{!}}{{!}}
{{!}}{{!}}Section
{{!}}{{!}}
{{!}}{{!}}<source lang="LANGUAGE">gateway:
scaling:
pollingInterval: 30
maxReplicaCount: 100
prometheusAddress: http://monitoring-prometheus-prometheus.monitoring:9090
thresholdSignins: 70</source>
{{!}}-
{{!}}{{!}}gateway.scaling.prometheusAddress
{{!}}{{!}}Describes the auto-scaling parameters. If the <tt>deployment.keda</tt> option is set to <tt>false</tt>, you can skip this option.
{{!}}{{!}}optional
{{!}}{{!}}http://monitoring-prometheus-prometheus.monitoring:909
{{!}}{{!}}string, address
{{!}}{{!}}
{{!}}{{!}}
{{!}}-
{{!}}{{!}}gateway.scaling.pollingInterval
{{!}}{{!}}KEDA polling interval (in seconds) - the interval to check each trigger on. See KEDA documentation for more information.
{{!}}{{!}}optional
{{!}}{{!}}30
{{!}}{{!}}integer
{{!}}{{!}}
{{!}}{{!}}
{{!}}-
{{!}}{{!}}gateway.scaling.maxReplicaCount
{{!}}{{!}}Maximum number of replicas that will be raised by KEDA/HPA. See KEDA documentation for more information.
{{!}}{{!}}optional
{{!}}{{!}}100
{{!}}{{!}}integer
{{!}}{{!}}
{{!}}{{!}}
{{!}}-
{{!}}{{!}}gateway.scaling.thresholdSignins
{{!}}{{!}}In persons - number of registered agents that causes the Gateway auto-scaling if exceeded
{{!}}{{!}}optional
{{!}}{{!}}71
{{!}}{{!}}integer
{{!}}{{!}}
{{!}}{{!}}
{{!}}-
{{!}}{{!}}gateway.budget.minAvailable
{{!}}{{!}}Option to configure the <tt>PodDisruptionBudget</tt> option. Do not specify this option, ff you do not need the <tt>PodDisruptionBudget</tt> option for the Gateway deployment.
{{!}}{{!}}optional
{{!}}{{!}}
{{!}}{{!}}Kubernetes PodDisruptionBudget (PBD) value
{{!}}{{!}}
{{!}}{{!}}<source lang="LANGUAGE">gateway:
budget:
minAvailable: 50%</source>
{{!}}-
{{!}}{{!}}secrets.type
{{!}}{{!}}Describes where the secrets will be taken - in Kubernetes secrets, CSI driver, or from the Environment variables
{{!}}{{!}}mandatory
{{!}}{{!}}
{{!}}{{!}}csi k8s env
{{!}}{{!}}
{{!}}{{!}}
{{!}}-
{{!}}{{!}}secrets.csi.gws
{{!}}{{!}}If the <tt>secrets.type</tt> option is set to <tt>csi</tt>, the name of the CSI object contains the GWS secret
{{!}}{{!}}
{{!}}{{!}}
{{!}}{{!}}string
{{!}}{{!}}
{{!}}{{!}}
{{!}}-
{{!}}{{!}}secrets.k8s.gws
{{!}}{{!}}If the <tt>secrets.type</tt> option is set to <tt>k8s</tt>, the name of the Kubernetes Secret object that contains the GWS secret
{{!}}{{!}}
{{!}}{{!}}
{{!}}{{!}}string
{{!}}{{!}}
{{!}}{{!}}
{{!}}-
{{!}}{{!}}secrets.k8s.env.gwsClient
{{!}}{{!}}If the <tt>secrets.type</tt> option is set to <tt>env</tt>, the value is GWS clientid created for WebRTC
{{!}}{{!}}
{{!}}{{!}}
{{!}}{{!}}string
{{!}}{{!}}
{{!}}{{!}}
{{!}}-
{{!}}{{!}}secrets.k8s.env.gwsSecret
{{!}}{{!}}If the <tt>secrets.type</tt> option is set to <tt>env</tt>, the value is GWS secret for the client given clientid
{{!}}{{!}}
{{!}}{{!}}
{{!}}{{!}}string
{{!}}{{!}}
{{!}}{{!}}
{{!}}-
{{!}}{{!}}gateway.securityContext
{{!}}{{!}}Security context for the Gateway container
{{!}}{{!}}optional
{{!}}{{!}}
{{!}}{{!}}Specification
{{!}}{{!}}
{{!}}{{!}}<source lang="LANGUAGE">gateway:
securityContext:
runAsUser: 500
runAsGroup: 500</source>
{{!}}-
{{!}}{{!}}gateway.serviceAccountName
{{!}}{{!}}Name of the ServiceAccount that should be used to run the Gateway pod
{{!}}{{!}}optional
{{!}}{{!}}
{{!}}{{!}}string
{{!}}{{!}}
{{!}}{{!}}
{{!}}-
{{!}}{{!}}gateway.logPath
{{!}}{{!}}Path to the log-directory. This path will be used for both - PVC or HostPath types of logs. Also, check the <tt>esServer</tt> option. If <tt>/mnt/log/webrtc</tt> is specified, the <tt>/mnt/log/webrtc/<gateway pod name>/webrtcgw</tt> logfiles will be created and used in the mentioned path. If the <tt>image.initContainerImage</tt> option is not specified, the folder with the pod name will not be created and the <tt>/mnt/log/webrtc/webrtcgw</tt> logfiles will be created.
{{!}}{{!}}mandatory
{{!}}{{!}}"/mnt/log/webrtc"
{{!}}{{!}}string
{{!}}{{!}}
{{!}}{{!}}<source lang="LANGUAGE">"/export/vol1/PAT/infra/webrtc"</source>
{{!}}-
{{!}}{{!}}gateway.logPvc
{{!}}{{!}}Option for Persistent Volume Claim used for the Gateway logs. If this is not defined, the HostPath will be used for the logs mount.
{{!}}{{!}}optional
{{!}}{{!}}
{{!}}{{!}}Section
{{!}}{{!}}
{{!}}{{!}}<source lang="LANGUAGE">gateway:
logPvc:
pvcName: webrtc-gateway-log-pvc
volumeName: webrtc-gateway-log-volume
storageClassName: genesys-webrtc
capacity: 5Gi
volumeSpec:
accessModes:
- ReadWriteMany
persistentVolumeReclaimPolicy: Retain
nfs:
path: /export/vol1/PAT/infra/webrtc
server: 192.168.30.51</source>
{{!}}-
{{!}}{{!}}gateway.logPvc.pvcName
{{!}}{{!}}Name of the Persistent Volume Claim. If this option is present, the PVC will be created. Else, the <tt>hostpath</tt> will be used for the Gateway logs.
{{!}}{{!}}optional
{{!}}{{!}}
{{!}}{{!}}string
{{!}}{{!}}
{{!}}{{!}}
{{!}}-
{{!}}{{!}}gateway.logPvc.volumeName
{{!}}{{!}}PersistentVolume name for the PVC. Single Volume will be used for both green and blue deployments of the gateway
{{!}}{{!}}optional
{{!}}{{!}}
{{!}}{{!}}string
{{!}}{{!}}
{{!}}{{!}}
{{!}}-
{{!}}{{!}}gateway.logPvc.volumeSpec
{{!}}{{!}}If the Perisitent Volume specification is configured in the <tt>gateway.logPvc.volumeSpec</tt> option, the PersistentVolume object with name from the <tt>gateway.logPvc.volumeName</tt> option will be created using this specification.
{{!}}{{!}}optional
{{!}}{{!}}
{{!}}{{!}}Specification
{{!}}{{!}}
{{!}}{{!}}<source>
gateway:
logPvc:
volumeSpec:
accessModes:
- ReadWriteMany
persistentVolumeReclaimPolicy: Retain
nfs:
path: /export/vol1/PAT/infra/webrtc
server: 192.168.30.51</source>
{{!}}-
{{!}}{{!}}gateway.logPvc.volumeAnnotations
{{!}}{{!}}Any additional annotations that will be used for the PersistentVolume if the <tt>gateway.logPvc.volumeSpec</tt> is specified here.
{{!}}{{!}}optional
{{!}}{{!}}
{{!}}{{!}}Specification
{{!}}{{!}}
{{!}}{{!}}<source>
gateway:
logPvc:
volumeAnnotations:
pv.kubernetes.io/bound-by-controller: 'yes'</source>
{{!}}-
{{!}}{{!}}gateway.esServer
{{!}}{{!}}Specifies the destination for the ElasticSearch logging - ElasticSearch server address or stdout.<br>Gateway produces messages in the ElasticSearch format.
{{!}}{{!}}optional
{{!}}{{!}}stdout
{{!}}{{!}}network address or "stdout"
{{!}}{{!}}
{{!}}{{!}}
{{!}}-
{{!}}{{!}}coturn.port
{{!}}{{!}}Coturn port that will be used by the CoTurn Load Balancer
{{!}}{{!}}optional
{{!}}{{!}}443
{{!}}{{!}}integer
{{!}}{{!}}
{{!}}{{!}}
{{!}}-
{{!}}{{!}}coturn.lbIpBlue
{{!}}{{!}}External IP for CoTurn blue Load Balancer service. The IP must be same as the one used for the <tt>gateway.turnExternalUriBlue</tt> A-record
{{!}}{{!}}mandatory
{{!}}{{!}}
{{!}}{{!}}IP address
{{!}}{{!}}
{{!}}{{!}}
{{!}}-
{{!}}{{!}}coturn.lbIpGreen
{{!}}{{!}}External IP for CoTurn green Load Balancer service. The IP must be same as the one used for the <tt>gateway.turnExternalUriGreen</tt> A-record
{{!}}{{!}}mandatory
{{!}}{{!}}
{{!}}{{!}}IP address
{{!}}{{!}}
{{!}}{{!}}
{{!}}-
{{!}}{{!}}coturn.replicas
{{!}}{{!}}Number of CoTurn pods
{{!}}{{!}}optional
{{!}}{{!}}1
{{!}}{{!}}integer
{{!}}{{!}}
{{!}}{{!}}
{{!}}-
{{!}}{{!}}coturn.podAnnotations
{{!}}{{!}}Any additional annotations that will be applied for CoTurn pods
{{!}}{{!}}optional
{{!}}{{!}}
{{!}}{{!}}Specification
{{!}}{{!}}
{{!}}{{!}}<source>
coturn:
podAnnotations:
pods/realtime: "true"
pods/owner: "1051"</source>
{{!}}-
{{!}}{{!}}coturn.resources
{{!}}{{!}}Describes resources requested for the CoTurn pods. Do not specify this option if you do not need resources requests/limits.
{{!}}{{!}}optional
{{!}}{{!}}
{{!}}{{!}}Section
{{!}}{{!}}
{{!}}{{!}}<source>
coturn:
resources:
requests:
cpu: "0.5"
memory: "768Mi"
limits:
memory: "8Gi"</source>
{{!}}-
{{!}}{{!}}coturn.resources.requests.cpu
{{!}}{{!}}Requested amount of CPU. Coturn requires 0.08CPU per call.
{{!}}{{!}}optional
{{!}}{{!}}0.5
{{!}}{{!}}Kubernetes CPU request format
{{!}}{{!}}
{{!}}{{!}}
{{!}}-
{{!}}{{!}}coturn.resources.requests.memory
{{!}}{{!}}Requested amount of Memory
{{!}}{{!}}optional
{{!}}{{!}}150
{{!}}{{!}}Kubernetes memory request format
{{!}}{{!}}
{{!}}{{!}}
{{!}}-
{{!}}{{!}}coturn.resources.limits.memory
{{!}}{{!}}Absolute value for the CoTurn memory usage limit
{{!}}{{!}}optional
{{!}}{{!}}"8Gi"
{{!}}{{!}}Kubernetes value for resoure limit
{{!}}{{!}}
{{!}}{{!}}
{{!}}-
{{!}}{{!}}coturn.scaling
{{!}}{{!}}Describes the autoscaling parameters. If the <tt>deployment.keda</tt> option is set to <tt>false</tt>, you can skip this section
{{!}}{{!}}optional
{{!}}{{!}}
{{!}}{{!}}Section
{{!}}{{!}}
{{!}}{{!}}<source>coturn:
scaling:
pollingInterval: 30
maxReplicaCount: 100
thresholdCpu: 60
thresholdMemory: 60</source>
{{!}}-
{{!}}{{!}}coturn.scaling.pollingInterval
{{!}}{{!}}Specifies the KEDA polling interval in seconds - the interval to check each trigger on. Refer to KEDA documentation for more information.
{{!}}{{!}}optional
{{!}}{{!}}30
{{!}}{{!}}integer
{{!}}{{!}}
{{!}}{{!}}
{{!}}-
{{!}}{{!}}coturn.scaling.maxReplicaCount
{{!}}{{!}}Maxium number of replicas that will be raised by KEDA/HPA. Refer to KEDA documentation for more information.
{{!}}{{!}}optional
{{!}}{{!}}100
{{!}}{{!}}integer
{{!}}{{!}}
{{!}}{{!}}
{{!}}-
{{!}}{{!}}coturn.scaling.thresholdSignins
{{!}}{{!}}In percentage
{{!}}{{!}}optional
{{!}}{{!}}71
{{!}}{{!}}integer
{{!}}{{!}}
{{!}}{{!}}
{{!}}-
{{!}}{{!}}coturn.scaling.thresholdCpu
{{!}}{{!}}In percentage. The target value is the average of the CPU resource metric across all relevant pods, represented as a percentage of the requested value of the resource for the pods.
{{!}}{{!}}optional
{{!}}{{!}}60
{{!}}{{!}}integer
{{!}}{{!}}
{{!}}{{!}}
{{!}}-
{{!}}{{!}}coturn.scaling.thresholdMemory
{{!}}{{!}}In percentage. The target value is the average of the memory resource metric across all relevant pods, represented as a percentage of the requested value of the resource for the pods.
{{!}}{{!}}optional
{{!}}{{!}}60
{{!}}{{!}}integer
{{!}}{{!}}
{{!}}{{!}}
{{!}}-
{{!}}{{!}}coturn.budget.minAvailable
{{!}}{{!}}Option to configure <tt>PodDisruptionBudget</tt>. Do not specify this option, if you do not need <tt>PodDisruptionBudget</tt> for the CoTurn deployment.
{{!}}{{!}}optional
{{!}}{{!}}
{{!}}{{!}}Kubernetes PDB value
{{!}}{{!}}
{{!}}{{!}}<source>coturn:
budget:
minAvailable: 50%</source>
{{!}}-
{{!}}{{!}}coturn.securityContext
{{!}}{{!}}Security context for the CoTurn container.
{{!}}{{!}}optional
{{!}}{{!}}
{{!}}{{!}}Specification
{{!}}{{!}}
{{!}}{{!}}<source>coturn:
securityContext:
runAsUser: 500
runAsGroup: 500</source>
{{!}}-
{{!}}{{!}}coturn.serviceAccountName
{{!}}{{!}}Name of the ServiceAccount to use to run the CoTurn pod.
{{!}}{{!}}optional
{{!}}{{!}}
{{!}}{{!}}string
{{!}}{{!}}
{{!}}{{!}}
{{!}}-
{{!}}{{!}}coturn.logPath
{{!}}{{!}}Path to the log-directory. This can be the directory path or "stdout". This path will be used for both PVC or HostPath types of logs. <br>Example: If <tt>/mnt/log/webrtc</tt> is specified, <tt>"/mnt/log/webrtc/<coturn pod name>/turn.xxx.log"</tt> logfile will be created and used in the mentioned path. <br>If <tt>image.initContainerImage</tt> is not specified, the folder with pod name will not be created and <tt>mnt/log/webrtc/turn.xxx.log</tt> logfile will be created.
{{!}}{{!}}mandatory
{{!}}{{!}}"/mnt/log/webrtc"
{{!}}{{!}}string
{{!}}{{!}}
{{!}}{{!}}
{{!}}-
{{!}}{{!}}coturn.logPvc
{{!}}{{!}}Section for Persistent Volume Claim used for CoTurn logs. If this option not defined, the <tt>HostPath</tt> will be used for logs mount.
{{!}}{{!}}optional
{{!}}{{!}}"/mnt/log/webrtc"
{{!}}{{!}}Section
{{!}}{{!}}
{{!}}{{!}}<source>coturn:
logPvc:
pvcName: webrtc-coturn-log-pvc
storageClassName: default
capacity: 10Gi
volumeName: webrtc-coturn-log-volume
volumeSpec:
nfs:
server: 192.168.1.5
path: /storage/webrtc
volumeMode: Filesystem
persistentVolumeReclaimPolicy: Retain</source>
{{!}}-
{{!}}{{!}}coturn.logPvc.pvcName
{{!}}{{!}}Name of PersistentVolumeClaim. If this option is present, PVC will be created. Else, the <tt>HostPath</tt> will be used for CoTurn logs.
{{!}}{{!}}optional
{{!}}{{!}}
{{!}}{{!}}string
{{!}}{{!}}
{{!}}{{!}}
{{!}}-
{{!}}{{!}}coturn.logPvc.storageClassName
{{!}}{{!}}StorageClass name for the CoTurn PVC
{{!}}{{!}}optional
{{!}}{{!}}
{{!}}{{!}}string
{{!}}{{!}}
{{!}}{{!}}
{{!}}-
{{!}}{{!}}coturn.logPvc.capacity
{{!}}{{!}}Volume capacity
{{!}}{{!}}optional
{{!}}{{!}}
{{!}}{{!}}Kubernetes capacity storage values
{{!}}{{!}}
{{!}}{{!}}
{{!}}-
{{!}}{{!}}coturn.logPvc.volumeName
{{!}}{{!}}Persistent Volume name for the PVC. Single Volume will be used for both green and blue deployments of the CoTurn logs
{{!}}{{!}}optional
{{!}}{{!}}
{{!}}{{!}}string
{{!}}{{!}}
{{!}}{{!}}
{{!}}-
{{!}}{{!}}coturn.logPvc.volumeSpec
{{!}}{{!}}If the Persistent Volume specification is configured in <tt>coturn.logPvc.volumeSpec</tt>, the Persistent Volume object with name from the <tt>coturn.logPvc.volumeName</tt> will be created using this specification.
{{!}}{{!}}optional
{{!}}{{!}}
{{!}}{{!}}Specification
{{!}}{{!}}
{{!}}{{!}}<source lang="LANGUAGE">gateway:
logPvc:
volumeSpec:
accessModes:
- ReadWriteMany
persistentVolumeReclaimPolicy: Retain
nfs:
path: /export/vol1/PAT/infra/webrtc
server: 192.168.30.51</source>
{{!}}-
{{!}}{{!}}coturn.logPvc.volumeAnnotations
{{!}}{{!}}Any additional annotations that will be used for the Persistent Volume, if the <tt>coturn.logPvc.volumeSpec</tt> option is specified
{{!}}{{!}}optional
{{!}}{{!}}
{{!}}{{!}}Specification
{{!}}{{!}}
{{!}}{{!}}<source lang="LANGUAGE">gateway:
logPvc:
volumeAnnotations:
pv.kubernetes.io/bound-by-controller: 'yes'</source>
{{!}}-
{{!}}{{!}}labels.common
{{!}}{{!}}Describes the additional labels for common resources
{{!}}{{!}}optional
{{!}}{{!}}
{{!}}{{!}}
{{!}}{{!}}
{{!}}{{!}}
{{!}}-
{{!}}{{!}}labels.gateway
{{!}}{{!}}Describes the additional labels for the Gateway resources - pods, deployments, and services
{{!}}{{!}}optional
{{!}}{{!}}
{{!}}{{!}}
{{!}}{{!}}
{{!}}{{!}}
{{!}}-
{{!}}{{!}}labels.coturn
{{!}}{{!}}Describes the additional labels for the CoTurn resources - pods, deployments, and services
{{!}}{{!}}optional
{{!}}{{!}}
{{!}}{{!}}
{{!}}{{!}}
{{!}}{{!}}
{{!}}-
{{!}}{{!}}labels.alerts
{{!}}{{!}}Describes the additional labels for the alert objects
{{!}}{{!}}optional
{{!}}{{!}}
{{!}}{{!}}
{{!}}{{!}}
{{!}}{{!}}
{{!}}-
{{!}}}
|Status=No
}}{{Section
|sectionHeading=Configure Kubernetes
|alignment=Vertical
|structuredtext=<div style="background-color: aliceblue; font-style: italic;">Document the layouts for the following so customers can create them if their Helm chart doesn't include a way to do this:

*ConfigMaps
*Secrets
</div>
|Status=No
}}{{Section
|sectionHeading=Configure security
|alignment=Vertical
|structuredtext=Not applicable
|Status=No
}}{{Section
|sectionHeading=Configure the service
|alignment=Vertical
|structuredtext=Before proceeding with the deployment process, perform the following pre-steps:

#'''Review values-template.yaml in helm charts''': It provides all the available options with comments and explanations.
#'''Configure all the options in your own values file''': Configure/overwrite values for options that you need. Use the values-template.yaml file from the package that displays the list of available options with their description.
#:{{NoteFormat|Do not configure deployment.type and deployment.color options in values.yaml-file(s). These values should be used only during deployment process as command-line parameters to specify the deployment process.}}
#:Sample values.yaml file:
#:<source lang="LANGUAGE">deployment:
namespace: webrtc
ingress:
domain: apps.vce-c0.eps.genesys.com
annotations:
kubernetes.io/ingress.class: nginx01-internal
nginx.ingress.kubernetes.io/affinity: cookie
nginx.ingress.kubernetes.io/affinity-mode: persistent
nginx.ingress.kubernetes.io/ssl-redirect: "false"
nginx.ingress.kubernetes.io/session-cookie-path: "/; Secure"
nginx.ingress.kubernetes.io/session-cookie-samesite: None
dnsPolicy: ClusterFirst
dnsConfig:
options:
- name: ndots
value: "3"
keda: false
coturnDeployment: external

monitoring:
enabled: false
dashboards: false
prometheusMetrics: false
prometheusAlerts: false

image:
imagePullSecrets:
- webrtcjfrogsecret
initContainerImage: pureengage-docker-staging.jfrog.io/alpine:3.7-curl
webrtc: pureengage-docker-staging.jfrog.io/webrtc
coturn: pureengage-docker-staging.jfrog.io/webrtc
webrtcVersion: 9.0.000.88
coturnVersion: 9.0.000.88

gateway:
logPath: "/export/vol1/PAT/infra/webrtc"
logPvc:
pvcName: webrtc-gateway-log-pvc
volumeName: webrtc-gateway-log-volume
storageClassName: genesys-webrtc
capacity: 5Gi
volumespec:
accessModes:
- ReadWriteMany
persistentVolumeReclaimPolicy: Retain
nfs:
path: /export/vol1/PAT/infra/webrtc
server: 192.168.30.51
esServer: stdout
replicas: 1
workersCount: 1
voiceSipProxy: voice-sipproxy.voice.svc.cluster.local:5080;transport=tcp
turnExternalUriBlue: 192.168.30.208
turnExternalUriGreen: 192.168.30.209
authRedirectUri: http://gauth.apps.vce-c0.eps.genesys.com:80
authService: http://gauth-auth.gauth.svc.cluster.local:80
envService: https://gws.apps.vce-c0.eps.genesys.com
resources:
requests:
# NB! 800m per worker, MUST be integer, not string - will be multiplied by workersCount in helm
cpu: 800
# NB! 150Mi per worker, MUST be integer, not string - will be multiplied by workersCount in helm
memory: 150
limits:
memory: "8Gi"
secrets:
type: env
env:
gwsClient: external_api_client
gwsSecret: secret
securityContext:
runAsUser: 500
runAsGroup: 500

coturn:
logPath: "/export/vol1/PAT/infra/coturn/"
logPvc:
pvcName: webrtc-coturn-log-pvc
volumeName: webrtc-coturn-log-volume
storageClassName: genesys-webrtc
capacity: 5Gi
volumeSpec:
accessModes:
- ReadWriteMany
persistentVolumeReclaimPolicy: Retain
nfs:
path: /export/vol1/PAT/infra/webrtc
server: 192.168.30.51
replicas: 1
port: 443
lbIpBlue: 192.168.30.208
lbIpGreen: 192.168.30.209
securityContext:
runAsUser: 500
runAsGroup: 500</source>
#'''PersistentVolume (PV) and PersistentVolumeClaim (PVC)''': If you plan to use PV for logs, create the PV and then specify it for PVC of Gateway and CoTurn.
#:PV can also be created during the common-infrastructure deployment. You should review the <tt>values-template.yaml</tt> file and then configure the PV specification for Gateway and CoTurn.
#:Single PV/PVC pair will be used for both Green and Blue deployments of Gateway, and another single PV/PVC pair will be used for both Green and Blue deployments of CoTurn.
|Status=No
}}
|PEPageType=9c3ae89b-4f75-495b-85f8-d8c4afcb3f97
}}

@@ Line 943: / Line 943: @@
    fsGroup: null
 </source>
 ===Arbitrary UIDs in AKS===
 If you want to use arbitrary UIDs in your Azure Kubernetes Services deployment, override the '''securityContext''' settings in the '''values.yaml''' file, so that you do not define any specific IDs.<source lang="bash">
@@ Line 957: / Line 956: @@
    runAsGroup: 0
 </source><br />
 |Status=No
 }}{{Section

@@ Line 8: / Line 8: @@
 |alignment=Vertical
 |structuredtext=Download the WebRTC Helm charts from JFrog using your credentials. Override the configuration parameters in the '''values.yaml''' file to provide deployment-specific values for certain parameters. You can override values in the Helm charts to configure Private Edition. For more information about overriding Helm chart values, see the "suite-level" documentation about how to override Helm chart values: {{SuiteLevelLink|helmoverride}}
 {{{!}} class="wikitable"
@@ Line 76: / Line 74: @@
 {{!}}{{!}}
 {{!}}{{!}}Specification
-{{!}}{{!}}As the default value of the HAProxy route timeout is set to 30 s, there is a possibility it interferes with the WebRTC long-polling timeout (30 s) and disconnect the session. You can override this default value and increase the timeout to 50 s using the annotation, <tt>haproxy.router.openshift.io/timeout: 50 s</tt>, for the session to respond and connect.
+{{!}}{{!}}As the default value of the HAProxy route timeout is set to 30 s, there is a possibility it interferes with the WebRTC long-polling timeout (30 s) and disconnect the session.
 {{!}}{{!}}<source lang="LANGUAGE">deployment
    ingress:
@@ Line 86: / Line 84: @@
        nginx.ingress.kubernetes.io/session-cookie-path:     "/; Secure"
        nginx.ingress.kubernetes.io/session-cookie-samesite: None
 {{!}}-
 {{!}}{{!}}deployment.ingress.tls
@@ Line 932: / Line 929: @@
    runAsGroup: 500
    fsGroup: 500
 </source>
 ===Arbitrary UIDs in AKS===

@@ Line 522: / Line 522: @@
 {{!}}{{!}}gateway.logPath
 {{!}}{{!}}Path to the log-directory. used for both - PVC or HostPath types of logs. Also, check the <tt>esServer</tt> option. If <tt>/mnt/log/webrtc</tt> is specified, the <tt>/mnt/log/webrtc/<gateway pod name>/webrtcgw</tt> logfiles are created and used in the mentioned path. If the <tt>image.initContainerImage</tt> option is not specified, the folder with the pod name will not be created and the <tt>/mnt/log/webrtc/webrtcgw</tt> logfiles will be created.
 {{!}}{{!}}mandatory
 {{!}}{{!}}"/mnt/log/webrtc"

@@ Line 27: / Line 27: @@
 {{!}}{{!}}webrtc
 {{!}}{{!}}string
-{{!}}{{!}}
+{{!}}{{!}}You can modify default namespace used to deploy applications in the <tt>deployment.namespace</tt> option.
-{{!}}{{!}}
+{{!}}{{!}}<source lang="LANGUAGE">deployment:
 {{!}}-
 {{!}}{{!}}deployment.priorityClassName

@@ Line 7: / Line 7: @@
 |sectionHeading=Override Helm chart values
 |alignment=Vertical
-|structuredtext=You can override values in the Helm charts to configure Private Edition. For more information about overriding Helm chart values, see the "suite-level" documentation about how to override Helm chart values: {{SuiteLevelLink|helmoverride}}
+|structuredtext=Download the WebRTC Helm charts from JFrog using your credentials. You must override certain parameters in the '''values.yaml''' file to provide deployment-specific values for certain parameters. You can override values in the Helm charts to configure Private Edition. For more information about overriding Helm chart values, see the "suite-level" documentation about how to override Helm chart values: {{SuiteLevelLink|helmoverride}}
 {{{!}} class="wikitable"
 {{!}}-
@@ Line 893: / Line 896: @@
 |sectionHeading=Configure security
 |alignment=Vertical
-|structuredtext=Not applicable
+|structuredtext=The security context settings define the privilege and access control settings for pods and containers.
 |Status=No
 }}{{Section