feat: add libvirt-guest module to nixos
This commit is contained in:
parent
1296c0e998
commit
df14232cc0
GPG Key ID:
FD266B810DF48DF2
527
modules/nixos/virtualisation/libvirt-guest.nix
Normal file
527
modules/nixos/virtualisation/libvirt-guest.nix
Normal file
@ -0,0 +1,527 @@
|
||||
{
|
||||
config,
|
||||
lib,
|
||||
pkgs,
|
||||
...
|
||||
}:
|
||||
let
|
||||
inherit (lib)
|
||||
concatStrings
|
||||
mapAttrsToList
|
||||
mkIf
|
||||
mkMerge
|
||||
mkOption
|
||||
optionalString
|
||||
;
|
||||
inherit (lib.types)
|
||||
attrsOf
|
||||
bool
|
||||
enum
|
||||
int
|
||||
listOf
|
||||
nullOr
|
||||
path
|
||||
str
|
||||
submodule
|
||||
;
|
||||
cfg = config.ataraxia.virtualisation.guests;
|
||||
|
||||
diskOptions.options = {
|
||||
diskFile = mkOption {
|
||||
type = str;
|
||||
};
|
||||
# TODO
|
||||
bus = mkOption {
|
||||
type = enum [
|
||||
"virtio"
|
||||
"ide"
|
||||
"scsi"
|
||||
"sata"
|
||||
];
|
||||
default = "virtio";
|
||||
};
|
||||
type = mkOption {
|
||||
type = enum [
|
||||
"raw"
|
||||
"qcow2"
|
||||
];
|
||||
default = "qcow2";
|
||||
};
|
||||
targetName = mkOption {
|
||||
type = str;
|
||||
default = "vda";
|
||||
};
|
||||
discard = mkOption {
|
||||
type = enum [
|
||||
"ignore"
|
||||
"unmap"
|
||||
];
|
||||
default = "unmap";
|
||||
};
|
||||
cache = mkOption {
|
||||
type = enum [
|
||||
"none"
|
||||
"writethrough"
|
||||
"writeback"
|
||||
"directsync"
|
||||
"unsafe"
|
||||
];
|
||||
default = "writeback";
|
||||
};
|
||||
};
|
||||
mountOptions.options = {
|
||||
sourceDir = mkOption {
|
||||
type = str;
|
||||
default = "";
|
||||
};
|
||||
targetDir = mkOption {
|
||||
type = str;
|
||||
default = "";
|
||||
};
|
||||
# TODO
|
||||
type = mkOption {
|
||||
type = enum [
|
||||
"virtiofs"
|
||||
"9p"
|
||||
];
|
||||
default = "virtiofs";
|
||||
};
|
||||
};
|
||||
guestsOptions =
|
||||
{ ... }:
|
||||
{
|
||||
options = rec {
|
||||
xmlFile = mkOption {
|
||||
type = nullOr path;
|
||||
default = null;
|
||||
};
|
||||
connectUri = mkOption {
|
||||
type = str;
|
||||
default = "qemu:///system";
|
||||
};
|
||||
user = mkOption {
|
||||
type = str;
|
||||
default = "qemu-libvirtd";
|
||||
};
|
||||
group = mkOption {
|
||||
type = str;
|
||||
default = "qemu-libvirtd";
|
||||
};
|
||||
autoStart = mkOption {
|
||||
type = bool;
|
||||
default = false;
|
||||
};
|
||||
autoDefine = mkOption {
|
||||
type = bool;
|
||||
default = true;
|
||||
};
|
||||
guestOsType = mkOption {
|
||||
type = enum [
|
||||
"linux"
|
||||
"windows"
|
||||
];
|
||||
default = "linux";
|
||||
};
|
||||
uefi = mkOption {
|
||||
type = bool;
|
||||
default = false;
|
||||
};
|
||||
memory = mkOption {
|
||||
type = int;
|
||||
default = 1024;
|
||||
};
|
||||
sharedMemory = mkOption {
|
||||
type = bool;
|
||||
# TODO: not needed if using 9p mount
|
||||
default = devices.mounts != [ ];
|
||||
};
|
||||
cpu = {
|
||||
sockets = mkOption {
|
||||
type = int;
|
||||
default = 1;
|
||||
};
|
||||
cores = mkOption {
|
||||
type = int;
|
||||
default = 1;
|
||||
};
|
||||
threads = mkOption {
|
||||
type = int;
|
||||
default = 1;
|
||||
};
|
||||
};
|
||||
devices = {
|
||||
disks = mkOption {
|
||||
type = listOf (submodule diskOptions);
|
||||
default = [ ];
|
||||
};
|
||||
mounts = mkOption {
|
||||
type = listOf (submodule mountOptions);
|
||||
default = [ ];
|
||||
};
|
||||
tablet = mkOption {
|
||||
type = bool;
|
||||
default = true;
|
||||
};
|
||||
serial = mkOption {
|
||||
type = bool;
|
||||
default = true;
|
||||
};
|
||||
qemuGuestAgent = mkOption {
|
||||
type = bool;
|
||||
default = guestOsType != "windows";
|
||||
};
|
||||
audio = {
|
||||
enable = mkOption {
|
||||
type = bool;
|
||||
default = true;
|
||||
};
|
||||
type = mkOption {
|
||||
# TODO
|
||||
type = enum [
|
||||
"none"
|
||||
"alsa"
|
||||
"coreaudio"
|
||||
"dbus"
|
||||
"jack"
|
||||
"oss"
|
||||
"pulseaudio"
|
||||
"sdl"
|
||||
"spice"
|
||||
"file"
|
||||
];
|
||||
default = "spice";
|
||||
};
|
||||
};
|
||||
graphics = {
|
||||
enable = mkOption {
|
||||
type = bool;
|
||||
# TODO: must be true if video == true?
|
||||
default = true;
|
||||
};
|
||||
type = mkOption {
|
||||
# TODO
|
||||
type = enum [
|
||||
"sdl"
|
||||
"vnc"
|
||||
"spice"
|
||||
"rdp"
|
||||
"desktop"
|
||||
"egl-headless"
|
||||
];
|
||||
default = "spice";
|
||||
};
|
||||
};
|
||||
video = {
|
||||
enable = mkOption {
|
||||
type = bool;
|
||||
default = true;
|
||||
};
|
||||
type = mkOption {
|
||||
# TODO
|
||||
type = enum [
|
||||
"vga"
|
||||
"cirrus"
|
||||
"vmvga"
|
||||
"xen"
|
||||
"vbox"
|
||||
"qxl"
|
||||
"virtio"
|
||||
"gop"
|
||||
"bochs"
|
||||
"ramfb"
|
||||
"none"
|
||||
];
|
||||
default = "virtio";
|
||||
};
|
||||
};
|
||||
network = {
|
||||
enable = mkOption {
|
||||
type = bool;
|
||||
default = true;
|
||||
};
|
||||
interfaceType = mkOption {
|
||||
# TODO
|
||||
type = enum [
|
||||
"network"
|
||||
"macvlan"
|
||||
"bridge"
|
||||
];
|
||||
default = "network";
|
||||
};
|
||||
modelType = mkOption {
|
||||
type = enum [
|
||||
"virtio"
|
||||
"e1000"
|
||||
];
|
||||
default = "virtio";
|
||||
};
|
||||
macAddress = mkOption {
|
||||
type = nullOr str;
|
||||
default = null;
|
||||
};
|
||||
active = mkOption {
|
||||
type = bool;
|
||||
default = true;
|
||||
};
|
||||
sourceDev = mkOption {
|
||||
type = str;
|
||||
default = "default";
|
||||
};
|
||||
};
|
||||
};
|
||||
timeout = mkOption {
|
||||
type = int;
|
||||
default = 10;
|
||||
};
|
||||
};
|
||||
};
|
||||
|
||||
genXML =
|
||||
name: guest:
|
||||
pkgs.writeText "libvirt-guest-${name}.xml" ''
|
||||
<domain type="kvm">
|
||||
<name>${name}</name>
|
||||
<uuid>UUID</uuid>
|
||||
<memory unit="MiB">${toString guest.memory}</memory>
|
||||
${optionalString guest.sharedMemory ''
|
||||
<memoryBacking>
|
||||
<source type="memfd"/>
|
||||
<access mode="shared"/>
|
||||
</memoryBacking>
|
||||
''}
|
||||
<vcpu placement="static">${with guest.cpu; toString (sockets * cores * threads)}</vcpu>
|
||||
<os>
|
||||
<type arch="x86_64" machine="pc-q35-9.2">hvm</type>
|
||||
${optionalString guest.uefi ''
|
||||
<loader readonly="yes" type="pflash" format="raw">/run/libvirt/nix-ovmf/OVMF_CODE.fd</loader>
|
||||
<nvram template="/run/libvirt/nix-ovmf/OVMF_CODE.fd" templateFormat="raw" format="raw">/var/lib/libvirt/qemu/nvram/${name}_VARS.fd</nvram>
|
||||
''}
|
||||
</os>
|
||||
<features>
|
||||
<acpi/>
|
||||
<apic/>
|
||||
${optionalString (guest.guestOsType == "windows") ''
|
||||
<pae/>
|
||||
<hyperv mode="custom">
|
||||
<relaxed state="on"/>
|
||||
<vapic state="on"/>
|
||||
<spinlocks state="on" retries="8191"/>
|
||||
<vpindex state="on"/>
|
||||
<synic state="on"/>
|
||||
</hyperv>
|
||||
''}
|
||||
<vmport state="off"/>
|
||||
</features>
|
||||
<cpu mode="host-passthrough" check="none" migratable="on">
|
||||
${with guest.cpu; ''
|
||||
<topology
|
||||
sockets="${toString sockets}"
|
||||
cores="${toString cores}"
|
||||
threads="${toString threads}"
|
||||
/>
|
||||
''}
|
||||
</cpu>
|
||||
<clock offset="${if guest.guestOsType == "windows" then "localtime" else "utc"}">
|
||||
<timer name="rtc" tickpolicy="catchup"/>
|
||||
<timer name="pit" tickpolicy="delay"/>
|
||||
<timer name="hpet" present="no"/>
|
||||
${optionalString (guest.guestOsType == "windows") ''
|
||||
<timer name="hypervclock" present="yes"/>
|
||||
''}
|
||||
</clock>
|
||||
<pm>
|
||||
<suspend-to-mem enabled="no"/>
|
||||
<suspend-to-disk enabled="no"/>
|
||||
</pm>
|
||||
<devices>
|
||||
<emulator>/run/libvirt/nix-emulators/qemu-system-x86_64</emulator>
|
||||
${concatStrings (
|
||||
map (disk: ''
|
||||
<disk type="file" device="disk">
|
||||
<driver name="qemu" type="${disk.type}" cache="${disk.cache}" discard="${disk.discard}"/>
|
||||
<source file="${disk.diskFile}"/>
|
||||
<target dev="${disk.targetName}" bus="${disk.bus}"/>
|
||||
</disk>
|
||||
'') guest.devices.disks
|
||||
)}
|
||||
${concatStrings (
|
||||
map (mount: ''
|
||||
<filesystem type="mount" accessmode="passthrough">
|
||||
<driver type="virtiofs" queue="1024"/>
|
||||
<binary path="/run/current-system/sw/bin/virtiofsd" xattr="on">
|
||||
<cache mode="always"/>
|
||||
<lock posix="on" flock="on"/>
|
||||
</binary>
|
||||
<source dir="${mount.sourceDir}"/>
|
||||
<target dir="${mount.targetDir}"/>
|
||||
</filesystem>
|
||||
'') guest.devices.mounts
|
||||
)}
|
||||
${
|
||||
with guest.devices.network;
|
||||
if enable then
|
||||
if interfaceType == "network" then
|
||||
''
|
||||
<interface type="network">
|
||||
${optionalString (macAddress != null) ''
|
||||
<mac address="${macAddress}"/>
|
||||
''}
|
||||
<source network="${sourceDev}"/>
|
||||
<model type="${modelType}"/>
|
||||
</interface>
|
||||
''
|
||||
else if interfaceType == "bridge" then
|
||||
''
|
||||
<interface type="bridge">
|
||||
${optionalString (macAddress != null) ''
|
||||
<mac address="${macAddress}"/>
|
||||
''}
|
||||
<source bridge="${sourceDev}"/>
|
||||
<model type="${modelType}"/>
|
||||
</interface>
|
||||
''
|
||||
else if interfaceType == "macvlan" then
|
||||
''
|
||||
<interface type="direct">
|
||||
${optionalString (macAddress != null) ''
|
||||
<mac address="${macAddress}"/>
|
||||
''}
|
||||
<source dev="${sourceDev}" mode="bridge"/>
|
||||
<model type="${modelType}"/>
|
||||
</interface>
|
||||
''
|
||||
else
|
||||
""
|
||||
else
|
||||
""
|
||||
}
|
||||
${optionalString guest.devices.tablet ''
|
||||
<input type="tablet" bus="usb"/>
|
||||
''}
|
||||
${optionalString guest.devices.serial ''
|
||||
<serial type="pty"/>
|
||||
''}
|
||||
${optionalString guest.devices.qemuGuestAgent ''
|
||||
<channel type="unix">
|
||||
<target type="virtio" name="org.qemu.guest_agent.0"/>
|
||||
</channel>
|
||||
''}
|
||||
${optionalString guest.devices.audio.enable ''
|
||||
<audio id="1" type="${guest.devices.audio.type}"/>
|
||||
<sound model="ich9"/>
|
||||
''}
|
||||
${
|
||||
if guest.devices.graphics.enable then
|
||||
if guest.devices.graphics.type == "spice" then
|
||||
''
|
||||
<graphics type="spice" autoport="yes">
|
||||
<listen type="address"/>
|
||||
<image compression="off"/>
|
||||
</graphics>
|
||||
''
|
||||
else
|
||||
""
|
||||
else
|
||||
""
|
||||
}
|
||||
${
|
||||
with guest.devices.video;
|
||||
with lib;
|
||||
optionalString enable ''
|
||||
<video>
|
||||
${
|
||||
if type == "virtio" then
|
||||
''
|
||||
<model type="virtio" heads="1"/>
|
||||
''
|
||||
else if type == "qxl" then
|
||||
''
|
||||
<model type="qxl" ram="65536" vram="65536" vgamem="16384" heads="1"/>
|
||||
''
|
||||
else
|
||||
""
|
||||
}
|
||||
</video>
|
||||
''
|
||||
}
|
||||
<channel type="spicevmc">
|
||||
<target type="virtio" name="com.redhat.spice.0"/>
|
||||
</channel>
|
||||
<input type="mouse" bus="ps2"/>
|
||||
<input type="keyboard" bus="ps2"/>
|
||||
<redirdev bus='usb' type='spicevmc'/>
|
||||
<memballoon model="virtio"/>
|
||||
${optionalString (guest.guestOsType == "windows") ''
|
||||
<rng model="virtio">
|
||||
<backend model="random">/dev/urandom</backend>
|
||||
</rng>
|
||||
''}
|
||||
</devices>
|
||||
</domain>
|
||||
'';
|
||||
in
|
||||
{
|
||||
options.ataraxia.virtualisation.guests = mkOption {
|
||||
default = { };
|
||||
type = attrsOf (submodule guestsOptions);
|
||||
};
|
||||
|
||||
config.systemd.services = mkMerge (
|
||||
mapAttrsToList (name: guest: {
|
||||
"libvirt-guest-define-${name}" = {
|
||||
after = [ "libvirtd.service" ];
|
||||
requires = [ "libvirtd.service" ];
|
||||
wantedBy = mkIf guest.autoDefine [ "multi-user.target" ];
|
||||
serviceConfig = {
|
||||
Type = "oneshot";
|
||||
RemainAfterExit = "no";
|
||||
User = guest.user;
|
||||
Group = guest.group;
|
||||
};
|
||||
environment = {
|
||||
LIBVIRT_DEFAULT_URI = guest.connectUri;
|
||||
};
|
||||
script =
|
||||
if guest.xmlFile != null then
|
||||
''
|
||||
${pkgs.libvirt}/bin/virsh define --file ${guest.xmlFile}
|
||||
${pkgs.libvirt}/bin/virsh net-start ${guest.devices.network.sourceDev} || true
|
||||
''
|
||||
else
|
||||
''
|
||||
uuid="$(${pkgs.libvirt}/bin/virsh domuuid '${name}' || true)"
|
||||
${pkgs.libvirt}/bin/virsh define <(sed "s/UUID/$uuid/" '${genXML name guest}')
|
||||
${optionalString (
|
||||
guest.devices.network.interfaceType == "network"
|
||||
) "${pkgs.libvirt}/bin/virsh net-start ${guest.devices.network.sourceDev} || true"}
|
||||
'';
|
||||
};
|
||||
"libvirt-guest-${name}" = {
|
||||
after = [ "libvirt-guest-define-${name}.service" ];
|
||||
requires = [ "libvirt-guest-define-${name}.service" ];
|
||||
wantedBy = mkIf guest.autoStart [ "multi-user.target" ];
|
||||
serviceConfig = {
|
||||
Type = "oneshot";
|
||||
RemainAfterExit = "yes";
|
||||
User = guest.user;
|
||||
Group = guest.group;
|
||||
};
|
||||
environment = {
|
||||
LIBVIRT_DEFAULT_URI = guest.connectUri;
|
||||
};
|
||||
script = "${pkgs.libvirt}/bin/virsh start '${name}'";
|
||||
preStop = ''
|
||||
${pkgs.libvirt}/bin/virsh shutdown '${name}'
|
||||
let "timeout = $(date +%s) + ${toString guest.timeout}"
|
||||
while [ "$(${pkgs.libvirt}/bin/virsh list --name | grep --count '^${name}$')" -gt 0 ]; do
|
||||
if [ "$(date +%s)" -ge "$timeout" ]; then
|
||||
${pkgs.libvirt}/bin/virsh destroy '${name}'
|
||||
else
|
||||
sleep 0.5
|
||||
fi
|
||||
done
|
||||
'';
|
||||
};
|
||||
}) cfg
|
||||
);
|
||||
}
|
||||
Loading…
x
Reference in New Issue
Block a user