Docs - Add documentation for --no-docker parameter requirements (#715)

[NJX-njx]

Summary

Fixes #715 - Documents the requirements and expectations when using --no-docker on remote nodes.

Problem

Users running sb run --no-docker on remote nodes encountered command not found (rc=127) because the documentation did not explain that SuperBench must be pre-installed on each target host.

Changes

• docs/getting-started/run-superbench.md: Added section "Using --no-docker on Remote Nodes" covering:
  • Requirement: sb CLI and dependencies must be pre-installed on each remote node
  • Deployment options (extract container, install from source, etc.)
  • Environment variables (e.g., SB_MICRO_PATH)
  • Use cases (Kubernetes, HPC clusters where containers are restricted)
• docs/cli.md: Updated --no-docker description with brief requirements and link to detailed docs

[Copilot]

Pull request overview

This PR updates SuperBench documentation to clarify the requirements for running sb run --no-docker against remote nodes, addressing failures where remote hosts don’t have the sb CLI installed.

Changes:

• Added a new “Using --no-docker on Remote Nodes” section to describe prerequisites and deployment approaches.
• Expanded the --no-docker CLI flag description to call out remote-node requirements and link to the detailed guide.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 4 comments.

File	Description
docs/getting-started/run-superbench.md	Adds a dedicated section documenting remote-node prerequisites and guidance for --no-docker.
docs/cli.md	Updates --no-docker help text with a brief prerequisite note and link to detailed docs.

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[Copilot]

For readability in this table cell, consider formatting the literal error text as code (e.g., command not found) and/or shortening the row by moving the longer explanation into the linked getting-started section. Very long table cells can make the markdown harder to maintain and review.

Suggested change

	| `--no-docker` | `False` | Run on host directly without Docker. When using remote nodes, SuperBench (`sb` binary and dependencies) must be pre-installed on each target host; otherwise `command not found` will occur. See [Run SuperBench - Using --no-docker on Remote Nodes](getting-started/run-superbench.md#using---no-docker-on-remote-nodes) for details. |
	| `--no-docker` | `False` | Run on host directly without Docker. See [Run SuperBench - Using --no-docker on Remote Nodes](getting-started/run-superbench.md#using---no-docker-on-remote-nodes) for details on using this option with remote nodes. |

[microsoft-github-policy-service]

@NJX-njx please read the following Contributor License Agreement(CLA). If you agree with the CLA, please reply with the following information.

@microsoft-github-policy-service agree [company="{your company}"]

Options:

• (default - no company specified) I have sole ownership of intellectual property rights to my Submissions and I am not making Submissions in the course of work for my employer.

@microsoft-github-policy-service agree

• (when company given) I am making Submissions in the course of work for my employer (or my employer has intellectual property rights in my Submissions by contract or applicable law). I have permission from my employer to make Submissions and enter into this Agreement on behalf of my employer. By signing below, the defined term “You” includes me and my employer.

@microsoft-github-policy-service agree company="Microsoft"

Contributor License Agreement

Contribution License Agreement

This Contribution License Agreement (“Agreement”) is agreed to by the party signing below (“You”),
and conveys certain license rights to Microsoft Corporation and its affiliates (“Microsoft”) for Your
contributions to Microsoft open source projects. This Agreement is effective as of the latest signature
date below.

1. Definitions.
   “Code” means the computer software code, whether in human-readable or machine-executable form,
   that is delivered by You to Microsoft under this Agreement.
   “Project” means any of the projects owned or managed by Microsoft and offered under a license
   approved by the Open Source Initiative (www.opensource.org).
   “Submit” is the act of uploading, submitting, transmitting, or distributing code or other content to any
   Project, including but not limited to communication on electronic mailing lists, source code control
   systems, and issue tracking systems that are managed by, or on behalf of, the Project for the purpose of
   discussing and improving that Project, but excluding communication that is conspicuously marked or
   otherwise designated in writing by You as “Not a Submission.”
   “Submission” means the Code and any other copyrightable material Submitted by You, including any
   associated comments and documentation.
2. Your Submission. You must agree to the terms of this Agreement before making a Submission to any
   Project. This Agreement covers any and all Submissions that You, now or in the future (except as
   described in Section 4 below), Submit to any Project.
3. Originality of Work. You represent that each of Your Submissions is entirely Your original work.
   Should You wish to Submit materials that are not Your original work, You may Submit them separately
   to the Project if You (a) retain all copyright and license information that was in the materials as You
   received them, (b) in the description accompanying Your Submission, include the phrase “Submission
   containing materials of a third party:” followed by the names of the third party and any licenses or other
   restrictions of which You are aware, and (c) follow any other instructions in the Project’s written
   guidelines concerning Submissions.
4. Your Employer. References to “employer” in this Agreement include Your employer or anyone else
   for whom You are acting in making Your Submission, e.g. as a contractor, vendor, or agent. If Your
   Submission is made in the course of Your work for an employer or Your employer has intellectual
   property rights in Your Submission by contract or applicable law, You must secure permission from Your
   employer to make the Submission before signing this Agreement. In that case, the term “You” in this
   Agreement will refer to You and the employer collectively. If You change employers in the future and
   desire to Submit additional Submissions for the new employer, then You agree to sign a new Agreement
   and secure permission from the new employer before Submitting those Submissions.
5. Licenses.

• Copyright License. You grant Microsoft, and those who receive the Submission directly or
  indirectly from Microsoft, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license in the
  Submission to reproduce, prepare derivative works of, publicly display, publicly perform, and distribute
  the Submission and such derivative works, and to sublicense any or all of the foregoing rights to third
  parties.
• Patent License. You grant Microsoft, and those who receive the Submission directly or
  indirectly from Microsoft, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license under
  Your patent claims that are necessarily infringed by the Submission or the combination of the
  Submission with the Project to which it was Submitted to make, have made, use, offer to sell, sell and
  import or otherwise dispose of the Submission alone or with the Project.
• Other Rights Reserved. Each party reserves all rights not expressly granted in this Agreement.
  No additional licenses or rights whatsoever (including, without limitation, any implied licenses) are
  granted by implication, exhaustion, estoppel or otherwise.

6. Representations and Warranties. You represent that You are legally entitled to grant the above
   licenses. You represent that each of Your Submissions is entirely Your original work (except as You may
   have disclosed under Section 3). You represent that You have secured permission from Your employer to
   make the Submission in cases where Your Submission is made in the course of Your work for Your
   employer or Your employer has intellectual property rights in Your Submission by contract or applicable
   law. If You are signing this Agreement on behalf of Your employer, You represent and warrant that You
   have the necessary authority to bind the listed employer to the obligations contained in this Agreement.
   You are not expected to provide support for Your Submission, unless You choose to do so. UNLESS
   REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING, AND EXCEPT FOR THE WARRANTIES
   EXPRESSLY STATED IN SECTIONS 3, 4, AND 6, THE SUBMISSION PROVIDED UNDER THIS AGREEMENT IS
   PROVIDED WITHOUT WARRANTY OF ANY KIND, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY OF
   NONINFRINGEMENT, MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE.
7. Notice to Microsoft. You agree to notify Microsoft in writing of any facts or circumstances of which
   You later become aware that would make Your representations in this Agreement inaccurate in any
   respect.
8. Information about Submissions. You agree that contributions to Projects and information about
   contributions may be maintained indefinitely and disclosed publicly, including Your name and other
   information that You submit with Your Submission.
9. Governing Law/Jurisdiction. This Agreement is governed by the laws of the State of Washington, and
   the parties consent to exclusive jurisdiction and venue in the federal courts sitting in King County,
   Washington, unless no federal subject matter jurisdiction exists, in which case the parties consent to
   exclusive jurisdiction and venue in the Superior Court of King County, Washington. The parties waive all
   defenses of lack of personal jurisdiction and forum non-conveniens.
10. Entire Agreement/Assignment. This Agreement is the entire agreement between the parties, and
    supersedes any and all prior agreements, understandings or communications, written or oral, between
    the parties relating to the subject matter hereof. This Agreement may be assigned by Microsoft.

[Copilot]

Pull request overview

Copilot reviewed 2 out of 2 changed files in this pull request and generated no new comments.

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[polarG]

Multi-perspective code review for PR #783

2 files, +16 / −1 (docs-only).
Dimensions reviewed: Correctness (×2 reviewers) + Maintainability (×2 reviewers). Performance / Security / Testing skipped — not exercised by a docs-only change.

Summary

#	Severity	Title	Location
1	BLOCKER	(Correctness) Option C documents an unsupported "extract container filesystem" workflow	docs/getting-started/run-superbench.md L60
2	SHOULD-FIX	(Correctness) Option B's third_party/ + "build instructions" pointer is unactionable	docs/getting-started/run-superbench.md L59
3	SHOULD-FIX	(Correctness) docs/cli.md cell omits the actual failing binary name (sb exec/sb)	docs/cli.md L378
4	SHOULD-FIX	(Correctness + Maintainability) docs/cli.md table cell is ~280 chars vs ≤80 in siblings	docs/cli.md L378
5	SHOULD-FIX	(Correctness) Cross-link omits the section anchor	docs/cli.md L378
6	SHOULD-FIX	(Maintainability) Cross-link label uses non-standard "Page - Section" format with --	docs/cli.md L378
7	SHOULD-FIX	(Maintainability) New section ignores file's paragraph + bash-fence + admonition style	docs/getting-started/run-superbench.md L51
8	SHOULD-FIX	(Maintainability) New section should be H3 under ## Run, not a peer H2	docs/getting-started/run-superbench.md L51
9	NON-BLOCKING	(Maintainability) No back-link from run-superbench.md to cli.md	docs/getting-started/run-superbench.md L64
10	NON-BLOCKING	(Maintainability) No cross-reference between pre-existing :::tip TIP and new section	docs/getting-started/run-superbench.md L51
11	NON-BLOCKING	(Maintainability) "execute sb exec directly" leaks an internal subcommand	docs/getting-started/run-superbench.md L55
12	NOTED	(Correctness) Ansible-sb exec-127 claim verified against runner.py:127 / runner.py:498	n/a
13	NOTED	(Correctness) SB_MICRO_PATH semantics verified against micro_base.py:182 / runner.py:94	n/a

Verdict

BLOCKED — The PR correctly identifies and documents the rc=127 / command not found pitfall for sb run --no-docker against remote hosts, but Option C in the new section prescribes a workflow ("manually extract the container filesystem to the host") that is not supported anywhere in the repo, contradicts the section's own use-case statement, and would lead users into the exact failure mode the PR is trying to fix. Removing Option C plus addressing the SHOULD-FIX items (especially the deep-link anchor and the oversized cli.md table cell) is sufficient to merge.

[polarG]

[BLOCKER] (Correctness) Option C documents an unsupported "extract container filesystem to host" workflow

Issue (verified facts):

• "Manually extract the container filesystem to the host" describes a workflow that does not exist in this repository. A grep for docker export, docker cp, extract.*container, container filesystem returns only this new doc.
• sb deploy (superbench/runner/playbooks/deploy.yaml) creates and runs the sb-workspace container and keeps the rootfs inside it. There is no script, Makefile target, test, or other doc covering a rootfs extraction step.
• Option C is internally contradictory with item Setup: Init - Initial setup.py and basic configs #4 ("for standard deployments, prefer sb deploy + sb run without --no-docker"): it sits inside a section titled "Using --no-docker on Remote Nodes" yet starts with "requires Docker on remote nodes".

Impact: Readers who try to follow Option C will hand-roll fragile docker export / docker cp / flows whose layouts will not match the SB_WORKSPACE / SB_MICRO_PATH expectations baked into superbench/runner/runner.py — exactly the failure class this PR is trying to prevent.

Recommendation: Delete Option C. If the underlying intent is "Docker is available but we cannot nest containers", point readers to the existing :::tip TIP block at lines 43–49 (privileged container + sb run --no-docker -l localhost). Only re-introduce a rootfs-extraction recipe once it is a supported, tested workflow shipped with the repo.

Agreement: 3/3 reviewers (severity 1 BLOCKER / 2 SHOULD-FIX, escalated to the highest per orchestrator policy).

[polarG]

[SHOULD-FIX] (Correctness) third_party/ + "build instructions" pointer is unactionable

Issue: third_party/Makefile does exist (targets cuda, rocm, common, cuda_cutlass, …, keyed off SB_MICRO_PATH, MPI_HOME, HIP_HOME, CUDA_VER), but there is no user-facing "build third_party on the host" guide in docs/. docs/getting-started/installation.mdx documents only the control-node build (pip install . && make postinstall). A user following "see third_party/ and build instructions" lands on a Makefile with no surrounding guidance and no required env-var documentation.

Impact: Option B cannot be reproduced from this doc alone, undermining the PR's goal of preventing rc=127.

Recommendation: Replace with a concrete pointer + required vars, e.g.:

   - **Option B:** On each node, install SuperBench (see
     [installation](installation.mdx)) and then build the native
     micro-benchmark binaries with the project Makefile:
     \`\`\`bash
     export SB_MICRO_PATH=/opt/superbench  # must match the value used at runtime
     cd third_party && make -j cuda   # or `make rocm` on AMD
     \`\`\`
     The supported variables (`SB_MICRO_PATH`, `MPI_HOME`, `HIP_HOME`,
     `CUDA_VER`, …) are defined at the top of `third_party/Makefile`.

Agreement: 2/3 reviewers.

[polarG]

[SHOULD-FIX] (Correctness) Cell omits the actual failing binary name (sb exec / sb)

Issue: The user types sb run --no-docker … on the control node, but the command Ansible actually runs on each remote host is sb exec … (superbench/runner/runner.py:127, wrapped via bash -c '... && cd $SB_WORKSPACE && {command}' at runner.py:494-498 when self._docker_config.skip is True). The shell error on a non-prepared host is therefore sb: command not found (rc 127). A user grepping logs for sb run: command not found will not find it.

Impact: Diagnostic ambiguity for the exact failure mode the PR is trying to document (fixes #715, which is precisely this command not found / rc=127 confusion).

Recommendation: Reword the cell (combine with the anchor and label fixes — see other comments on this line):

| `--no-docker` | `False` | Run on host directly without Docker. On remote nodes, the `sb` CLI (which Ansible invokes as `sb exec`) and its dependencies must be pre-installed on every target host; otherwise the remote shell exits with `sb: command not found` (rc 127). See [Using --no-docker on Remote Nodes](getting-started/run-superbench.md#using---no-docker-on-remote-nodes). |

Agreement: 1/3 reviewers (cross-references finding 11 below).

[polarG]

[SHOULD-FIX] (Correctness + Maintainability) Table cell is ~280 chars vs ≤80 in every sibling row

Issue: Valid Markdown, but ~280 chars in one cell forces the rendered Description column to balloon dramatically, breaks the visual alignment of every sibling row, and duplicates content that already lives at the link target. Every other Description cell in this table is one short sentence.

Impact: Source diffing / future column-width edits become painful. Readers scanning the flag table get a wall of text in one cell instead of a uniform reference table.

Recommendation: Reduce to a single-line caveat + deep link (also fixes the anchor and label findings):

| `--no-docker` | `False` | Run on host directly without Docker. On remote nodes, `sb` must be pre-installed on every host — see [Using --no-docker on Remote Nodes](getting-started/run-superbench.md#using---no-docker-on-remote-nodes). |

Agreement: 2/3 reviewers (1 NON-BLOCKING / 1 SHOULD-FIX, escalated).

[polarG]

[SHOULD-FIX] (Correctness) Cross-link omits the section anchor

Issue: run-superbench.md is now 64 lines with the new section as its last block. A no-anchor link lands the reader at # Run SuperBench and forces them to scroll through ## Deploy, ## Run, and the existing :::tip TIP before reaching the content the link promises. Existing precedent in this docs tree deep-links to in-page sections:

• docs/user-tutorial/system-config.md:31: [Deploy SuperBench](../getting-started/run-superbench.md#deploy)
• docs/user-tutorial/system-config.md:33: [Ansible Inventory](../getting-started/configuration.md#ansible-inventory)

Impact: Worse UX (extra scrolling) and inconsistent with the established #deploy / #ansible-inventory deep-link convention.

Recommendation: Append the Docusaurus-slugified fragment (verify the slug against a local yarn build once the heading is final):

[Using --no-docker on Remote Nodes](getting-started/run-superbench.md#using---no-docker-on-remote-nodes)

Agreement: 3/3 reviewers.

[polarG]

[SHOULD-FIX] (Maintainability) New section ignores the file's paragraph + bash-fence + admonition style

Issue: Every other prose unit in this file follows "1 short paragraph → ```bash fenced example → optional :::note / :::tip admonition" (## Deploy, ## Run). Confirmed by git grep -nE ':::(tip|note|caution|warning|info)' -- docs/:

docs/getting-started/installation.mdx:17::::tip Tips
docs/getting-started/installation.mdx:32::::note
docs/getting-started/installation.mdx:61::::note Note
docs/getting-started/run-superbench.md:27::::note Note
docs/getting-started/run-superbench.md:44::::tip TIP
docs/user-tutorial/baseline-generation.md:31::::tip Tips
docs/user-tutorial/result-summary.md:31::::tip Tips

The new section uses none — it is one dense 4-item bold-led numbered list, zero runnable code blocks, no admonitions. Items 1 (command not found, exit code 127) and 4 (HPC clusters with restricted container runtimes) are textbook :::caution / :::note material; Options A/B/C are command-driven yet show no commands.

Impact: Future editors will see one section that looks foreign to the rest of the page, increasing drift over time.

Recommendation: Restructure as paragraphs + 1–2 bash code fences + admonitions, e.g.:

### Using `--no-docker` on Remote Nodes

When you run `sb run --no-docker` against remote hosts (via `--host-file` or
`--host-list`), Ansible SSHes into each node and invokes the `sb` binary
directly, so SuperBench must already be installed on every target host.

\`\`\`bash
sb run --no-docker -f remote.ini -c resnet.yaml \\
  --config-override superbench.env.SB_MICRO_PATH=/opt/superbench
\`\`\`

:::caution
If `sb` is not on `PATH` on a remote host, the run fails with
`sb: command not found` (exit code 127).
:::

:::note
Set `SB_MICRO_PATH` (env var or `superbench.env.SB_MICRO_PATH` via
`--config-override`) to the on-host install path of the micro-benchmark
binaries.
:::

Agreement: 2/3 reviewers.

[polarG]

[SHOULD-FIX] (Maintainability) New section should be H3 under ## Run, not a peer H2

Issue: This document's existing H2 structure is the top-level workflow narrative (## Deploy → ## Run). The new section documents requirements for one specific variant of the sb run step and is logically a Run-time caveat — the existing :::tip TIP for the same flag is already correctly nested under ## Run. Adding it as a third peer H2 implies it is a separate workflow stage and splits --no-docker guidance across two sibling H2s.

Impact: Readers and the Docusaurus sidebar/TOC will surface "Using --no-docker on Remote Nodes" as a peer to Deploy/Run.

Recommendation: Demote to H3 under ## Run, immediately after (or merged into) the existing :::tip TIP:

## Run
...
:::tip TIP
... (existing local privileged-container note) ...
:::

### Using `--no-docker` on Remote Nodes
...

Agreement: 1/3 reviewers.

[polarG]

[NON-BLOCKING] (Maintainability) No cross-reference between the pre-existing :::tip TIP and the new section

Issue: Two adjacent blocks on the same flag with no narrative linkage (tip = local privileged container; new section = remote hosts). Not strictly contradictory, but future maintainers may update one and forget the other.

Recommendation: After demoting the new section to H3 under ## Run (sibling finding), add a leading sentence: "The tip above covers running --no-docker locally inside a privileged container. The requirements below apply when --no-docker is used against remote hosts."

Agreement: 1/3 reviewers.

[polarG]

[NON-BLOCKING] (Maintainability) "execute sb exec directly" leaks an internal subcommand

Issue: sb exec is the actual remote command (superbench/runner/runner.py:127, superbench/runner/playbooks/cleanup.yaml:5-7) but it is not documented as a user-facing command in docs/cli.md (which lists sb deploy, sb run, sb result …, etc.). Exposing it by name without explanation couples user docs to an implementation detail of runner.py — a future rename will silently rot this line.

Note: This conflicts with the suggestion to name sb exec in cli.md for diagnostic clarity (see the docs/cli.md line 378 comment about the failing binary). Reconcile by: in cli.md, say "the failing binary is sb"; in run-superbench.md, drop the sb exec reference and say "invokes the sb binary directly".

Recommendation: Rephrase, e.g.: "Ansible SSHes into each node and invokes the sb binary directly; if sb is not on PATH you will see sb: command not found (exit code 127)."

Agreement: 1/3 reviewers.

[polarG]

[NON-BLOCKING] (Maintainability) No back-link from run-superbench.md to cli.md

Issue: cli.md now links forward to this new section, but the new section never references cli.md. Other tutorial pages routinely back-link to the canonical flag table:

docs/user-tutorial/baseline-generation.md:17: ... [SuperBench CLI](../cli.md).
docs/user-tutorial/result-summary.md:17:   ... [SuperBench CLI](../cli.md).
docs/user-tutorial/data-diagnosis.md:17:   ... [SuperBench CLI](../cli.md).

Readers landing on the new section have no pointer back to --host-file, --host-list, --config-override (all referenced by name).

Recommendation: Add a one-liner at the top or bottom of the new section:

For the full list of flags accepted by `sb run`, see [SuperBench CLI](../cli.md#sb-run).

Agreement: 2/3 reviewers.