> ## Documentation Index
> Fetch the complete documentation index at: https://kvm.xdr.ooo/llms.txt
> Use this file to discover all available pages before exploring further.

# OpenXDR KVM Installer

> Deploy and operate Stellar Cyber OpenXDR components on KVM-based Linux hosts with repeatable installer workflows.

OpenXDR deployment automation

# Deploy Stellar Cyber appliances on KVM with repeatable guardrails.

Prepare KVM hosts, deploy Data Processor and Sensor VMs, validate hardware, networking, and storage state, and resume safely across reboots with a guided installer workflow.

[Choose an installer →](https://kvm.xdr.ooo/getting-started/choose-installer.md)
[Open quickstart](https://kvm.xdr.ooo/getting-started/quickstart.md)

**Prepare**Validate hardware, libvirt, storage, networking, and passthrough readiness.**Deploy**Use guided DP, Standard Sensor, or AIO + Sensor installation workflows.**Resume**Keep step state and validation visible across reboots and partial runs.

## Documentation Overview

OpenXDR KVM Installer automates the host work required for a KVM deployment. It configures libvirt, storage, networking, VM images, passthrough, CPU placement, and reboot/resume state through a menu-driven installer with saved progress and validation.

The installer automates common deployment tasks so the same procedure can be repeated across hosts:

* prepare KVM / libvirt host environments
* deploy Data Processor (DP) and Sensor virtual machines
* configure network interfaces, bridges, and PCI passthrough
* support Auto Execute or step-by-step execution
* validate host configuration and deployment state

All installation workflows use an **interactive menu-driven interface**, allowing operators to run only the required steps or execute an end-to-end deployment.

> [!TIP]
>
> **First deployment?** Follow **[Choose an Installer](https://kvm.xdr.ooo/getting-started/choose-installer.md)** → **[Deployment Method](https://kvm.xdr.ooo/getting-started/deployment-guide.md)** → **[Requirements](https://kvm.xdr.ooo/getting-started/requirements.md)** → **[Prepare Ubuntu 24.04](https://kvm.xdr.ooo/getting-started/installing-ubuntu-24-04.md)** → **[Quickstart](https://kvm.xdr.ooo/getting-started/quickstart.md)**.

## Quick Path

> [card] [1. Choose an Installer](https://kvm.xdr.ooo/getting-started/choose-installer.md)
>
> Select DP, Standard Sensor, or AIO + Sensor for the target deployment.

> [card] [2. Choose a Deployment Model](https://kvm.xdr.ooo/getting-started/deployment-guide.md)
>
> Decide the network model and topology for bare metal, clusters, and private-cloud environments.

> [card] [3. Check Requirements](https://kvm.xdr.ooo/getting-started/requirements.md)
>
> Verify CPU, memory, storage, BIOS, NIC, and access requirements.

> [card] [4. Prepare Ubuntu 24.04](https://kvm.xdr.ooo/getting-started/installing-ubuntu-24-04.md)
>
> Prepare BIOS, OS, storage, and networking on the KVM host.

> [card] [5. Quickstart](https://kvm.xdr.ooo/getting-started/quickstart.md)
>
> Start the first deployment with DRY\_RUN, validation, real execution, and reboot/resume.

> [card] [6. Installation Demo Videos](https://kvm.xdr.ooo/getting-started/installation-demo-videos.md)
>
> Watch the installation flow in three demonstration videos.

> [card] [Troubleshooting](https://kvm.xdr.ooo/operations/troubleshooting.md)
>
> Diagnose failures using validation, logs, and step-level reruns.

## Who This Documentation Is For

* **Stellar Cyber system administrators** operating on-premises XDR infrastructure
* **deployment engineers and operators** performing PoC, staging, or production installations

## Deployment Targets

> [card] [Data Processor](https://kvm.xdr.ooo/installers/dp.md)
>
> Prepare the KVM host and configure DL/DA storage, DL-master/DA-master VMs, and high-performance networking.

> [card] [Standard Sensor](https://kvm.xdr.ooo/installers/sensor.md)
>
> Deploy a Standard Modular Sensor VM with management networking and SPAN interfaces.

> [card] [AIO + Sensor](https://kvm.xdr.ooo/installers/aio-sensor.md)
>
> Deploy AIO Data Processor and Sensor together on one KVM host.

## Design Principles

### ① Repeatability

* installation steps follow a defined order
* steps can be re-executed safely
* PoC, staging, and production environments can use the same installation sequence

### ② Visible changes and validation

* actions are visible through logs and validation
* operators can see what the automation is doing

### ③ Selective Automation

* run the complete automated deployment
* or execute only specific steps for the current scenario

### ④ Field-Driven Design

* procedures are based on field deployment requirements rather than lab-only assumptions

## Scope and Coverage

This documentation covers preparation, deployment, reboot/resume, validation, and post-deployment operation on KVM hosts.

Included:

* host preparation and baseline configuration
* VM deployment and resource allocation
* networking and PCI passthrough
* post-deployment validation and health checks

Primary target environments:

* **on-premises**
* **KVM-based Linux**
* **Ubuntu LTS** as the primary documented platform

## Automation Scope

| Area | Automation |
| - | - |
| Hardware | Detect CPU, memory, disks, NICs, virtualization, and IOMMU |
| KVM Stack | Install and configure KVM/libvirt |
| Networking | Management, NAT/bridge, SR-IOV, SPAN, passthrough |
| Storage | Prepare LVM-based VM storage |
| VM Deployment | Prepare images, define VMs, and deploy components |
| Performance | CPU affinity, NUMA-aware placement, PCI passthrough |
| Lifecycle | Step state, reboot, resume |
| Safety | DRY\_RUN, explicit confirmation, full configuration validation |

## What This Installer Does

* automates repetitive and error-prone deployment tasks
* enforces a consistent installation order and dependency handling
* supports both step-level execution and continuous Auto Execute
* validates system readiness and configuration correctness
* supports recovery and continuation from partially completed installations

## What This Installer Does Not Do

* replace official product documentation or architecture decisions
* automatically tune performance beyond documented best practices
* completely abstract Linux or KVM operational knowledge
* act as a general-purpose VM management platform

> [!WARNING]
>
> Basic familiarity with **Linux, KVM, and networking** is still required.

## Common deployment flow

```text theme={null}
Check hardware
  → Configure installer inputs with DRY_RUN enabled
  → Review the complete DRY_RUN flow
  → Run Full Configuration Validation
  → Resolve FAIL results and re-check inputs
  → Set DRY_RUN=0
  → Run all steps or a specific step
  → Reboot when required
  → Relaunch the same installer and resume
  → Perform post-deployment validation
```

> [!WARNING]
>
> The installer can modify networking, storage, kernel settings, virtualization configuration, and VM definitions. Always complete DRY\_RUN and full configuration validation before making changes.

## Source Code and Contributions

The installer source is maintained on GitHub and continues to evolve based on field feedback.

➡ **[Project Repository](https://github.com/xdr-labs/OpenXDR-KVM-Installer)**

Feedback is welcome for:

* bug reports
* improvement proposals
* issues found during operations

## Related Projects

* [OpenXDR KVM Installer](https://github.com/xdr-labs/OpenXDR-KVM-Installer)
* [XDR Labs](https://xdr.ooo/)
* [Stellar Appliance CLI](https://github.com/xdr-labs/Stellar-appliance-cli)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.