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

WikiSysop at 11:01, March 6, 2023

2023-03-06T11:01:27Z

WikiSysop at 16:16, September 29, 2022

2022-09-29T16:16:45Z

WikiSysop at 12:45, April 26, 2022

2022-04-26T12:45:58Z

WikiSysop at 19:51, March 30, 2022

2022-03-30T19:51:55Z

Julie.munn@genesys.com: Published

2021-10-29T17:44:21Z

Published

New page

{{Article
|Standalone=No
|DisplayName=Deploy Digital Channels
|Context=Learn how to deploy Digital Channels.
|ComingSoon=No
|Section={{Section
|alignment=Vertical
|structuredtext={{NoteFormat|Make sure to review {{Link-SomewhereInThisVersion|topic=Planning}} for the full list of prerequisites required to deploy Digital Channels.|}}
|Status=No
}}{{Section
|sectionHeading=Prepare your environment
|anchor=prepare
|alignment=Vertical
|structuredtext=To prepare your environment for the deployment, first confirm the cluster is running:<syntaxhighlight>

oc get clusterversion
</syntaxhighlight>Create a new namespace (also called a project) for Digital Channels:<syntaxhighlight>
oc new-project nexus
</syntaxhighlight>
{{AnchorDiv|secret}}
===Configure a secret to access JFrog===
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=<jfrog_username> --docker-password=<API_key_from_jfrog></source>

Now map the secret to the default service account (for Openshift):
<source lang="text">oc secrets link default <credential-name> --for=pull</source>
|Status=No
}}{{Section
|sectionHeading=Deploy in OpenShift
|anchor=deploy
|alignment=Vertical
|structuredtext=To deploy Digital Channels in OpenShift, you'll need the Helm package and override files you {{Link-SomewhereInThisVersion|manual=DCPEGuide|topic=Planning|anchor=Helm|display text=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:<syntaxhighlight>
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
</syntaxhighlight>

Run the following command to install Digital Channels:<syntaxhighlight>
helm install nexus ./nexus-<version>.tgz --set version=<version> -f values.yaml
</syntaxhighlight>
|Status=No
}}{{Section
|sectionHeading=Validate the deployment in OpenShift
|anchor=validate
|alignment=Vertical
|structuredtext=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:<syntaxhighlight>
{
"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"
}
</syntaxhighlight>The deployment was successful if <code>state="green"</code>. You can also confirm that <code>db.ready=true</code> and <code>cache.ready=true</code>.
|Status=No
}}{{Section
|sectionHeading=Next steps
|anchor=next
|alignment=Vertical
|structuredtext=Complete the steps in the "Integrate and provision" chapter to finish deploying Digital Channels.

*{{Link-SomewhereInThisVersion|manual=DCPEGuide|topic=PreConfig}}
*{{Link-SomewhereInThisVersion|manual=DCPEGuide|topic=EnableTenant}}
*{{Link-SomewhereInThisVersion|manual=DCPEGuide|topic=ProvisionAPI}}
*{{Link-SomewhereInThisVersion|manual=DCPEGuide|topic=ProvisionSMS}}

<br />
|Status=No
}}
|PEPageType=45d1441f-dc69-4a17-bd47-af5d811ce167
}}

@@ Line 26: / Line 26: @@
 Log in to the GKE cluster from the host where you will run the deployment:<syntaxhighlight>
 gcloud container clusters get-credentials <cluster>
 </syntaxhighlight>Create a JSON file called '''create-nexus-namespace.json''' with the following content:<syntaxhighlight>
