Jump to: navigation, search
(Created target blank page For Version: HTCC:9.0.0)
 
(Update with the copy of version: 9.0.0DRAFT)
Line 1: Line 1:
−
<!-- Creation of the target page -->
+
= Deploying GWS in Test Labs =
 +
 
 +
==Install Docker and docker-compose==
 +
 
 +
# {{#Widget:ExtLink|link=https://docs.docker.com/install/linux/docker-ce/ubuntu/#install-docker-ce-1|displaytext=Install Docker}}
 +
# {{#Widget:ExtLink|link=https://docs.docker.com/compose/install/|displaytext=Install Docker-Compose}}
 +
 
 +
==Install GWS micro-services==
 +
 
 +
# Create a '''premise''' directory under the '''/opt/genesys/gws''' directory and copy the contents of the package's '''docker''' directory in all target machines.
 +
# Run the following command at all target machines: <pre># ./bin/preflight.sh</pre>{{NoteFormat|This script disables firewalls and sets SElinux to ''permissive'' mode.}}
 +
# Run the following command at all target machines:<pre># ./bin/dump-restore.sh restore</pre>
 +
 
 +
==Create GWS-data service Containers==
 +
 
 +
# Create a ''systemd'' unit. <pre>SERVICE_NAME="data" ./bin/register-systemd-unit.sh</pre>
 +
# Start the data services.<pre>systemctl start gws-data.service</pre>
 +
# Configure Redis.<pre>./bin/redis-starter.sh</pre>
 +
 
 +
==Create GWS-applications Containers==
 +
 
 +
# Create a ''systemd'' unit. <pre>SERVICE_NAME="applications" ./bin/register-systemd-unit.sh</pre>
 +
# Start the applications services. <pre>systemctl start gws-applications.service</pre>
 +
# Create the client. <pre>./bin/client-curl-script.sh</pre>
 +
# Check the status of applications. <pre>./bin/healthcheck.sh</pre>
 +
 
 +
==Configure GWS ==
 +
===Configure Config Server===
 +
Refer to [[Documentation:HTCC:Dep:InstallationProcedures|InstallationProcedures]] for information on configuring GWS.
 +
 
 +
==Create a Genesys Environment==
 +
===Mapping ===
 +
<pre>POST http://<GWS_APPLICATIONS_IP>:80/environment/v3/environments </pre>
 +
 
 +
=== 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 ====
 +
<pre>
 +
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"
 +
}
 +
}
 +
</pre>
 +
 
 +
Response:
 +
 
 +
<pre>
 +
{
 +
"statusCode": 0,
 +
"path": "/environments/2"
 +
}
 +
</pre>
 +
 
 +
==Create contact-center==
 +
=== Mapping===
 +
<pre>POST http://<GWS_APPLICATIONS_IP>:80/environment/v3/contact-centers</pre>
 +
 
 +
=== 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 ====
 +
<pre>
 +
POST .../environment/v3/contactCenters
 +
  {
 +
    "data": {
 +
      "environmentId": "5",
 +
      "domains": ["customerC.com"],
 +
      "auth": "configServer"
 +
    }
 +
}
 +
</pre>
 +
 
 +
Response:
 +
 
 +
<pre>
 +
{
 +
  "statusCode": 0,
 +
  "path": "/conatctCenters/6"
 +
}
 +
</pre>
 +
 
 +
==Links==
 +
# Auth API: <nowiki>http://<GWS_APPLICATIONS_IP>:80/auth/v3/*</nowiki>
 +
# Config API:  <nowiki>http://<GWS_APPLICATIONS_IP>:80/configuration/v3/*</nowiki>
 +
# Environment API:  <nowiki>http://<GWS_APPLICATIONS_IP>:80/environment/v3/*</nowiki>
 +
# Provisioning API:  <nowiki>http://<GWS_APPLICATIONS_IP>:80/provisioning/v3/*</nowiki>
 +
# Workspace API:  <nowiki>http://<GWS_APPLICATIONS_IP>:80/workspace/v3/*</nowiki>
 +
 
 +
[[Category:V:HTCC:9.0.0]]

Revision as of 17:00, April 29, 2019

Deploying GWS in Test Labs

Install Docker and docker-compose

  1. Install Docker
  2. Install Docker-Compose

Install GWS micro-services

  1. Create a premise directory under the /opt/genesys/gws directory and copy the contents of the package's docker directory in all target machines.
  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

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/*
Comments or questions about this documentation? Contact us for support!