1.8 KiB
Usage
Imperative guests
A guest declaration must live in a Nix Flake. To get started, you can use the flake template with the following shortcut:
miniguest template my-guests/
To build and deploy a guest, run
sudo miniguest install «flakeRef»#«guestName»
To give the guest a different name than the one it has in the flake, use
sudo miniguest install -n «guestName» «flakeRef»#«guestNameInFlake»
When built, an imperative guest live in its own nix profile. It must be updated manually, and old generations can be garbage collected. You can update with
sudo miniguest upgrade «guestName»
To remove a guest, run
sudo miniguest remove «guestName»
Declarative guests
On a NixOS host, guests can be embedded in the configuration of the host, provided it lives in a flake. In that case, they will be added, updated, and removed as the host system is updated. imperative and declarative guests can exist side-by-side on the same system. Imperative commands cannot be used on declarative guests.
To use this feature, simply add the Miniguest flake as an input and define guests like
{
import = [ inputs.miniguest.nixosModules.declarative ];
networking.hostName = "myhost";
# ...
miniguests.«guestName».configuration = { ... }: {
networking.hostName = "myguest";
# ...
};
}
By default, guests are built for the same platform as their host. If you wish
to create a guest for a different platform, you should use the
miniguest.«guestName».system option.
Configuring the hypervisor
To configure a guest in your hypervisor, for example Libvirt, run
miniguest create -t libvirt «guestName»
This will print a command. Edit the command if you wish, and execute it.