Documentation:HTCC:Dep:SimplifiedLabDeployment:9.0.0DRAFT

Deploying Web Services and Applications in Docker Compose

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

Important

• To support Gplus Adapter for Salesforce, Docker Compose must be deployed with HTTPS.
• To upgrade Web Services and Applications, you must install the new version of Web Services Docker Compose.

Prerequisites

For hardware, software, Workspace Web Edition, and Gplus Adapter for Salesforce requirements, refer to Prerequisites. Also, ensure your environment has access to docker.io/library. If internet access is not available, manually load the following public container images to the Docker registry:

• Elasticsearch 7.8
• Postgres 11
• Redis 5
• CentOS latest

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 (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)
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 the installation package: 
   

   • for i in *.tar.gz; do sudo docker load --input $i; done

   Important

   This command must be run with Docker-capable privileges.

4. Edit the following values in the /opt/genesys/gws/kubernetes/parameters.yaml 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 white space 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.
GWS_HTTPS_ENABLE	false	The option to enable https support for deployment.
GWS_HTTPS_SERVER_CERTIFICATE	server.crt	The path to server certificate, which will be used during the SSL handshake with clients.
GWS_HTTPS_SERVER_CERT_KEY	server.key	The path to server key, which will be used during the SSL handshake with clients.
ENVIRONMENT_USERNAME	default	The username to connect to Configuration Server.
ENVIRONMENT_APPNAME	GWS_App	The application name to connect to Configuration Server. For details, refer to Creating GWS Client Application.
ENVIRONMENT_PASSWORD	password	The password to connect to 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	onpremiselab.com	The domain associated with this contact center. Important While logging on to WWE, use the domain name as the tenant name.

5. 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

6. Navigate to the /opt/genesys/gws/docker/wwe directory.
7. Source the common-env file with environment variables:

   . ../common-env

8. Invoke docker-compose: 

   docker-compose up -d

9. Wait until docker-compose is up and running. It may take up to 10 minutes.

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:8080/auth/v3/version
Configuration Service	http://GWS_APPLICATIONS_IP:8080/configuration/v3/version
Environment Service	http://GWS_APPLICATIONS_IP:8080/environment/v3/version
Data Collector Service	http://GWS_APPLICATIONS_IP:8080/datacollector/v3/version
Workspace Web Edition	http://GWS_APPLICATIONS_IP:8080/ui/wwe/index.html

If the GWS_HTTPS_ENABLE option is set to true, HTTPS endpoints can be used for verification too:

Service	Verification URLs
Authentication Service	https://GWS_APPLICATIONS_IP:8443/auth/v3/version
Configuration Service	https://GWS_APPLICATIONS_IP:8443/configuration/v3/version
Environment Service	https://GWS_APPLICATIONS_IP:8443/environment/v3/version
Data Collector Service	https://GWS_APPLICATIONS_IP:8443/datacollector/v3/version
Workspace Web Edition	https://GWS_APPLICATIONS_IP:8443/ui/wwe/index.html