Skip to content

docs: document supported guest OS flavors in README #47

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tjjh89017 merged 1 commit into from
Aug 18, 2026
Merged

docs: document supported guest OS flavors in README #47

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 12 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

A Kubernetes Operator that manages the virtual router configuration running on KubeVirt, Proxmox VE, or bare-metal via the vrouter-daemon gRPC agent. Configuration is delivered via QEMU Guest Agent (QGA) over a virtio channel or gRPC - no network reachability or sidecar injection required.

vRouter-Operator is a community project for managing virtual routers across Kubernetes/KubeVirt, Proxmox VE, and bare-metal deployments.
vRouter-Operator is a community project for managing virtual routers across Kubernetes/KubeVirt, Proxmox VE, and bare-metal deployments. Supported guest OSes are [VyOS](https://vyos.io/) and [DozenOS](https://dozenos.github.io/dozenos-nightly-build/) — see [Guest OS Support](#guest-os-support).

## Demo

Expand Down Expand Up @@ -505,6 +505,17 @@ kubectl wait vrc/<name> --for=condition=Applied --timeout=120s

---

## Guest OS Support

| Guest OS | `/etc/os-release` ID | Router service unit | Notes |
|----------|---------------------|---------------------|-------|
| [VyOS](https://vyos.io/) | `vyos` | `vyos-router.service` | Validated on Harvester and Proxmox VE |
| [DozenOS](https://dozenos.github.io/dozenos-nightly-build/) | `dozenos` | `dozenos-router.service` | Community 1:1 rebuild of VyOS rolling with freely downloadable nightly images; used by the CI e2e suite |

The KubeVirt provider auto-detects the guest flavor by reading `/etc/os-release` over QGA and resolves the router service unit from its `ID` field; an unknown ID fails loudly instead of guessing. Both flavors share the same vbash/commit semantics, so templates and bindings work unchanged on either.

---

## Provider Support

| Provider | Status | Notes |
Expand Down