PEC-DC/Current/DCPEGuide/Configure - Revision history

WikiSysop at 11:01, March 6, 2023

2023-03-06T11:01:22Z

WikiSysop at 19:51, March 30, 2022

2022-03-30T19:51:51Z

Jumunn: Published

2022-02-15T13:22:47Z

Published

Jumunn: Published

2022-02-15T13:20:51Z

Published

Ed.jamer@genesys.com: Text replacement - "Genesys Engage [cC]loud" to "Genesys Multicloud CX"

2021-11-09T20:28:40Z

Text replacement - "Genesys Engage [cC]loud" to "Genesys Multicloud CX"

Julie.munn@genesys.com: Published

2021-10-29T17:44:07Z

Published

New page

{{Article
|Standalone=No
|DisplayName=Configure Digital Channels
|Context=Learn how to configure Digital Channels.
|ComingSoon=No
|Section={{Section
|alignment=Vertical
|structuredtext=Complete the steps on this page to configure your Digital Channels deployment.
|Status=No
}}{{Section
|sectionHeading=Override Helm chart values
|anchor=override
|alignment=Vertical
|structuredtext=You can specify parameters for the deployment by overriding Helm chart values in the '''values.yaml''' file. See the '''Parameters''' table for a full list of overridable values.

For more information about how to override Helm chart values, see {{SuiteLevelLink|helmoverride}} 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 {{Link-SomewhereInThisVersion|manual=DCPEGuide|topic=Configure|anchor=security|display text=Configure security}} below.

{{{!}} class="wikitable"
{{!}}+
Parameters
!Parameter
!Description
!Valid values
!Default
{{!}}-
{{!}}global.imageRegistry
{{!}}The Docker registry from which Kubernetes pulls images.
{{!}}A valid registry URL
{{!}}nil
{{!}}-
{{!}}global.imagePullSecrets
{{!}}An array of global docker-registry secret names.
{{!}}An array of secret names
{{!}}[] (does not add image pull secrets to deployed pods)
{{!}}-
{{!}}global.storageClass
{{!}}The global storage class used for dynamic provisioning.
{{!}}A valid storage class
{{!}}nil
{{!}}-
{{!}}image.registry
{{!}}The Nexus image registry.
{{!}}A valid registry URL
{{!}}TBD
{{!}}-
{{!}}image.repository
{{!}}The Nexus image name.
{{!}}A valid image name
{{!}}nexus/nexus
{{!}}-
{{!}}image.tag
{{!}}The Nexus image tag.
{{!}}A valid image tag
{{!}}{TAG_NAME}
{{!}}-
{{!}}image.pullPolicy
{{!}}Specifies when Kubernetes pulls images from the registry on start up.
{{!}}IfNotPresent or Always
{{!}}IfNotPresent
{{!}}-
{{!}}image.pullSecrets
{{!}}An array of docker-registry secret names.
{{!}}An array of secret names
{{!}}[] (does not add image pull secrets to deployed pods)
{{!}}-
{{!}}nameOverride
{{!}}A string to partially override the nexus.fullname template. This string is prepended to the release name.
{{!}}String
{{!}}nil
{{!}}-
{{!}}fullnameOverride
{{!}}A string to fully override the nexus.fullname template.
{{!}}String
{{!}}nil
{{!}}-
{{!}}nexus.redirectProtocol
{{!}}Defines the Web Services and Applications to Nexus redirect protocol (HTTP or HTTPS).
{{!}}A valid protocol
{{!}}http://
{{!}}-
{{!}}nexus.redis.enabled
{{!}}Specifies whether to use Redis. You must not changes this from the default value of true.
{{!}}true
{{!}}true
{{!}}-
{{!}}nexus.redis.nodes
{{!}}A comma-separated list of Redis nodes to connect.
{{!}}A valid URL
{{!}}<nowiki>redis://nexus-redis-master.default.svc.cluster.local:6379</nowiki>
{{!}}-
{{!}}nexus.redis.useCluster
{{!}}Specifies whether to deploy Redis as a cluster.
{{!}}true or false
{{!}}false
{{!}}-
{{!}}nexus.redis.enableTls
{{!}}Specifies whether to use TLS on the Redis connection.
{{!}}true or false
{{!}}false
{{!}}-
{{!}}nexus.redis.password
{{!}}The password for Redis authentication.
{{!}}A valid password
{{!}}""
{{!}}-
{{!}}nexus.db.host
{{!}}The Postgres service URL.
{{!}}A valid URL
{{!}}nexus-postgres-postgresql.default.svc.cluster.local
{{!}}-
{{!}}nexus.db.port
{{!}}The Postgres service port.
{{!}}A valid port
{{!}}5432
{{!}}-
{{!}}nexus.db.user
{{!}}The user assigned for the Nexus application to access Postgres.
{{!}}A valid user
{{!}}nexus
{{!}}-
{{!}}nexus.db.password
{{!}}The password assigned for the Nexus application to access Postgres.
{{!}}A valid password
{{!}}nexus
{{!}}-
{{!}}podSecurityContext.runAsNonRoot
{{!}}Specifies whether the container must run as a non-root user.
{{!}}true or false
{{!}}true
{{!}}-
{{!}}podSecurityContext.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
{{!}}500
{{!}}-
{{!}}podSecurityContext.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
{{!}}500
{{!}}-
{{!}}podSecurityContext.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
{{!}}500
{{!}}-
{{!}}resources
{{!}}The requests and limits for CPU and memory usage in Kubernetes. See the [https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ Kubernetes documentation] for details.
{{!}}
{{!}}requests: { cpu: "300m", memory: "512Mi" }
{{!}}-
{{!}}affinity
{{!}}Specifies the affinity and anti-affinity for Digital Channels pods. See the {{#Widget:ExtLink|link=https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/#affinity-and-anti-affinity|displaytext=Kubernetes documentation}} for details.
{{!}}Object
{{!}}{}
{{!}}-
{{!}}nodeSelector
{{!}}The labels Kubernetes uses to assign pods to nodes. See the {{#Widget:ExtLink|link=https://kubernetes.io/docs/concepts/configuration/assign-pod-node/|displaytext=Kubernetes documentation}} for details.
{{!}}Object
{{!}}{}
{{!}}-
{{!}}tolerations
{{!}}The tolerations Kubernetes uses for advanced pod scheduling. See the {{#Widget:ExtLink|link=https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/|displaytext=Kubernetes documentation}} for details.
{{!}}Object
{{!}}[]
{{!}}-
{{!}}priorityClassName
{{!}}The class name Kubernetes uses to determine the priority of a pod relative to other pods. See the {{#Widget:ExtLink|link=https://kubernetes.io/docs/concepts/configuration/pod-priority-preemption/#priorityclass|displaytext=Kubernetes documentation}} for details.
{{!}}A valid priority class name
{{!}}""
{{!}}-
{{!}}monitoring.enabled
{{!}}Specifies whether to deploy Custom Resource Definitions (CRD) for ServiceMonitors to determine which services should be monitored.
{{!}}true or false
{{!}}false
{{!}}-
{{!}}service.type
{{!}}The Kubernetes service type.
{{!}}See the {{#Widget:ExtLink|link=https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services-service-types|displaytext=Kubernetes documentation}} for details.
{{!}}LoadBalancer
{{!}}-
{{!}}service.port
{{!}}The Kubernetes service HTTP port.
{{!}}A valid port
{{!}}80
{{!}}-
{{!}}service.httpsPort
{{!}}The Kubernetes service HTTPS port.
{{!}}A valid port
{{!}}443
{{!}}-
{{!}}service.nodePorts.http
{{!}}The Kubernetes service HTTP node port.
{{!}}A valid port
{{!}}""
{{!}}-
{{!}}service.nodePorts.https
{{!}}The Kubernetes service HTTPS node port.
{{!}}A valid port
{{!}}""
{{!}}-
{{!}}service.externalTrafficPolicy
{{!}}Enables client source IP preservation. See the {{#Widget:ExtLink|link=https://kubernetes.io/docs/tasks/access-application-cluster/create-external-load-balancer/#preserving-the-client-source-ip|displaytext=Kubernetes documentation}} for details.
{{!}}Cluster or Local
{{!}}Cluster
{{!}}-
{{!}}service.loadBalancerIP
{{!}}The IP address of the load balancer service.
{{!}}A valid IP address
{{!}}""
{{!}}-
{{!}}ingress.enabled
{{!}}Enables the ingress controller resource.
{{!}}true or false
{{!}}false
{{!}}-
{{!}}ingress.annotations
{{!}}The ingress annotations.
{{!}}A valid set of annotations as "name: value"
{{!}}[]
{{!}}-
{{!}}ingress.certManager
{{!}}Add annotations for cert-manager.
{{!}}true or false
{{!}}false
{{!}}-
{{!}}ingress.hosts[0].name
{{!}}The hostname of your Nexus installation.
{{!}}A valid hostname
{{!}}nexus.local
{{!}}-
{{!}}ingress.hosts[0].path
{{!}}The path (within the URL structure) to your Nexus installation.
{{!}}A valid path
{{!}}/
{{!}}-
{{!}}ingress.hosts[0].tls
{{!}}Specifies whether to use TLS backend in ingress.
{{!}}true or false
{{!}}false
{{!}}-
{{!}}ingress.hosts[0].tlsHosts
{{!}}An array of TLS hosts for ingress record. If nil, this value defaults to the value of ingress.hosts[0].name.
{{!}}Valid hosts
{{!}}nil
{{!}}-
{{!}}ingress.hosts[0].tlsSecret
{{!}}The TLS secret (certificates).
{{!}}A valid secret
{{!}}nexus.local-tls-secret
{{!}}-
{{!}}ingress.secrets[0].name
{{!}}The TLS secret name.
{{!}}A valid name
{{!}}nil
{{!}}-
{{!}}ingress.secrets[0].certificate
{{!}}The TLS secret certificate.
{{!}}A valid certificate
{{!}}nil
{{!}}-
{{!}}ingress.secrets[0].key
{{!}}The TLS secret key.
{{!}}A valid key
{{!}}nil
{{!}}-
{{!}}podAnnotations
{{!}}Custom annotations for each pod.
{{!}}A valid set of labels as "name: value"
{{!}}{}
{{!}}}
|Status=No
}}{{Section
|sectionHeading=Configure Kubernetes
|alignment=Vertical
|structuredtext=Digital Channels stores passwords for Redis and the default database as Kubernetes secrets. In the '''nexus''' namespace, create a secret called "deployment-secrets" using the following YAML:<syntaxhighlight lang="yaml">
kind: Secret
apiVersion: v1
metadata:
name: deployment-secrets
namespace: nexus
stringData:
nexus_db_password: <db_password>
nexus_redis_password: <Redis_password>
type: Opaque
</syntaxhighlight>

<br />
|Status=No
}}{{Section
|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.

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 <code>500:500:500</code>, meaning the '''genesys''' user.<syntaxhighlight>
podSecurityContext:
runAsUser: 500
runAsGroup: 500
fsGroup: 500
runAsNonRoot: true
</syntaxhighlight>
===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>
podSecurityContext:
runAsUser: null
runAsGroup: 0
fsGroup: null
runAsNonRoot: true
</syntaxhighlight>For details about these parameters and possible values, see '''podSecurityContext.*''' in the {{Link-SomewhereInThisVersion|manual=DCPEGuide|topic=Configure|anchor=override|display text=Parameters}} table above.

<br />
|Status=No
}}
|PEPageType=9c3ae89b-4f75-495b-85f8-d8c4afcb3f97
}}

@@ Line 14: / Line 14: @@
 |structuredtext=You can specify parameters for the deployment by overriding Helm chart values in the '''values.yaml''' file. See the '''Parameters''' table for a full list of overridable values.
-For more information about how to override Helm chart values, see {{SuiteLevelLink|helmoverride}} in the ''Setting up Genesys Multicloud CX Private Edition'' guide.
+For more information about how to override Helm chart values, see {{SuiteLevelLink|helmoverride}}.
 If you want to use arbitrary UIDs in your OpenShift deployment, you must override the '''securityContext''' settings in the '''values.yaml''' file, so that no user or group IDs are specified. For details, see {{Link-SomewhereInThisVersion|manual=DCPEGuide|topic=Configure|anchor=security|display text=Configure security}} below.
@@ Line 276: / Line 276: @@
 |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 Multicloud CX Private Edition'' guide.
+|structuredtext=To learn more about how security is configured for private edition, be sure to read {{Link-AnywhereElse|product=PrivateEdition|version=Current|manual=PEGuide|topic=Prerequisites|display text=Permissions}} and {{Link-AnywhereElse|product=PrivateEdition|version=Current|manual=PEGuide|topic=ConfigSecurity}}.
 The security context settings define the privilege and access control settings for pods and containers.

@@ Line 15: / Line 15: @@
 For more information about how to override Helm chart values, see {{SuiteLevelLink|helmoverride}}.
 {{{!}} class="wikitable"
@@ Line 141: / Line 139: @@
 {{!}}-
 {{!}}podSecurityContext.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.
+{{!}}The user ID to run the entry point of the container process.
 {{!}}A valid user ID
 {{!}}500
 {{!}}-
 {{!}}podSecurityContext.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.
+{{!}}The group ID to run the entry point of the container process.
 {{!}}A valid group ID
 {{!}}500
 {{!}}-
 {{!}}podSecurityContext.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 supplemental group ID that applies to all containers in a pod.
 {{!}}A valid group ID
 {{!}}500
@@ Line 314: / Line 312: @@
      runAsNonRoot: true
 </syntaxhighlight>
 <br />
 |Status=No

@@ Line 41: / Line 41: @@
 {{!}}nil
 {{!}}-
-{{!}}image.registry
+{{!}}{{AnchorDiv|image}}image.registry
 {{!}}The Nexus image registry.
 {{!}}A valid registry URL
@@ Line 50: / Line 50: @@
 {{!}}A valid image name
 {{!}}nexus/nexus
 {{!}}-
 {{!}}image.pullPolicy
@@ Line 61: / Line 56: @@
 {{!}}IfNotPresent
 {{!}}-
-{{!}}image.pullSecrets
+{{!}}imagePullSecrets
 {{!}}An array of docker-registry secret names.
 {{!}}An array of secret names
@@ Line 81: / Line 76: @@
 {{!}}http://
 {{!}}-
-{{!}}nexus.redis.enabled
+{{!}}{{AnchorDiv|fqdn}}nexus.fqdn
 {{!}}Specifies whether to use Redis. You must not changes this from the default value of true.
 {{!}}true
@@ Line 106: / Line 110: @@
 {{!}}""
 {{!}}-
-{{!}}nexus.db.host
+{{!}}{{AnchorDiv|db}}nexus.db.host
 {{!}}The Postgres service URL.
 {{!}}A valid URL
@@ Line 125: / Line 129: @@
 {{!}}A valid password
 {{!}}nexus
 {{!}}-
 {{!}}podSecurityContext.runAsNonRoot
@@ Line 211: / Line 220: @@
 {{!}}""
 {{!}}-
-{{!}}ingress.enabled
+{{!}}{{AnchorDiv|ingress}}ingress.enabled
 {{!}}Enables the ingress controller resource.
 {{!}}true or false
@@ Line 231: / Line 240: @@
 {{!}}nexus.local
 {{!}}-
-{{!}}ingress.hosts[0].path
+{{!}}{{AnchorDiv|paths}}ingress.hosts[0].paths
-{{!}}The path (within the URL structure) to your Nexus installation.
+{{!}} colspan="1" rowspan="1"{{!}}The internal or external URI of the nexus services.
-{{!}}A valid path
+{{!}}<syntaxhighlight>
 {{!}}/
 {{!}}-

@@ Line 271: / Line 271: @@
 {{!}}{}
 {{!}}}
 |Status=No
 }}{{Section