# Virtual Machine (VM) Deployment

In most cases, OvalEdge is installed on a virtual machine (VM). The operating system can be selected based on organizational preference.

Before installing the OvalEdge application on a VM, the following steps must be completed:

1. Verify that the hardware meets the specifications listed in the **Hardware Requirements** section.
2. Install the software specified in the **Software Requirements** section.
3. Complete the mandatory pre-installation steps outlined in the **Installation Activities** section.

## Prerequisites

### Hardware Requirements

### **Single Virtual Machine (All-in-One VM)**

Installing all components—including the database, Elasticsearch, and application server—on a single VM is recommended only for the Essential edition or for proof-of-concept (POC) environments. This configuration is not suitable for multi-user deployments.

**Supported Operating Systems**:

* Windows
* Linux: Ubuntu and RHEL

**Recommended Hardware:**

| HARDWARE                                      | ESSENTIAL                               | PROFESSIONAL                        | ENTERPRISE                            |
| --------------------------------------------- | --------------------------------------- | ----------------------------------- | ------------------------------------- |
| <mark style="color:$primary;">**RAM**</mark>  | <mark style="color:green;">32GB</mark>  | <mark style="color:blue;">NR</mark> | <mark style="color:orange;">NR</mark> |
| <mark style="color:$primary;">**SSD**</mark>  | <mark style="color:green;">200GB</mark> | <mark style="color:blue;">NR</mark> | <mark style="color:orange;">NR</mark> |
| <mark style="color:$primary;">**vCPU**</mark> | <mark style="color:green;">8</mark>     | <mark style="color:blue;">NR</mark> | <mark style="color:orange;">NR</mark> |

{% hint style="warning" %}
\*A single VM is not recommended for Professional and Enterprise packages since it will result in performance issues.
{% endhint %}

### **Multiple VMs (Separate VMs for different components)**&#x20;

It is recommended to use:

* One VM for the Application Server (AS)
* A separate VM for Elasticsearch (ES)
* A separate VM or cloud-hosted database service

As Amazon RDS manages backups and recovery tasks, using RDS or an equivalent cloud database service is recommended for the database.

For non-production or proof-of-concept (POC) workloads, a separate database environment is advised. In such cases, the AS and ES components can be hosted on a single VM.

**Recommended Hardware for the Application Server(AS) VM**

| HARDWARE                                      | ESSENTIAL                               | PROFESSIONAL                           | ENTERPRISE                               |
| --------------------------------------------- | --------------------------------------- | -------------------------------------- | ---------------------------------------- |
| <mark style="color:$primary;">**RAM**</mark>  | <mark style="color:green;">32GB</mark>  | <mark style="color:blue;">64GB</mark>  | <mark style="color:orange;">64GB</mark>  |
| <mark style="color:$primary;">**SSD**</mark>  | <mark style="color:green;">100GB</mark> | <mark style="color:blue;">200GB</mark> | <mark style="color:orange;">200GB</mark> |
| <mark style="color:$primary;">**vCPU**</mark> | <mark style="color:green;">8</mark>     | <mark style="color:blue;">16</mark>    | <mark style="color:orange;">16</mark>    |

**Recommended Hardware for the Elasticsearch** **VM**

| HARDWARE                                      | ESSENTIAL                               | PROFESSIONAL                           | ENTERPRISE                               |
| --------------------------------------------- | --------------------------------------- | -------------------------------------- | ---------------------------------------- |
| <mark style="color:$primary;">**RAM**</mark>  | <mark style="color:green;">32GB</mark>  | <mark style="color:blue;">64GB</mark>  | <mark style="color:orange;">64GB</mark>  |
| <mark style="color:$primary;">**SSD**</mark>  | <mark style="color:green;">100GB</mark> | <mark style="color:blue;">200GB</mark> | <mark style="color:orange;">200GB</mark> |
| <mark style="color:$primary;">**vCPU**</mark> | <mark style="color:green;">8</mark>     | <mark style="color:blue;">16</mark>    | <mark style="color:orange;">16</mark>    |

**Recommended Hardware for the Database RDS or VM**

| HARDWARE                                      | ESSENTIAL                               | PROFESSIONAL                           | ENTERPRISE                               |
| --------------------------------------------- | --------------------------------------- | -------------------------------------- | ---------------------------------------- |
| <mark style="color:$primary;">**RAM**</mark>  | <mark style="color:green;">16GB</mark>  | <mark style="color:blue;">32GB</mark>  | <mark style="color:orange;">64GB</mark>  |
| <mark style="color:$primary;">**SSD**</mark>  | <mark style="color:green;">100GB</mark> | <mark style="color:blue;">100GB</mark> | <mark style="color:orange;">200GB</mark> |
| <mark style="color:$primary;">**vCPU**</mark> | <mark style="color:green;">4</mark>     | <mark style="color:blue;">8</mark>     | <mark style="color:orange;">16</mark>    |