+{
@@ Line 39: / Line 44: @@
 </syntaxhighlight>Use the JSON file to create a new namespace for Digital Channels:<syntaxhighlight>
 kubectl apply -f apply create-nexus-namespace.json
-</syntaxhighlight>Now confirm the namespace was created:<syntaxhighlight>
+</syntaxhighlight>Now, confirm the created namespace:<syntaxhighlight>
 kubectl describe namespace nexus
 </syntaxhighlight>
-{{AnchorDiv|secret}}
+Add Helm repo and execute Helm upgrade to create persistent volumes and persistent volume claims<syntaxhighlight>
 ===Configure a secret to access JFrog===
 If you haven't done so already, create a secret for accessing the JFrog registry:
@@ Line 54: / Line 62: @@
 |anchor=deploy
 |alignment=Vertical
-|structuredtext=To deploy Digital Channels, you'll need the Helm package and override files you {{Link-SomewhereInThisVersion|manual=DCPEGuide|topic=Planning|anchor=Helm|display text=downloaded in a previous step}}. Copy '''values.yaml''' and the Helm package ('''nexus-<version>.tgz''') to the installation location.
+|structuredtext=To deploy Digital Channels, you need the Helm package and override files you {{Link-SomewhereInThisVersion|manual=DCPEGuide|topic=Planning|anchor=Helm|display text=downloaded in a previous step}}. Copy '''values.yaml''' and the Helm package ('''nexus-<version>.tgz''') to the installation location.
 You must override the following key sections in '''values.yaml''':
@@ Line 179: / Line 187: @@
 |Status=No
 }}
 }}

@@ Line 10: / Line 10: @@
 |anchor=prepare
 |alignment=Vertical
-|structuredtext=To prepare your environment for the deployment, complete the steps in this section for either OpenShift or Google Kubernetes Engine (GKE).
+|structuredtext=To prepare your environment for the deployment, complete the steps in this section for either Google Kubernetes Engine (GKE) or Azure Kubernetes Service (AKS).
 ===GKE===
@@ Line 55: / Line 44: @@
 <source lang="text">kubectl create secret docker-registry <credential-name> --docker-server=<docker repo> --docker-username=<jfrog_username> --docker-password=<API_key_from_jfrog></source>
 |Status=No
 }}{{Section

@@ Line 1: / Line 1: @@
-{{Article
+{{ArticlePEServiceDeploy
-|Standalone=No
+|ServiceId=9e7aa6a5-e8c6-4d8c-816f-4790127eabe7
-|DisplayName=Deploy Digital Channels
+|IncludeAssumptions=Yes
 |Section={{Section
 |alignment=Vertical

@@ Line 12: / Line 12: @@
 |anchor=prepare
 |alignment=Vertical
-|structuredtext=To prepare your environment for the deployment, first confirm the cluster is running:<syntaxhighlight>
+|structuredtext=To prepare your environment for the deployment, complete the steps in this section for either OpenShift or Google Kubernetes Engine (GKE).
 oc get clusterversion
-</syntaxhighlight>Create a new namespace (also called a project) for Digital Channels:<syntaxhighlight>
+</syntaxhighlight>Create a new project for Digital Channels:<syntaxhighlight>
 oc new-project nexus
 </syntaxhighlight>
 {{AnchorDiv|secret}}
@@ Line 23: / Line 49: @@
 <source lang="text">kubectl create secret docker-registry <credential-name> --docker-server=<docker repo> --docker-username=<jfrog_username> --docker-password=<API_key_from_jfrog></source>
-Now map the secret to the default service account (for Openshift):
+For OpenShift deployments, map the secret to the default service account (this is an optional step):
 <source lang="text">oc secrets link default <credential-name> --for=pull</source>
 |Status=No
 }}{{Section
-|sectionHeading=Deploy in OpenShift
+|sectionHeading=Deploy
 |anchor=deploy
 |alignment=Vertical
-|structuredtext=To deploy Digital Channels in OpenShift, you'll need the Helm package and override files you {{Link-SomewhereInThisVersion|manual=DCPEGuide|topic=Planning|anchor=Helm|display text=downloaded in a previous step}}. Copy '''values.yaml''' and the Helm package ('''nexus-<version>.tgz''') to the installation location.
+|structuredtext=To deploy Digital Channels, you'll need the Helm package and override files you {{Link-SomewhereInThisVersion|manual=DCPEGuide|topic=Planning|anchor=Helm|display text=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:<syntaxhighlight>
+*{{Link-SomewhereInThisVersion|manual=DCPEGuide|topic=Configure|anchor=image|display text=image.*}}
 deploymentType: Deployment
 replicaCount: 1
@@ Line 62: / Line 96: @@
      apikey: ""
      retryTimeout: 10000
 service:
    enabled: true
@@ Line 93: / Line 122: @@
    alarms: true
 </syntaxhighlight>
 Run the following command to install Digital Channels:<syntaxhighlight>
@@ Line 101: / Line 128: @@
 |Status=No
 }}{{Section
-|sectionHeading=Validate the deployment in OpenShift
+|sectionHeading=Validate the deployment
 |anchor=validate
 |alignment=Vertical
@@ Line 149: / Line 176: @@
 |anchor=next
 |alignment=Vertical
-|structuredtext=Complete the steps in the "Integrate and provision" chapter to finish deploying Digital Channels.
+|structuredtext=Complete the steps in the "Integrate and provision" chapter to finish deploying Digital Channels. See {{Link-SomewhereInThisVersion|manual=DCPEGuide|topic=ProvisionOverview}} for details.
 <br />