AUTH/Current/AuthPEGuide/Planning - Revision history

WikiSysop at 12:15, September 23, 2022

2022-09-23T12:15:35Z

WikiSysop at 20:30, September 21, 2022

2022-09-21T20:30:35Z

WikiSysop at 13:15, June 10, 2022

2022-06-10T13:15:37Z

WikiSysop at 17:00, May 4, 2022

2022-05-04T17:00:29Z

Jumunn: Published

2022-01-14T14:34:46Z

Published

Ed.jamer@genesys.com: Text replacement - "Genesys Engage [cC]loud" to "Genesys Multicloud CX"

2021-11-09T20:29:48Z

Text replacement - "Genesys Engage [cC]loud" to "Genesys Multicloud CX"

Julie.munn@genesys.com: Published

2021-10-29T19:25:58Z

Published

Julie.munn@genesys.com: Published

2021-07-12T22:46:51Z

Published

Julie.munn@genesys.com: Published

2021-07-12T13:25:10Z

Published

Julie.munn@genesys.com: Published

2021-06-30T22:27:20Z

Published

New page

{{PEPrerequisites
|DisplayName=Before you begin
|Context=Find out what to do before deploying Genesys Authentication.
|LimitationsStatus=No
|LimitationsText={{Notices|Notice=PEComingSoon}}
|HelmStatus=No
|HelmText=Genesys Authentication in Genesys Engage cloud private edition is made up of three containers, one for each of its components:

*gws-core-auth - Authentication API service
*gws-ui-auth - Authentication UI service
*gws-core-environment - Environment API service

The service also includes a container for its Helm chart, which you must deploy to install all three containers for Genesys Authentication:

*gauth

To download the Helm chart, navigate to the '''gauth''' folder in the JFrog repository. See {{SuiteLevelLink|helmchart}} for details.
|ThirdPartyStatus=No
|ThirdPartyText=Install the prerequisite dependencies listed in the '''Third-party services''' table before you deploy Genesys Authentication.
|SectionThirdPartyItem={{SectionThirdPartyItem
|ThirdPartyItem=1a407778-58fe-4acd-8ca7-5af8eac31283
}}{{SectionThirdPartyItem
|ThirdPartyItem=3aee73ed-68e0-4c70-8693-2421c68b86cd
|Notes=Redis must be in cluster mode.
}}{{SectionThirdPartyItem
|ThirdPartyItem=2afd763e-337c-47eb-8428-3bafcc89dbca
}}
|StorageStatus=No
|StorageText=Genesys Authentication uses PostgreSQL to store key/value pairs for the Authentication API and Environment API services. It uses Redis to cache data for the Authentication API service.
|NetworkStatus=No
|NetworkText={{Notices|Notice=PEComingSoon}}
|BrowserStatus=No
|BrowserText=The Authentication UI supports the web browsers listed in the '''Browsers''' table.
|SectionBrowser={{SectionBrowser
|Browser=4f7728b3-945a-440d-8003-5a2f4043240c
}}{{SectionBrowser
|Browser=a1c5ae9e-3ec5-450a-8518-2ee52f956d3f
}}{{SectionBrowser
|Browser=a19c4594-2cac-422e-9f58-0123de3fa7c8
}}{{SectionBrowser
|Browser=8c8ffa24-11cf-4387-aa39-120675d9c1ae
}}
|DependenciesStatus=No
|DependenciesText=Genesys Authentication must be deployed before other Genesys Engage cloud private edition services. To {{Link-SomewhereInThisVersion|manual=AuthPEGuide|topic=Provision|display text=complete provisioning}} the service, you must first deploy {{Link-AnywhereElse|product=GWS|version=Current|manual=GWSPEGuide|display text=Web Services and Applications}} and the {{Link-AnywhereElse|product=PrivateEdition|version=Current|manual=TenantPEGuide|display text=Tenant Service}}. For a look at the high-level deployment order, see {{SuiteLevelLink|deployorder}}.
|GDPRStatus=No
|GDPRText={{Notices|Notice=PEComingSoon}}
|PEPageType=bf21dc7c-597d-4bbe-8df2-a2a64bd3f167
}}

@@ Line 27: / Line 27: @@
 }}{{SectionThirdPartyItem
 |ThirdPartyItem=2afd763e-337c-47eb-8428-3bafcc89dbca
 }}{{SectionThirdPartyItem
 |ThirdPartyItem=bc90a902-fc45-4546-b05b-bba8f567dba2
@@ Line 35: / Line 36: @@
 }}{{SectionThirdPartyItem
 |ThirdPartyItem=f1d380bf-42b1-4b67-9d27-d574bad90c86
 }}
 |StorageStatus=No
@@ Line 45: / Line 52: @@
 *internal_ingress - Internal ingress for internal API clients. Internal ingress contains an extended list of API endpoints that are not available for external ingress. Internal ingress should not be public.
-These ingress objects support TLS mode, which is disabled by default. You can configure TLS for internal and external ingress by overriding the '''ingress.tls''' and '''internal_ingress.tls''' settings in '''values.yaml'''.
+These ingress objects support Transport Layer Security (TLS) version 1.2. TLS is enabled by default and you can configure it by overriding the '''ingress.tls''' and '''internal_ingress.tls''' settings in '''values.yaml'''.
 For example:
@@ Line 51: / Line 58: @@
    enabled: true
    frontend: gauth.example.com
    tls:
      - hosts:
-    - gauth.example.com
+        - gauth.example.com
        secretName: gauth-example-com
