Jump to: navigation, search
(→‎Prerequisites)
Line 13: Line 13:
 
#* Openshift Kubernetes Deployment
 
#* Openshift Kubernetes Deployment
 
#* Rancher Kubernetes Deployment
 
#* Rancher Kubernetes Deployment
−
#* Google Kubernetes Engine
+
#* Google Kubernetes Engine (GKE)
−
#* <span style="color: rgb(35, 47, 62);">Amazon Elastic Kubernetes Service</span>
+
#* Amazon Elastic Kubernetes Service (EKS)
 +
 
 
# Client-side utilities installed at deployment host:
 
# Client-side utilities installed at deployment host:
−
#* [https://kubernetes.io/docs/tasks/tools/install-kubectl/ Kubectl] tool
+
#* [https://kubernetes.io/docs/tasks/tools/install-kubectl/ Kubectl] tool
−
#* [https://docs.helm.sh/using_helm/ Helm] client, Tiller is not required.
+
#* [https://cloud.google.com/sdk/docs/#linux gcloud] utility (for GKE deployments)
−
#* [https://cloud.google.com/sdk/docs/ gcloud] utility (for GKE deployments)
+
#* [https://docs.aws.amazon.com/eks/latest/userguide/getting-started.html eksctl] (for Amazon EKS)
−
# Valid credentials for your Kubernetes cluster.
+
#* Genesys applications package from Genesys Software Distribution Services.  
−
# The '''gws-microservices.tgz''' package downloaded from Genesys FTP to the deployment host.
 
−
# Docker images of GWS components uploaded into a registry available from the target Kubernetes instance.
 
−
 
 
−
====Configuring the Web Services applications====
 
−
To install Web Services, set up the two application objects in the Genesys configuration environment using Genesys Administrator
 
−
* An application of type Genesys Generic Server that is called the GWS Server Application.
 
−
* An application of type Genesys Generic Client that is called the GWS Client Application.
 
−
 
 
−
===Creating and importing the application templates===
 
−
Web Services and Applications package includes a template for Genesys Generic Server (Web_Services_and_Applications_900), but you must create a new template for Genesys Generic Client.
 
−
# To create the Genesys Generic Client template, navigate to '''PROVISIONING > Environment> Application Templates'''.
 
−
# Select '''New...''' and configure the properties of the template as shown below:
 
−
#* Name: GWS_App
 
−
#* Type: Genesys Generic Client
 
−
#* Version: 9.0
 
−
#* State: Enabled
 
−
# Click '''Save & Close'''.
 
−
# To import the Genesys Generic Server template, click '''Upload Template''' in the '''Tasks''' panel. The '''Click 'Add' and choose application template (APD) file to import''' dialog opens.
 
−
# Click '''Add''' and navigate to the '''templates''' folder in your installation package.
 
−
# Select the '''Web_Services_and_Applications_900''' template file and click '''Open'''.
 
−
# Click '''Save & Close'''.
 
−
 
 
−
====Creating the GWS Server Application====
 
−
# Navigate to '''PROVISIONING > Environment > Application''' and click '''New...'''.
 
−
# In the '''General''' section, configure the properties of the application as shown below:
 
−
 
 
−
#* Name: GWS
 
−
#* Template: Web_Services_and_Applications_900
 
−
#* State: Enabled
 
−
 
 
−
# Add the following connections:
 
−
 
 
−
#* Configuration Server
 
−
#* SIP Server (if supporting voice)
 
−
#* Interaction Server (if supporting multimedia)
 
−
#* Universal Contact Server
 
−
#* Stat Server
 
−
 
 
−
For each connection added, configure the location. In the '''Advanced''' tab of '''Connection Info''' in '''Application parameters''' set the region, e.g.: ''locations=/USW2.''
 
−
# In the '''Server Info''' section, select a Tenant:
 
−
 
 
−
#* Click '''Add'''.
 
−
#* Choose the Environment tenant (or any other tenant that has a connection to your Configuration Server).
 
−
#* Click '''OK'''.
 
−
 
 
−
# Choose a Host object.
 
−
# Add a default Listening Port:
 
−
 
 
−
#* Click '''Add'''.
 
−
#* Enter the application's Port. For instance, ''7000''.
 
−
#* Click '''OK'''.
 
−
 
 
−
# Add a "." to the '''Working Directory''','''Command Line''', and '''Command Line Arguments''' fields. These values are mandatory for all applications and must be entered to save the application object. Web Services does not use these values, so the "." is used as a placeholder.
 
