Skip to content

Commit 4dc9630

Browse files
committed
docs: document python3-venv prereq on the coordinator host
The preflight job creates a venv to install the labgrid-client fork; modern Debian/Ubuntu ships `python3-venv` as a separate package and omits it from default installs, so the first run on a fresh coordinator host fails with "ensurepip is not available" until the admin runs `apt install python3-venv`. Surface this in the runner prerequisites section and make the probe's error message name the exact fix.
1 parent f3951f7 commit 4dc9630

2 files changed

Lines changed: 14 additions & 1 deletion

File tree

.github/workflows/hardware-test.yml

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,11 @@ jobs:
5151
VENV="$HOME/.cache/adidt-ci/labgrid-venv"
5252
if [[ ! -x "$VENV/bin/labgrid-client" ]]; then
5353
echo "Creating labgrid venv at $VENV" >&2
54-
python3 -m venv "$VENV"
54+
if ! python3 -m venv "$VENV" 2>&1; then
55+
echo "venv creation failed — python3-venv package likely missing." >&2
56+
echo "Install on the coordinator host: sudo apt-get install -y python3-venv python3-full" >&2
57+
exit 1
58+
fi
5559
"$VENV/bin/pip" install --quiet --disable-pip-version-check --upgrade pip
5660
"$VENV/bin/pip" install --quiet --disable-pip-version-check "$LABGRID_PIP"
5761
fi

doc/source/developer/hardware_ci.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -162,6 +162,15 @@ System-tool prerequisites on each hw-node runner:
162162
# For ZCU102/AD9081 (USB SD-mux mode):
163163
sudo apt-get install -y usbsdmux
164164
165+
On the **coordinator host** (the one labeled ``hw-coordinator``), the
166+
preflight job creates a venv to host the labgrid-client install.
167+
Modern Debian/Ubuntu ships ``python3-venv`` separately, so install
168+
the matching package before the first run:
169+
170+
.. code-block:: bash
171+
172+
sudo apt-get install -y python3-venv python3-full
173+
165174
Coordinator-mode tests additionally require SSH key-auth from the
166175
``hw-coordinator`` runner to the exporter host (for the
167176
``MassStorageDriver`` SSH-proxy path) and write access to

0 commit comments

Comments
 (0)