Unverified Commit 10d564cb authored by Jacek Galowicz's avatar Jacek Galowicz Committed by GitHub
Browse files

nixos/doc: clarify scope of debugHook feature in the test driver (#426935)

parents 6affcbd4 9372904a
Loading
Loading
Loading
Loading
+9 −0
Original line number Diff line number Diff line
@@ -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.