Official NixOS Wiki

Libvirt: Difference between revisions

← Older edit
Sandro (talk | contribs)
78 edits
VisualWikitext
Removing the unstable keyword (non-standard)
Sandro (talk | contribs)
78 edits
 
(16 intermediate revisions by 9 users not shown)
Line 5: Line 5:
Enable libvirt daemon
Enable libvirt daemon


{{file|/etc/nixos/configuration.nix|nix|<nowiki>
{{file|||<nowiki>
virtualisation.libvirtd = {
virtualisation.libvirtd.enable = true;
  enable = true;
 
  qemu = {
# Enable TPM emulation (optional)
    package = pkgs.qemu_kvm;
# install pkgs.swtpm system-wide for use in virt-manager (optional)
    runAsRoot = true;
virtualisation.libvirtd.qemu = {
    swtpm.enable = true;
  swtpm.enable = true;
    ovmf = {
      enable = true;
      packages = [(pkgs.OVMF.override {
        secureBoot = true;
        tpmSupport = true;
      }).fd];
    };
  };
};
};


# Enable USB redirection (optional)
# Enable USB redirection (optional)
virtualisation.spiceUSBRedirection.enable = true;
virtualisation.spiceUSBRedirection.enable = true;
</nowiki>}}
 
</nowiki>|name=/etc/nixos/configuration.nix|lang=nix}}


To enable local user access to libvirt, for example by using <code>virt-manager</code> or <code>gnome-boxes</code>, add yourself to the <code>libvirtd</code> group
To enable local user access to libvirt, for example by using <code>virt-manager</code> or <code>gnome-boxes</code>, add yourself to the <code>libvirtd</code> group
Line 37: Line 30:


=== UEFI with OVMF ===
=== UEFI with OVMF ===
Enable UEFI firmware support, following Qemu configuration for your local user is required
{{file|~/.config/libvirt/qemu.conf|nix|<nowiki>
# Adapted from /var/lib/libvirt/qemu.conf
# Note that AAVMF and OVMF are for Aarch64 and x86 respectively
nvram = [ "/run/libvirt/nix-ovmf/AAVMF_CODE.fd:/run/libvirt/nix-ovmf/AAVMF_VARS.fd", "/run/libvirt/nix-ovmf/OVMF_CODE.fd:/run/libvirt/nix-ovmf/OVMF_VARS.fd" ]
</nowiki>}}


