Jump to: navigation, search
(Update with the copy of version: 9.0.0DRAFT)
(Update with the copy of version: 9.0.0DRAFT)
Line 1: Line 1:
−
= Deploying Web Services and Applications in a Lab environment =
+
= Deploying Web Services and Applications in Docker Compose =
  
−
The page provides instructions on preparing and deploying Web Services and Applications with Docker. 
+
This page provides instructions on preparing and deploying Web Services and Applications with Docker. 
  
 
== Prerequisites ==
 
== Prerequisites ==
 +
For Hardware, Software, and Workspace Web requirements, refer to [[Prerequisites|Prerequisites]].
 +
<!--
 
=== Software Requirements ===
 
=== Software Requirements ===
  
−
* OS: Any Enterprise Linux distribution version 7 (RHEL-7, CentOS-7)
+
* OS: CentOS-7
 
* {{#Widget:ExtLink|link=https://docs.docker.com/install|displaytext=Docker}}. Please use the latest stable version.
 
* {{#Widget:ExtLink|link=https://docs.docker.com/install|displaytext=Docker}}. Please use the latest stable version.
 
* {{#Widget:ExtLink|link=https://docs.docker.com/compose/install|displaytext=Docker Compose}}. Please use the latest stable version.
 
* {{#Widget:ExtLink|link=https://docs.docker.com/compose/install|displaytext=Docker Compose}}. Please use the latest stable version.
Line 13: Line 15:
 
*** {{#Widget:ExtLink|link=https://hub.docker.com/_/centos|displaytext=centos:latest}}
 
*** {{#Widget:ExtLink|link=https://hub.docker.com/_/centos|displaytext=centos:latest}}
 
*** {{#Widget:ExtLink|link=https://hub.docker.com/_/elasticsearch|displaytext=elasticsearch:6.6.2}}
 
*** {{#Widget:ExtLink|link=https://hub.docker.com/_/elasticsearch|displaytext=elasticsearch:6.6.2}}
−
*** {{#Widget:ExtLink|link=https://hub.docker.com/_/postgres|displaytext=postgres:9.5.12-alpine}}
+
*** {{#Widget:ExtLink|link=https://hub.docker.com/_/postgres|displaytext=postgres:10.10-alpine}}
−
*** {{#Widget:ExtLink|link=https://hub.docker.com/_/redis|displaytext=redis:4}}
+
*** {{#Widget:ExtLink|link=https://hub.docker.com/_/redis|displaytext=redis:5}}
  
 
=== Hardware Requirements ===
 
=== Hardware Requirements ===
  
 
* CPU: Minimum 2-core CPU
 
* CPU: Minimum 2-core CPU
−
* RAM : Minimum 16 GB of RAM
+
* RAM: Minimum 16 GB of RAM
 +
* HDD: 100 GB
  
−
=== Requirements for WWE ===
+
=== Workspace Web Requirements ===
  
−
* OS: Windows 10
+
* Browser:
−
* Browsers : Google Chrome 63+, Mozilla Firefox 57+ or Firefox ESR 52+, or Microsoft Edge
+
*:* Google Chrome 75+
 +
*:* Mozilla Firefox 68+
 +
*:* Firefox ESR 60.9
 +
*:* Microsoft Internet Explorer 11
 +
*:* Microsoft Edge
 +
-->
 +
 
 +
==Configuring Web Services and Applications==
 +
To configure Web Services and Applications, refer to [[Documentation:HTCC:Dep:ConfigurationPremise|Configuring Web Services and Applications]].
  
 
==Deploying Web Services and Applications==
 
==Deploying Web Services and Applications==
  
−
# Unpack the installation package file (e.g., '''IP_HTCCDev_9000207b1_ENU_dockerlinux.zip''' ) , and navigate to the '''ip''' folder which should contain the following files:
+
# Unpack the installation package file (Example, '''IP_HTCCDev_9000207b1_ENU_dockerlinux.zip''') , and navigate to the '''ip''' folder which should contain the following files:
 
#* '''gws-microservices.tgz'''
 
#* '''gws-microservices.tgz'''
 
#* exported microservices in tar.gz format (e.g., '''gws-platform-configuration_9.0.000.50.tar.gz''')
 
#* exported microservices in tar.gz format (e.g., '''gws-platform-configuration_9.0.000.50.tar.gz''')
−
# Unpack the '''gws-microservices.tgz''' archive to '''/opt/genesys/gws''' directory. <br />
+
# Unpack the '''gws-microservices.tgz''' archive to the '''/opt/genesys/gws''' directory. <br />
 
#*<pre>mkdir -p /opt/genesys/gws </pre>
 
#*<pre>mkdir -p /opt/genesys/gws </pre>
 
#*<pre>tar xvf gws-microservices.tgz -C /opt/genesys/gws</pre>
 
#*<pre>tar xvf gws-microservices.tgz -C /opt/genesys/gws</pre>
Line 51: Line 62:
 
|
 
|
 
A comma-separated array of resolvable host names or IP addresses of the Docker host machine. Used as a part of the OAuth authentication flow.
 
A comma-separated array of resolvable host names or IP addresses of the Docker host machine. Used as a part of the OAuth authentication flow.
−
{{NoteFormat| To access the lab deployment, it is mandatory to set resolvable hostnames or IP addresses for the Docker host machine.  
+
{{NoteFormat| To access the lab deployment, it is mandatory to set resolvable host
 +
names or IP addresses for the Docker host machine.  
  
 
The array should use double quotes and the quotes should be escaped using backslashes. The array should not have any whitespace between items.
 
The array should use double quotes and the quotes should be escaped using backslashes. The array should not have any whitespace between items.
Line 63: Line 75:
 
| <tt>/USW2</tt>
 
| <tt>/USW2</tt>
 
| The location of Configuration Server.
 
| The location of Configuration Server.
−
{{NoteFormat|The Web Services and Applications Cluster Application object (typically names ''CloudCluster'') in the Configuration Database must be configured with a specified location for each connection to Genesys servers like Configuration Server, Stat Server, T-Server, and so on. This Settings defines which server instance is visible by the Web Services and Applications node based on its position in the Web Services and Applications Cluster. }}
+
{{NoteFormat|The Web Services and Applications Cluster Application object (typically names ''CloudCluster'') in the Configuration Database must be configured with a specified location for each connection to Genesys servers like Configuration Server, Stat Server, T-Server, and so on. This setting defines which server instance is visible by the Web Services and Applications node based on its position in the Web Services and Applications Cluster. }}
 
|-
 
|-
 
| ENVIRONMENT_USERNAME
 
| ENVIRONMENT_USERNAME
Line 70: Line 82:
 
|-
 
|-
 
| ENVIRONMENT_APPNAME
 
| ENVIRONMENT_APPNAME
−
| Cloud
+
| GWS_App
−
| The application name to connect to the Configuration Server.
+
| The application name to connect to the Configuration Server. For details, refer to [[ConfigurationPremise#gaxgwsclient| Creating GWS Client Application]].
 
|-
 
|-
 
| ENVIRONMENT_PASSWORD
 
| ENVIRONMENT_PASSWORD
Line 91: Line 103:
 
| CONTACT_CENTER_DOMAIN_NAME
 
| CONTACT_CENTER_DOMAIN_NAME
 
| on_premise_lab
 
| on_premise_lab
−
| The domain associated with this contact center.
+
| The domain associated with this contact center. {{NoteFormat|While logging on to WWE, use the domain name as the tenant name.}}
 
|}
 
|}
  
 
<ol start="5">
 
<ol start="5">
−
<li>For Elasticsearch, the default operating system limits on '''mmap''' counts is likely to be too low, which may result in out-of-memory exceptions. To mitigate it temporarily:
+
<li>For Elasticsearch, the default operating system limits on '''mmap''' counts is likely to be too low, which may result in out-of-memory exceptions. To mitigate it temporarily, run the following:
 
<pre>sudo sysctl -w vm.max_map_count=262144</pre>
 
<pre>sudo sysctl -w vm.max_map_count=262144</pre>
  
−
To set this value permanently, update the '''vm.max_map_count''' setting in '''/etc/sysctl.conf'''. To verify after rebooting, run:
+
To set this value permanently, update the '''vm.max_map_count''' setting in '''/etc/sysctl.conf'''. To verify after restarting, follow these steps:
 
<pre>sudo sysctl vm.max_map_count</pre>
 
<pre>sudo sysctl vm.max_map_count</pre>
 
</li>
 
</li>
Line 108: Line 120:
 
<li>Wait until <tt>docker-compose</tt> is up and running. It may take up to 10 minutes.</li>
 
<li>Wait until <tt>docker-compose</tt> is up and running. It may take up to 10 minutes.</li>
  
−
==Verifying Web Services and Applications Services==
+
==Verifying Web Services and Applications==
  
−
Use the following links to get and verify that expected versions of the Web Services and Applications services are correct:
+
Use the following links to get the expected versions of the Web Services and Applications components and verify they are correct:
 
{|
 
{|
 
! '''Service'''
 
! '''Service'''

Revision as of 16:50, February 19, 2020

Deploying Web Services and Applications in Docker Compose

This page provides instructions on preparing and deploying Web Services and Applications with Docker. 

Prerequisites

For Hardware, Software, and Workspace Web requirements, refer to Prerequisites.

Configuring Web Services and Applications

To configure Web Services and Applications, refer to Configuring Web Services and Applications.

Deploying Web Services and Applications

  1. Unpack the installation package file (Example, IP_HTCCDev_9000207b1_ENU_dockerlinux.zip) , and navigate to the ip folder which should contain the following files:
    • gws-microservices.tgz
    • exported microservices in tar.gz format (e.g., gws-platform-configuration_9.0.000.50.tar.gz)
  2. Unpack the gws-microservices.tgz archive to the /opt/genesys/gws directory. 
    • mkdir -p /opt/genesys/gws 
    • tar xvf gws-microservices.tgz -C /opt/genesys/gws
  3. Populate the Docker images (presented in *.tar.gz format) from installation package: 
    • for i in *.tar.gz; do sudo docker load --input $i; done
  4. Edit the following values in the /opt/genesys/gws/docker/common-env file:
Environment Variable Value Description
DOCKER_REPOSITORY Should be empty if the Web Services and Applications images are loaded manually.
REDIRECT_URIS \"http://uri1\",\"http://uri2\"

A comma-separated array of resolvable host names or IP addresses of the Docker host machine. Used as a part of the OAuth authentication flow.

Important
To access the lab deployment, it is mandatory to set resolvable host

names or IP addresses for the Docker host machine.

The array should use double quotes and the quotes should be escaped using backslashes. The array should not have any whitespace between items.

DOCKERHUB_MIRROR Should be empty if the images of the Infrastructure components are loaded manually.
LOCATION /USW2 The location of Configuration Server.
Important
The Web Services and Applications Cluster Application object (typically names CloudCluster) in the Configuration Database must be configured with a specified location for each connection to Genesys servers like Configuration Server, Stat Server, T-Server, and so on. This setting defines which server instance is visible by the Web Services and Applications node based on its position in the Web Services and Applications Cluster.
ENVIRONMENT_USERNAME default The username to connect to the Configuration Server.
ENVIRONMENT_APPNAME GWS_App The application name to connect to the Configuration Server. For details, refer to Creating GWS Client Application.
ENVIRONMENT_PASSWORD password The password to connect to the Configuration Server.
ENVIRONMENT_CONFIG_SERVER_PORT 8888 The port number of the primary Configuration Server.
ENVIRONMENT_CONFIG_SERVER_PRIMARY_ADDRESS 127.0.0.1 The IP address of the primary Configuration Server.
ENVIRONMENT_CONFIG_SERVER_TENANT Environment The Configuration Server's tenant name.
CONTACT_CENTER_DOMAIN_NAME on_premise_lab The domain associated with this contact center.
Important
While logging on to WWE, use the domain name as the tenant name.
  1. For Elasticsearch, the default operating system limits on mmap counts is likely to be too low, which may result in out-of-memory exceptions. To mitigate it temporarily, run the following: 
    sudo sysctl -w vm.max_map_count=262144

    To set this value permanently, update the vm.max_map_count setting in /etc/sysctl.conf. To verify after restarting, follow these steps: 

    sudo sysctl vm.max_map_count
  2. Navigate to the /opt/genesys/gws/docker/wwe directory.
  3. Source the common-env file with environment variables: 
    . ../common-env
  4. Invoke docker-compose:  
    docker-compose up -d
  5. Wait until docker-compose is up and running. It may take up to 10 minutes.

    6. Verifying Web Services and Applications

    Use the following links to get the expected versions of the Web Services and Applications components and verify they are correct:

    Service Verification URLs
    Authentication Service http://GWS_APPLICATIONS_IP/auth/v3/version
    Configuration Service http://GWS_APPLICATIONS_IP/configuration/v3/version
    Environment Service http://GWS_APPLICATIONS_IP/environment/v3/version
    Data Collector Service http://GWS_APPLICATIONS_IP/datacollector/v3/version
    Workspace Web Edition http://GWS_APPLICATIONS_IP/ui/wwe/index.html
Comments or questions about this documentation? Contact us for support!