hypersdk

HyperSDK Documentation Index

Welcome to the HyperSDK documentation. This guide helps you navigate all available documentation.

Quick Start

• Getting Started - Quick start guide for new users
• Quickstart Guide - Fast-track setup and usage
• README - Project overview and introduction
• Docker Quick Start - Get running with Docker in 5 minutes
• Kubernetes Quick Start - Deploy to Kubernetes in 10 minutes
• K3d Quick Start - Local k3d cluster testing and development

Tutorials

Step-by-step tutorials for common tasks:

• Getting Started Tutorial - Your first VM export with Docker, Kubernetes, or Docker Compose
• Configuration Tutorial - Advanced configuration options for all deployment methods
• Multi-Cloud Setup - Configure and use multiple cloud providers simultaneously
• NFS Shared Storage - Deploy with NFS for cross-environment access (Kubernetes + Native Linux)

User Guides

Core Guides

1. Interactive Mode User Guide - Complete guide to the interactive TUI for VM migration
2. VM Export Guide - Step-by-step VM export procedures
3. Integration Guide - Integrating HyperSDK into your workflow
4. Manifest Integration with hyper2kvm - Artifact Manifest examples and integration patterns

Deployment & Configuration

• Deployment Guide - Production deployment guidelines
• Upstream Kubernetes Guide - GKE, EKS, AKS, vanilla K8s deployment
• Helm Chart - Official Helm chart for Kubernetes
• Docker/Podman Deployment - Container deployment with Docker Compose
• Kubernetes Deployment - Kubernetes with Kustomize (dev/staging/prod)
• Systemd Integration - Native Linux systemd service
• Multi-Cloud Guide - Multi-cloud migration workflows

Cloud Provider Integrations

• Cloud Providers Overview - All supported cloud platforms
• Alibaba Cloud - Alibaba Cloud integration
• AWS Migration - Amazon Web Services migration
• Oracle Cloud (OCI) - Oracle Cloud Infrastructure
• OpenStack - OpenStack cloud platform
• Proxmox VE - Proxmox Virtual Environment

Feature Documentation

1. Interactive Migration Features - Detailed interactive migration features
2. Hyperctl Features - Command-line interface features
3. Feature Reference - Comprehensive feature catalog
4. Features Complete - Complete feature documentation
5. Hyperexport Features - Hyperexport-specific features
   • Export resumption, bandwidth throttling, TUI guides, and more

Reference Documentation

Technical References

• Reference Documentation - Complete technical reference
  • CLI Reference - Command-line interface
  • Configuration Reference - Config file options
  • Performance Tuning - Optimization guide
  • Troubleshooting Guide - Problem solving

Architecture & API

• API Documentation - Complete API reference
  • API Overview - API introduction and architecture
  • Daemon API - REST API reference
  • API Endpoints - Endpoint reference
  • New Features - Recent API additions
• Architecture Documentation - System architecture and design
  • NFS Deployment Architecture - Complete NFS architecture with diagrams
• Project Summary - High-level architecture overview

Examples

• Examples Index - Configuration file examples
• Demo Scripts - Live demonstration scripts

Testing & Development

Testing Documentation

• Testing Overview - Test structure and organization
• Testing Guide - Practical testing guide with examples
• Test Results - Test coverage and results
• Bug Fixes and Tests - Bug fixes and test cases
• Dashboard Testing - Web dashboard testing guide
• Hyperexport Testing - Hyperexport test guide
• Hyperexport Quick Test - Quick test procedures
• Recording Guide - Creating demo recordings

Integration Guides

• Daemon Integration - Daemon integration complete guide
• Systemd Daemon - Systemd service integration
• Pipeline Integration - CI/CD pipeline integration

Development Notes

• Code Review - Code review documentation
• Code Review Detailed - Detailed code review
• Code Review Report - Code review report
• Code Review Summary - Code review summary
• Implementation Summary - Implementation notes
• Final Changes Summary - Final changes
• Task 15 Completion - Task completion notes
• TUI Crash Fix - TUI crash fix documentation
• Web UX Integration - Web UX integration summary
• Hyperexport Development - Hyperexport dev notes
  • Implementation details, roadmaps, and enhancement tracking

Project Organization

• Directory Organization - Repository structure and organization guidelines
• Roadmap - Future features and development plans
• New Features - Recent feature additions and changes

Documentation Structure

