Planning

Important

• Currently, EX Engage Connector supports only single SIP Server deployments.
• Genesys does not deploy and operate databases in on-premises deployments. It is the responsibility of customer. In a production deployment, data store components (Redis) must be deployed outside of the Docker network and managed by the customer's DBA team. The customer's DBA team is also responsible for ensuring that the data store components are configured with the appropriate scalability, resiliency, and data protection (backups).

Planning for Deployment

Mandatory

• Genesys Cloud OAuth Client Credentials - EX Engage Connector requires an OAuth client with grant type Client Credentials created in the EX Org to connect to GC and the EX Integration role should be assigned to the OAuth client.
• Access to Engage Config database.
• Virtual Machines - VMs running Linux kernel 4.18+, 64bit, 4 Core, 8 GB RAM, at least 20 GB HDD. We recommend four VMs to be deployed in the production environment.
  • 1 VM for EX Engage Connector Config Sync (EXCS)
  • 1 VM for EX Engage Connector Agent State Sync (EXAS)
  • 2 VMs for EX Engage Connector Conversation Provider (EXCP)

• Bootstrap Virtual Machine - Any Linux VM. It will be used only for administrative purposes. Requires Python 3.9+ and SSH connectivity to EXEC VMs.

• Docker - version 20 or later
• Redic - version 6.x or later

• Container orchestration- Docker Compose Version 2.8.1

• Network/DNS - All VMs running EX Engage Connector components should belong to the same local network segment and be interconnected so that all components can communicate over the network. EXEC components can use either FQDNs or IP addresses to establish communication with each other.

• Genesys core components - v.8.5+
  • EX Engage Connector components operate with Genesys core services on the back-end. Ensure the following Engage components (Config DB, Stat Server, and SIP Server) are deployed and running. Also, the EXEC components should be able to communicate with Config DB, Stat Server, and SIP Server.

Optional

• Monitoring solution (Prometheus) - EXEC component provides metrics that can be consumed by Prometheus.
• Observability Solution - Prometheus-based observability solution (Grafana) to make monitoring and alerting friendly and efficient.
• Logging - Log collection systems (Filebeat/ElasticSearch, promtail/Grafana.loki, etc) to collect and index logs in a centralized place.

Preparing for Deployment

Perform the following items before deploying EX Engage Connector:

• Download Bootstrap Script:
  • Download the latest Bootstrap script package from an FTP directory and copy it into a Linux machine (Bootstrap VM). Ensure that this Bootstrap VM is not one of the VMs running the EXEC services.
  • Install Python 3.9+ and pip 3 in the bootstrap VM.
• Deploy Bootstrap Package:
  1. Go to the installation directory where the bootstrap script is copied and extract the package.
  2. Under the installation directory, verify if the following files are available:
     • .env
     • bootstrap.py
     • Docker Compose files for EXCS, EXCP, and EXAS
     • alerts.yml
     • prometheus.yml
  3. Make sure the file is executable: chmod +x bootstrap.py
  4. Run ./bootstrap.py --help and verify if the following screen is displayed:

Welcome to EXEC deployment bootstrap script. Following actions are supported
 
init                                      - Initialize EXEC environment
start                                     - Start EXEC services
stop                                      - Stop EXEC services
restart                                   - Restart EXEC services
update                                    - upgrade/downgrade EXEC services
rollback                                  - rollback EXEC service