AUTH/Current/AuthPEGuide/Deploy - Revision history

WikiSysop at 12:00, March 22, 2023

2023-03-22T12:00:45Z

WikiSysop at 16:15, September 29, 2022

2022-09-29T16:15:38Z

Jumunn: Published

2022-04-22T16:35:56Z

Published

WikiSysop at 15:15, April 11, 2022

2022-04-11T15:15:49Z

Julie.munn@genesys.com: Published

2021-12-16T14:22:29Z

Published

Julie.munn@genesys.com: Published

2021-11-15T13:24:20Z

Published

Julie.munn@genesys.com: Published

2021-10-29T19:28:18Z

Published

Show changes

Julie.munn@genesys.com: Published

2021-07-21T14:12:17Z

Published

Julie.munn@genesys.com: Published

2021-06-30T22:27:15Z

Published

New page

{{Article
|Standalone=No
|DisplayName=Deploy Genesys Authentication
|Context=Learn how to deploy Genesys Authentication.
|ComingSoon=No
|Section={{Section
|alignment=Vertical
|structuredtext={{NoteFormat|Make sure to review {{Link-SomewhereInThisVersion|manual=AuthPEGuide|topic=Planning}} for the full list of prerequisites required to deploy Genesys Authentication.|}}
|Status=No
}}{{Section
|sectionHeading=Deploy in OpenShift
|anchor=de
|alignment=Vertical
|structuredtext=To deploy Genesys Authentication in OpenShift, you'll need the Helm package and your overrides file.

Copy '''values_gauth.yaml''' and the Helm package ('''gauth-<version>.tgz''') to the installation location.

Log in to the OpenShift cluster from the host where you will run the deployment:
oc login --token <token> --server <url of api server>

Select the '''gauth''' namespace you created in {{Link-SomewhereInThisVersion|manual=AuthPEGuide|topic=Configure|anchor=Prepare|display text=Prepare your environment}}:
oc project gauth

For debugging purposes, use the following command to render templates without installing so you can check that resources are created properly:
helm template --debug /gauth-<version>.tgz -f values-gauth.yaml

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

Now you're ready to deploy Genesys Authentication:
helm install gauth ./gauth-<version>.tgz -f values-gauth.yaml

Check the installed Helm release:
helm list

The results should show the Genesys Authentication deployment details. For example:
NAME NAMESPACE REVISION UPDATED STATUS CHART APP VERSION
gauth gauth 1 2021-05-20 11:56:32.5531685 +0530 +0530 deployed gauth-0.1.77 0.1

Check the '''gauth''' namespace status:
helm status gauth

The result should show the namespace details with a status of deployed:
NAME: gauth
LAST DEPLOYED: Thu May 20 11:56:32 2021
NAMESPACE: gauth
STATUS: deployed
REVISION: 1
TEST SUITE: None

Check the Genesys Authentication OpenShift objects created by Helm:
oc get all -n gauth

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

===Expose Genesys Authentication===
After deploying, make the Genesys Authentication services accessible from outside the cluster using the standard HTTP port. Make sure to use the same hostname for all three routes. Genesys recommends using the following host format: <code>gauth.<cluster-subdomain></code>. For example, the VCE cluster (<nowiki>https://console-openshift-console.apps.<yourclusterdomain>.com/</nowiki>) should have the hostname '''gauth.apps.<yourclusterdomain>.com'''
oc create route edge --service=<env-service> --hostname=<hostname> --path /environment
oc create route edge --service=<gauth-service> --hostname=<hostname> --path /auth
oc create route edge --service=<gauth-auth-ui-service> --hostname=<hostname> --path /ui/auth

Verify the new route is created in the '''gauth''' namespace:
oc get route -n gauth

The result includes the following information about the services:
NAME HOST/PORT PATH SERVICES PORT TERMINATION WILDCARD
env gauth.apps.<yourclusterdomain>.com /environment gauth-environment https None
gauth gauth.apps.<yourclusterdomain>.com /auth gauth-auth https None
gauth-auth-ui gauth.apps.<yourclusterdomain>.com /ui/auth gauth-auth-ui https None

Note: <code>HOST</code> is the host name generated by OpenShift.
|Status=No
}}{{Section
|sectionHeading=Validate the deployment in OpenShift
|alignment=Vertical
|structuredtext=Verify that you can now access Genesys Authentication at the following URL: https://<hostname>/ui/auth/sign-in.html
|Status=No
}}
|PEPageType=45d1441f-dc69-4a17-bd47-af5d811ce167
}}

@@ 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 Google Kubernetes Engine (GKE).
 ===GKE===
 Log in to the GKE cluster from the host where you will run the deployment:
@@ Line 68: / Line 58: @@
 |alignment=Vertical
 |structuredtext=To deploy Genesys Authentication, you'll need the Helm package and your overrides file. Copy '''values.yaml''' and the Helm package ('''gauth-<version>.tgz''') to the installation location.
 For debugging purposes, use the following command to render templates without installing so you can check that resources are created properly:
@@ Line 84: / Line 71: @@
 |anchor=access
 |alignment=Vertical
-|structuredtext=Follow the instructions for either OpenShift, GKE, or AKS to make the Genesys Authentication services accessible from outside the cluster.
+|structuredtext=Follow the instructions for either GKE or AKS to make the Genesys Authentication services accessible from outside the cluster.
-===Create routes in OpenShift===
+<br />
 {{AnchorDiv|GKEingress}}
@@ Line 185: / Line 160: @@
   NAME    NAMESPACE       REVISION        UPDATED                                 STATUS          CHART           APP VERSION
   gauth   gauth           1               2021-05-20 11:56:32.5531685 +0530 +0530 deployed        gauth-0.1.77    0.1
-Check the '''gauth''' namespace (or '''gws''' if you are using the OpenShift Ingress Controller) status:
+Check the '''gauth''' namespace status:
   helm status gauth
 The result should show the namespace details with a status of deployed:

@@ Line 26: / Line 26: @@
 <syntaxhighlight>
 gcloud container clusters get-credentials <cluster>
-</syntaxhighlight>Create a JSON file called '''create-gauth-namespace.json''' with the following content: <syntaxhighlight>
+</syntaxhighlight>Create a new namespace for Genesys Authentication with a JSON file that specifies the namespace metadata. For example, '''create-gauth-namespace.json''': <syntaxhighlight>
+{
    "apiVersion": "v1",
@@ Line 37: / Line 37: @@
+   }
+}
-</syntaxhighlight>Use the JSON file to create a new namespace for Genesys Authentication:<syntaxhighlight>
+</syntaxhighlight>Execute the following command to create the namespace:<syntaxhighlight>
 kubectl apply -f create-gauth-namespace.json
-</syntaxhighlight>Now confirm the namespace was created:<syntaxhighlight>
+</syntaxhighlight>Confirm the namespace was created:<syntaxhighlight>
 kubectl describe namespace gauth
-</syntaxhighlight><br />
+</syntaxhighlight>
 |Status=No
 }}{{Section
@@ Line 64: / Line 84: @@
 |anchor=access
 |alignment=Vertical
-|structuredtext=Follow the instructions for either OpenShift or GKE to make the Genesys Authentication services accessible from outside the cluster.
+|structuredtext=Follow the instructions for either OpenShift, GKE, or AKS to make the Genesys Authentication services accessible from outside the cluster.
 ===Create routes in OpenShift===
@@ Line 81: / Line 101: @@
 {{AnchorDiv|GKEingress}}
-===Provision ingresses for GKE===
+===Provision ingresses for GKE or AKS===
-After deploying, make Genesys Authentication services accessible from outside the GKE cluster using the NGINX Ingress Controller.
+After deploying, make Genesys Authentication services accessible from outside the GKE or AKS cluster using the NGINX Ingress Controller.
 Create a YAML 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>

@@ Line 1: / Line 1: @@
-{{Article
+{{ArticlePEServiceDeploy
-|Standalone=No
+|ServiceId=6f7f1a8d-4e60-4b8d-a6f0-8cafdbdf0a3e
-|DisplayName=Deploy Genesys Authentication
+|IncludeAssumptions=Yes
 |Section={{Section
 |alignment=Vertical
@@ Line 21: / Line 19: @@
 <source lang="text">oc get clusterversion</source>
-Create a new project for Genesys Authentication:{{NoteFormat|For OpenShift, you must deploy Genesys Authentication in the '''gws''' namespace if you are using the OpenShift Ingress Controller.|}}
+Create a new project for Genesys Authentication:{{NoteFormat|Deploy Genesys Authentication in the '''gws''' namespace if you use the default OpenShift Ingress Controller; otherwise, deploy in the '''gauth''' namespace.|}}
-<source lang="text">oc new-project gauth</source>
+<source lang="text">oc new-project gws</source>
 ===GKE===
 Log in to the GKE cluster from the host where you will run the deployment:

@@ Line 40: / Line 40: @@
+}
 </syntaxhighlight>Use the JSON file to create a new namespace for Genesys Authentication:<syntaxhighlight>
-kubectl apply -f apply create-gauth-namespace.json
+kubectl apply -f create-gauth-namespace.json
 </syntaxhighlight>Now confirm the namespace was created:<syntaxhighlight>
 kubectl describe namespace gauth

@@ Line 82: / Line 82: @@
 Note: <code>HOST</code> is the host name generated by OpenShift.
 ===Provision ingresses for GKE===
-This step is completed as part of the private edition deployment for {{Link-AnywhereElse|product=GWS|version=Current|manual=GWSPEGuide|topic=DeployIngress|anchor=GKEingress|display text=Web Services and Applications}}.
+After deploying, make Genesys Authentication services accessible from outside the GKE cluster using the NGINX Ingress Controller.
 |Status=No
 }}{{Section