]> git.ipfire.org Git - thirdparty/libvirt.git/commitdiff
docs: Document supported URIs for CH driver
authorMichal Privoznik <mprivozn@redhat.com>
Fri, 31 Oct 2025 09:39:05 +0000 (10:39 +0100)
committerMichal Privoznik <mprivozn@redhat.com>
Fri, 31 Oct 2025 12:14:02 +0000 (13:14 +0100)
Our docs suggest that only session mode is supported for CH
drvier. Well, that's clearly not case. Document the system URI
and refer to other (remote) supported transport modes (yeah, that
works too).

Signed-off-by: Michal Privoznik <mprivozn@redhat.com>
Reviewed-by: Jiri Denemark <jdenemar@redhat.com>
docs/drvch.rst

index bb13599e6fe657be51944caa806af6b251693bca..b8c48a775bb33333ae7f436ed19660bf3ef10702 100644 (file)
@@ -12,13 +12,20 @@ customers inside a cloud provider. For our purposes this means modern
 operating systems with most I/O handled by paravirtualised devices
 (i.e. virtio), no requirement for legacy devices, and 64-bit CPUs.
 
-The libvirt Cloud Hypervisor driver is intended to be run as a session
-driver without privileges. The cloud-hypervisor binary itself should be
-``setcap cap_net_admin+ep`` (in order to create tap interfaces).
+The libvirt Cloud Hypervisor (CH) driver is intended to be run as a
+session driver without privileges. The cloud-hypervisor binary itself
+should be ``setcap cap_net_admin+ep`` (in order to create tap
+interfaces). Though, system-wide connection URI is also supported.
 
 Expected connection URI would be
 
-``ch:///session``
+::
+
+  ch:///session         (local access to per-user instance)
+  ch:///system          (local access to system instance)
+
+But all other transport modes are supported too
+(see `documentation <uri.html#remote-uris>`__).
 
 
 Example guest domain XML configurations