Deployment

Important

You should always deploy EX Engage Connector using the bootstrap script.

Deploying in EX Engage Connector in Production

To set up the EX Engage Connector services in the production environment, run the init command: ./bootstrap.py --init

The init script performs the following actions:

1. Prompt for following passwords:
   • DB password - The password for the Config database.
   • Redis Password - The password for the redis server (if the redis-secure parameter is set to true).
2. Create a /tmp/.env file containing the provisioning information along with password information.
3. Extract the VM address for each service and copy the docker-compose file of the respective service to their respective VMs.
4. Copy the /tmp/.env file to the list of VMs on which the connector services need to be installed and delete the /tmp/.env file.

The docker-compose files and .env files are stored under the exec directory in the home path of the Genesys user.

Starting EXEC Services

Once the EXEC services environment is initialized, exec services can be started/stopped/restarted using the below commands

After initializing the environment, the EXEC services can be started using any of the following commands:

• ./bootstrap.py --start - starts all the EXEC services in their respective VMs configured.
• ./bootstrap.py --start --service=exas - starts the EXAS service in its respective VM
• ./bootstrap.py --start --service=excp --pair 1 - starts the EXCP service in both the VMs belonging to excp pair 1
• ./bootstrap.py --start --service=excp --pair 1 --host 1 - starts the EXCP service in the VM host 1 belonging to excp pair 1

Similarly, all services or a specific service or a specific instance of a service can be stopped using the ./bootstrap.py --stop command. The ./bootstrap.py --restart command can be used to restart all services or a specific service or a specific instance of a service.

Deploying in EX Engage Connector in a Sandbox environment

To set up EXEC services in the Sandbox (Single VM) environment,

1. Switch to genesys user using the sudo command (sudo genesys).
2. Create a new folder named exec.
3. Download the bootstrap package from the FTP path into this folder.
4. Unzip the bootstrap package in this folder.
5. Verify if the following files are present in the bootstrap folder:
   • bootstrap.py
   • .env
   • docker-compose files for EXEC service
   • docker-compose file for infra service (redis, grafana and Prometheus)
6. From the exec folder, run the init command, ./bootstrap.py --init. The init script performs the following actions:
   • Prompt for the following passwords:
     • DB password - The password for the Config database.
     • Redis Password - The password for the redis server (if the redis-secure parameter is set to true).
7. Update the .env file with password information.

Starting EXEC Services

When the EXEC service is started, the bootstrap script will start up the docker-compose file of infra, EXCS, EXAS, and EXCP services. In a sandbox environment, only one instance of EXCP service will be started. Similarly, when the exec services are stopped, the bootstrap script will shut down the docker-compose files of infra, EXCS, EXAS, and EXCP services.