Installing Eggplant DAI

You can access the Eggplant DAI server from any connected machine on your network with a supported browser. This section provides step-by-step instructions to install and license Eggplant DAI on Windows.

System Requirements

Hardware Requirements

  • Operating system: Windows Server 2019, 2016 (recommended for production use), Windows 10, Red Hat Enterprise Linux (RHEL) 7.6\7.7 (supported on Eggplant DAI 4.0.1 only)
  • RAM: 8 GB minimum
  • Disk Space: 4 GB minimum
  • Processor: 64-bit Intel 2.3 GHz or equivalent (4+ cores or 8+ threads recommended)

Port Availability

  • 8000 or the next available port if port 8000 is in use (HTTP Access)

Important: Do NOT configure the following TCP ports to prevent conflicts during Eggplant DAI installation on Linux OS:

Nginx:

  • 8100 (also the main port for Linux)

Other services:

  • 4566
  • 4568
  • 4577
  • 4646
  • 4647
  • 4648
  • 4650

In addition, the inter-service communications use ports between 7800-7900.

As the Linux installer includes Nginx and PostgreSQL packages, if they are already installed in the system, the Eggplant DAI installation may fail.

If the postgresql-server package is already installed on the Linux operating system, you may not be able to install Eggplant DAI.

Supported Browsers

  • Google Chrome 80 and later
  • Mozilla Firefox 72 and later
  • Safari 13 and later

Installing Eggplant DAI on Windows

This section assumes you're performing a fresh installation of Eggplant DAI 4.1.

Important: If you're trying to install Eggplant DAI on a machine that has Eggplant AI 3.1 installed, you'll be prompted to uninstall Eggplant AI first. Make sure to uninstall Eggplant AI from Windows Control Panel > Add or remove Programs.

It's recommended to back up your Eggplant AI data before uninstalling Eggplant AI, especially if you want to migrate data across to Eggplant DAI by using the existing location as specified in step 4.

Tip: You can install Eggplant DAI 4.1 without uninstalling Eggplant DAI 4.0.1

  1. Download the Eggplant DAI installation file from the Eggplant DAI Downloads page.
  2. Double-click the downloaded installation file to launch the Setup wizard. Click Next to begin installing Eggplant DAI. You may be prompted to uninstall Eggplant AI if you haven't uninstalled it previously.
  3. On the Installation Directory screen, use the default installation directory (C:\Program Files\ Digital Automation Intelligence) or the file browser to select the desired installation directory. Click Next to continue your installation.
  4. Note: If you’re upgrading from Eggplant DAI 4.0.1, this screen will not be available.

  5. On the Advanced installer Options screen, select Run Advanced Install Configuration checkbox if you want to enable the option to specify ports, change the PostgreSQL data location, or specify Suite Data Directory and click Next to continue. Alternatively, leave this checkbox unselected to install Eggplant DAI as specified in step 8.
  6. On the PostgresSQL Data Directory screen, you might need to enter a path for the current installation of Eggplant DAI. Use the following information to decide whether this step is necessary for your installation:
    • If you're happy with the default path, then leave this field as-is.
    • lf you want to use a different directory, then add the path for the current application data (<install directory>/pgsql/data) by clicking the Choose Directory field.
    • If you want to configure the installer to use the Postgres data directory that was left behind after uninstalling Eggplant AI 3.1, then add the path of the previous installation folder (e.g., C:\eggplantAI\pgsql) by clicking the Choose Directory field.
  7. Click Next to continue to the next screen. When prompted, set the default HTTP port as follows:
    • If port 8000 is available, the installation suggests using port 8000. Click Next to continue.
    • If port 8000 is not available, you can enter the HTTP port you want to use.
  8. Leave the Report usage statistics checkbox selected to let Eggplant collect your usage statistics. Typically, the usage report will include: Product Identifier, Product Version, Host OS, Host OS Version, and License (Serial Number) information. You can disable this option by clearing the checkbox. Note that this option is only available if the Run Advanced Install Configuration checkbox is enabled.
  9. Specify the directory to point to the folder where you'd like your suites to be stored by browsing to that location and then click Next. This is the location where the agent will upload your suites to, which is also useful when running test configurations. Note that this is a completely different location to where you may be currently storing your Eggplant Functional suites.
  10. Set your suites directory

    New feature: This screen is available in Eggplant DAI 4.1 and later.
  11. On the Select Start Menu Folder screen, if you want to use a different directory, browse to select it. Click Next to continue or Back to return and make changes.
  12. Note: If you’re upgrading from Eggplant DAI 4.0.1, this screen will not be available.

  13. On the Ready to Install screen, click Install to begin installation. This installation step takes some time to complete.
  14. Click Finish to complete the installation.

