Run the Installer

If you want to securely store the Synthetic Server credentials (inputs.groovy file), ensure that OpenSSL is installed before proceeding with the installation:
Unix or Linux
  1. Check if OpenSSL is installed:
    CODE 
    openssl version
  2. If it is not installed, use the following command to install OpenSSL:
    Ubuntu/Debian:
    CODE 
    sudo apt-get update
sudo apt-get install openssl
    RHEL/CentOS:
    CODE 
    sudo yum install openssl
macOS
CODE 
brew install openssl
Windows
  1. Download and install OpenSSL from Win32OpenSSL (Win64 OpenSSL v3.x.x is recommended).
  2. Add the OpenSSL binary directory to the system PATH.
    1. Right-click This PC.
    2. Navigate to Properties > Advanced System Settings > Environment Variables > System Variables > Path > Edit.
    3. Add C:\Program Files\OpenSSL-Win64\bin.
  3. Restart your terminal or command prompt.
  4. Verify the installation:
    CODE 
    openssl version

From the root directory of the installer, run the following command as the root user.

CODE 
unix/deploy.sh install

In the output from the install command, you should see the log of completed tasks similar to the following:

CODE 
Task [facts for localhost] completed executing in [274] ms.
Task [Create the encryption directory] completed executing in [78] ms.
Task [Create keystore for encryption] completed executing in [796] ms.
Task [Create the encrypted password] completed executing in [566] ms.
Task [Obfuscate the key store password] completed executing in [397] ms.
Task [Read created password] completed executing in [46] ms.
Task [Read the obfuscated key store password] completed executing in [43] ms.
Task [Change configurations for the shepherd and scheduler conf] completed executing in [81] ms.
Task [Read created password] completed executing in [24] ms.
Task [Read the obfuscated key store password] completed executing in [26] ms.
Task [Change configurations for the shepherd and scheduler conf] completed executing in [76] ms.
Task [Read created password] completed executing in [29] ms.
Task [Read the obfuscated key store password] completed executing in [20] ms.
Task [Change configurations for the shepherd and scheduler conf] completed executing in [31] ms.
Task [Delete the encryption directory] completed executing in [47] ms.
Task [Change configurations for the liquibase properties file] completed executing in [26] ms.
Task [Update schema of SQL DB to include synthetic schema] completed executing in [2412] ms.
Task [Install flake8 for script linting] completed executing in [1671] ms.
Task [Start the synthetic services] completed executing in [67] ms.

You will be asked to confirm whether you want to encrypt the inputs.groovy file. If you choose to encrypt, set a password and store it securely. You will need this password for any future upgrades or uninstalls.

Note:

If you forget or lose the password, you will need to recreate the inputs.groovy file with credentials.

Verify the Installation was successful

  1. Confirm that the Synthetic Server is running:
    CODE 
    ps aux | grep synthetic-processor
    Note: If you have jps installed, you can also just run it to verify the Synthetic Server are running.
  2. Verify that the Synthetic Scheduler and Synthetic Shepherd are listening on the default ports:
    CODE 
    netstat -lan | grep "1[0,2,6]10[1,2]"
  3. With mysql installed on the Synthetic Server machine, you can verify that the Synthetic Server machine can connect to the EUM Server MySQL eum_db database:
    CODE 
    mysql -h <eum_server_instance> -P 3388 -D eum_db -u eum_user -p
  4. If you cannot connect to the EUM Server MySQL database, return to Grant Privileges to the EUM Server MySQL Database and complete the steps again.