−
 
 
−
For information on configuring Workspace Web Edition, see [https://docs.genesys.com/Documentation/HTCC/9.0.0/IWWDep/Welcome Configuration Guide for WWE].
 
−
 
 
−
====Creating the GWS Client Application====
 
  
−
# Navigate to '''PROVISIONING > Environment > Application''' and click '''New...'''.
+
== Deploying GWS ==
−
# In the '''General''' section, configure the properties of the application as shown below:
+
# Unpack the Genesys Applications package tarball and change to the '''kubernetes''' directory: <br /> <pre>$ cd kubernetes</pre>
−
#* Name: GWS_App
+
# Create an environment configuration file ('''gws.env''') from template located
−
#* Template: GWS_App
+
#* The versions of GWS applications should be specified by setting environment variables in the created gws.env file: <br /> <pre>export GWS_SOME_SERVICE_VERSION="9.0.000.00.470"</pre>
−
#* State: Enabled
+
# Run the environment file you have created and see all available commands: <br /> <pre>* $ . ./gws.env</pre>
−
# Add the following connections:
+
# Import GWS applications docker images to the client's container registry.
−
#* GWS Server application that was configured in the previous procedure.
 
−
# Click '''Save & Close'''.
 
  
 
==Deployment Steps==
 
==Deployment Steps==

Revision as of 11:11, June 17, 2019

Deployment of Web Services and Applications

Important: This content is restricted and not viewable without a login supplied by Genesys. The information contained in this documentation is not considered final and is managed under the terms and conditions found in the Pre-release Agreement. This documentation provides the most up-to-date reference information available for this pre-release version and is restricted for use by those who have signed the Pre-release Agreement with Genesys to acquire an early version of the software.

Hardware recommendations

The solution can be deployed at a Kubernetes cluster with a minimal size of 3 nodes with an overall amount of 96 GB RAM. Recommended hardware requirements for each Kubernetes node:

  • CPU: 4 - 8 cores
  • RAM: 32 GB
  • HDD: 500 GB

Prerequisites

  1. Kubernetes cluster deployed and available. The following Kubernetes distributions are currently supported:
    • Red Hat Openshift Enterprise
    • Openshift Kubernetes Deployment
    • Rancher Kubernetes Deployment
    • Google Kubernetes Engine (GKE)
    • Amazon Elastic Kubernetes Service (EKS)
  1. Client-side utilities installed at deployment host:
    • Kubectl tool
    • gcloud utility (for GKE deployments)
    • eksctl (for Amazon EKS)
    • Genesys applications package from Genesys Software Distribution Services.

Deploying GWS

  1. Unpack the Genesys Applications package tarball and change to the kubernetes directory: 
    $ cd kubernetes
  2. Create an environment configuration file (gws.env) from template located
    • The versions of GWS applications should be specified by setting environment variables in the created gws.env file: 
      export GWS_SOME_SERVICE_VERSION="9.0.000.00.470"
  3. Run the environment file you have created and see all available commands: 
    * $ . ./gws.env
  4. Import GWS applications docker images to the client's container registry.

Deployment Steps

  1. Validate your Kubernetes credentials:
    • Follow the registration web-UI steps. and type gcloud container clusters list command to see all GKE clusters available to you, if any.
      1. Unpack the gws-microservices.tgz file with the following command:

tar -zxf gws-microservices.tgz




  1. Go to the kubernetes directory:
    cd gws-microservices/kubernetes


  1. Modify the <ToBeChanged: …'''> values defined in the configurations files with the actual values required by deployment.
    • the conf/gke.env file for GKE deployments
    • the conf/openshift.env file for OpenShift deployments


  1. Apply the modified configuration file to the current bash session:
    source conf/gke.env for GKE deployments
    source conf/openshift.env for OpenShift deployments


  1. Deploy the monitoring stack using gws-monitoring-deploy.sh script. The script will deploy Prometheus and Grafana solutions at your Kubernetes cluster.
  2. Deploy GWS infrastructure using gws-infra-deploy.sh script. The script will deploy GWS dependency servers - ElasticSearch, Redis, Consul, etc., at your Kubernetes cluster.
  3. Deploy GWS microservices using gws-app-deploy.sh script.
  4. Initialize GWS using gws-postinstall.sh script. The script uses GWS REST API to provision environment, contact center, and authentication client.

Upgrade Procedure

  1. Download new version of gws-microservices.tgz package from Genesys FTP to the deployment host.
  2. Unpack the gws-microservices.tgz file with the following command:
    tar -zxf gws-microservices.tgz
  3. Go to the kubernetes directory:
    cd gws-microservices/kubernetes
  4. Modify the <ToBeChanged: …> values defined in the conf/gke.env file with the actual values required by deployment. Refer to the file used in deployment.
  5. Apply the modified configuration file to the current bash session:
    source conf/gke.env
  6. Upgrade GWS microservices using gws-app-deploy.sh script.
Comments or questions about this documentation? Contact us for support!