See Licensing AI to open Eggplant DAI and manage your Eggplant DAI licenses.

Changing the Eggplant DAI Port on Windows

Although Eggplant DAI assigns port 8000 by default during installation, you can specify a different port later:

  1. Open C:\ProgramData\Eggplant\Digital Automation Intelligence\settings.ini.
    Important: The C:\ProgramData folder might not be initially visible, as it is hidden by default.
  2. Find the [settings] section and update the line server_port=8000 to include the port you want to use.
  3. Save your work.
  4. Restart the Digital Automation Intelligence Windows service.

Note: Any port changes made here should also be reflected in the Agent Server address section in your execution environment.

Upgrading from Eggplant DAI 4.0.1 to Eggplant DAI 4.1 on Windows

The upgrade steps for Eggplant DAI 4.0.1 are similar to installing Eggplant DAI 4.1 except you'll be presented with fewer screens. Note that you must uninstall the previous agent and install a new agent from Eggplant DAI 4.1 to use the new features.

Upgrading from Eggplant AI 3.1 to Eggplant DAI 4.1 on Windows

If you're upgrading from Eggplant AI 3.1, then follow these steps after installing Eggplant DAI 4.1:

  1. Locate the Digital Automation Intelligence service in the Windows Services panel and stop it.
  2. Copy over all the Postgres data files and folders from your original location (e.g., C:\eggplantAI\pgsql\data) to the Eggplant DAI location (e.g.,C:\ProgramData\Eggplant\Digital Automation Intelligence\data).
  3. Important:
    • The C:\ProgramData folder might not initially be visible, as it is a hidden folder by default.
    • Copy all files and subfolders. When prompted, overwrite the existing files in the destination.

  4. From the Windows Services panel, start the Digital Automation Suite service.

Note: To configure the Eggplant DAI installer to use the Postgres data directory that was left behind after uninstalling Eggplant AI 3.1, choose C:\eggplantAI\pgsql when installing Eggplant DAI 4.1.

Uninstalling Eggplant DAI on Windows

Use the following instructions for uninstalling Eggplant DAI.

  1. Locate and run the Eggplant DAI uninstall program by choosing Start > All Programs > Uninstall Eggplant DAI.
  2. Click Yes when prompted to uninstall Eggplant DAI and all its components.
  3. Click OK after the removal process is done.

Uninstalling Eggplant DAI does leave some folders intact. Note that the data that's left behind after you uninstall Eggplant DAI contains user account information, user models, and execution data. Only remove these files and folders if they are no longer required. Assuming you installed Eggplant DAI in the C:/Program Files/ DAI directory, the following folders remain if you need to retain any files:

Eggplant AI data directory files: C:\ProgramData\Eggplant\Digital Automation Intelligence\data

Server and Eggplant DAI log files: C:\ProgramData\Eggplant\Digital Automation Intelligence\logs

If you decide that you want to do a complete Eggplant DAI removal after following the above steps to uninstall Eggplant DAI, delete the following directory or folder:

C:\Program Files\Digital Automation Intelligence

Installing Eggplant DAI on Linux

Note: Use sudo in front of your commands (as specified below) to perform all operations related to installing, upgrading, and uninstalling Eggplant DAI. In addition, it is recommended to install Eggplant DAI on a dedicated server or virtual machine.

  1. Download dai-installer-4.0.1.run (installation package) from the Eggplant website.
  2. Run the installation (binary) package:
  3. sudo ./dai-installer-4.0.1.run

    The binary package includes Nginx and PostgreSql, which are installed in their standard locations. The Eggplant DAI application is installed in the /opt/eggplant/dai folder, with logs in the /var/log/eggplant/dai folder.

    The binary package also installs the following systemd services relevant to Eggplant DAI, which enables and starts them as part of the post-installation script:

    Active by default:
    • dai-api: The main REST API of the product
    • dai-composer: Supports API Proxy to allow better UI integration

    • dai-engine-wrapper: Supports proxy to allow scheduled executions

    • dai-ml: Machine learning service
    • dai-server: Supports Eggplant DAI runs
    • dai-sut: Allows the definition of SUTs to be used by the scheduler and configuration services

    • dai-task-scheduler: Supports proxy to allow scheduled executions

    • dai-test-config: Allows the definition of test configurations to be executed

      Note: Although dai.service is active by default after installing Eggplant DAI, it will not be listed along with the other services.

    Inactive by default (requires manual setup):
    • dai-ri-engine: The main engine for Release Insights
    • dai-ri-connectors: Release Insights analysis connectors
    Third-party services
    • nginx: The main HTTP server for Eggplant DAI
    • postgresql-9.6: Supports PostgreSQL service for Eggplant DAI

    For more information about systemd services, see RHEL's official documentation.

