diff options
| author | Jacek Galowicz <jacek@galowicz.de> | 2024-03-06 07:51:02 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2024-03-06 07:51:02 +0100 |
| commit | 3b2b12769d66d3955234849c69878ac54113f127 (patch) | |
| tree | fd79058d02332cf88352d2f591293721430fa389 /nixos | |
| parent | 9df3e30ce24fd28c7b3e2de0d986769db5d6225d (diff) | |
| parent | eb787006d739947f662894139400a9d0115ed80d (diff) | |
Merge pull request #293573 from hercules-ci/nixos-running-tests-requirements
nixos/doc: Describe NixOS test system requirements
Diffstat (limited to 'nixos')
| -rw-r--r-- | nixos/doc/manual/development/running-nixos-tests.section.md | 10 |
1 files changed, 10 insertions, 0 deletions
diff --git a/nixos/doc/manual/development/running-nixos-tests.section.md b/nixos/doc/manual/development/running-nixos-tests.section.md index 33076f5dc2a7d..b8191ebd313c5 100644 --- a/nixos/doc/manual/development/running-nixos-tests.section.md +++ b/nixos/doc/manual/development/running-nixos-tests.section.md @@ -18,3 +18,13 @@ you can view a log of the test: ```ShellSession $ nix-store --read-log result ``` + +## System Requirements {#sec-running-nixos-tests-requirements} + +NixOS tests require virtualization support. +This means that the machine must have `kvm` in its [system features](https://nixos.org/manual/nix/stable/command-ref/conf-file.html?highlight=system-features#conf-system-features) list, or `apple-virt` in case of macOS. +These features are autodetected locally, but `apple-virt` is only autodetected since Nix 2.19.0. + +Features of **remote builders** must additionally be configured manually on the client, e.g. on NixOS with [`nix.buildMachines.*.supportedFeatures`](https://search.nixos.org/options?show=nix.buildMachines.*.supportedFeatures&sort=alpha_asc&query=nix.buildMachines) or through general [Nix configuration](https://nixos.org/manual/nix/stable/advanced-topics/distributed-builds). + +If you run the tests on a **macOS** machine, you also need a "remote" builder for Linux; possibly a VM. [nix-darwin](https://daiderd.com/nix-darwin/) users may enable [`nix.linux-builder.enable`](https://daiderd.com/nix-darwin/manual/index.html#opt-nix.linux-builder.enable) to launch such a VM. |