hyper2kvm

Deployment & Operations

This directory contains guides for deploying Hyper2KVM in various environments, from standalone installations to enterprise Kubernetes/OpenShift deployments.

Quick Links

🚀 Getting Started

Production Deployment Guide - Comprehensive production deployment
Deployment Quickref - Quick reference card
Deployment Status - Current deployment capabilities

☁️ Kubernetes & OpenShift

Kubernetes on CentOS 8 - Quick Start ⭐ - Deploy on CentOS 8 in 10 minutes
Kubernetes on CentOS 8 - Full Guide ⭐ - Complete CentOS 8 deployment guide
OpenShift Deployment Guide - Complete OpenShift Container Platform guide
OpenShift Quickstart - Get started on OpenShift in 5 minutes
OpenShift Features Summary - OpenShift-specific features
Kubernetes Integration - Native Kubernetes deployment
KubeVirt Integration - KubeVirt virtual machine support

🐳 Container Deployments

Container Deployment Guide - Docker/Podman deployment
K3d Test Report - K3d lightweight Kubernetes testing

🔄 Worker Protocol & API

Phase 4 Deployment - OfflineFixJob CRD and orchestration
Phase 6 REST API - Complete REST API documentation
Worker Protocol Summary - Worker protocol overview
Production Enhancements - Production-grade features

📦 Version History

Release Notes

Version Enhancements

v1.2.0 - Enhancements - Initial production features
v1.3.0 - CI/CD & Ops - CI/CD integration
v1.4.0 - Kubernetes Operator - Operator framework
v1.5.0 - Webhooks & Metrics - Admission webhooks, Prometheus metrics
v1.6.0 - Helm Chart - Official Helm charts
v1.7.0 - Helm Repository - Helm repository hosting
v1.8.0 - Operator HA - High availability features
v1.9.0 - Advanced Job Scheduling - DAG dependencies, priorities
v2.0.0 - Comprehensive Features - Complete feature set

Deployment Methods

Method 1: Helm Chart (Recommended for Kubernetes/OpenShift)

# Install on OpenShift
helm install hyper2kvm-operator ./helm/hyper2kvm-operator \
  --namespace hyper2kvm-system \
  --create-namespace \
  --set openshift.enabled=true

# Install on Kubernetes
helm install hyper2kvm-operator ./helm/hyper2kvm-operator \
  --namespace hyper2kvm-system \
  --create-namespace \
  --set openshift.enabled=false

Documentation: v1.6.0 Helm Chart

Method 2: OLM Bundle (OperatorHub)

# Install via operator-sdk
operator-sdk run bundle ghcr.io/ssahani/hyper2kvm-operator-bundle:v2.1.0 \
  --namespace hyper2kvm-system

# Or install from OperatorHub UI

Documentation: v1.4.0 Operator

Method 3: Container Deployment

# Run operator container
podman run -d --name hyper2kvm-operator \
  ghcr.io/ssahani/hyper2kvm:2.1.0-operator

# Run worker container
podman run -d --name hyper2kvm-worker \
  -v /data:/data \
  ghcr.io/ssahani/hyper2kvm:2.1.0-worker

Documentation: Container Deployment Guide

Method 4: Standalone Installation

# Install via pip
pip install "hyper2kvm[full]"

# Run migration
hyper2kvm --config migration.yaml

Documentation: Installation Guide

Architecture Overview

┌─────────────────────────────────────────────────────┐
│                OpenShift/Kubernetes                  │
│  ┌─────────────────┐         ┌──────────────────┐   │
│  │  Hyper2KVM      │────────▶│  Custom          │   │
│  │  Operator       │         │  Resources       │   │
│  │  (Kopf)         │◀────────│  (CRDs)          │   │
│  └─────────────────┘         └──────────────────┘   │
│         │                             │              │
│         │                             │              │
│         ▼                             ▼              │
│  ┌─────────────────┐         ┌──────────────────┐   │
│  │  Worker Pods    │────────▶│  Storage         │   │
│  │  (Migration)    │         │  (PVC/PV)        │   │
│  └─────────────────┘         └──────────────────┘   │
│         │                                            │
│         │                                            │
│         ▼                                            │
│  ┌─────────────────────────────────────────────┐    │
│  │         Prometheus/Grafana Metrics          │    │
│  └─────────────────────────────────────────────┘    │
└─────────────────────────────────────────────────────┘

Key Features by Deployment Method

Feature	Standalone	Container	Helm	OLM
VM Migration	✅	✅	✅	✅
Batch Processing	✅	✅	✅	✅
Worker Protocol	❌	✅	✅	✅
Kubernetes CRDs	❌	❌	✅	✅
Admission Webhooks	❌	❌	✅	✅
Prometheus Metrics	❌	✅	✅	✅
High Availability	❌	❌	✅	✅
Auto-scaling	❌	❌	✅	✅
OpenShift Routes	❌	❌	✅	✅
OLM Lifecycle	❌	❌	❌	✅

Platform Support

✅ OpenShift Container Platform 4.10-4.16
✅ Kubernetes 1.24-1.33
✅ K3s/K3d - Lightweight Kubernetes
✅ MicroShift - Edge computing
✅ Docker/Podman - Container runtime
✅ KubeVirt - Kubernetes virtualization

Getting Help

Issues: GitHub Issues
Documentation: Main Index
Troubleshooting: Troubleshooting Guide

Contributing

See Contributing Guide for development and deployment contributions.

This site is open source. Improve this page.