Merge pull request #562 from wazuh/enhancement/545-update-ova-documentation-with-local-build

Add documentation for local ova build

Author: c-bordon

CHANGELOG.md

@@ -5,6 +5,7 @@ All notable changes to this project will be documented in this file.
 
 ### Added
 
+- Add documentation for local ova build ([#562](https://github.com/wazuh/wazuh-virtual-machines/pull/562))
 - Add the installation assistant tools revision in the generate presigned urls script ([#531](https://github.com/wazuh/wazuh-virtual-machines/pull/531))
 - Added debug mode to customizer script for AMI. ([#513](https://github.com/wazuh/wazuh-virtual-machines/pull/513))
 

docs/SUMMARY.md

@@ -22,6 +22,7 @@
 - [Installation](ref/installation/installation.md)
   - [AMI Installation](ref/installation/ami/ami-installation.md)
   - [OVA Installation](ref/installation/ova/ova-installation.md)
+  - [Local OVA Installation](ref/installation/ova/local-ova-installation.md)
 - [Configuration](ref/configuration/configuration.md)
   - [AMI Configuration](ref/configuration/ami/ami-configuration.md)
   - [OVA Configuration](ref/configuration/ova/ova-configuration.md)

docs/ref/installation/installation.md

@@ -4,3 +4,4 @@ This section covers how to correctly install AMI and OVA. Once the installation
 
 - **AMI installation** ([ami-installation.md](ami/ami-installation.md)): This section covers the installation of the AMI on AWS. It includes the steps to create an EC2 instance using the AMI.
 - **OVA installation** ([ova-installation.md](ova/ova-installation.md)): This section covers the installation of the OVA on VirtualBox. It includes the steps to import the OVA into VirtualBox.
+- **Local OVA creation** ([local-ova-installation.md](ova/local-ova-installation.md)): This section covers how to create the OVA locally. It includes the steps to set up the environment and build the OVA.

docs/ref/installation/ova/local-ova-installation.md

@@ -0,0 +1,69 @@
+# Local OVA installation
+
+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. To build it locally, we will use the `wazuh_local_ova` module from the [Wazuh Virtual Machines](https://github.com/wazuh/wazuh-virtual-machines/tree/main/wazuh_local_ova) repository.
+
+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:
+
+- Virtual Box
+- Vagrant
+- Git
+- Python
+    - Make sure `pip` and `hatch` are installed for Python
+
+
+## Create the Wazuh VM
+
+To create the Wazuh OVA locally, we will use the `wazuh_local_ova` module. This module is written in Python and has the following options:
+
+| Option | Short | Description | Required | Default |
+|--------|-------|-------------|----------|---------|
+| `--name` | `-n` | Name of the generated `.ova` file | No | `wazuh-local-ova` |
+| `--output` | `-o` | Directory where the `.ova` file will be stored | No | Current directory |
+| `--packages_url_path` | `-p` | Path to the file containing the package download URLs | **Yes** | - |
+| `--checksum` | `-c` | Generate a `.sha512` file for the OVA | No | `False` |
+
+The file specified in `--packages_url_path` must contain the URLs of the Wazuh core component packages. Below is an example of the file content with the different supported package nomenclatures:
+
+```yaml
+wazuh_manager_amd64_deb: "http://example.com/wazuh-manager-amd64.deb"
+wazuh_manager_arm64_deb: "http://example.com/wazuh-manager-arm"
+wazuh_manager_amd64_rpm: "http://example.com/wazuh-manager-amd64.rpm"
+wazuh_manager_arm64_rpm: "http://example.com/wazuh-manager-arm.rpm"
+wazuh_indexer_amd64_deb: "http://example.com/wazuh-indexer-amd64.deb"
+wazuh_indexer_arm64_deb: "http://example.com/wazuh-indexer-arm"
+wazuh_indexer_amd64_rpm: "http://example.com/wazuh-indexer-amd64.rpm"
+wazuh_indexer_arm64_rpm: "http://example.com/wazuh-indexer-arm.rpm"
+wazuh_dashboard_amd64_deb: "http://example.com/wazuh-dashboard-amd64.deb"
+wazuh_dashboard_arm64_deb: "http://example.com/wazuh-dashboard-arm"
+wazuh_dashboard_amd64_rpm: "http://example.com/wazuh-dashboard-amd64.rpm"
+wazuh_dashboard_arm64_rpm: "http://example.com/wazuh-dashboard-arm.rpm"
+...
+```
+
+Follow the steps below to create the Wazuh virtual machine:
+
+1. Clone the Wazuh Virtual Machines repository and select the Wazuh version you want to install in the OVA, in this case `5.0.0`:
+
+   ```bash
+   git clone https://github.com/wazuh/wazuh-virtual-machines && cd wazuh-virtual-machines/ && git checkout v5.0.0
+   ```
+
+2. Execute the following command to build the OVA image:
+
+   ```bash
+   hatch run local-ova:create -p \<path to the urls file\>
+   ```
+
+    This command will set up the execution environment, configure the Vagrant VM and export the OVA image.
+
+    You can also customize the name and output directory of the OVA file using the `--name` and `--output` options. For example:
+    
+    ```bash
+    hatch run local-ova:create -p \<path to the urls file\> -n custom-wazuh-ova -o /path/to/output/directory
+    ```
+
+    To see all available options, you can use the `-h` or `--help` flag:
+    
+    ```bash
+    hatch run local-ova:create --help
+    ```

pyproject.toml

@@ -10,6 +10,7 @@ dependencies = [
     "paramiko",
     "pyyaml",
     "jinja2",
+    "requests",
 ]
 requires-python = ">= 3.12"
 description = "Wazuh - Virtual Machines (OVA and AMI)"
@@ -72,7 +73,6 @@ dependencies = [
     "pytest-cov~=6.0",
     "pytest-xdist",
     "ruff",
-    "requests",
 ]
 
 [tool.hatch.envs.dev-provisioner]
@@ -186,3 +186,14 @@ run = "python -m wazuh_local_ova {args:}"
 
 [tool.hatch.envs.dev-ova-dependencies.scripts]
 install = "python3 -c 'from configurer.ova.ova_pre_configurer.install_dependencies import main; main()'"
+
+[tool.hatch.envs.local-ova]
+description = """
+Enviroment to be used for testing all virtual-machines modules
+"""
+dependencies = [
+    "typer",
+]
+
+[tool.hatch.envs.local-ova.scripts]
+create = "python -m wazuh_local_ova {args:}"

wazuh_local_ova/__main__.py

@@ -4,7 +4,7 @@
 
 from .build_ova import configure_vagrant_vm, export_ova_image, generate_checksum, setup_execution_environment
 
-app = typer.Typer()
+app = typer.Typer(context_settings={"help_option_names": ["-h", "--help"]})
 
 
 @app.command(name="create", help="Create a new Wazuh OVA image.")
@@ -32,4 +32,4 @@ def create_ova(
 
 
 if __name__ == "__main__":
-    app()
+    app(prog_name="hatch run local-ova:create")