[PATCH] docs: bhyve: document sound device and VNC bits

Roman Bogorodskiy posted 1 patch 3 years, 7 months ago
Test syntax-check failed
Patches applied successfully (tree, apply log)
git fetch https://github.com/patchew-project/libvirt tags/patchew/20200924161828.15010-1-bogorodskiy@gmail.com
docs/drvbhyve.html.in | 47 +++++++++++++++++++++++++++++++++++++++++++
1 file changed, 47 insertions(+)
[PATCH] docs: bhyve: document sound device and VNC bits
Posted by Roman Bogorodskiy 3 years, 7 months ago
 * Document sound device support,
 * Document VNC password configuration and framebuffer resolution.

Signed-off-by: Roman Bogorodskiy <bogorodskiy@gmail.com>
---
 docs/drvbhyve.html.in | 47 +++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 47 insertions(+)

diff --git a/docs/drvbhyve.html.in b/docs/drvbhyve.html.in
index ca511eeccd..cffb63f1ad 100644
--- a/docs/drvbhyve.html.in
+++ b/docs/drvbhyve.html.in
@@ -389,6 +389,30 @@ it with the <code>port</code> attribute):</p>
     &lt;graphics type='vnc' autoport='yes'&gt;
 </pre>
 
+<p><span class="since">Since 6.8.0</span>, it's possible to set framebuffer resolution
+using the <code>resolution</code> sub-element:</p>
+
+<pre>
+   &lt;video&gt;
+     &lt;model type='gop' heads='1' primary='yes'&gt;
+       &lt;resolution x='800' y='600'/&gt;
+     &lt;/model&gt;
+   &lt;/video&gt;
+</pre>
+
+<p><span class="since">Since 6.8.0</span>, VNC server can be configured to use
+password based authentication:</p>
+
+<pre>
+  &lt;graphics type='vnc' port='5904' passwd='foobar'&gt;
+    &lt;listen type='address' address='127.0.0.1'/&gt;
+  &lt;/graphics&gt;
+</pre>
+
+<p>Note: VNC password authentication is known to be cryptographically weak.
+Additionally, the password is passed as a command line argument in clear text.
+Make sure you understand the risks associated with this feature before using it.</p>
+
 <h3><a id="clockconfig">Clock configuration</a></h3>
 
 <p>Originally bhyve supported only localtime for RTC. Support for UTC time was introduced in
@@ -432,6 +456,29 @@ supports Intel e1000 network adapter emulation. It's supported in libvirt
 ...
 </pre>
 
+<h3><a id="sound">Sound device</a></h3>
+
+<p>As of <a href="https://svnweb.freebsd.org/changeset/base/349355">r349355</a> bhyve
+supports sound device emulation. It's supported in libvirt
+<span class="since">since 6.7.0</span>.</p>
+
+<pre>
+...
+  &lt;sound model='ich7'&gt;
+    &lt;audio id='1'/&gt;
+  &lt;/sound&gt;
+  &lt;audio id='1' type='oss'&gt;
+    &lt;input dev='/dev/dsp0'/&gt;
+    &lt;output dev='/dev/dsp0'/&gt;
+  &lt;/audio&gt;
+...
+</pre>
+
+<p>Here, the <code>sound</code> element specifies the sound device as it's exposed
+to the guest, with <code>ich7</code> being the only supported model now,
+and the <code>audio</code> element specifies how the guest device is mapped
+to the host sound device.</p>
+
 <h3><a id="wired">Wiring guest memory</a></h3>
 
 <p><span class="since">Since 4.4.0</span>, it's possible to specify that guest memory should
-- 
2.27.0

Re: [PATCH] docs: bhyve: document sound device and VNC bits
Posted by Andrea Bolognani 3 years, 6 months ago
On Thu, 2020-09-24 at 20:18 +0400, Roman Bogorodskiy wrote:
> +<p>Note: VNC password authentication is known to be cryptographically weak.
> +Additionally, the password is passed as a command line argument in clear text.
> +Make sure you understand the risks associated with this feature before using it.</p>

Great warning :)

> +<h3><a id="sound">Sound device</a></h3>
> +
> +<p>As of <a href="https://svnweb.freebsd.org/changeset/base/349355">r349355</a> bhyve
> +supports sound device emulation.

Is this changeset part of any FreeBSD release yet? If so, I would use
its version number here; if not, at least clarify it by saying "as of
[FreeBSD changeset r349355]" or something like that.

With the link text tweaked,

  Reviewed-by: Andrea Bolognani <abologna@redhat.com>

-- 
Andrea Bolognani / Red Hat / Virtualization

Re: [PATCH] docs: bhyve: document sound device and VNC bits
Posted by Roman Bogorodskiy 3 years, 6 months ago
  Andrea Bolognani wrote:

> On Thu, 2020-09-24 at 20:18 +0400, Roman Bogorodskiy wrote:
> > +<p>Note: VNC password authentication is known to be cryptographically weak.
> > +Additionally, the password is passed as a command line argument in clear text.
> > +Make sure you understand the risks associated with this feature before using it.</p>
> 
> Great warning :)
> 
> > +<h3><a id="sound">Sound device</a></h3>
> > +
> > +<p>As of <a href="https://svnweb.freebsd.org/changeset/base/349355">r349355</a> bhyve
> > +supports sound device emulation.
> 
> Is this changeset part of any FreeBSD release yet? If so, I would use
> its version number here; if not, at least clarify it by saying "as of
> [FreeBSD changeset r349355]" or something like that.

It's not part of any released version. It'll be available with FreeBSD
13.0-RELEASE, which is planned to be released next year.

> With the link text tweaked,
> 
>   Reviewed-by: Andrea Bolognani <abologna@redhat.com>

Thanks.
I'll fix this link and will push the change as it should be safe for the
freeze.

Also, this document has a number of other similarly formatted links.
I'll update those in a separate patch, along with some other nits I
noticed.

> -- 
> Andrea Bolognani / Red Hat / Virtualization
> 

Roman Bogorodskiy
Re: [PATCH] docs: bhyve: document sound device and VNC bits
Posted by Andrea Bolognani 3 years, 6 months ago
On Tue, 2020-09-29 at 18:52 +0400, Roman Bogorodskiy wrote:
> I'll fix this link and will push the change as it should be safe for the
> freeze.
> 
> Also, this document has a number of other similarly formatted links.
> I'll update those in a separate patch, along with some other nits I
> noticed.

Sounds good!

-- 
Andrea Bolognani / Red Hat / Virtualization