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

WikiSysop at 11:01, March 6, 2023

2023-03-06T11:01:30Z

Balaji: Published

2022-08-17T04:54:58Z

Published

Balaji: Published

2022-08-10T17:49:34Z

Published

New page

{{ArticlePEServiceDeploy
|ServiceId=AI Connector
|IncludeAssumptions=Yes
|Section={{Section
|sectionHeading=Deploy AI Connector
|alignment=Vertical
|structuredtext={{NoteFormat|Make sure to review {{Link-SomewhereInThisVersion|topic=PlanningAIConnector}} for the full list of prerequisites required to deploy Digital Channels AI Connector.|}}
|Status=No
}}{{Section
|sectionHeading=Prepare your environment
|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).
===OpenShift===
Log in to the OpenShift cluster from the host where you will run the deployment:<syntaxhighlight>
oc login --token <token> --server <url of api server>
</syntaxhighlight>First confirm the cluster is running:<syntaxhighlight>

oc get clusterversion
</syntaxhighlight>Create a new project for Digital Channels:<syntaxhighlight>
oc new-project athena
</syntaxhighlight>
===GKE===
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>
{
"apiVersion": "v1",
"kind": "Namespace",
"metadata": {
"name": "athena",
"labels": {
"name": "athena"
}
}
}
</syntaxhighlight>Use the JSON file to create a new namespace for Digital Channels AI Connector:<syntaxhighlight>
kubectl apply -f apply create-athena-namespace.json
</syntaxhighlight>Now confirm the namespace was created:<syntaxhighlight>
kubectl describe namespace athena
</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>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
|anchor=deploy
|alignment=Vertical
|structuredtext=To deploy AI Connector, 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 ('''athena-<version>.tgz''') to the installation location.

You must override the following key sections in '''values.yaml:'''

*{{Link-SomewhereInThisVersion|anchor=imageAIConnector|display text=image.*|manual=DCPEGuide|topic=ConfigureAIConnector}}
*{{Link-SomewhereInThisVersion|anchor=athenanexusAIConnector|display text=athena.nexus.*|manual=DCPEGuide|topic=ConfigureAIConnector}}
*{{Link-SomewhereInThisVersion|anchor=athenaredisAIConnector|display text=athena.redis.*|manual=DCPEGuide|topic=ConfigureAIConnector}}
*{{Link-SomewhereInThisVersion|anchor=athenadbAIConnector|display text=athena.db.*|manual=DCPEGuide|topic=ConfigureAIConnector}}
*{{Link-SomewhereInThisVersion|anchor=ingressAIConnector|display text=ingress.*|manual=DCPEGuide|topic=ConfigureAIConnector}}

Here's an example of how your '''values.yaml''' file might look:<syntaxhighlight>
# Default values for athena.
# This is a YAML-formatted file.
# Declare variables to be passed into your templates.

version: "100.0.124.3419" # AI Connector Version

nameOverride: ""

fullnameOverride: ""

replicaCount: 1

image:
registry: "pureengage-docker-staging.jfrog.io"
repository: nexus/athena
pullPolicy: IfNotPresent
pullSecrets:
- name: <pullsecret>

serviceAccount:
create: false
name: ""
annotations: {}

podAnnotations: {}

podLabels: {}

podSecurityContext:
runAsNonRoot: true
runAsUser: 500
runAsGroup: 500
fsGroup: 500

securityContext: {}

configChecksum: true

secretChecksum: true

containerPort: 4084

service:
enabled: true
type: ClusterIP
annotations: {}
port: 80

ingress:
enabled: false
annotations: {}
hosts:
- host: athena.local
paths: []
tls: []
# - secretName: athena-tls-secret
# hosts:
# - athena.local

resources: {}
# limits:
# cpu: 100m
# memory: 128Mi
# requests:
# cpu: 100m
# memory: 128Mi

nodeSelector: {}

tolerations: []

affinity: {}

priorityClassName: ""

dnsPolicy: ClusterFirst

dnsConfig:
options:
- name: ndots
value: "3"

monitoring:
enabled: false

athena:
server:
apiPrefix: "/nexus/v3"
nexus:
url: "<nexus-url>"
apiPrefix: "/nexus/v3"
apiKey: "<cluster-api-key>"
timeout: 10000
db:
host: "<postgres-host>"
port: 5432
user: "<user>"
password: "<password>"
database: "<dbname>"
ssl: false
redis:
nodes: "redis://<redis-host>:6379"
password: "<password>"
cluster: true
tls: false
google:
speechApiKey: ""
</syntaxhighlight>

Run the following command to install AI Connector:<syntaxhighlight>
helm upgrade --install <deployment-name> <helm-repo>/athena-<version>.tgz -f values.yaml
</syntaxhighlight>
|Status=No
}}{{Section
|sectionHeading=Validate the deployment
|anchor=validate
|alignment=Vertical
|structuredtext=To validate the deployment, first run the following code snippet
kubectl port-forward service/athena <port>:80

and then send GET request on the following URL

$athenaURL/health/detail

Where '''$athenaURL''' is the fully qualified domain name (FQDN) for AI Connector.

The response should look like this:<syntaxhighlight>
{
"buildInfo": {
"version": "100.0.001.97446",
"changeset": "565f432fa8f4555276b55e8237cebcfb201b986e",
"timestamp": "Mon Jan 17 10:21:22 UTC 2022"
},
"startTime": "2022-03-17T13:15:22.873Z",
"upTime": 49338032,
"os": {
"hostname": "athena-6bb9c5c68f-bz449",
"upTime": 52366.39,
"freemem": 1316397056,
"loadavg": [0.35, 0.37, 0.63],
"totalmem": 4124729344
},
"memoryUsage": {
"rss": 178757632,
"heapTotal": 83382272,
"heapUsed": 80987072,
"external": 1890524,
"arrayBuffers": 126610
},
"redis": {
"state": "READY",
"latency": 5
},
"db": {
"latency": 202
},
"isReady": true
}
</syntaxhighlight>The deployment was successful if <code>state="green"</code>. You can also confirm that <code>db.ready=true</code> and <code>redis.ready=true</code>.

==Uninstall==
Execute the following command to uninstall AI Connector:

helm delete <deployment-name> -n <namespace>
|Status=No
}}{{Section
|sectionHeading=Next steps
|anchor=next
|alignment=Vertical
|structuredtext=Complete the steps in {{Link-AnywhereElse|product=PEC-DC|version=Current|manual=DCPEGuide|topic=ProvisionAIConnector}} to finish deploying AI Connector.

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

@@ Line 11: / Line 11: @@
 |anchor=prepare
 |alignment=Vertical
-|structuredtext=To prepare your environment for either OpenShift or Google Kubernetes Engine (GKE) deployment, complete the steps in this section.
+|structuredtext=To prepare your environment for the Google Kubernetes Engine (GKE) deployment, complete the steps in this section.
 ===GKE===
 Log in to the GKE cluster from the host where you will run the deployment:<syntaxhighlight>
@@ Line 41: / Line 33: @@
 </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>For OpenShift deployment, 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>
+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>
 |Status=No
 }}{{Section

@@ Line 11: / Line 11: @@
 |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 either OpenShift or Google Kubernetes Engine (GKE) deployment, complete the steps in this section.
 ===OpenShift===
 Log in to the OpenShift cluster from the host where you will run the deployment:<syntaxhighlight>
@@ Line 37: / Line 37: @@
 </syntaxhighlight>Use the JSON file to create a new namespace for Digital Channels AI Connector:<syntaxhighlight>
 kubectl apply -f apply create-athena-namespace.json
-</syntaxhighlight>Now confirm the namespace was created:<syntaxhighlight>
+</syntaxhighlight>Now, confirm the  created namespace:<syntaxhighlight>
 kubectl describe namespace athena
 </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>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>
+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>For OpenShift deployment, 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
@@ Line 178: / Line 178: @@
   kubectl port-forward service/athena <port>:80
-and then send GET request on the following URL
+Then, send the GET request on the following URL:
   $athenaURL/health/detail
-Where '''$athenaURL'''  is the fully qualified domain name (FQDN) for AI Connector.
+where '''$athenaURL'''  is the fully qualified domain name (FQDN) for AI Connector.
 The response should look like this:<syntaxhighlight>
@@ Line 216: / Line 216: @@
      "isReady": true
+}
-</syntaxhighlight>The deployment was successful if <code>state="green"</code>. You can also confirm that <code>db.ready=true</code> and <code>redis.ready=true</code>.
+</syntaxhighlight>The deployment is successful if <code>state="green"</code>. You can also confirm that <code>db.ready=true</code> and <code>redis.ready=true</code>.
 ==Uninstall==