Zorvia documentation
Start here: root README.md (hero, gallery, quick start) · live site zyvorai.github.io/zyvor-zorvia.
Guides (moved from the root README)
| Doc | Topic |
|---|---|
| getting-started.md | Install, Helm, first VM, ports, health/login/audit examples |
| whats-inside.md | Why Zorvia and every capability, grouped by job |
| console-and-api.md | Web console routes, WebSocket endpoints, Fabric HTTP API |
| profiles-blueprints-templates.md | 8 profiles, 5 blueprints, 43 templates |
| day-2-ops.md | The everyday CLI loop |
| operator-toolkit.md | Drift, change plans, guest insight, golden images, Terraform, placement |
| platform-surface.md | Security, cost, tenancy, backup/DR, HA, automation, observability |
| config-and-library.md | VM config files and the Rust library |
| develop.md | The make-first dev loop |
| roadmap.md | Feature maturity and what is not shipped yet |
| leave-openshift.md | Zorvia vs OpenShift Virtualization vs Zorvia with commercial support, honestly |
| adopt-existing-kubevirt-cluster.md | Point Zorvia at an existing KubeVirt cluster, read-only first |
| PRICING.md | Launch pricing, billing rules and examples |
| SUPPORT_SCOPE.md | What paid support covers and excludes |
| COMMERCIAL_FAQ.md | Licensing, contracts and expiry questions |
| OPENSHIFT_COMPARISON.md | How to compare against OpenShift Virtualization Engine |
| COMMERCIAL_OFFERINGS.md | Offerings, quote → contract flow and API |
Core
| Doc | Topic |
|---|---|
| LAB.md | Remote deploy, auth Secret, NodePort 30152, lab-smoke.sh |
| WEB_CONSOLE.md | SPA, Fabric HTTP API, console/VNC/SSH/pod WebSockets, Disk Images, hotplug, migration, Rook, RBAC, audit export |
| PODS.md | Pods page: all-namespace inventory, Terminal.app logs + exec, WebSocket protocol, RBAC, audit |
| RESCUE.md | Rescue mode: offline hostname/SSH-key/enable-SSH via a Job-mounted disk, GuestKit, RBAC, audit |
| SUPPORT_MATRIX.md | Validated versions and measured E2E results; what is not validated |
| DEVICES.md | GPU / SR-IOV / host-device passthrough: create, preflight, inventory (Experimental) |
| KEY_PROVIDER.md | Encrypting TOTP secrets at rest (local key, Vault Transit), rotation, 2FA reset |
| TLS_ROTATION.md | Certificate hot reload (cert-manager, rotated Secrets) |
| GUEST_AGENT.md | In-guest agent (GuestKit / qemu-guest-agent): install at creation, freeze fix, read-only guest views, snapshot hooks, drill probe |
| MAINTENANCE.md | Pre-drain plan: what a node drain would do to each VM |
| HA.md | Supported control-plane topology (one replica, or two on PostgreSQL), failover behaviour, node-loss test |
| POSTGRES.md | PostgreSQL store: what moves (users, operations, audit, JSON documents), import from SQLite, limits (Beta) |
| TENANCY.md | Per-user namespace allow-lists |
| OFFCLUSTER_BACKUP.md | Encrypted, verified S3 backups, restore, recovery drills, retention (Atlas bucket target) |
| VM_IMPORT.md | VMware import with h2kvm: waves, preflight, rollback |
| ATLAS_INTEGRATION.md | Atlas storage control plane integration |
| OIDC.md | Opt-in OIDC SSO (PKCE + token exchange + JWKS) |
| OIDC_LAB.md | Lab IdP bake-off (Dex/Keycloak) |
| FEATURE_MATURITY.md | GA / Beta / Experimental / Model-only (GET /api/v1/features) |
| PHASE5_ENTERPRISE.md | Enterprise plan APIs (S3, Transiva, DR, GPU, fleet) |
| UPGRADE.md | 0.3.2 → 0.3.3+ operator notes |
| OS_TEMPLATES.md | 43 OS templates |
| INNOVATIVE_FEATURES.md | Profiles, blueprints, health, recommendations |
| THEME.md | CLI/TUI theme |
Day-2 ops
| Doc | Topic |
|---|---|
| SNAPSHOTS.md | Snapshot create/restore/retention |
| DISK_MANAGEMENT.md | Disks and volumes |
| NETWORK_MANAGEMENT.md | Networking |
| ADVANCED_FEATURES.md | Platform zorvia vm status + advanced CLI |
| GUEST_INSIGHT.md | QEMU Guest Agent readiness |
| GOLDEN_IMAGES.md | Golden images: Linux imports (containerdisks, CDI image-bundle), VM captures, Windows builds via Kryton |
Drift, plan & inventory
| Doc | Topic |
|---|---|
| DRIFT_GUARD.md | Semantic desired-vs-live drift (zorvia change drift) |
| CHANGE_PLANNER.md | Operational change plan (zorvia change plan) |
| VCENTER_FEATURE_MATRIX.md | Inventory, activity, maintenance, placement |
Integrations
| Doc | Topic |
|---|---|
| KRYTON_INTEGRATION.md | Windows via Kryton — Create VM wizard + /app/windows |
| ATLAS_INTEGRATION.md | Storage via Atlas — backend/RBD/object-store, DR, AI insights, governance, DataBridge |
| TERRAFORM.md | Terraform scaffold + Fabric API module |
TUI
| Doc | Topic |
|---|---|
| INTERACTIVE_TUI.md | Canonical interactive TUI guide |
| INTERACTIVE_TUI_README.md | Pointer → interactive TUI |
| TUI_FEATURES_DEMO.md | Demo walkthrough notes |
Presentations & social
| Doc | Topic |
|---|---|
| client-presentations/ | HTML decks for client demos |
| social/ | Share / OG card (1200×630) and LinkedIn/X card (1600×900) |
Also: QUICK_REFERENCE.md, DEVELOPMENT.md, CHANGELOG.md, CONTRIBUTING.md, SECURITY.md.
Lab at a glance
https://<HOST>:30152/ # UI (NodePort)
https://<HOST>:30152/api/v1/health
https://<HOST>:30152/api/v1/features
./scripts/deploy-remote.sh <host> sus --quick
ZORVIA_E2E_PASSWORD=… ./scripts/lab-smoke.sh
Full steps: LAB.md.