From: Roman Bogorodskiy <bogorodskiy@gmail.com>
Date: Sat, 2 May 2026 11:42:18 +0000 (+0200)
Subject: docs: bhyve: document virtio-console and blkiotune
X-Git-Tag: v12.4.0-rc1~147
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=4f96feef86b76b2c007757b602c75cb6eee51242;p=thirdparty%2Flibvirt.git

docs: bhyve: document virtio-console and blkiotune

Add sections describing usage of the virtio-console device
and about block I/O tuning.

Signed-off-by: Roman Bogorodskiy <bogorodskiy@gmail.com>
Reviewed-by: Peter Krempa <pkrempa@redhat.com>
---

diff --git a/docs/drvbhyve.rst b/docs/drvbhyve.rst
index e9eceb8740..79418537df 100644
--- a/docs/drvbhyve.rst
+++ b/docs/drvbhyve.rst
@@ -819,6 +819,44 @@ Example:
 Every NUMA domain must have `memory` and `cpus` specified.
 Bhyve allows configuring up to 8 NUMA domains.
 
+Virtio-console device
+~~~~~~~~~~~~~~~~~~~~~
+
+:since:`Since 12.4.0`, it is possible to use the virtio console device.
+Example::
+
+  <devices>
+    <channel type='unix'>
+      <source mode='bind' path='/var/run/libvirt/bhyve/bhyve.agent'/>
+      <target type='virtio' name='org.qemu.guest_agent.0'/>
+      <address type='virtio-serial' controller='0' bus='0' port='1'/>
+    </channel>
+  </devices>
+
+Bhyve supports up to 16 ports per console.
+
+Block I/O Tuning
+~~~~~~~~~~~~~~~~
+:since:`Since 12.3.0`, it is possible to tune domain I/O.
+This works on top of the
+`rctl(4) <https://man.freebsd.org/cgi/man.cgi?query=rctl&sektion=4>`__
+framework.
+Sample configuration::
+
+  <blkiotune>
+    <device>
+      <path>*</path>
+      <read_iops_sec>20000</read_iops_sec>
+      <write_iops_sec>20000</write_iops_sec>
+      <read_bytes_sec>10000</read_bytes_sec>
+      <write_bytes_sec>10000</write_bytes_sec>
+    </device>
+  </blkiotune>
+
+The ``*`` path here means that the limits are applied to the domain
+as a whole. Currently, it is not possible to apply limits to the
+individual devices of the domain.
+
 Guest-specific considerations
 -----------------------------