From e2d85e6fa17b55a10cb60bfdb68f04f0cb55ec05 Mon Sep 17 00:00:00 2001 From: Roman Bogorodskiy Date: Sat, 1 Mar 2014 13:04:56 +0400 Subject: [PATCH] bhyve: add basic documentation --- 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 7aa44f3b8e..a1d42407ee 100644 --- a/docs/drivers.html.in +++ b/docs/drivers.html.in @@ -33,6 +33,7 @@
  • Microsoft Hyper-V
  • IBM PowerVM (phyp)
  • Parallels
  • +
  • Bhyve - The BSD Hypervisor
  • Storage drivers

    diff --git a/docs/drvbhyve.html.in b/docs/drvbhyve.html.in new file mode 100644 index 0000000000..60eee85bf7 --- /dev/null +++ b/docs/drvbhyve.html.in @@ -0,0 +1,83 @@ + + + + +

    Bhyve driver

    + + + +

    +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 the vmm +kernel module. Additionally, if_tap and if_bridge modules +should be loaded for networking support. +

    + +

    +Additional information on bhyve could be obtained on bhyve.org. +

    + +

    Connections to the Bhyve driver

    +

    +The libvirt bhyve driver is a single-instance privileged driver. Some sample +connection URIs are: +

    + +
    +bhyve:///system                     (local access)
    +bhyve+unix:///system                (local access)
    +bhyve+ssh://root@example.com/system (remote access, SSH tunnelled)
    +
    + +

    Example guest domain XML configurations

    + +

    Example config

    +

    +The 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. +

    + +

    +A limitation that is not obvious from this sample domain XML is that currently only a +single network and a single disk device are supported for each domain (as PCI slot allocation code +in libvirt bhyve driver is yet to be implemented). +

    + +
    +<domain type='bhyve'>
    +  <name>bhyve</name>
    +  <uuid>df3be7e7-a104-11e3-aeb0-50e5492bd3dc</uuid>
    +    <memory>219136</memory>
    +    <currentMemory>219136</currentMemory>
    +    <vcpu>1</vcpu>
    +    <os>
    +       <type>hvm</type>
    +    </os>
    +    <features>
    +      <apic/>
    +      <acpi/>
    +    </features>
    +    <clock offset='utc'/>
    +    <on_poweroff>destroy</on_poweroff>
    +    <on_reboot>restart</on_reboot>
    +    <on_crash>destroy</on_crash>
    +    <devices>
    +      <disk type='file'>
    +        <driver name='file' type='raw'/>
    +        <source file='/path/to/bhyve_freebsd.img'/>
    +        <target dev='hda' bus='sata'/>
    +      </disk>
    +      <interface type='bridge'>
    +        <model type='virtio'/>
    +        <source bridge="virbr0"/>
    +      </interface>
    +    </devices>
    +</domain>
    +
    + + + diff --git a/docs/index.html.in b/docs/index.html.in index 16bd6d5af6..c94f4444b0 100644 --- a/docs/index.html.in +++ b/docs/index.html.in @@ -74,6 +74,9 @@
  • The Parallels hypervisor
  • +
  • + The Bhyve hypervisor +
  • Virtual networks using bridging, NAT, VEPA and VN-LINK.
  • diff --git a/docs/sitemap.html.in b/docs/sitemap.html.in index 7d0610b4bb..78e84e310c 100644 --- a/docs/sitemap.html.in +++ b/docs/sitemap.html.in @@ -248,6 +248,10 @@ Parallels Driver for Parallels Cloud Server +
  • + Bhyve + Driver for bhyve +
  • diff --git a/src/README b/src/README index 00d11d19a2..bb3cddfc6e 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