Flavours
A Flavour is a kind of way of building a composition & running the Driver.
They are inter-changeable at anytime.
This enables you to use the best tool to run your test-script, without changing the composition itself.
Building a composition with a Flavour will create its Composition file in
build/[composition_name]::[flavour_name].json.
Note
A compositionâs Flavour can be changed any time: when you build your composition with a Flavour, it will store the result for that specific Flavour. You can have multiple built compositions stored under the
builddirectory.
Once built, you can deploy the composition with this Flavour whenever.
Warning
When it comes to the Deploy phase, you first need to have your composition built with the Flavour you are trying to use!
Local Flavours
Some flavours are designed to be run on your local machine, here they are:
vm
The main flavour to be used locally. This is also the default in nixos-test.
This flavour builds a QEMU image & runs it with as many VMs as necessary for your composition.
It allows for advanced kernel, stage1 & networking tweaks.
vm-ramdisk
Basically the same as above, but is to be used on bigger machines for heavy disk operations.
docker
This flavour is useful for quick local iterations, and running many nodes locally (if you are not in advanced scenarios, see limitations below).
It supports all NixOS-Compose features, but does not allow for kernel, stage1 or networking manipulation (as your composition is ran in containers).
It also has limited support for experimental low-level processor features.
nspawn
This flavour is experimental & is not recommended for general use. It can permanently alter your nftables.
The current best way to use this flavour is to use it for iterating on large-scale experiments in a throwaway environment (such as a testbed node).
It does not allow for kernel, stage1 or networking manipulation (as your composition is ran in containers).
Testbed Flavours
The following flavours are to be used on Grid5000 for quick iterations or large scale experiments.
g5k-image
The main flavour to be used on Grid5000.
It allows for a composition image to be built, ready to be deployed with kadeploy.
g5k-image-script
This flavour is an alternative to the one above; The only difference is that it builds the tarball in user space (not with nix).
This allows you to not store the resulting tarball in your nix-store, which can save a lot of space in some bigger experiments.
g5k-nfs-store
This flavour builds a tarball to be executed on non-deploy & sudo-g5kâed nodes, with the help of a kexec (via root SSH).
Deployment is faster with this method, as you can easily re-kexec your nodes (if you have root SSH access).
This method does not allow for kadeploy integrations at all, it only kexecs already running nodes.
g5k-ramdisk
This flavour does the same as above, but everything is in ram.