Note: By default, the Report usage statistics setting is enabled in the Linux installer for Eggplant to collect your usage statistics. The usage report typically includes: Product Identifier, Product Version, Host OS, Host OS Version, and License (Serial Number) information.

To disable this option, perform the following steps:

  1. Open the env.conf file in the following path:
  2. /etc/dai/env.conf

  3. Locate the following settings:
  4. Environment=DISABLE_USAGE_BEACON="False"

    Then, replace the value "False" with "True"

  5. Restart the Eggplant DAI services:
  6. sudo systemctl restart dai.service

Configuration

Eggplant DAI configuration files are in its default folder location: /etc/nginx/conf.d/.

This folder contains configuration files for Nginx:

eggplant-dai.conf: Includes a sample standard Eggplant DAI nginx configuration. See the official NGINX documentation for more details.

For information about configuring Insights data, contact Eggplant support.

SELinux

Eggplant DAI has been tested to work with the default Security-Enhanced Linux (SELinux) in permissive mode. SELinux enables system admins to define and access transition rights of users, application, process, and files in a Linux environment. If you suspect a possible issue, disable SELinux temporarily and include the results of running without SELinux for reporting the problem to Eggplant support.

Changing the default port after installing Eggplant DAI on Linux

Although Eggplant DAI assigns port 8100 by default during installation, you can specify a different port later:

  1. Stop the Nginx service:
  2. sudo systemctl stop nginx
  3. Rename the default.conf file and move it to the previous folder (inactive):
  4. mv /etc/nginx/conf.d/default.conf /etc/nginx/default.conf.old
  5. Edit the eggplant-dai.conf file that's located in the following directory:
  6. vim /etc/nginx/conf.d/eggplant-dai.conf
  7. In the eggplant-dai.conf file, locate the following line:
  8. listen 8100;listen [::]: 8100;

    Replace it with your preferred port (if it is free), for e.g., if your new port is 8101, then change it to:

    listen 8101;listen [::]: 8101;
  9. Verify if the updated port works as expected by testing it:
  10. sudo nginx -t

    Note: If you receive warnings about SELinux in permissive mode, follow these steps for enabling ports:

    Check SELinux Http ports:

    sepolicy network -t http_port_t

    Check if the port is available:

    sepolicy network -p 8001

    Activate port in SELinux:

    semanage port -a -t http_port_t -p tcp 8001

  11. Activate the Nginx service:
  12. sudo systemctl start nginx

    For information on how to configure Nginx, see the official NGINX documentation.

  13. Save the changes.

Note: Any port changes made here should also be reflected in the Agent Server address section in your execution environment.

Upgrading from Eggplant AI 3.1 to Eggplant DAI 4.0.1 on Linux

Use the following section to upgrade from Eggplant AI 3.1 to Eggplant DAI 4.0.1:

Important: Use this upgrade method with caution as it will destroy all the databases in PostgreSQL (including Eggplant Manager and any other Eggplant applications). Therefore, you must perform a backup before initiating this upgrade method.
  1. Locate the active Eggplant AI 3.1 services and stop all of them except the eai-pgsql service.
  2. systemctl stop eai-nginx eai-server eai-ri-engine eai-api eai-ml
  3. Back up the Eggplant AI 3.1 data. Note that you’ll be prompted to provide the password several times depending on the number of databases you're migrating.
    /opt/eggplantai/bin/pg_dumpall -c -U postgres -h localhost -p 5432 --file="/tmp/eai_dump.sql"
  4. Use the following commands to stop the Eggplant AI services and then uninstall Eggplant AI:
  5. sh /opt/eggplantai/bin/remove-services.sh
    rpm -eav eggplantai
  6. Download the dai-installer-4.0.1.run (Linux package) and install it.
  7. ./dai-installer-4.0.1.run
  8. After Eggplant DAI 4.0.1 installation is complete, stop the following services (Nginx and DAI):
  9. systemctl stop dai nginx
  10. Restore Eggplant AI 3.1 data into Eggplant DAI 4.0.1:
  11. /usr/pgsql-9.6/bin/psql -h localhost -d postgres -U postgres -f "/tmp/eai_dump.sql"
  12. After the data is restored, start the Eggplant DAI and Nginx services:
  13. systemctl start dai nginx

    Note that it may take a while for the following Eggplant DAI services to start:

    dai-composer.service

    dai-task-scheduler.service

    dai-sut.service

    dai-ml.service

    dai-test-config.service

    dai-engine-wrapper.service

    dai-api.service

    dai-server.service

  14. Verify the services for Eggplant DAI, Nginx, and Postgres are active by using the following commands:
  15. systemctl status | grep dai
    systemctl status nginx
    systemctl status postgres*

