Deploying GWS in Test Labs

Hardware Requirements

• Single node of 64 GB of RAM for a full WWE service set.
• At least 4 CPU cores are required.
• HDD 200 GB

Software Requirements

• Any Enterprise Linux version 7 (CentOS, RHEL, etc.)

Install Docker and docker-compose

1. Install Docker
2. Install Docker-Compose

Install GWS micro-services

1. Create a gws directory under the /opt/genesys directory and copy the contents of the package's docker directory .
2. Navigate to the /opt/genesys/gws/docker/images directory.
3. Populate the images directory with the Docker image tarballs in *.tar format:

   for i in *.tar; do sudo docker load —input $i; done

4. Edit the following values in the opt/genesys/gws/docker/common-env file:
   • LOCATION=USW2 - Genesys-specific value which affect server visibility. (should corresponds with value specified in CloudCluster’s connections > Advanced tab).
   • REDIRECT_URIS=http://uri1,http://uri2 - specified as an array of double-quoted, comma-separated values with no whitespace between. Should be resolved from outside the docker host.
   • DOCKER_REPOSITORY - just leave intact, for manual GWS-images distribution.
   • DOCKERHUB_MIRROR= - just leave empty for manual infrastructure images distribution, or fetching them from Dockerhub (assuming you have internet connection in your environment).
   • Set the respective GWS components versions.
5. Create symbolic links for proper docker-compose invocation.
   

   ln -s /usr/local/bin/docker-compose docker-compose

   
   

   sudo ln -s /usr/libexec/docker/docker-runc-current /usr/bin/docker-runc 

6. Navigate to the /opt/genesys/gws/wwe directory.
7. Invoke startup script:
   

   sudo start-gws-sevices.sh

8. Wait until docker-compose stabilizes. It can take up to 10 minutes.

Configure GWS

Configure Config Server

Refer to InstallationProcedures for information on configuring GWS.

Create a Genesys Environment

Mapping

POST http://<GWS_APPLICATIONS_IP>:80/environment/v3/environments 

Object Description

Name	Type	Description	Required	Default
tenant	String	Tenant name	Y	--
appName	String	Application name to connect to	Y	--
username	String	Username to connect to ConfigurationServer	Y	--
password	String	Password to connect to ConfigurationServer	Y	--
connectionProtocol	String	Connection protocol	N	addp
localTimeout	Integer	Local timeout	N	5
remoteTimeout	Integer	Remote timeout	N	7
traceMode	String	Trace mode	N	CFGTMBoth
tlsEnabled	Boolean	Use tls to connect to Configuration Server	N	false
configServers	Array	List of Configuration Servers in this environment (see bellow)	N	empty array

Configuration Server Object

Name	Type	Description	Required	Default
primaryAddress	String	Address of primary Configuration Server	Y	--
primaryPort	Integer	Port of primary Configuration Server	Y	--
backupAddress	String	Address of backup Configuration Server	N	--
backupPort	Integer	Port of backup Configuration Server	N	--
readOnly	Boolean	Indicates if Configuration Server works in read only mode	Y	--
locations	String	Location of Configuration Server	Y	--

Example

POST .../environment/v3/environments
 {
 "data": {
   "username": "default",
   "remoteTimeout": 7,
   "appName": "WS_Node",
   "traceMode": "CFGTMBoth",
   "tlsEnabled": false,
   "localTimeout": 5,
   "connectionProtocol": "addp",
   "password": "passowrd",
   "configServers": [
     {
       "primaryPort": 8888,
       "readOnly": false,
       "primaryAddress": "voice-p.dev",
       "locations": "usw1"
     },
     {
       "primaryPort": 8888,
       "primaryAddress": "10.20.10.1",
       "readOnly": false,
       "locations": "use2",
       "backupPort": 8888,
       "backupAddress": "10.20.20.1"
     }
   ],
   "tenant": "Environment"
 }
 }
 

Response:

{
"statusCode": 0,
 "path": "/environments/2"
}
 

Create contact-center

Mapping

POST http://<GWS_APPLICATIONS_IP>:80/environment/v3/contact-centers

Object description

Name	Type	Description	Required	Default
environmentId	String	Environment id	Y	--
domains	Array	List of domains associated with this contact center	N	Empty list
auth	String	Authentication type for this contact center	Y	--

Example

 POST .../environment/v3/contactCenters
  {
    "data": {
      "environmentId": "5",
      "domains": ["customerC.com"],
      "auth": "configServer"
    }
 }

Response:

 {
   "statusCode": 0,
   "path": "/conatctCenters/6"
 }

Links

1. Auth API: http://<GWS_APPLICATIONS_IP>:80/auth/v3/*
2. Config API: http://<GWS_APPLICATIONS_IP>:80/configuration/v3/*
3. Environment API: http://<GWS_APPLICATIONS_IP>:80/environment/v3/*
4. Provisioning API: http://<GWS_APPLICATIONS_IP>:80/provisioning/v3/*
5. Workspace API: http://<GWS_APPLICATIONS_IP>:80/workspace/v3/*
6. Workspace UI: http://<GWS_APPLICATIONS_IP>:80/ui/wwe/index.html