## Software Requirements

To run OvalEdge on a VM, install the following software components:

* **Database Server**
  * **MySQL (Standalone)**
    * [MySQL 8.4.x (Ubuntu)](https://docs.ovaledge.com/deployment-and-maintenance/installation/mysql-8.4.x-on-ubuntu-22.04+)
    * [MySQL 8.4.x (RHEL)](https://docs.ovaledge.com/deployment-and-maintenance/installation/mysql-8.4.x-on-rhel-8+)
    * [MySQL 8.4.x (Windows)](https://docs.ovaledge.com/deployment-and-maintenance/installation/mysql-8.4.x-on-windows)
  * **MySQL (RDS)**
    * [MySQL 8.4.x (AWS)](https://docs.ovaledge.com/deployment-and-maintenance/installation/mysql-8.4.x-on-aws)
    * [MySQL 8.4.x (Azure)](https://docs.ovaledge.com/deployment-and-maintenance/installation/mysql-8.4.x-on-azure)
* **Elasticsearch Server**
  * [Elasticsearch 7.17.x (Ubuntu)](https://docs.ovaledge.com/deployment-and-maintenance/installation/elasticsearch-7.17.x-on-ubuntu-22.04+)
  * [Elasticsearch 7.17.x (RHEL)](https://docs.ovaledge.com/deployment-and-maintenance/installation/elasticsearch-7.17.x-on-rhel-8+)
  * [Elasticsearch 7.17.x (Windows)](https://docs.ovaledge.com/deployment-and-maintenance/installation/elasticsearch-7.17.x-on-windows)
* **Application Server**
  * **Java**
    * [Java 17.x (Ubuntu)](https://docs.ovaledge.com/deployment-and-maintenance/installation/java-17.x-on-ubuntu-22.04+)
    * [Java 17.x (Windows)](https://docs.ovaledge.com/deployment-and-maintenance/installation/java-17.x-on-windows-machine)
  * **Apache Tomcat**
    * [Apache Tomcat 10.1.x (Ubuntu)](https://docs.ovaledge.com/deployment-and-maintenance/installation/tomcat-10.1.x-on-ubuntu-22.04)
    * [Apache Tomcat 10.1.x (Windows)](https://docs.ovaledge.com/deployment-and-maintenance/installation/tomcat-10.1.x-on-windows)

## Pre-Installation Activities

The following activities must be completed to install OvalEdge on a virtual machine.

#### 1. Download OvalEdge installation artifacts

Clients using a virtual machine infrastructure must complete the questionnaire to receive the installation artifacts link. The artifacts include:

* **ovaledge.war** – Application WAR file
* **masterscripts.sql** – Database scripts file
* **Connector JARs and drivers**
* **Configuration files** – `oasis.properties`, `log4j.properties`

#### 2. Verify database setup

Ensure the MySQL database is installed and configured, and the required schemas, users, and tables are created using the provided **masterscripts.sql**.

#### 3. Verify Tomcat configuration

Ensure the Tomcat server is installed and configured with the required settings, including:

* Deployment of **ovaledge.war** in the `webapps` folder
* Placement of configuration files (`oasis.properties`, `log4j.properties`) in the correct location
* Correct configuration of the **setenv** file (`setenv.bat` for Windows or `setenv.sh` for Linux/Unix)

## Post-Installation Activities

1. **Access the Application**
   * Open a web browser and go to:

     ```
     http://<PublicIP>:8080/ovaledge/login
     ```
   * The **OvalEdge License Information** page is displayed.
   * Enter the license key provided by the OvalEdge Global Customer Service (GCS) team in the **Apply License** section, then click **Update License**.
   * A pop-up with one-time admin credentials is displayed.
   * Use the admin credentials to log in and immediately change the default password.
2. **Update Application Configurations**

   * In the OvalEdge application, navigate to **Configuration** and update the following:

   **System Path**

   * `ovaledge.base.url` – Replace the default `http://localhost:8080/ovaledge` with the actual OvalEdge access URL.
   * `ovaledge.temppath` – Update with the path to the temp folder created during installation. This folder must also be on the same machine where OvalEdge is installed.

   **Notification**

   * Update the **SMTP details** to enable email notifications for configured alerts.
3. **Verify Elasticsearch Integration**
   * On the OvalEdge Home page, enter text in the search bar and press Enter.
   * The **Global Search** results page should appear, confirming Elasticsearch integration.

     <figure><img src="https://1813356899-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FhTnkoJQml0pok9awFDhx%2Fuploads%2Fb3QrJLmtxyGVxJU1Mxb7%2Fimage.png?alt=media&#x26;token=d18aeec7-fa5a-4d77-b605-0409775d1890" alt=""><figcaption></figcaption></figure>

***

Copyright © 2025, OvalEdge LLC, Peachtree Corners, GA, USA.