Uninstalling Eggplant DAI on Linux

Use the following instructions for uninstalling Eggplant DAI on Linux.

  1. Locate and run the Eggplant DAI uninstall script from the following directory:
  2. /opt/eggplant/dai/config/uninstall-dai.sh
  3. Stop the services by entering the following command:
  4. sudo systemctl stop dai
  5. Uninstall Eggplant DAI by entering the following command:
  6. sudo ./uninstall-dai.sh

Uninstalling Eggplant DAI does leave some directories intact. Note that the data that's left behind after you uninstall Eggplant DAI contains user account information, user models, and execution data. Only remove these files and directories if they are no longer required:

Eggplant AI data directory files: /var/lib/pgsql/9.6/data

Server and Eggplant DAI log files: /var/log/eggplant/dai

Initial Login and Licensing

When Eggplant DAI is installed and running, you access the application in a browser. On your initial login, you must create an administrator account and enter your license key. Follow these steps to complete your initial login:

  1. Launch your browser from any computer that has access to the Eggplant DAI server and enter the appropriate URL:
    • To display the login prompt from the computer on which the Eggplant DAI server is running, enter http://localhost:8000
    • To display the login prompt from a remote computer, enter http://<serverIPaddress>:8000 where <serverIPaddress> is the Eggplant DAI server's IP address or fully qualified domain name
    Note: To obtain the IP address of the Eggplant DAI server, see your local IT administrator. Distribute the URLs from this step to all users requiring access to this Eggplant DAI application.
  2. Eggplant DAI prompts you to set up an administrator account. Enter an email address (username) and password for the account.
  3. On initial log in to Eggplant AI, you create an admin account and enter your license key

    Enter your initial admin credentials and license key for Eggplant DAI

    After you've configured the administrator account, you can use it to set roles for other users requesting access. See Approving New Users for more information.

  4. Enter a license key. You can generate this in the Greenhouse Licensing Web Portal.
  5. Click OK.

After your account is created, a new Login dialog box appears prompting you to log in to Eggplant AI. After you've entered your valid credentials, the Models tab appears.

Greenhouse Licensing Web Portal

As an Eggplant customer, you have access to the Greenhouse licensing web portal, where you can review and create available license keys as well as download generated licenses for your account.

Note: When you're generating a license key in Greenhouse, copy the physical address of the machine where Eggplant DAI is installed into the Host ID field.

You can also use this portal to submit questions to support and view information about any support cases.

You should receive your initial Greenhouse login information from your account manager. If you don't have a password, you'll need to contact your account manager or sales@eggplant.io. If you need an Eggplant DAI license, contact your account manager or Eggplant Support.

Frequently Asked Questions

  • When installing Eggplant DAI on a Windows machine, why do I get the following error message?

    Remove EAI to progress with DAI

    Uninstall Eggplant AI via Windows Control Panel > Add or remove Programs.

    If that doesn't work, you need to delete the Eggplant AI (e.g., Eggplant AI 3.1 folder) registry key, which is found here:

    HKEY_LOCAL_MACHINE\SOFTWARE\WOW6432Node\Microsoft\Windows\CurrentVersion\Uninstall
    Important: Care must be taken while accessing the registry keys, as it can cause major issues if not done correctly. In addition, you should back up the registry before making any changes.

    Restart your computer and install Eggplant DAI.

  • Where can I find the Eggplant DAI log files?
  • The log files for Eggplant DAI 4.x are located in the following path:

    Windows: C:\ProgramData\Eggplant\Digital Automation Intelligence\logs
    Linux:/var/log/eggplant/dai

    DAI Agent Log files:

    Windows: %LOCALAPPDATA%\eggplant\agent\Logs

    Mac: ~Home\Library\Logs

 

This topic was last updated on July 01, 2020, at 05:05:42 PM.

Eggplant icon Eggplantsoftware.com | Documentation Home | User Forums | Support | Copyright © 2020 Eggplant