Revision as of 10:22, January 22, 2020

Deploying Web Services and Applications in Docker Compose

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

Prerequisites

Software Requirements

OS: Any Enterprise Linux distribution version 7 (RHEL-7, CentOS-7)
Docker. Please use the latest stable version.
Docker Compose. Please use the latest stable version.
Access to docker.io/library
- If Internet access is not available, the following images should be manually loaded to docker:

Hardware Requirements

CPU: Minimum 2-core CPU
RAM : Minimum 16 GB of RAM

Workspace Web Requirements

OS: Windows 10
Browsers : Google Chrome 63+, Mozilla Firefox 57+ or Firefox ESR 52+, or Microsoft Edge

Configuring the Web Services applications Configuring the Web Services applications

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
- Type
- Version
- State
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 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
- Template
- State
Add the following connections:
- Confuration 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. (Example: locations=/USW2)
In the Server Info section, select a Tenant:
- Click Add.
- Select the Environment tenant (or any other tenant that has a connection to your Configuration Server).
- Click OK.
Select 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.

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:
- gws-microservices.tgz
- 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.

```
mkdir -p /opt/genesys/gws 
```

tar xvf gws-microservices.tgz -C /opt/genesys/gws

Populate the Docker images (presented in *.tar.gz format) from installation package:
- ```
for i in *.tar.gz; do sudo docker load --input $i; done
```
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 hostnames 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 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.
ENVIRONMENT_USERNAME	default	The username to connect to the Configuration Server.
ENVIRONMENT_APPNAME	Cloud	The application name to connect to the Configuration Server.
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.

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:
```
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 rebooting, run:
```
sudo sysctl vm.max_map_count
```
Navigate to the /opt/genesys/gws/docker/wwe directory.
Source the common-env file with environment variables:
```
. ../common-env
```
Invoke docker-compose:
```
docker-compose up -d
```
Wait until docker-compose is up and running. It may take up to 10 minutes.

Verifying Web Services and Applications Services

Use the following links to get and verify that expected versions of the Web Services and Applications services 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

@@ Line 37: / Line 37: @@
 # 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
+#:*Name
-**Type
+#:*Type
-**Version
+#:*Version
-**State
+#:*State
-# Next
+# 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 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
+#:*Template
+#:*State
+# Add the following connections:
+#:*Confuration 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. (Example: locations=/USW2)
+# In the '''Server Info''' section, select a Tenant:
+#:*Click '''Add'''.
+#:*Select the Environment tenant (or any other tenant that has a connection to your Configuration Server).
+#:*Click '''OK'''.
+# Select 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.
 ==Deploying Web Services and Applications==

Revision as of 10:22, January 22, 2020

Contents