Docs - Add documentation for --no-docker parameter requirements (#715)#783
Docs - Add documentation for --no-docker parameter requirements (#715)#783NJX-njx wants to merge 4 commits intomicrosoft:mainfrom
Conversation
- Add new section 'Using --no-docker on Remote Nodes' in run-superbench.md - Document that sb binary and dependencies must be pre-installed on each remote host - Describe deployment options (extract container, install from source, etc.) - Note environment variables and use cases - Update --no-docker description in cli.md with link to detailed docs Fixes microsoft#715 Made-with: Cursor
There was a problem hiding this comment.
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-dockeron Remote Nodes” section to describe prerequisites and deployment approaches. - Expanded the
--no-dockerCLI 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.
docs/cli.md
Outdated
| | `--host-password` | `None` | Host password or key passphrase if needed. | | ||
| | `--host-username` | `None` | Host username if needed. | | ||
| | `--no-docker` | `False` | Run on host directly without Docker. | | ||
| | `--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. | |
There was a problem hiding this comment.
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.
| | `--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. | |
|
@NJX-njx please read the following Contributor License Agreement(CLA). If you agree with the CLA, please reply with the following information.
Contributor License AgreementContribution License AgreementThis Contribution License Agreement (“Agreement”) is agreed to by the party signing below (“You”),
|
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Summary
Fixes #715 - Documents the requirements and expectations when using
--no-dockeron remote nodes.Problem
Users running
sb run --no-dockeron remote nodes encounteredcommand not found(rc=127) because the documentation did not explain that SuperBench must be pre-installed on each target host.Changes
sbCLI and dependencies must be pre-installed on each remote nodeSB_MICRO_PATH)--no-dockerdescription with brief requirements and link to detailed docs