Virtual machine

In this section, we describe how to create a virtual machine (VM) in Open Virtual Appliance (OVA) format with the Wazuh server, dashboard, and indexer components pre-installed. The wazuh-virtual-machines/ova/generate_ova.sh script automates the creation of the VM. The VM works with any hypervisor, allowing quick setup of a single-node Wazuh deployment.

Requirements

You need a system with a minimum of 4 CPU cores and 8 GB of RAM to build the virtual machine. Ensure that these dependencies are installed on the system:

Creating the Wazuh VM

Follow the steps below to create the Wazuh virtual machine:

  1. Clone the wazuh-virtual-machines repository and navigate to the ova/ directory. Select the version, for example, v4.14.9.

    $ git clone https://github.com/wazuh/wazuh-virtual-machines && cd wazuh-virtual-machines/ova/ && git checkout v4.14.9

  2. Execute the generate_ova.sh script to create the VM.

    $ ./generate_ova.sh

    The command returns output similar to the following example:

    . . .
Exporting ova
0%...10%...20%...30%...40%...50%...60%...70%...80%...90%...100%
Successfully exported 1 machine(s).
==> default: Destroying VM and associated drives...
wazuh-4.11.1.ovf
wazuh-4.11.1-disk001.vmdk
Setting up ova for VMware ESXi
Standardizing OVA
Setting OVA to default
wazuh-4.11.1.ovf
wazuh-4.11.1-disk001.vmdk
OVF extracted
mv: '/home/ubuntu/wazuh-virtual-machines/ova/new-ova/wazuh-4.11.1.ovf' and '/home/ubuntu/wazuh-virtual-machines/ova/new-ova/wazuh-4.11.1.ovf' are the same file
Files renamed
OVF Version changed
OVF Size changed
Manifest changed
wazuh-4.11.1.ovf
wazuh-4.11.1-disk-1.vmdk
wazuh-4.11.1.mf
New OVA created
Cleaned temporary directory
Process finished
. . .

The above command builds a VM with Wazuh central components. It uses production packages by default. If you are building a pre-release version, you must select the development package dev instead.

$ ./generate_ova.sh -r dev

The -r or --repository option selects the stage to use for the packages. For example:

  • prod: Packages released for production environments.

  • dev: Pre-release packages for testing and development purposes.

The generated virtual machine can be found in the /wazuh-virtual-machines/ova/output directory in .ova format.

Run the following command to check all available options:

$ ./generate_ova.sh -h

NAME
generate_ova.sh - Build Wazuh OVA.

SYNOPSIS
        generate_ova.sh -r | -s | -c | -f | -h

DESCRIPTION
        -a,  --installation-assistant
                Set the installation assistant branch for building the OVA.
                By default the same branch name as wazuh-virtual-machines will be used.

        -r,  --repository
                Use development or production repository.
                Values: [prod|dev|staging]. By default: prod.

        -s,  --store
                Set the destination absolute path where the OVA file will be stored.
                By default, a output folder will be created in /wazuh-virtual-machines/ova/output.

        -c,  --checksum
                Generate OVA checksum.
                Values: [yes|no]. By default: no.

        -g,  --debug
                Set debug mode.
                Values: [yes|no]. By default: no.

        -h,  --help
                Show this help.