@@ Line 59: / Line 67: @@
    enabled: true
    frontend: gauth.int.example.com
    tls:
      - hosts:
-      - gauth.int.example.com
+        - gauth.int.example.com
        secretName: gauth-int-example-com
 </source>
@@ Line 67: / Line 76: @@
 In the example above:
-* '''secretName''' is the name of the Kubernetes secret that contains the certificate. The secret is a prerequisite and must be created before you deploy Genesys Authentication, unless you have Certificate ClusterIssuer installed and configured in Kubernetes Cluster. In this case, the secret is created by ClusterIssuer.
+*'''secretName''' is the certificate and private key to use for TLS. The secret is a prerequisite and must be created before you deploy Genesys Authentication, unless you have Certificate ClusterIssuer installed and configured in Kubernetes Cluster. In this case, the secret is created by ClusterIssuer.
-* '''hosts''' is a list of the fully qualified domain names that should use the certificate. The list must be the same as the value configured for '''ingress.frontend''' and '''internal_ingress.frontend'''.
+*'''hosts''' is a list of the fully qualified domain names that should use the certificate. The list must be the same as the value configured for '''ingress.frontend''' and '''internal_ingress.frontend'''.
 ===Cookies===

← Older revision		Revision as of 13:25, July 12, 2021
Line 14:		Line 14:

	*gauth		*gauth
		+
		+	See {{Link-AnywhereElse\|product=ReleaseNotes\|version=Current\|manual=GenesysEngage-cloud\|topic=AuthenticationHelm}} for the Helm chart version you must download for your release.

	To download the Helm chart, navigate to the '''gauth''' folder in the JFrog repository. See {{SuiteLevelLink\|helmchart}} for details.		To download the Helm chart, navigate to the '''gauth''' folder in the JFrog repository. See {{SuiteLevelLink\|helmchart}} for details.

@@ Line 2: / Line 2: @@
 |DisplayName=Before you begin
 |Context=Find out what to do before deploying Genesys Authentication.
 |LimitationsStatus=Yes
 |HelmStatus=No
@@ Line 27: / Line 28: @@
 }}{{SectionThirdPartyItem
 |ThirdPartyItem=2afd763e-337c-47eb-8428-3bafcc89dbca
-|Notes=
+|Notes={{Editgrn open}}Genesys Authentication uses Consul only for the tenant's host discovery. The tenant's host entries in Consul are provisioned by Voice Microservices and Genesys Authentication accesses these records through Consul.{{Editgrn close}}
 }}{{SectionThirdPartyItem
 |ThirdPartyItem=bc90a902-fc45-4546-b05b-bba8f567dba2

@@ Line 21: / Line 21: @@
 |SectionThirdPartyItem={{SectionThirdPartyItem
 |ThirdPartyItem=1a407778-58fe-4acd-8ca7-5af8eac31283
 }}{{SectionThirdPartyItem
 |ThirdPartyItem=3aee73ed-68e0-4c70-8693-2421c68b86cd

@@ Line 38: / Line 38: @@
 |StorageText=Genesys Authentication uses PostgreSQL to store key/value pairs for the Authentication API and Environment API services. It uses Redis to cache data for the Authentication API service.
 |NetworkStatus=No
-|NetworkText={{Notices|Notice=PEComingSoon}}
+|NetworkText====Ingress===
 |BrowserStatus=No
 |BrowserText=The Authentication UI supports the web browsers listed in the '''Browsers''' table.

@@ Line 4: / Line 4: @@
 |LimitationsStatus=Yes
 |HelmStatus=No
-|HelmText=Genesys Authentication in Genesys Engage cloud private edition is made up of three containers, one for each of its components:
+|HelmText=Genesys Authentication in Genesys Multicloud CX private edition is made up of three containers, one for each of its components:
 *gws-core-auth - Authentication API service
@@ Line 51: / Line 51: @@
 }}
 |DependenciesStatus=No
-|DependenciesText=Genesys Authentication must be deployed before other Genesys Engage cloud private edition services. To {{Link-SomewhereInThisVersion|manual=AuthPEGuide|topic=Provision|display text=complete provisioning}} the service, you must first deploy {{Link-AnywhereElse|product=GWS|version=Current|manual=GWSPEGuide|display text=Web Services and Applications}} and the {{Link-AnywhereElse|product=PrivateEdition|version=Current|manual=TenantPEGuide|display text=Tenant Service}}. For a look at the high-level deployment order, see {{SuiteLevelLink|deployorder}}.
+|DependenciesText=Genesys Authentication must be deployed before other Genesys Multicloud CX private edition services. To {{Link-SomewhereInThisVersion|manual=AuthPEGuide|topic=Provision|display text=complete provisioning}} the service, you must first deploy {{Link-AnywhereElse|product=GWS|version=Current|manual=GWSPEGuide|display text=Web Services and Applications}} and the {{Link-AnywhereElse|product=PrivateEdition|version=Current|manual=TenantPEGuide|display text=Tenant Service}}. For a look at the high-level deployment order, see {{SuiteLevelLink|deployorder}}.
 |GDPRStatus=Yes
 |PEPageType=bf21dc7c-597d-4bbe-8df2-a2a64bd3f167
 }}

@@ Line 11: / Line 11: @@
 *gws-core-environment - Environment API service
-The service also includes a container for its Helm chart, which you must deploy to install all three containers for Genesys Authentication:
+The service also includes a Helm chart, which you must deploy to install all three containers for Genesys Authentication:
 *gauth