Skip to main content

GuestKit documentation

GuestKit — offline VM intelligence and migration assurance

Published at zyvorai.github.io/guestkit. The docs home has the product tour and a map of this folder.

Operator cheat sheets (cutover cookbook, day-0/rescue, Passport, env vars): GitHub Wiki.

Start here​

GuideDescription
Getting startedBuild, install, first commands
CLI referenceCommand index → topic guides & guestkit --help
Quick referenceCheat sheet
Dump virshReplace virsh qemu-agent-command with guestkit qga
FAQCommon questions
TroubleshootingFixes for common issues

Features​

GuideDescription
TUI dashboardTwo-tier tabs, Assurance (doctor/migrate-plan), fix-plan preview — zyvor.dev/guestkit
Web Image VaultOSS zyvor-ui: inventory tabs, Assurance, Profiles, Files browse
File explorerguestkit explore (+ web Browse files)
Interactive shellREPL mode
Security profilesSecurity, compliance, migration profiles
Migration assuranceDoctor, migrate-plan, fleet, policy, forensic diff
QEMU / VirtIO runtimeAssured `guestkit-qemu plan
VM lifecycleLab guestkit vm; production run/network/TTL → FluxVM
Industry use casesReal-world scenarios, PM/TA view, Zyvor product stack
Fix plansOffline patch workflow
Export formatsJSON, YAML, HTML, PDF
Python bindingspip install zyvor-guestkit (v1.2.5). Import stays guestkit. Includes inject_json and live-fix helpers.
h2kvm integrationConvert/deploy pipeline with h2kvm
Handoff / quarantinePassport → h2kvmctl job, fleet quarantine, virtctl plugin
VM migrationEnd-to-end migration handoff
KubeVirt + Zeus OSIn-cluster boot inspect API (pure Rust, not legacy appliance tooling)
Replace virtctl guestfsvirtctl-guestkit guestfs on a PVC — GuestKit, not libguestfs
Guest agentIn-guest agent + host guestkit qga / agent-call
Guest Control FabricTransport ladder, airgap QGA install, Agent Doctor, capability contract
Dump virshCommand map: QGA / inspect / doctor replace virsh; lifecycle stays virtctl/Machina
img / firstboot / virtio-winqemu-img wrapper, domain disk parse, virtio-win plan, first-boot gate
Rescue / SBOM CIRescue dry-run Action, sbom-diff, forensic-diff SBOM attach
Cloud profiles / RegoAWS/Azure/GCP/OpenStack policy packs + policy rego
Cloud-init datasourceOffline Ec2/Azure/GCE/NoCloud pin + seed
Cutover bundlegate + sysprep/SELinux/BitLocker + cloud-profile/rego + virtctl resolve
SELinux / sysprep / BitLockerOffline relabel, Windows generalize prep, recovery-key escrow

Deployment​

GuideDescription
DevOps runbooksPassport CI gate, repair worker, air-gap packages, fleet, cutover weekend, triage
Run from GHCRPull ghcr.io/zyvorai/* images, docker compose up, or Helm
DockerContainer usage (web stack + CLI)
Cloud disk sourcesS3 / GCS / Azure URI pulls + cache + CI recipe
Remote deploySSH deploy to Linux hosts + web console access
RPM buildFedora/RHEL packages

Architecture & project​

GuideDescription
ArchitectureHow GuestKit is structured
RoadmapShipped Unreleased slices; issue-driven next work
ChangelogVersion history
ContributingHow to contribute

Zyvor / Enterprise​

GuideDescription
Open source vs EnterpriseOSS engine vs GuestKit Enterprise control plane
Enterprise guideSales, SLAs, full HyperSDK suite

Examples​

See examples/ in the repository root.