GWS/Current/GWSPEGuide/Deploy - Revision history

WikiSysop at 13:01, February 28, 2023

2023-02-28T13:01:37Z

WikiSysop at 16:16, September 29, 2022

2022-09-29T16:16:37Z

WikiSysop at 13:15, July 22, 2022

2022-07-22T13:15:52Z

WikiSysop at 19:31, May 24, 2022

2022-05-24T19:31:04Z

WikiSysop at 12:16, May 4, 2022

2022-05-04T12:16:01Z

WikiSysop at 12:45, April 26, 2022

2022-04-26T12:45:51Z

WikiSysop at 18:45, April 8, 2022

2022-04-08T18:45:56Z

Tanyai: Corrected the command to create namespace ("helm" to "kubectl")

2022-01-14T02:20:02Z

Corrected the command to create namespace ("helm" to "kubectl")

Julie.munn@genesys.com: Published

2021-10-29T20:49:31Z

Published

Olena.chapovska@genesys.com: Published

2021-06-29T13:54:03Z

Published

New page

{{Article
|Standalone=No
|DisplayName=Deploy Genesys Web Services and Applications
|TocName=Deploy GWS
|Context=Learn how to deploy Genesys Web Services and Applications.
|ComingSoon=No
|Section={{Section
|sectionHeading=Deploying Genesys Web Services and Applications in OpenShift
|alignment=Vertical
|structuredtext====Login to OpenShift Cluster===
Use the following command to log in to OpenShift cluster from the host where you will run deployment:
oc login --token <token> --server <url of api server>

===Select your GWS Project===
Use the following command to select the default GWS project that was created as a prerequisite:
oc project gws

===Render Templates===
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-1.0.18.tgz -f values-gws-new.yaml -f gws-versions_ltst.yaml
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===
Use the following command to deploy GWS:
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
|alignment=Vertical
|structuredtext=Use the following command to check the installed Helm release:
helm list –n gws

The result should show gws-service deployment details similar to the following:
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:
helm status gws-services

The result should display the details with <tt>STATUS: deployed</tt>:
NAME: gws-services
LAST DEPLOYED: Wed May 19 11:49:49 2021
NAMESPACE: gws
STATUS: deployed
REVISION: 1
TEST SUITE: None

To check the GWS OpenShift objects created by Helm, use the following command:
oc get all -n gws
|Status=No
}}
|PEPageType=45d1441f-dc69-4a17-bd47-af5d811ce167
}}

@@ Line 11: / Line 11: @@
 |anchor=prepare
 |alignment=Vertical
-|structuredtext=To prepare your environment for the deployment, complete the steps in this section for OpenShift, Google Kubernetes Engine (GKE), or Azure Kubernetes Service (AKS).
+|structuredtext=To prepare your environment for the deployment, complete the steps in this section for Google Kubernetes Engine (GKE) or Azure Kubernetes Service (AKS).
+<!--
 ===OpenShift===
 Log in to the OpenShift cluster from the host where you will run the deployment:
@@ Line 20: / Line 20: @@
 Create a new project for Genesys Web Services and Applications (GWS):
   oc new-project gws
 ===GKE===
 Log in to the GKE cluster from the host where you will run the deployment:
@@ Line 70: / Line 71: @@
 |alignment=Vertical
 |structuredtext=To deploy GWS Services, 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
+-->
 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

@@ 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 the deployment, complete the steps in this section for OpenShift, Google Kubernetes Engine (GKE), or Azure Kubernetes Service (AKS).
 ===OpenShift===
@@ Line 19: / Line 19: @@
   oc get clusterversion
 Create a new project for Genesys Web Services and Applications (GWS):
