VirtRigaud Documentation
Welcome to the VirtRigaud documentation. VirtRigaud is a Kubernetes operator for managing virtual machines across multiple hypervisors including vSphere, Libvirt/KVM, and Proxmox VE.
Quick Navigation
Getting Started
- 15-Minute Quickstart - Get up and running quickly
- Installation Guide - Helm installation instructions
- Helm CRD Upgrades - Managing CRD updates
Core Documentation
- Custom Resource Definitions - Complete API reference
- Examples - Practical configuration examples
- Cloud-Init Configuration - UserData and MetaData guide
- Provider Documentation - Provider development guide
- Provider Capabilities Matrix - Feature comparison
Provider-Specific Guides
- vSphere Provider - VMware vCenter/ESXi integration
- Libvirt Provider - KVM/QEMU virtualization
- Proxmox VE Provider - Proxmox Virtual Environment
- Provider Tutorial - Build your own provider
- Provider Versioning - Version management
Advanced Features
- VM Lifecycle Management - Advanced VM operations
- VM Adoption - Onboard existing VMs into VirtRigaud
- Nested Virtualization - Run hypervisors in VMs
- Graceful Shutdown - Proper VM shutdown handling
- VM Snapshots - Backup and restore
- Remote Providers - Provider architecture
Operations & Administration
- Observability - Monitoring and metrics
- Security - Security best practices
- Resilience - High availability and fault tolerance
- Upgrade Guide - Version upgrade procedures
- vSphere Hardware Versions - Hardware compatibility
Security Configuration
API Reference
- CLI Tools Reference - Command-line interface guide
- CLI API Reference - Detailed CLI documentation
- Metrics Catalog - Available metrics
- Provider Catalog - Available providers
Development
- Testing Workflows Locally - Local CI/CD testing
- Contributing - Contribution guidelines
- Development Guide - Developer setup
Examples Directory
- Example README - Overview of all examples
- Complete Examples - Working configuration files
- Advanced Examples - Complex scenarios
- Security Examples - Security configurations
Version Information
This documentation covers VirtRigaud v0.2.3.
Recent Changes
- v0.2.3: Provider feature parity - Reconfigure, Clone, TaskStatus, ConsoleURL
- v0.2.2: Nested virtualization, TPM support, snapshot management
- v0.2.1: Critical fixes and documentation updates
- v0.2.0: Production-ready vSphere and Libvirt providers
See CHANGELOG.md for complete version history.
Provider Status
| Provider | Status | Maturity | Documentation |
|---|---|---|---|
| vSphere | Production Ready | Stable | Guide |
| Libvirt/KVM | Production Ready | Stable | Guide |
| Proxmox VE | Production Ready | Beta | Guide |
| Mock | Complete | Testing | PROVIDERS.md |
Support
- GitHub Issues: github.com/projectbeskar/virtrigaud/issues
- Discussions: github.com/projectbeskar/virtrigaud/discussions
- Slack: #virtrigaud on Kubernetes Slack
Quick Links
- Main README - Project overview
- CHANGELOG - Version history
- Contributing - How to contribute
- License - Apache License 2.0