nova-bhyve 0.9.0__tar.gz

nova_bhyve-0.9.0/PKG-INFO

@@ -0,0 +1,57 @@
+Metadata-Version: 2.3
+Name: nova-bhyve
+Version: 0.9.0
+Summary: Bhyve virtualization driver for OpenStack Nova
+Author: joshiggins
+Author-email: joshiggins <josh@joshh.info>
+License: Apache-2.0
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+
+# nova-bhyve
+
+An OpenStack Nova compute driver that runs instances as [bhyve](https://bhyve.org/) virtual machines on FreeBSD.
+
+## Status
+
+### Features
+
+- Direct VM management through `bhyve`/`bhyvectl`
+- Instance root disks on ZFS
+- Supports booting from qcow2 and raw Glance images
+- Glance images cached as zvols with zero copy root disk cloning
+- VNC console integration through `nova-novncproxy`
+- Cold attach of cinder volumes
+- Instance snapshot and upload to Glance
+
+### Roadmap
+
+- Cold attach of network interfaces
+- Cold migration between hosts (currently only supports same-host migration i.e. instance resize)
+- Automatically remove cached images once last instance is gone
+- Support for additional ephemeral/swap disks
+
+### Limitations
+
+- Live migration is not supported yet by bhyve, so is not implemented in this driver
+
+## Host requirements
+
+`zfs allow` delegation is needed for the dataset holding images and instances.
+
+A `devfs.rules` entry is needed to grant the group running Nova read/write access to the zvol device nodes.
+
+You must configure `volmode=dev` on the dataset so that the host does not publish guest partition tables into its own `/dev`.
+
+## Configuration
+
+Example configuration for Nova:
+
+```
+[DEFAULT]
+compute_driver = bhyve.driver.BhyveDriver
+allow_resize_to_same_host = True
+
+[bhyve]
+zfs_dataset = zroot/nova
+```

nova_bhyve-0.9.0/README.md

@@ -0,0 +1,47 @@
+# nova-bhyve
+
+An OpenStack Nova compute driver that runs instances as [bhyve](https://bhyve.org/) virtual machines on FreeBSD.
+
+## Status
+
+### Features
+
+- Direct VM management through `bhyve`/`bhyvectl`
+- Instance root disks on ZFS
+- Supports booting from qcow2 and raw Glance images
+- Glance images cached as zvols with zero copy root disk cloning
+- VNC console integration through `nova-novncproxy`
+- Cold attach of cinder volumes
+- Instance snapshot and upload to Glance
+
+### Roadmap
+
+- Cold attach of network interfaces
+- Cold migration between hosts (currently only supports same-host migration i.e. instance resize)
+- Automatically remove cached images once last instance is gone
+- Support for additional ephemeral/swap disks
+
+### Limitations
+
+- Live migration is not supported yet by bhyve, so is not implemented in this driver
+
+## Host requirements
+
+`zfs allow` delegation is needed for the dataset holding images and instances.
+
+A `devfs.rules` entry is needed to grant the group running Nova read/write access to the zvol device nodes.
+
+You must configure `volmode=dev` on the dataset so that the host does not publish guest partition tables into its own `/dev`.
+
+## Configuration
+
+Example configuration for Nova:
+
+```
+[DEFAULT]
+compute_driver = bhyve.driver.BhyveDriver
+allow_resize_to_same_host = True
+
+[bhyve]
+zfs_dataset = zroot/nova
+```

nova_bhyve-0.9.0/pyproject.toml

@@ -0,0 +1,25 @@
+[project]
+name = "nova-bhyve"
+version = "0.9.0"
+description = "Bhyve virtualization driver for OpenStack Nova"
+readme = "README.md"
+requires-python = ">=3.12"
+dependencies = []
+
+[[project.authors]]
+name = "joshiggins"
+email = "josh@joshh.info"
+
+[project.license]
+text = "Apache-2.0"
+
+[build-system]
+requires = ["uv_build>=0.11.28,<0.12.0"]
+build-backend = "uv_build"
+
+[tool.uv.build-backend]
+module-name = [
+    "nova_bhyve",
+    "nova.virt.bhyve",
+]
+namespace = true

nova_bhyve-0.9.0/pyproject.toml.orig

@@ -0,0 +1,19 @@
+[project]
+name = "nova-bhyve"
+version = "0.9.0"
+description = "Bhyve virtualization driver for OpenStack Nova"
+readme = "README.md"
+authors = [
+    { name = "joshiggins", email = "josh@joshh.info" }
+]
+license = {text = "Apache-2.0"}
+requires-python = ">=3.12"
+dependencies = []
+
+[build-system]
+requires = ["uv_build>=0.11.28,<0.12.0"]
+build-backend = "uv_build"
+
+[tool.uv.build-backend]
+module-name = ["nova_bhyve", "nova.virt.bhyve"]
+namespace = true

nova_bhyve-0.9.0/src/nova/virt/bhyve/__init__.py

@@ -0,0 +1 @@
+"""Namespace shim that makes the driver importable as ``nova.virt.bhyve``."""

nova_bhyve-0.9.0/src/nova/virt/bhyve/driver.py

@@ -0,0 +1,5 @@
+"""Re-export of the bhyve driver."""
+
+from nova_bhyve.driver import BhyveDriver
+
+__all__ = ["BhyveDriver"]

nova_bhyve-0.9.0/src/nova/virt/bhyve/privsep.py

@@ -0,0 +1,133 @@
+"""Privileged operations for the bhyve driver."""
+
+import os
+import re
+import signal
+import sys
+
+import nova.privsep
+from oslo_concurrency import processutils
+from oslo_log import log as logging
+
+LOG = logging.getLogger(__name__)
+
+# TODO: these are defined in multiple places across the codebase. we should reuse from the main pkg
+BHYVE = "/usr/sbin/bhyve"
+BHYVECTL = "/usr/sbin/bhyvectl"
+DAEMON = "/usr/sbin/daemon"
+
+VMM_DIR = "/dev/vmm"
+
+# TODO: should this be a validate_uuid helper?
+UUID_RE = re.compile(r"^[0-9a-fA-F-]{36}$")
+
+
+def check_name(name):
+    """Raise unless a name is shaped like an instance UUID."""
+    if not UUID_RE.match(name):
+        raise ValueError("refusing to act on %r: not an instance uuid" % name)
+    return name
+
+
+def check_state_dir(state_dir, name):
+    """Raise unless a state directory is absolute and belongs to this VM."""
+    check_name(name)
+    if not os.path.isabs(state_dir) or os.path.basename(state_dir.rstrip("/")) != name:
+        raise ValueError(
+            "refusing to use %r as the state directory for %s" % (state_dir, name)
+        )
+    return state_dir
+
+
+def pid_from(path):
+    """Read a pidfile, returning None if it is absent or unreadable."""
+    try:
+        with open(path) as handle:
+            return int(handle.read().strip())
+    except (OSError, ValueError):
+        return None
+
+
+@nova.privsep.sys_admin_pctxt.entrypoint
+def start_domain(state_dir, name, argv, console_log=None):
+    """Start a guest under a nova_bhyve.supervisor process."""
+    check_state_dir(state_dir, name)
+    if not all(isinstance(a, str) for a in argv):
+        raise ValueError("bhyve arguments must all be strings")
+
+    cmd = [DAEMON, "-f", "-p", os.path.join(state_dir, "supervisor.pid")]
+    if console_log:
+        # the serial device is configured by the driver as stdio, so the log
+        # from daemon(8) is literally the console log ;-)
+        cmd += ["-o", console_log, "-m", "3", "-M", "0640"]
+    cmd += [
+        "--",
+        sys.executable,
+        "-m",
+        "nova_bhyve.supervisor",
+        "--state-dir",
+        state_dir,
+        "--name",
+        name,
+        "--",
+        *argv,
+    ]
+
+    LOG.info("bhyve privsep: starting %(name)s under a supervisor", {"name": name})
+    processutils.execute(*cmd)
+
+
+@nova.privsep.sys_admin_pctxt.entrypoint
+def stop_domain(state_dir, name, graceful=True):
+    """Signal a running guest, returning whether there was one to signal."""
+    check_state_dir(state_dir, name)
+
+    # send SIGTERM to the supervisor (ACPI shutdown)
+    sup_pid = pid_from(os.path.join(state_dir, "supervisor.pid"))
+    if sup_pid:
+        try:
+            os.kill(sup_pid, signal.SIGTERM if graceful else signal.SIGUSR1)
+            return True
+        except ProcessLookupError:
+            pass
+
+    # supervisor is dead, try to kill bhyve directly
+    pid = pid_from(os.path.join(state_dir, "bhyve.pid"))
+    if pid is None:
+        return False
+    try:
+        os.kill(pid, signal.SIGTERM if graceful else signal.SIGKILL)
+    except ProcessLookupError:
+        return False
+    return True
+
+
+@nova.privsep.sys_admin_pctxt.entrypoint
+def reap_vm(name):
+    """Reclaim a VM object left behind in /dev/vmm."""
+    check_name(name)
+    if not os.path.exists(os.path.join(VMM_DIR, name)):
+        return False
+    LOG.info("bhyve privsep: reclaiming the vmm object for %s", name)
+    try:
+        processutils.execute(BHYVECTL, "--destroy", "--vm=%s" % name)
+    except processutils.ProcessExecutionError as err:
+        LOG.warning(
+            "bhyve privsep: could not reclaim %(name)s: %(err)s",
+            {"name": name, "err": err},
+        )
+        return False
+    return True
+
+
+@nova.privsep.sys_admin_pctxt.entrypoint
+def vm_stats(name):
+    """Return bhyvectl's per-vcpu statistics as raw text, or None."""
+    check_name(name)
+    if not os.path.exists(os.path.join(VMM_DIR, name)):
+        return None
+    try:
+        out, _err = processutils.execute(BHYVECTL, "--vm=%s" % name, "--get-stats")
+    except processutils.ProcessExecutionError:
+        return None
+    return out

nova_bhyve-0.9.0/src/nova_bhyve/__init__.py

@@ -0,0 +1 @@
+"""Nova compute driver for bhyve."""

nova_bhyve-0.9.0/src/nova_bhyve/conf.py

@@ -0,0 +1,77 @@
+"""Configuration options for the bhyve compute driver."""
+
+from oslo_config import cfg
+
+bhyve_group = cfg.OptGroup(
+    "bhyve",
+    title="bhyve driver options",
+    help="Options for the bhyve compute driver.",
+)
+
+bhyve_opts = [
+    cfg.StrOpt(
+        "zfs_dataset",
+        help="Dataset under which the driver creates its zvols, e.g. "
+        '"zroot/nova". Required: the driver refuses to start if this '
+        "is unset or if the dataset (or its images/ and instances/ "
+        "children) is missing. The nova user must hold ZFS delegated "
+        "administration on it.",
+    ),
+    cfg.StrOpt(
+        "mechanism",
+        default="direct",
+        choices=("direct",),
+        help="Mechansim for interacting with bhyve.",
+    ),
+    cfg.StrOpt(
+        "bootrom_path",
+        default="/usr/local/share/edk2-bhyve/BHYVE_UEFI_CODE.fd",
+        help="UEFI firmware image used for bhyve bootrom.",
+    ),
+    cfg.StrOpt(
+        "nvram_template",
+        default="/usr/local/share/edk2-bhyve/BHYVE_UEFI_VARS.fd",
+        help="Template for instance UEFI variables."
+    ),
+    cfg.IntOpt(
+        "destroy_timeout",
+        default=10,
+        min=1,
+        help="Seconds to wait for a guest to disappear after a hard stop "
+        "before giving up and reclaiming its resources anyway."
+    ),
+    cfg.StrOpt(
+        "image_scratch_dir",
+        default="$state_path/bhyve-scratch",
+        help="Directory for spool files while converting qcow2 to raw.",
+    ),
+    cfg.StrOpt(
+        "snapshot_image_format",
+        default="qcow2",
+        choices=("qcow2", "raw"),
+        help="Disk format for instance snapshots uploaded to Glance.\n"
+        "\n"
+        "qcow2 is the default so that snapshots are sparse.",
+    ),
+    cfg.BoolOpt(
+        "ignore_unimplemented_msr",
+        default=False,
+        help="Might help with running bhyve nested in a KVM guest.",
+    ),
+    cfg.IntOpt(
+        "shutdown_timeout_graceful",
+        default=30,
+        min=0,
+        help="Seconds to wait for an ACPI shutdown to complete before "
+        "destroying the domain.",
+    ),
+]
+
+CONF = cfg.CONF
+CONF.register_group(bhyve_group)
+CONF.register_opts(bhyve_opts, group=bhyve_group)
+
+
+def list_opts():
+    """Return the driver options for oslo-config-generator."""
+    return [(bhyve_group, bhyve_opts)]