Documentation
How the platform works, written down.
Documentation is written alongside the platform. Each section below carries the status of the capability it documents.
Published documentation will be linked from here as each section is released. Nothing on this page links to a document that does not exist.
Getting Started
Platform concepts, the objects VEXO manages and how they relate.
- Concepts
- Architecture overview
- First host
- First VM
Installation
Preparing a host and bringing the control plane up.
- Requirements
- Host preparation
- Control plane
- Agent
VEXO Virtualize
Hosts, machines, allocation and the job model behind every action.
- Hosts
- Virtual machines
- Allocation
- Jobs
Networking
Virtual networks, interfaces and how a guest is attached to them.
- Virtual networks
- Interfaces
- Addressing
Storage
Virtual disks, images and snapshots.
- Virtual disks
- ISO & images
- Snapshots
VM Management
Lifecycle operations, console access and reconfiguration.
- Lifecycle
- Console
- Reconfiguration
Security
Identity, roles, sessions and the audit record.
- Authentication
- RBAC
- Sessions
- Audit
Backup
Protection policies, repositories and restore.
- Policies
- Repositories
- Restore
Monitoring
Host and machine signals, alerts and capacity.
- Host signals
- VM signals
- Alerts
- Capacity
Migration
Assessment, conversion, dry run and cutover.
- Assessment
- Conversion
- Dry run
- Cutover
API
The management API behind the console.
- Authentication
- Resources
- Jobs
- Errors
CLI
Scripted operation of the same management surface.
- Install
- Auth
- Commands
Troubleshooting
Diagnosing a failed job, an unreachable host or a machine that will not start.
- Failed jobs
- Host connectivity
- Boot problems
Release Notes
What changed in each platform release.
- Current release
- Previous releases
Documentation
Need an answer before the docs land?
Ask the team directly. An honest answer today beats a documentation page next quarter.