See [https://ostechnix.com/enable-uefi-support-for-kvm-virtual-machines-in-linux/ this tutorial] on how to run a guest machine in UEFI mode using <code>virt-manager</code>.
See [https://ostechnix.com/enable-uefi-support-for-kvm-virtual-machines-in-linux/ this tutorial] on how to run a guest machine in UEFI mode using <code>virt-manager</code>.
Line 52: Line 37:
If you would like to enable nested virtualization for your guests to run KVM hypervisors inside them, you should enable it as follows:  {{nixos:option|boot.extraModprobeConfig}}, for example:
If you would like to enable nested virtualization for your guests to run KVM hypervisors inside them, you should enable it as follows:  {{nixos:option|boot.extraModprobeConfig}}, for example:


{{file|/etc/nixos/configuration.nix|xml|<nowiki>
{{file|||<nowiki>
boot.extraModprobeConfig = "options kvm_intel nested=1";
boot.extraModprobeConfig = ''
</nowiki>}}
  options kvm_intel nested=1
'';
</nowiki>|name=/etc/nixos/configuration.nix|lang=nix}}
 
=== Networking ===
 
==== Default networking ====
 
To utilize the default libvirt network, you will need to install the {{nixos:package|dnsmasq}} package. This is required for DNS and DCHP functionality within the network:
 
{{File|3=environment.systemPackages = with pkgs; [
  dnsmasq
];|name=/etc/nixos/configuration.nix|lang=nix}}
 
Once the package is installed, enable and start the default network using the following commands:
 
<syntaxhighlight lang="console">
# virsh net-autostart default
# virsh net-start default
</syntaxhighlight>
 
This will configure the default network to start automatically on boot and immediately activate it. You may need to whitelist the interface for the firewall like so:
 
{{File|3=networking.firewall.trustedInterfaces = [ "virbr0" ];|name=/etc/nixos/configuration.nix|lang=nix}}


=== Bridge networking ===
==== Bridge networking ====


Create a XML file called <code>virbr0.xml</code> with the definition of the bridge interface
Create a XML file called <code>virbr0.xml</code> with the definition of the bridge interface.


<syntaxhighlight lang="bash">
<syntaxhighlight lang="bash">
Line 68: Line 76:
</syntaxhighlight>
</syntaxhighlight>


Add and enable bridge interface
Add and enable bridge interface.


<syntaxhighlight lang="bash">
<syntaxhighlight lang="bash">
Line 78: Line 86:
</syntaxhighlight>
</syntaxhighlight>


Edit the libvirt guest <code>my_guest</code> XML file and add the bridge interface to it
Edit the libvirt guest <code>my_guest</code> XML file and add the bridge interface to it.


<syntaxhighlight lang="bash">
<syntaxhighlight lang="bash">
Line 84: Line 92:
</syntaxhighlight>
</syntaxhighlight>


Add
Add:


<syntaxhighlight lang="bash">
<syntaxhighlight lang="bash">
Line 99: Line 107:
</syntaxhighlight>
</syntaxhighlight>


Inside the guest configure networking for the interface <code>enp1s0</code> (name might differ)
Inside the guest configure networking for the interface <code>enp1s0</code> (name may differ).


{{file|/etc/nixos/configuration.nix|nix|<nowiki>
{{file|/etc/nixos/configuration.nix|nix|<nowiki>
networking.interfaces.enp1s0.ipv4.addresses = [{
networking.interfaces.enp1s0 = {
  address = "10.25.0.2";
  ipv4.addresses = [{
  prefixLength = 24;
    address = "10.25.0.2";
}];
    prefixLength = 24;
  }];
  defaultGateway = {
    address = "10.25.0.1";
    interface = "ens1s0";
  };
};
</nowiki>}}
</nowiki>}}


Line 112: Line 126:
=== File sharing ===
=== File sharing ===


In order to share files between host and guest, one recommended way of doing this is to use <code>spice-webdavd</code>.
In order to share files between host and guest, one recommended way is to use <code>spice-webdavd</code>.


Shutdown the client, in this example named <code>my_guest</code>, and edit the libvirt XML file.
Shutdown the client, in this example named <code>my_guest</code>, and edit the libvirt XML file.
Line 130: Line 144:
</syntaxhighlight>
</syntaxhighlight>


Start the guest machine. Inside the guest, add following part to your system configuration and apply it
Start the guest machine. Inside the guest, add following part to your system configuration and apply it.


{{file|/etc/nixos/configuration.nix|nix|<nowiki>
{{file|/etc/nixos/configuration.nix|nix|<nowiki>
Line 136: Line 150:
</nowiki>}}
</nowiki>}}


List available shares for the guest
List available shares for the guest.


<syntaxhighlight lang="bash">
<syntaxhighlight lang="bash">
Line 142: Line 156:
</syntaxhighlight>
</syntaxhighlight>


Mount an example share called <code>myshare</code> to the mountpoint <code>myshare</code>
Mount an example share called <code>myshare</code> to the mountpoint <code>myshare.</code>


{{file|/etc/nixos/configuration.nix|nix|<nowiki>
{{file|/etc/nixos/configuration.nix|nix|<nowiki>
Line 158: Line 172:
};
};
</nowiki>}}
</nowiki>}}
=== Hooks ===
Libvirt allows the use of hooks to run custom scripts during specific events, such as daemon lifecycle events, domain lifecycle events, and network events. On NixOS, you can configure hooks via the NixOS module to automate the placement of hook scripts in the appropriate directories.
The following directories are used for placing hook scripts:
* '''<code>/var/lib/libvirt/hooks/daemon.d/</code>'''  Scripts here are triggered by daemon events like start, shutdown, and SIGHUP.
* '''<code>/var/lib/libvirt/hooks/qemu.d/</code>'''  Scripts for handling QEMU domain events such as begin, end, and migration.
* '''<code>/var/lib/libvirt/hooks/lxc.d/</code>'''  Scripts for LXC container events like begin and end.
* '''<code>/var/lib/libvirt/hooks/libxl.d/</code>'''  Scripts for Xen domains managed by <code>libxl</code> (begin/end events).
* '''<code>/var/lib/libvirt/hooks/network.d/</code>'''  Scripts triggered by network events such as begin and end.
See the [https://libvirt.org/hooks.html libvirt documentation] for more information.
An example config would be:<syntaxhighlight lang="nix">
{
  virtualisation.libvirtd.hooks = {
    daemon = {
      "example" = ./scripts/daemon-example.sh;
    };
    qemu = {
      "example" = ./scripts/qemu-example.sh;
    };
    network = {
      "example" = ./scripts/network-example.sh;
    };
  };
}
</syntaxhighlight>Note that after you added the configuration and switch, you'll have the following command to setup the hooks.<syntaxhighlight lang="bash">
systemctl start libvirtd-config.service
</syntaxhighlight>
=== PCI Passthrough ===
For detailed instructions on configuring PCI passthrough with libvirt, refer to the [[PCI passthrough]] page.


== Clients ==
== Clients ==
Line 168: Line 217:


Following are notes regarding the use of some of those tools
Following are notes regarding the use of some of those tools
==== error: cannot find any suitable libguestfs supermin ====
Use use the package libguestfs-with-appliance. See https://github.com/NixOS/nixpkgs/issues/37540
=== guestfs-tools ===
Includes virt-sysprep, used to prepare a VM image for use.  Review the manpage of virt-sysprep, virt-clone, and virt-builder.


==== <code>virt-builder</code> ====
==== <code>virt-builder</code> ====


virt-builder is installed with <code>libguestfs</code>, but has some issues from its packaging.
virt-builder is installed with <code>guestfs-tools</code>, but has some issues from its packaging.


It is possible to work around those issues without modifying the package (when a pristine nixpkgs is needed).
It is possible to work around those issues without modifying the package (when a pristine nixpkgs is needed).
Line 184: Line 243:


This will make your user use the shipped repo configurations, and works around the fact that virt-builder reads its executable name to build its configuration path. The executable being wrapped, it is named differently.
This will make your user use the shipped repo configurations, and works around the fact that virt-builder reads its executable name to build its configuration path. The executable being wrapped, it is named differently.
==== error: cannot find any suitable libguestfs supermin ====
Use use the package libguestfs-with-appliance. See https://github.com/NixOS/nixpkgs/issues/37540
=== guestfs-tools ===
Includes virt-sysprep, used to prepare a VM image for use.  Review the manpage of virt-sysprep, virt-clone, and virt-builder.


=== NixVirt ===
=== NixVirt ===


[https://flakehub.com/flake/AshleyYakeley/NixVirt NixVirt] is a flake that provides NixOS and Home Manager modules for setting up libvirt domains, networks and pools declaratively.
[https://github.com/AshleyYakeley/NixVirt NixVirt] is a flake that provides NixOS and Home Manager modules for setting up libvirt domains, networks and pools declaratively.


=== Accessing QEMU VMs through Webbrowser ===
=== Accessing QEMU VMs through Webbrowser ===
Line 239: Line 289:
==== Get EyeOS Spice Web Client ====
==== Get EyeOS Spice Web Client ====


As said, the experience with the EyeOS Spice Web Client has been the best so far. Another client would be the [https://cgit.freedesktop.org/spice/spice-html5/ spice-html5] from freedesktop.org.
As said, the experience with the EyeOS Spice Web Client has been the best so far. Another client would be the [https://gitlab.freedesktop.org/spice/spice-html5/ spice-html5] from freedesktop.org.


1. Download the [https://github.com/eyeos/spice-web-client/ EyeOS Spice Web Client] and unpack it (if necessary) or , as example, just <code>git clone https://github.com/eyeos/spice-web-client/ /var/www/spice</code>
1. Download the [https://github.com/eyeos/spice-web-client/ EyeOS Spice Web Client] and unpack it (if necessary) or , as example, just <code>git clone https://github.com/eyeos/spice-web-client/ /var/www/spice</code>
Line 282: Line 332:


And finally you can access the VMs GUI through <code>https://mydomain.tld:4500/spice/index.html?host=mydomain.tld&port=5959</code>
And finally you can access the VMs GUI through <code>https://mydomain.tld:4500/spice/index.html?host=mydomain.tld&port=5959</code>
[[Category:Virtualization]]
[[Category:Virtualization]]
[[Category:Applications]]
[[Category:Applications]]
Retrieved from "https://wiki.nixos.org/wiki/Libvirt"