nixos/doc: clarify scope of debugHook feature in the test driver

As discussed with tfc before, it's probably better in most cases to try
the interactive test-driver with the SSH backdoor first and resort to
this feature for flaky tests.
This commit is contained in:
Maximilian Bosch
2025-07-20 15:46:14 +02:00
parent fba6f87e26
commit 9372904a35
@@ -343,6 +343,15 @@ source: @NIXOS_TEST_OPTIONS_JSON@
## Accessing VMs in the sandbox with SSH {#sec-test-sandbox-breakpoint}
::: {.note}
For debugging with SSH access into the machines, it's recommended to try using
[the interactive driver](#sec-running-nixos-tests-interactively) with its
[SSH backdoor](#sec-nixos-test-ssh-access) first.
This feature is mostly intended to debug flaky test failures that aren't
reproducible elsewhere.
:::
As explained in [](#sec-nixos-test-ssh-access), it's possible to configure an
SSH backdoor based on AF_VSOCK. This can be used to SSH into a VM of a running
build in a sandbox.