[PATCH] bhyve: add basic documentation

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



---
 docs/drivers.html.in  |  1 +
 docs/drvbhyve.html.in | 83 +++++++++++++++++++++++++++++++++++++++++++++++++++
 docs/index.html.in    |  3 ++
 docs/sitemap.html.in  |  4 +++
 src/README            |  1 +
 5 files changed, 92 insertions(+)
 create mode 100644 docs/drvbhyve.html.in

diff --git a/docs/drivers.html.in b/docs/drivers.html.in
index 7aa44f3..a1d4240 100644
--- a/docs/drivers.html.in
+++ b/docs/drivers.html.in
@@ -33,6 +33,7 @@
       <li><strong><a href="drvhyperv.html">Microsoft Hyper-V</a></strong></li>
       <li><strong><a href="drvphyp.html">IBM PowerVM (phyp)</a></strong></li>
       <li><strong><a href="drvparallels.html">Parallels</a></strong></li>
+      <li><strong><a href="drvbhyve.html">Bhyve</a></strong> - The BSD Hypervisor</li>
     </ul>
 
     <h2><a name="storage">Storage drivers</a></h2>
diff --git a/docs/drvbhyve.html.in b/docs/drvbhyve.html.in
new file mode 100644
index 0000000..5733cc2
--- /dev/null
+++ b/docs/drvbhyve.html.in
@@ -0,0 +1,83 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd";>
+<html xmlns="http://www.w3.org/1999/xhtml";>
+  <body>
+    <h1>Bhyve driver</h1>
+
+    <ul id="toc"></ul>
+
+<p>
+Bhyve is a FreeBSD hypervisor. It first appeared in FreeBSD 10.0. However, it's
+recommended to keep tracking FreeBSD 10-STABLE to make sure all new features
+of bhyve are supported.
+
+In order to enable bhyve on your FreeBSD host, you'll need to load <code>vmm</code>
+kernel module. Additionally, <code>if_tap</code> and <code>if_bridge</code> modules
+should be loaded for networking support.
+</p>
+
+<p>
+Additional information on bhyve could be obtained on <a href="http://bhyve.org/";>bhyve.org</a>.
+</p>
+
+<h2><a name="uri">Connections to the Bhyve driver</a></h2>
+<p>
+The libvirt bhyve driver is a single-instance privileged driver. Some sample
+connection URIs are:
+</p>
+
+<pre>
+bhyve:///system                     (local access)
+bhyve+unix:///system                (local access)
+bhyve+ssh://root@xxxxxxxxxxx/system (remote access, SSH tunnelled)
+</pre>
+
+<h2><a name="exconfig">Example guest domain XML configurations</a></h2>
+
+<h3>Example config</h3>
+<p>
+Bhyve driver in libvirt is in its early stage and under active development. So it supports
+only limited number of features bhyve provides. All the supported features could be found
+in this sample domain XML.
+</p>
+
+<p>
+A limitation that is not obvious from this sample domain XML is that currently it's only
+single network and single disk device are supported for each domain (as PCI slot allocation code
+in libvirt bhyve driver yet to be implemented).
+</p>
+
+<pre>
+&lt;domain type='bhyve'&gt;
+  &lt;name&gt;bhyve&lt;/name&gt;
+  &lt;uuid&gt;df3be7e7-a104-11e3-aeb0-50e5492bd3dc&lt;/uuid&gt;
+    &lt;memory&gt;219136&lt;/memory&gt;
+    &lt;currentMemory&gt;219136&lt;/currentMemory&gt;
+    &lt;vcpu&gt;1&lt;/vcpu&gt;
+    &lt;os&gt;
+       &lt;type&gt;hvm&lt;/type&gt;
+    &lt;/os&gt;
+    &lt;features&gt;
+      &lt;apic/&gt;
+      &lt;acpi/&gt;
+    &lt;/features&gt;
+    &lt;clock offset='utc'/&gt;
+    &lt;on_poweroff&gt;destroy&lt;/on_poweroff&gt;
+    &lt;on_reboot&gt;restart&lt;/on_reboot&gt;
+    &lt;on_crash&gt;destroy&lt;/on_crash&gt;
+    &lt;devices&gt;
+      &lt;disk type='file'&gt;
+        &lt;driver name='file' type='raw'/&gt;
+        &lt;source file='/path/to/bhyve_freebsd.img'/&gt;
+        &lt;target dev='hda' bus='sata'/&gt;
+      &lt;/disk&gt;
+      &lt;interface type='bridge'&gt;
+        &lt;model type='virtio'/&gt;
+        &lt;source bridge="virbr0"/&gt;
+      &lt;/interface&gt;
+    &lt;/devices&gt;
+&lt;/domain&gt;
+</pre>
+
+  </body>
+</html>
diff --git a/docs/index.html.in b/docs/index.html.in
index 16bd6d5..c94f444 100644
--- a/docs/index.html.in
+++ b/docs/index.html.in
@@ -75,6 +75,9 @@
         The <a href="http://libvirt.org/drvparallels.html";>Parallels</a> hypervisor
       </li>
       <li>
+        The <a href="http://libvirt.org/drvbhyve.html";>Bhyve</a> hypervisor
+      </li>
+      <li>
         Virtual networks using bridging, NAT, VEPA and VN-LINK.
       </li>
       <li>
diff --git a/docs/sitemap.html.in b/docs/sitemap.html.in
index 7d0610b..78e84e3 100644
--- a/docs/sitemap.html.in
+++ b/docs/sitemap.html.in
@@ -248,6 +248,10 @@
                 <a href="drvparallels.html">Parallels</a>
                 <span>Driver for Parallels Cloud Server</span>
               </li>
+              <li>
+                <a href="drvbhyve.html">Bhyve</a>
+                <span>Driver for bhyve</span>
+              </li>
             </ul>
           </li>
           <li>
diff --git a/src/README b/src/README
index 00d11d1..bb3cddf 100644
--- a/src/README
+++ b/src/README
@@ -25,6 +25,7 @@ There are two core shared modules to be aware of:
 
 Then there are the hypervisor implementations:
 
+ * bhyve         - bhyve - The BSD Hypervisor
  * esx/          - VMware ESX and GSX support using vSphere API over SOAP
  * hyperv/       - Microsoft Hyper-V support using WinRM
  * lxc/          - Linux Native Containers
-- 
1.8.4.2

--
libvir-list mailing list
libvir-list@xxxxxxxxxx
https://www.redhat.com/mailman/listinfo/libvir-list




[Index of Archives]     [Virt Tools]     [Libvirt Users]     [Lib OS Info]     [Fedora Users]     [Fedora Desktop]     [Fedora SELinux]     [Big List of Linux Books]     [Yosemite News]     [KDE Users]     [Fedora Tools]