Difference between revisions of "GWS/Current/GWSPEGuide/Deploy"

Revision as of 20:49, October 29, 2021

This topic is part of the manual Genesys Web Services and Applications Private Edition Guide for version Current of Genesys Web Services and Applications.

Prepare your environment

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:

oc login --token <token> --server <url of api server>

First, confirm the cluster is running:

oc get clusterversion

Create a new project for Web Services and Applications:

oc new -project gws

GKE

Log in to the GKE cluster from the host where you will run the deployment:

gcloud container clusters get-credentials <cluster>

Create a new namespace for Web Services and Applications:

helm create ns gws

Deploy

To deploy GWS, you'll need the Helm package and your override files. Copy values.yaml, versions.yaml and the Helm package (gws-services-<version>.tgz) to the installation location.

For OpenShift, select the gws project you created in Prepare your environment:

oc project gws

For debugging purposes, use the following command to render templates without installing so you can check that resources are created properly:

helm template --debug /gws-services-<version>.tgz -f values.yaml -f versions.yaml

The result shows Kubernetes descriptors. The values you see are generated from Helm templates, and based on settings from values.yaml and versions.yaml. Ensure that no errors are displayed; you will later apply this configuration to your Kubernetes cluster.

Now you're ready to deploy Web Services and Applications:

 helm upgrade --install gws-services helm-staging/gws-services --version=<version> -n gws -f ./override.gws-services.values.yaml -f ./versions.yaml

Validate the deployment

First check the installed Helm release:

helm list –n gws

The result should show the gws-services deployment details. For example:

NAME            NAMESPACE   REVISION    UPDATED                                     STATUS      CHART                   APP VERSION
gws-services    gws         1           2021-05-19  11:49:49.2243107 +0530 +0530    deployed    gws-services-1.0.18     1.0

Check the gws-services status:

helm status gws-services

The result should show the namespace details with a status of deployed:

NAME: gws-services
LAST DEPLOYED: Wed May 19 11:49:49 2021
NAMESPACE: gws
STATUS: deployed
REVISION: 1
TEST SUITE: None

Check the GWS Kubernetes objects created by Helm:

kubectl get all -n gws

The result should show all the created pods, services, ConfigMaps, and so on.

Next steps

@@ Line 6: / Line 6: @@
 |ComingSoon=No
 |Section={{Section
-|sectionHeading=Deploying Genesys Web Services and Applications in OpenShift
 |alignment=Vertical
-|structuredtext====Login to OpenShift Cluster===
+|structuredtext={{NoteFormat|Make sure to review {{Link-SomewhereInThisVersion|manual=GWSPEGuide|topic=Planning}} for the full list of prerequisites required to deploy Web Services and Applications.|}}
-Use the following command to log in to OpenShift cluster from the host where you will run deployment:
+|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:
   oc login --token <token> --server <url of api server>
+First, confirm the cluster is running:
-===Select your GWS Project===
+ oc get clusterversion
-Use the following command to select the default GWS project that was created as a prerequisite:
+Create a new project for Web Services and Applications:
+ oc new -project gws
+===GKE===
+Log in to the GKE cluster from the host where you will run the deployment:
+ gcloud container clusters get-credentials <cluster>
+Create a new namespace for Web Services and Applications:
+ helm create ns gws
+|Status=No
+}}{{Section
+|sectionHeading=Deploy
+|anchor=deploy
+|alignment=Vertical
+|structuredtext=To deploy GWS, you'll need the Helm package and your override files. Copy '''values.yaml''', '''versions.yaml''' and the Helm package ('''gws-services-<version>.tgz''') to the installation location.
+For OpenShift, select the '''gws''' project you created in {{Link-SomewhereInThisVersion|manual=GWSPEGuide|topic=Deploy|anchor=OpenShift|display text=Prepare your environment}}:
   oc project gws
-===Render Templates===
+For debugging purposes, use the following command to render templates without installing so you can check that resources are created properly:
-To ensure that resources are created correctly, you can render the templates for debugging purposes within installing them. Use the following command to render the templates:
+  helm template --debug /gws-services-<version>.tgz -f values.yaml -f versions.yaml
-  helm template --debug /gws-services-1.0.18.tgz -f values-gws-new.yaml -f gws-versions_ltst.yaml
+The result shows Kubernetes descriptors. The values you see are generated from Helm templates, and based on settings from '''values.yaml''' and '''versions.yaml'''. Ensure that no errors are displayed; you will later apply this configuration to your Kubernetes cluster.
-Kubernetes descriptors are displayed. The values are generated from Helm templates, based on settings from values-gws-new.yaml and gws-versions_ltst.yaml. Ensure that no errors are displayed. This configuration will be applied to your Kubernetes cluster.
-===Deploy GWS===
+Now you're ready to deploy Web Services and Applications:
-Use the following command to deploy GWS:
+  helm upgrade --install gws-services helm-staging/gws-services --version=<version> -n gws -f ./override.gws-services.values.yaml -f ./versions.yaml
- helm install gws-services./gws-services-1.0.18.tgz -f values-gws-new.yaml -f gws-versions_ltst.yaml
 |Status=No
 }}{{Section
-|sectionHeading=Validate OpenShift Deployment
+|sectionHeading=Validate the deployment
 |alignment=Vertical
-|structuredtext=Use the following command to check the installed Helm release:
+|structuredtext=First check the installed Helm release:
   helm list –n gws
-The result should show gws-service deployment details similar to the following:
+The result should show the '''gws-services''' deployment details. For example:
   NAME            NAMESPACE   REVISION    UPDATED                                     STATUS      CHART                   APP VERSION
   gws-services    gws         1           2021-05-19  11:49:49.2243107 +0530 +0530    deployed    gws-services-1.0.18     1.0
-To check the Genesys Web Services and Applications project status, use the following command:
+Check the '''gws-services''' status:
   helm status gws-services
-The result should display the details with <tt>STATUS: deployed</tt>:
+The result should show the namespace details with a status of deployed:
   NAME: gws-services
   LAST DEPLOYED: Wed May 19 11:49:49 2021
@@ Line 46: / Line 65: @@
   TEST SUITE: None
-To check the GWS OpenShift objects created by Helm, use the following command:
+Check the GWS Kubernetes objects created by Helm:
-  oc get all -n gws
+  kubectl get all -n gws
+The result should show all the created pods, services, ConfigMaps, and so on.
+|Status=No
+}}{{Section
+|sectionHeading=Next steps
+|anchor=next
+|alignment=Vertical
+|structuredtext=*{{Link-SomewhereInThisVersion|manual=GWSPEGuide|topic=ConfigureIngress}}
+*{{Link-SomewhereInThisVersion|manual=GWSPEGuide|topic=DeployIngress}}
+*{{Link-SomewhereInThisVersion|manual=GWSPEGuide|topic=ProvisionAS}}
 |Status=No
 }}
 |PEPageType=45d1441f-dc69-4a17-bd47-af5d811ce167
 }}

Genesys Web Services and Applications Private Edition Guide

Overview

Configure and deploy

Upgrade, roll back, or uninstall