hypersdk

HyperSDK Documentation

Complete documentation for HyperSDK - A multi-cloud VM migration framework with focus on vSphere to KVM migration.

📚 Documentation Navigation

Contact & security

• Security policy (repository root) — how to report vulnerabilities privately
• Maintainer: Susant Sahani (ssahani@gmail.com) — see Contributing for security reporting and maintainer topics

New Users Start Here

• Getting Started Guide - Install and run your first migration (includes dashboard!)
• Interactive Mode Guide - Learn the interactive TUI
• Dashboard README - Web dashboard usage and features

Dashboard Documentation

1. Dashboard README - Complete dashboard usage guide
2. Dashboard Implementation - Implementation details and features
3. Dashboard Testing Report - Comprehensive testing results (51+ endpoints)

User Guides

1. Interactive Mode - Complete guide to the TUI migration tool
2. VM Export Guide - Step-by-step export procedures
3. Integration Guide - Integrate HyperSDK into workflows

Feature Documentation

1. Interactive Migration Features - Interactive mode capabilities
2. Hyperctl Features - CLI command reference
3. Feature Reference - Comprehensive feature catalog

API & Reference

• API Endpoints - Complete API reference (51+ endpoints)
• API New Features - Phase 2 features documentation
• General API Documentation - API usage patterns
• Daemon API Reference - Legacy daemon API docs
• Examples - Configuration file examples
• Project Summary - Architecture overview

Testing & Development

• Test Results - Coverage and test reports
• Test API Script - Automated API testing (79 endpoints)
• Dashboard Endpoint Testing - Dashboard endpoint tests
• Demo Scripts - Live demonstrations
• Recording Guide - Creating demo videos

🗂️ Directory Structure

docs/
├── README.md                    # This file
├── 00-INDEX.md                  # Complete documentation index
│
├── user-guides/                 # Step-by-step tutorials
│   ├── 01-interactive-mode.md   # Interactive TUI guide
│   ├── 02-vm-export-guide.md    # VM export procedures
│   └── 03-integration.md        # Integration patterns
│
├── features/                    # Feature documentation
│   ├── 01-interactive-migration.md  # Interactive features
│   ├── 02-hyperctl-features.md      # CLI features
│   └── 03-feature-reference.md      # Complete feature list
│
└── api/                         # API references
    └── 01-daemon-api.md         # Daemon REST API

🚀 Quick Links

Most Common Tasks

• Access Web Dashboard - Browser-based UI
• View VM Consoles - VNC and Serial access
• List VMs from vCenter
• Migrate VMs interactively
• Export VMs via CLI
• Search and filter VMs
• API Reference - All 51+ endpoints

Configuration Examples

• Single VM export
• Batch VM export
• Daemon configuration

Dashboard Access

# Start daemon
./hypervisord

# Access dashboard
http://localhost:8080/web/dashboard/           # Main dashboard
http://localhost:8080/web/dashboard/vm-console.html  # Console viewer

📖 Reading Guide

For First-Time Users

1. Read Getting Started
2. Try Interactive Mode
3. Review Examples

For Developers

1. Read Project Summary
2. Review API Reference
3. Check Test Results

For DevOps Engineers

1. Read Integration Guide
2. Review Daemon API
3. Study Examples

🆘 Getting Help

• Documentation Index: See 00-INDEX.md for complete listing
• Issues: Report issues on GitHub
• Examples: Check examples/ directory

📝 Contributing to Documentation

When adding documentation:

1. Place in appropriate subdirectory (user-guides/, features/, api/)
2. Use numeric prefix for ordering (e.g., 04-new-guide.md)
3. Update this README and 00-INDEX.md
4. Follow existing documentation style
5. Include code examples where relevant

License

Documentation is licensed under LGPL-3.0-or-later.

This site is open source. Improve this page.