Documentation:HTCC:Dep:SimplifiedLabDeployment:9.0.0DRAFT

Deploying GWS in Test Labs

Install Docker and docker-compose

1. Install Docker
2. Install Docker-Compose

Install GWS micro-services

1. Copy the premise directory to all target machines as /opt/genesys/gws/premise. This would be the application's prefix.
2. Run the following command at all target machines:

   # ./bin/preflight.sh

   Important

   This script disables firewalls and sets SElinux to permissive mode.
3. Run the following command at all target machines:

   # ./bin/dump-restore.sh restore

Create GWS-data service Containers

1. Create a systemd unit.

   SERVICE_NAME="data" ./bin/register-systemd-unit.sh

2. Start the data services.

   systemctl start gws-data.service

3. Configure Redis.

   ./bin/redis-starter.sh

Create GWS-applications Containers

1. Create a systemd unit.

   SERVICE_NAME="applications" ./bin/register-systemd-unit.sh

2. Start the applications services.

   systemctl start gws-applications.service

3. Create the client.

   ./bin/client-curl-script.sh

4. Check the status of applications.

   ./bin/healthcheck.sh

Configure GWS

Configure Config Server

Refer to InstallationProcedures for information on configuring GWS.

Create a Genesys Environment

Information taken from http://internalwiki.us.int.genesyslab.com/dev_teams/index.php/Environment_API_Reference#Create_new__Environment

Mapping

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

Information taken from http://internalwiki.us.int.genesyslab.com/dev_teams/index.php/Environment_API_Reference#Create_new_Contact_Center

Mapping

 .../environment/v3/contactCenters

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/*
7. Portainer http://<GWS_APPLICATIONS_IP>:9000, http://<GWS_DATA_IP>:9000, http://<GWS_MONITORING_IP>:9000

Minimal Setup

Should this be included? To run the demo environment on your laptop, please follow these steps:

1. Connect to Genesys VPN to be able to pull GWS-microservices images.
2. Install Docker
3. Install Docker-Compose
4. Add Genesys Docker registry keys to your /etc/docker/certs.d directory.
5. Get the gws-microservices hg repository.

    $ cd gws-microservices/production/premise/docker/docker/minimal<pre><pre>$ docker-compose up

6. Wait a couple of minutes for bootstrap process to finish.
7. Open http://127.0.0.1:9000 to see the Portainer web-interface, select "Local connection".
8. Open http://127.0.0.1/auth/v3/ui/sign-in.html to see the GWS-auth web-interface.