Deploy Digital Channels

Learn how to deploy Digital Channels.

Related documentation:

• How Digital Channels works
• Suite-level guide
• All services
• Digital Channels Release Notes

RSS:

• For private edition

Important

Make sure to review Before you begin for the full list of prerequisites required to deploy Digital Channels.

Prepare your environment

To prepare your environment for the deployment, first confirm the cluster is running:

oc get clusterversion

Create a new namespace (also called a project) for Digital Channels:

oc new-project nexus

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=<jfrog_username> --docker-password=<API_key_from_jfrog>

Now map the secret to the default service account (for Openshift):

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

Deploy in OpenShift

To deploy Digital Channels in OpenShift, you'll need the Helm package and override files you downloaded in a previous step. Copy values.yaml and the Helm package (nexus-<version>.tgz) to the installation location.

The following example shows how your values.yaml file might look:

deploymentType: Deployment
replicaCount: 1
image:
  registry: pureengage-docker-staging.jfrog.io
  repository: nexus/nexus
  pullPolicy: IfNotPresent
imagePullSecrets: [ mycred ]
nameOverride: ""
fullnameOverride: ""
existingSecret:
existingConfig:
nexus:
  fqdn: "http://digital.<your-cluster>"
  redirectProtocol: "http://"
  redis:
    enabled: true
    nodes: "redis://<redis-url>:<redis-port>"
    useCluster: true
    enableTls: false
    password: $nexus_redis_password
  db:
    host: "<postgres-host>"
    port: <postgres-port>
    user: "<db-user>"
    password: nexus_db_password
    enableSsl: false
  social:
    apikey: ""
    retryTimeout: 10000
podSecurityContext:
    runAsUser: null
    runAsGroup: 0
    fsGroup: null
    runAsNonRoot: true	
service:
  enabled: true
  type: ClusterIP
ingress:
  tls:
    - hosts:
      - digital.<your-cluster>
      secretName: letsencrypt 
  enabled: true
  hosts:
    - host: digital.<your-cluster>
      paths:
        - path: '/chat/v3/'
          port: http
        - path: '/nexus/v3/'
          port: http
        - path: '/ux/'
          port: http
        - path: '/admin/'
          port: http
        - path: '/auth/'
          port: http
monitoring:
  enabled: true
  alarms: true

Run the following command to install Digital Channels:

helm install nexus ./nexus-<version>.tgz --set version=<version> -f values.yaml

Validate the deployment in OpenShift

To validate the deployment, send the following GET request:

$nexusURL/health/detail 

Where $nexusURL is the fully qualified domain name (FQDN) for Digital Channels.

The response should look like this:

{
	"buildInfo": {
		"@genesys/nexus-admin-ux": "^1.0.21",
		"@genesys/nexus-ux": "^2.2.46",
		"version": "9.0.001.01.95292",
		"changeset": "8c3a2b34888d41b318d949a4bda2903368cf3bda",
		"timestamp": "Thu Oct 21 13:55:13 UTC 2021"
	},
	"startTime": "2021-10-22T10:40:27.456Z",
	"os": {
		"upTime": 1142897,
		"freemem": 105664512,
		"loadavg": [1.32, 0.68, 0.43],
		"totalmem": 2052542464
	},
	"upTime": 279363374,
	"memoryUsage": {
		"rss": 306659328,
		"heapTotal": 196685824,
		"heapUsed": 162114568,
		"external": 2490373,
		"arrayBuffers": 818214
	},
	"cache": {
		"ready": true,
		"state": "READY"
	},
	"db": {
		"ready": true
	},
	"state": "green"
}

The deployment was successful if state="green". You can also confirm that db.ready=true and cache.ready=true.

Next steps

Complete the steps in the "Integrate and provision" chapter to finish deploying Digital Channels.

• Pre-configure tenant objects
• Enable a tenant for Digital Channels
• Provision API keys
• Setting up Integration for Inbound and Outbound SMS