hyper2kvm

Reference Documentation

Technical reference materials including API documentation, architecture, installation guides, and specifications.

Quick Navigation

📖 API Reference

🏗️ Architecture & Design

📦 Installation & Dependencies

🔌 Integrations

📋 Specifications & Schemas

🌐 Network & Resilience

Reference Categories

By Type

Type Documents Purpose
API 4 docs Complete API reference
Architecture 3 docs Design and patterns
Installation 3 docs Setup and dependencies
Integration 2 docs External integrations
Specifications 2 docs Schemas and contracts
Network 1 doc Network handling

By Audience

Audience Recommended Reading
Developers API Reference, Architecture, Integration Contract
Operators Installation, Dependencies, Failure Modes
Integrators Integration Contract, Manifest Workflow, HyperCtl Integration
Users Quick Reference, Dependencies

API Documentation

Complete API Reference

API Reference - Comprehensive API documentation covering:

Audience: Developers building with Hyper2KVM Complexity: ⭐⭐⭐ Advanced

VMCraft API (480+ Methods)

VMCraft API - Complete VMCraft guest manipulation API:

Audience: Advanced developers, custom fixers Complexity: ⭐⭐⭐ Advanced

Library API

Library API - Using Hyper2KVM as a Python library:

from hyper2kvm import Migration

# Create migration
migration = Migration(
    vmdk="/path/to/vm.vmdk",
    output_dir="/output/path"
)

# Execute
result = migration.run()

Audience: Python developers Complexity: ⭐⭐ Intermediate

Quick API Reference

Quick Reference - Essential API patterns and examples

Audience: All developers Complexity: ⭐ Easy

Architecture Documentation

System Architecture

Architecture - Complete system architecture covering:

Key Topics:

Audience: Architects, senior developers Complexity: ⭐⭐⭐ Advanced

Integration Contract

Integration Contract - Requirements for integrating with Hyper2KVM:

Audience: Integration developers Complexity: ⭐⭐⭐ Advanced

Failure Modes

Failure Modes - Comprehensive failure scenario documentation:

Audience: Operators, SREs Complexity: ⭐⭐ Intermediate

Installation & Dependencies

Installation Guide

Installation Guide - Fedora-specific installation:

Platform: Fedora, RHEL, CentOS Audience: System administrators Complexity: ⭐ Easy

See Also: General Installation Guide

Dependencies

Dependencies - Complete dependency documentation:

Required Dependencies:

Optional Dependencies:

Audience: System administrators, developers Complexity: ⭐ Easy

Optional Dependencies

Optional Dependencies - Detailed optional package guide:

Audience: System administrators Complexity: ⭐⭐ Intermediate

Integration Documentation

HyperCtl Integration

HyperCtl Integration - Integration with hyperctl/hypersdk:

Audience: Integration developers Complexity: ⭐⭐⭐ Advanced

Native GuestFS

Native GuestFS - libguestfs integration guide:

Audience: Advanced users Complexity: ⭐⭐⭐ Advanced

Specifications

Manifest Workflow

Manifest Workflow - Artifact manifest specification:

Example:

{
  "version": "1.0",
  "artifacts": [
    {
      "type": "disk",
      "path": "/output/vm.qcow2",
      "format": "qcow2"
    }
  ]
}

Audience: Integration developers Complexity: ⭐⭐ Intermediate

Artifact Manifest Schema

artifact-manifest-v1.0.schema.json - JSON Schema v1.0:

Usage:

# Validate manifest
jsonschema -i manifest.json artifact-manifest-v1.0.schema.json

Audience: Integration developers Complexity: ⭐⭐⭐ Advanced

Network & Resilience

Network Resilience

Network Resilience - Network failure handling:

Scenarios Covered:

Audience: Operators, developers Complexity: ⭐⭐ Intermediate

Quick References

Command Quick Reference

Quick Reference - Essential command patterns:

Audience: All users Complexity: ⭐ Easy

Reference by Use Case

For New Developers

Start Here:

  1. Quick Reference - Learn basic patterns
  2. Library API - Python library usage
  3. Architecture - Understand design

For Integration Work

Start Here:

  1. Integration Contract - Understand requirements
  2. API Reference - Complete API docs
  3. Manifest Workflow - Data formats

For System Administration

Start Here:

  1. Installation Guide - Install system
  2. Dependencies - Understand requirements
  3. Failure Modes - Handle errors

For Advanced Development

Start Here:

  1. VMCraft API - Deep filesystem access
  2. Architecture - System internals
  3. HyperCtl Integration - Advanced integration

Version Compatibility

API Versions

API Version Hyper2KVM Version Status
v1.0 1.0 - 2.1.0+ ✅ Current

Schema Versions

Schema Version Status
Artifact Manifest 1.0 ✅ Current
Migration Config 1.0 ✅ Current

Compatibility Matrix

Component Python libguestfs qemu-img
Core 3.10+ Optional 6.0+
VMCraft 3.10+ No 6.0+
Windows 3.10+ Optional 6.0+

Documentation Standards

API Documentation Format

All API documentation follows this structure:

  1. Overview - Purpose and use cases
  2. Parameters - Input parameters with types
  3. Returns - Return values and types
  4. Examples - Code examples
  5. Errors - Possible exceptions
  6. See Also - Related APIs

Code Examples

All code examples are:

Contributing to Reference Docs

Adding API Documentation

  1. Document all public APIs
  2. Include type hints
  3. Provide examples
  4. List exceptions
  5. Add to API reference index

Updating Specifications

  1. Version all schema changes
  2. Maintain backward compatibility
  3. Document breaking changes
  4. Provide migration guide

See: Contributing Guide

Before Reading Reference

While Using Reference

After Using Reference

External References

Standards & Specifications

What’s Next?

Choose your reference area:

📖 I need API documentation

→ Start with API Reference

🏗️ I need architecture details

→ Read Architecture

📦 I need installation help

→ See Installation Guide

🔌 I need integration info

→ Check Integration Contract

📋 I need specifications

→ Review Manifest Workflow

🔍 I need quick reference

→ Use Quick Reference

Last Updated: February 2026 API Version: v1.0 Schema Version: v1.0 Status: ✅ Production Ready

This site is open source. Improve this page.