hypersdk/
├── README.md                   # Project overview
├── CHANGELOG.md               # Version history
├── SECURITY.md                # Security policy
├── docs/
│   ├── 00-INDEX.md            # This file
│   ├── getting-started.md     # Quick start guide
│   ├── quickstart-guide.md    # Fast-track setup
│   ├── deployment-guide.md    # Deployment guide
│   ├── multi-cloud-guide.md   # Multi-cloud workflows
│   ├── project-summary.md     # Architecture overview
│   ├── test-results.md        # Test coverage and results
│   ├── tutorials/             # Step-by-step tutorials
│   │   ├── getting-started.md  # First VM export tutorial
│   │   ├── configuration.md    # Configuration tutorial
│   │   ├── multi-cloud-setup.md # Multi-cloud setup tutorial
│   │   └── nfs-shared-storage.md # NFS shared storage setup
│   ├── user-guides/           # Step-by-step guides
│   │   ├── 01-interactive-mode.md
│   │   ├── 02-vm-export-guide.md
│   │   ├── 03-integration.md
│   │   └── 04-manifest-integration.md
│   ├── features/              # Feature documentation
│   │   ├── 01-interactive-migration.md
│   │   ├── 02-hyperctl-features.md
│   │   ├── 03-feature-reference.md
│   │   ├── features-complete.md
│   │   └── hyperexport/       # Hyperexport features
│   │       ├── README.md
│   │       ├── user-guide.md
│   │       ├── keyboard-shortcuts.md
│   │       └── ...
│   ├── cloud-providers/       # Cloud provider integrations
│   │   ├── README.md
│   │   ├── alibabacloud-integration.md
│   │   ├── aws-migration-guide.md
│   │   ├── oci-integration.md
│   │   ├── openstack-integration.md
│   │   └── proxmox-integration.md
│   ├── architecture/          # Architecture documentation
│   │   └── nfs-deployment-architecture.md # NFS deployment architecture
│   ├── api/                   # API references
│   │   ├── README.md
│   │   ├── 00-overview.md
│   │   ├── 01-daemon-api.md
│   │   ├── 02-endpoints.md
│   │   └── 03-new-features.md
│   ├── reference/             # Technical references
│   │   ├── README.md
│   │   ├── cli-reference.md
│   │   ├── configuration-reference.md
│   │   ├── performance-tuning.md
│   │   └── troubleshooting-guide.md
│   ├── testing/               # Testing documentation
│   │   ├── README.md
│   │   ├── 00-testing-overview.md
│   │   ├── testing-guide.md
│   │   ├── bug-fixes-and-tests.md
│   │   ├── dashboard-testing.md
│   │   ├── hyperexport-testing.md
│   │   └── hyperexport-quicktest.md
│   ├── integration/           # Integration guides
│   │   ├── daemon-integration.md
│   │   ├── systemd-daemon.md
│   │   └── pipeline-integration.md
│   └── development/           # Development notes
│       ├── CODE_REVIEW.md
│       ├── IMPLEMENTATION_SUMMARY.md
│       ├── hyperexport/       # Hyperexport dev notes
│       │   ├── README.md
│       │   ├── implementation-summary.md
│       │   └── ...
│       └── ...
├── examples/                  # Configuration examples
│   ├── README.md
│   ├── docker-quickstart.md    # Docker quick start guide
│   ├── kubernetes-quickstart.md # Kubernetes quick start guide
│   ├── example-vm-export.yaml
│   ├── example-vm-export.json
│   ├── example-batch-export.yaml
│   └── example-batch-export.json
└── demos/                     # Demo scripts
    ├── README.md
    ├── quick-demo.sh
    └── RECORDING-GUIDE.md

Contributing

When adding new documentation:

1. Place tutorials in docs/tutorials/ (step-by-step guides with examples)
2. Place user guides in docs/user-guides/ with numeric prefix (e.g., 05-new-guide.md)
3. Place feature docs in docs/features/ with numeric prefix
4. Place API docs in docs/api/ with numeric prefix
5. Place cloud provider integrations in docs/cloud-providers/
6. Place testing docs in docs/testing/
7. Place integration guides in docs/integration/
8. Place development notes in docs/development/
9. Place quick start examples in examples/ (e.g., docker-quickstart.md)
10. Update this index file to include the new document
11. Follow the existing documentation style and format

License

All documentation is licensed under LGPL-3.0-or-later.

This site is open source. Improve this page.