-  oc new -project gws
+  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>
+  gcloud container clusters get-credentials <cluster-name>
-Create a new namespace for Genesys Web Services and Applications:
+Create a new namespace for Genesys Web Services and Applications with a JSON file that specifies the namespace metadata. For example, '''create-gws-namespace.json''':<syntaxhighlight>
-  kubectl create ns gws
 |Status=No
 }}{{Section
@@ Line 40: / Line 79: @@
 Now you're ready to deploy GWS Services:{{NoteFormat|If you have {{Link-SomewhereInThisVersion|manual=GWSPEGuide|topic=ConfigureTLS|display text=configured TLS}} for connections to third-party services or legacy Genesys servers, make sure to point to your local files in the <code>helm upgrade</code> command.|}}
-  helm upgrade --install gws-services helm-staging/gws-services --version=<version> -n gws -f ./override.gws-services.values.yaml -f ./versions.yaml
+ helm upgrade --install gws-services <helm_directory>/gws-services --version=<version> -n gws -f ./override.gws-services.values.yaml -f ./versions.yaml
 |Status=No
 }}{{Section

@@ Line 1: / Line 1: @@
 {{ArticlePEServiceDeploy
 |ServiceId=11ff3d39-ae2b-4526-b7e5-7dcdf781ef01
-|IncludedServiceId=c2867b76-3cf4-4d72-b8f2-cabf1986f5db
+|IncludedServiceId=8b6fe412-1610-46fb-b3cf-0ffbb2bbf543
 |IncludeAssumptions=Yes
 |Section={{Section
 |alignment=Vertical
-|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.|}}
+|structuredtext={{NoteFormat|Make sure to review {{Link-SomewhereInThisVersion|manual=GWSPEGuide|topic=Planning}} for the full list of prerequisites required to deploy Genesys Web Services and Applications.|}}
 |Status=No
 }}{{Section
@@ Line 30: / Line 30: @@
 |anchor=deploy
 |alignment=Vertical
-|structuredtext=To deploy GWS services, 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.
+|structuredtext=To deploy GWS Services, 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}}:
@@ Line 39: / Line 39: @@
 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:{{NoteFormat|If you have {{Link-SomewhereInThisVersion|manual=GWSPEGuide|topic=ConfigureTLS|display text=configured TLS}} for connections to third-party services or legacy Genesys servers, make sure to point to your local files in the <code>helm upgrade</code> command.|}}
+Now you're ready to deploy GWS Services:{{NoteFormat|If you have {{Link-SomewhereInThisVersion|manual=GWSPEGuide|topic=ConfigureTLS|display text=configured TLS}} for connections to third-party services or legacy Genesys servers, make sure to point to your local files in the <code>helm upgrade</code> command.|}}
    helm upgrade --install gws-services helm-staging/gws-services --version=<version> -n gws -f ./override.gws-services.values.yaml -f ./versions.yaml
 |Status=No

@@ Line 1: / Line 1: @@
 {{ArticlePEServiceDeploy
 |ServiceId=11ff3d39-ae2b-4526-b7e5-7dcdf781ef01
 |IncludeAssumptions=Yes
 |Section={{Section
@@ Line 17: / Line 18: @@
 First, confirm the cluster is running:
   oc get clusterversion
-Create a new project for Web Services and Applications:
+Create a new project for Genesys Web Services and Applications (GWS):
   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:
+Create a new namespace for Genesys Web Services and Applications:
   kubectl create ns gws
 |Status=No
@@ Line 29: / Line 30: @@
 |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.
+|structuredtext=To deploy GWS services, 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}}:
@@ Line 65: / Line 66: @@
   kubectl get all -n gws
 The result should show all the created pods, services, ConfigMaps, and so on.
 |Status=No
 }}{{Section

@@ Line 73: / Line 73: @@
 *{{Link-SomewhereInThisVersion|manual=GWSPEGuide|topic=DeployIngress}}
 *{{Link-SomewhereInThisVersion|manual=GWSPEGuide|topic=Provision}}
 |Status=No
 }}
 |PEPageType=45d1441f-dc69-4a17-bd47-af5d811ce167
 }}

@@ Line 6: / Line 6: @@
 |ComingSoon=No
 |Section={{Section
 |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
   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 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.
-===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
 |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
 |Status=No
 }}
 |PEPageType=45d1441f-dc69-4a17-bd47-af5d811ce167
 }}