Open XDR KVM Installer Documentation

A practical documentation site for the OpenXDR KVM Installer —
a script-based automation framework for deploying and operating Stellar Cyber Open XDR components on KVM-based Linux environments.

This installer is designed to reduce operational complexity by standardizing and automating common deployment tasks, including:

• Preparing KVM / libvirt host environments

• Deploying Data Processor (DP) and Sensor virtual machines

• Configuring network interfaces, bridges, and PCI passthrough

• Running installations in fully automated or step-by-step modes

• Validating host configuration and deployment status

All installation workflows are executed through an interactive, menu-driven interface, allowing operators to run only the steps they need or to perform end-to-end automated deployments.

Source Code and Contribution

The installer source code is maintained on GitHub and is actively evolving based on field feedback.

➡ Project Repository:
https://github.com/RickLee-kr/OpenXDR-KVM-Installer

Bug reports, improvement suggestions, and operational feedback are welcome.

Getting Started

If this is your first time using the installer, start with the recommended installation flow in the navigation menu.
If you are troubleshooting or modifying an existing deployment, jump directly to the relevant configuration or validation section.

Who this documentation is for

• Stellar Cyber system administrators managing on-premise XDR infrastructure

• Deployment teams performing PoC, staging, or production installations

How to use this site

Use the navigation menu to follow the recommended installation flow,
or jump directly to specific configuration, validation, or troubleshooting topics as needed.

Design Principles

The OpenXDR KVM Installer is designed with the following principles in mind:

• Repeatability
  Every installation step is deterministic and can be re-executed safely, enabling consistent results across PoC, staging, and production environments.

• Operational Transparency
  All actions are visible and traceable through logs and validation checks.
  Nothing is hidden behind opaque automation.

• Selective Automation
  Operators can run the full workflow or execute only specific steps depending on the deployment scenario.

• Field-driven Design
  The installer reflects real-world operational requirements observed in customer deployments, not theoretical lab assumptions.

Scope and Coverage

This documentation covers the end-to-end lifecycle of deploying Stellar Cyber Open XDR components on KVM hosts, including:

• Host preparation and baseline configuration

• VM deployment and resource allocation

• Network and PCI passthrough configuration

• Post-deployment validation and health checks

The focus is on on-premise, KVM-based Linux environments, with Ubuntu LTS as the primary supported platform.

What This Installer Does

The OpenXDR KVM Installer does:

• Automate repetitive and error-prone deployment tasks

• Enforce a consistent installation order and dependency handling

• Support both guided (step-by-step) and unattended execution

• Provide validation steps to confirm system readiness and correctness

• Allow recovery and continuation from partially completed installations

What This Installer Does Not Do

The OpenXDR KVM Installer does not:

• Replace vendor product documentation or architecture design decisions

• Automatically tune performance beyond documented best practices

• Abstract away all Linux or KVM operational knowledge

• Act as a general-purpose VM management platform

Basic familiarity with Linux, KVM, and networking concepts is still expected.