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

Revision as of 20:18, February 1, 2022

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

Prerequisites

Before you deploy GWS Ingress, you must first Deploy GWS Services and Configure GWS Ingress.

Deploy

To deploy GWS Ingress, you need the GWS Ingress Helm package and override file. Copy values.yaml and the Helm package (gws-ingress-<version>.tgz) to the installation location.

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

oc project gws

Run the following command to deploy GWS ingress:

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

Create routes in OpenShift

Follow the instructions to configure external access to GWS ingress in OpenShift.

Genesys recommends using the following hostname format: gws.<cluster-subdomain>. For example, the VCE cluster (https://console-openshift-console.apps.<yourclusterdomain>.com/) should have the hostname gws.<yourclusterdomain>.com

oc create route edge --service=gws-service-proxy --hostname=<hostname>

Validate the deployment

First, check that the pod is running:

kubectl get pod

The result should show that gws-service-proxy is running. For example:

gws-service-proxy-d5997957f-m4kcg 1/1 Running 0 4d13h

Check the service:

kubectl get svc

The result should display the service name, gws-service-proxy. For example:

gws-service-proxy ClusterIP 10.202.55.20 <none> 80/TCP,81/TCP,85/TCP,86/TCP 4d13h

Check the gws-ingress status:

helm status gws-ingress -n gws

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

NAME: gws-ingress
LAST DEPLOYED: Fri Sep 17 11:54:31 2021
NAMESPACE: gws
STATUS: deployed
REVISION: 1
TEST SUITE: None

Check the installed Helm release:

helm list –n gws

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

NAME            NAMESPACE    REVISION    UPDATED                                 STATUS       CHART                  APP VERSION

gws-ingress     gws          1           2021-09-17 11:54:31.339091 -0300 ADT    deployed     gws-ingress-0.2.7      1.0       

gws-services    gws          1           2021-09-17 11:43:50.0692273 -0300 ADT   deployed     gws-services-1.0.55    1.0

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

Provision Agent Setup

@@ Line 5: / Line 5: @@
 |ComingSoon=No
 |Section={{Section
+|alignment=Vertical
+|structuredtext={{NoteFormat|If you are deploying Web Services and Applications in a single namespace with other private edition services, then you do not need to deploy GWS ingress.|3}}
+|Status=No
+}}{{Section
 |sectionHeading=Prerequisites
 |anchor=prerequisites
 |alignment=Vertical
-|structuredtext=Before you deploy GWS Ingress, you must first {{Link-SomewhereInThisVersion|manual=GWSPEGuide|topic=Deploy}}.
+|structuredtext=Before you deploy GWS Ingress, you must first {{Link-SomewhereInThisVersion|manual=GWSPEGuide|topic=Deploy}} and {{Link-SomewhereInThisVersion|manual=GWSPEGuide|topic=ConfigureIngress}}.
 |Status=No
 }}{{Section
@@ Line 19: / Line 23: @@
   oc project gws
 Run the following command to deploy GWS ingress:
-  helm upgrade --install gws-ingress helm-staging/gws-ingress --version=<version> -n gws -f ./override.gws-ingress.values.yaml -f ./versions.yaml
+  helm upgrade --install gws-ingress <helm_directory>/gws-ingress --version=<version> -n gws -f ./override.gws-ingress.values.yaml -f ./versions.yaml
 |Status=No
 }}{{Section
-|sectionHeading=Configure external access
+|sectionHeading=Create routes in OpenShift
 |anchor=https
 |alignment=Vertical
-|structuredtext=Follow the instructions for either OpenShift or GKE to configure external access to GWS ingress.
+|structuredtext=Follow the instructions to configure external access to GWS ingress in OpenShift.
-===Create routes in OpenShift===
 Genesys recommends using the following hostname format: <code>gws.<cluster-subdomain></code>. For example, the VCE cluster (<nowiki>https://console-openshift-console.apps</nowiki>.<yourclusterdomain>.com/) should have the hostname '''gws.<yourclusterdomain>.com'''
   oc create route edge --service=gws-service-proxy --hostname=<hostname>
-{{AnchorDiv|GKEingress}}
-===Provision ingresses for GKE===
-After deploying, make Genesys Web Services services accessible from outside the GKE cluster using the NGINX Ingress Controller.
-Create a JSON file called '''gauth-ingress.yaml''' with the content below. '''Note:''' Replace '''gws.<domain>''' and '''gauth.<domain>''' with your GWS and Genesys Authentication domains, such as <code>gws.test.dev</code>.<syntaxhighlight>
-apiVersion: extensions/v1beta1
-kind: Ingress
-metadata:
-  name: gauth-gws-ingress
-  namespace: gauth
-  annotations:
-    # add an annotation indicating the issuer to use.
-    cert-manager.io/cluster-issuer: "selfsigned-cluster-issuer"
-    # Custom annotations for NGINX Ingress Controller
-    kubernetes.io/ingress.class: "nginx"
-    nginx.ingress.kubernetes.io/ssl-redirect: "false"
-    nginx.ingress.kubernetes.io/use-regex: "true"
-spec:
-  rules:
-  - host: gws.<domain> - e.g. gws.test.dev
-    http:
-      paths:
-        - path: /ui/auth/.*
-          backend:
-            serviceName:  gauth-auth-ui
-            servicePort: 80
-        - path: /auth/.*
-          backend:
-            serviceName:  gauth-auth
-            servicePort: 80
-        - path: /environment/.*
-          backend:
-            serviceName:  gauth-environment
-            servicePort: 80
-  tls:
-  - hosts:
-    - gws.<domain> - e.g. gws.test.dev
-    secretName: gauth-gws-ingress-cert
----
-apiVersion: extensions/v1beta1
-kind: Ingress
-metadata:
-  name: gauth-gauth-ingress
-  namespace: gauth
-  annotations:
-    # add an annotation indicating the issuer to use.
-    cert-manager.io/cluster-issuer: "selfsigned-cluster-issuer"
-    # Custom annotations for NGINX Ingress Controller
-    kubernetes.io/ingress.class: "nginx"
-    nginx.ingress.kubernetes.io/ssl-redirect: "false"
-    nginx.ingress.kubernetes.io/use-regex: "true"
-spec:
-  rules:
-  - host: gauth.<domain> - e.g. gauth.test.dev
-    http:
-      paths:
-        - path: /ui/auth/.*
-          backend:
-            serviceName:  gauth-auth-ui
-            servicePort: 80
-        - path: /auth/.*
-          backend:
-            serviceName:  gauth-auth
-            servicePort: 80
-        - path: /environment/.*
-          backend:
-            serviceName:  gauth-environment
-            servicePort: 80
-  tls:
-  - hosts:
-    - gauth.<domain> - e.g. gauth.test.dev
-    secretName: gauth-gauth-ingress-cert
-</syntaxhighlight>Create ingresses with the following command:<syntaxhighlight>
-kubectl apply -f gauth-ingress.yaml -n gws
-</syntaxhighlight>
 |Status=No
 }}{{Section
@@ Line 153: / Line 79: @@
   kubectl get all -n gws
 The result should show all the created pods, services, ConfigMaps, and so on.
-Finally, verify that you can now access Workspace Web Edition at the following URL: <nowiki>https://<hostname>/ui/wwe/index.html</nowiki>
 |Status=No
 }}{{Section

Genesys Web Services and Applications Private Edition Guide

Overview

Configure and deploy

Upgrade, roll back, or uninstall