Skip to main content

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 →Open quickstart
PrepareValidate hardware, libvirt, storage, networking, and passthrough readiness.
DeployUse guided DP, Standard Sensor, or AIO + Sensor installation workflows.
ResumeKeep 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.
First deployment? Follow Choose an Installer → Deployment Method → Requirements → Prepare Ubuntu 24.04 → Quickstart.

​
Quick Path

1. Choose an Installer

Select DP, Standard Sensor, or AIO + Sensor for the target deployment.

2. Choose a Deployment Model

Decide the network model and topology for bare metal, clusters, and private-cloud environments.

3. Check Requirements

Verify CPU, memory, storage, BIOS, NIC, and access requirements.

4. Prepare Ubuntu 24.04

Prepare BIOS, OS, storage, and networking on the KVM host.

5. Quickstart

Start the first deployment with DRY_RUN, validation, real execution, and reboot/resume.

6. Installation Demo Videos

Watch the installation flow in three demonstration videos.

Troubleshooting

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

Data Processor

Prepare the KVM host and configure DL/DA storage, DL-master/DA-master VMs, and high-performance networking.

Standard Sensor

Deploy a Standard Modular Sensor VM with management networking and SPAN interfaces.

AIO + Sensor

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

​
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
Basic familiarity with Linux, KVM, and networking is still required.

​
Common deployment flow

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 Feedback is welcome for:
  • bug reports
  • improvement proposals
  • issues found during operations
Last modified on September 30, 2026