Skip to content

docs: update prerequisites Docker-driver wording#4165

Closed
glenn-agent wants to merge 2 commits into
NVIDIA:mainfrom
glenn-agent:docs/prerequisites-docker-driver-wording
Closed

docs: update prerequisites Docker-driver wording#4165
glenn-agent wants to merge 2 commits into
NVIDIA:mainfrom
glenn-agent:docs/prerequisites-docker-driver-wording

Conversation

@glenn-agent
Copy link
Copy Markdown
Contributor

@glenn-agent glenn-agent commented May 25, 2026

Summary

  • Remove the stale top-level k3s RAM-consumer wording from prerequisites
  • Reword the Docker storage driver note around the OpenShell gateway image instead of a k3s-specific limitation
  • Keep the change scoped to the remaining prerequisites wording; docs/reference/architecture.mdx already describes the Docker-driver topology on current main

Part of #3432

Signed-off-by: Glenn-Agent glenn_agent@163.com

Verification

  • npm run docs:strict (passes; existing Fern upgrade warnings only)
  • git diff --check
  • git verify-commit HEAD

Summary by CodeRabbit

  • Documentation
    • Clarified hardware prerequisites to specify which runtime components run during sandbox image push and to update image-building behavior when using newer Docker setups.
    • Expanded troubleshooting guidance for "image push OOM" errors, explaining memory buffering during export and advising minimum RAM considerations (≈8 GB).

Review Change Stack

Signed-off-by: Glenn-Agent <glenn_agent@163.com>
@copy-pr-bot
Copy link
Copy Markdown

copy-pr-bot Bot commented May 25, 2026

This pull request requires additional validation before any workflows can run on NVIDIA's runners.

Pull request vetters can view their responsibilities here.

Contributors can view more details about this message here.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 25, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: 59b207b4-1eec-4d5f-bb90-177ec12e6c8a

📥 Commits

Reviewing files that changed from the base of the PR and between 84ae0de and 5793770.

📒 Files selected for processing (2)
  • docs/get-started/prerequisites.mdx
  • docs/reference/troubleshooting.mdx
✅ Files skipped from review due to trivial changes (2)
  • docs/reference/troubleshooting.mdx
  • docs/get-started/prerequisites.mdx

📝 Walkthrough

Walkthrough

Documentation updates replace k3s/cluster-image wording with OpenShell gateway terminology and expand troubleshooting text to clarify that the Docker daemon and OpenShell gateway run alongside the export pipeline, which buffers decompressed layers and can cause OOM on low-RAM machines.

Changes

Prerequisites Documentation Updates

Layer / File(s) Summary
OOM guidance updates
docs/get-started/prerequisites.mdx, docs/reference/troubleshooting.mdx
Reworded hardware OOM-risk guidance and expanded troubleshooting text to state that the Docker daemon and OpenShell gateway run alongside the export pipeline and that decompressed-layer buffering can trigger OOM on systems with limited RAM.
Docker 26+ storage-driver note
docs/get-started/prerequisites.mdx
Updated the Docker 26+ containerd image-store prerequisite to say nemoclaw onboard builds a fuse-overlayfs-enabled OpenShell gateway image (instead of a fuse-overlayfs-enabled k3s cluster image) to bypass nested-overlay limitations.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Suggested labels

v0.0.49

Suggested reviewers

  • jyaunches

Poem

🐰 The gateway hums where clusters once lay,
Docs refreshed to show the newer way,
Memory warnings now clearer and bright,
OpenShell guides the sandbox through the night. ✨

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title directly reflects the main change: updating Docker-driver-related wording in the prerequisites documentation.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Warning

There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 ESLint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

ESLint skipped: no ESLint configuration detected in root package.json. To enable, add eslint to devDependencies.


Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🧹 Nitpick comments (1)
docs/get-started/prerequisites.mdx (1)

22-22: ⚡ Quick win

Split this into one sentence per source line.

Line 22 currently contains multiple sentences on a single line, which violates the docs source formatting rule.

As per coding guidelines, "One sentence per line in source (makes diffs readable). Flag paragraphs where multiple sentences appear on the same line."

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@docs/get-started/prerequisites.mdx` at line 22, The paragraph starting "The
sandbox image is approximately 2.4 GB compressed." currently contains multiple
sentences on one source line; split that paragraph so each sentence becomes its
own source line (e.g., one line for "The sandbox image is approximately 2.4 GB
compressed.", one line for "During image push, the Docker daemon and OpenShell
gateway run alongside the export pipeline.", one line for "The pipeline buffers
decompressed layers in memory.", and one line for "On machines with less than 8
GB of RAM, this combined usage can trigger the OOM killer.", plus a line for "If
you cannot add memory, configuring at least 8 GB of swap can work around the
issue at the cost of slower performance."), ensuring one sentence per line to
satisfy the docs source formatting rule.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@docs/get-started/prerequisites.mdx`:
- Line 22: The prerequisites page's runtime-components sentence ("The sandbox
image is approximately 2.4 GB compressed...") omits k3s but
docs/reference/troubleshooting.mdx still lists Docker daemon, k3s, and the
OpenShell gateway as running during sandbox image push; update
docs/get-started/prerequisites.mdx to either add "k3s" to that runtime
components list (so it reads "Docker daemon, k3s, and the OpenShell gateway run
alongside the export pipeline") or add a brief clarifying sentence explaining
why k3s is intentionally omitted and include a cross-reference to
docs/reference/troubleshooting.mdx to keep the guidance on RAM/swap sizing
consistent.

---

Nitpick comments:
In `@docs/get-started/prerequisites.mdx`:
- Line 22: The paragraph starting "The sandbox image is approximately 2.4 GB
compressed." currently contains multiple sentences on one source line; split
that paragraph so each sentence becomes its own source line (e.g., one line for
"The sandbox image is approximately 2.4 GB compressed.", one line for "During
image push, the Docker daemon and OpenShell gateway run alongside the export
pipeline.", one line for "The pipeline buffers decompressed layers in memory.",
and one line for "On machines with less than 8 GB of RAM, this combined usage
can trigger the OOM killer.", plus a line for "If you cannot add memory,
configuring at least 8 GB of swap can work around the issue at the cost of
slower performance."), ensuring one sentence per line to satisfy the docs source
formatting rule.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: 253c13bd-66b4-4e5a-bbc0-6f5d5575ba5a

📥 Commits

Reviewing files that changed from the base of the PR and between 8be9986 and 84ae0de.

📒 Files selected for processing (1)
  • docs/get-started/prerequisites.mdx

Comment thread docs/get-started/prerequisites.mdx Outdated
| Disk | 20 GB free | 40 GB free |

The sandbox image is approximately 2.4 GB compressed. During image push, the Docker daemon, k3s, and the OpenShell gateway run alongside the export pipeline. The pipeline buffers decompressed layers in memory. On machines with less than 8 GB of RAM, this combined usage can trigger the OOM killer. If you cannot add memory, configuring at least 8 GB of swap can work around the issue at the cost of slower performance.
The sandbox image is approximately 2.4 GB compressed. During image push, the Docker daemon and OpenShell gateway run alongside the export pipeline. The pipeline buffers decompressed layers in memory. On machines with less than 8 GB of RAM, this combined usage can trigger the OOM killer. If you cannot add memory, configuring at least 8 GB of swap can work around the issue at the cost of slower performance.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟠 Major | ⚡ Quick win

Runtime components list appears incomplete for the OOM path.

This sentence now omits k3s, but docs/reference/troubleshooting.mdx (Lines 62-67) still documents that Docker daemon, k3s, and the OpenShell gateway run during sandbox image push. Please align these pages (or clarify why prerequisites intentionally differs), since this affects RAM sizing guidance.

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@docs/get-started/prerequisites.mdx` at line 22, The prerequisites page's
runtime-components sentence ("The sandbox image is approximately 2.4 GB
compressed...") omits k3s but docs/reference/troubleshooting.mdx still lists
Docker daemon, k3s, and the OpenShell gateway as running during sandbox image
push; update docs/get-started/prerequisites.mdx to either add "k3s" to that
runtime components list (so it reads "Docker daemon, k3s, and the OpenShell
gateway run alongside the export pipeline") or add a brief clarifying sentence
explaining why k3s is intentionally omitted and include a cross-reference to
docs/reference/troubleshooting.mdx to keep the guidance on RAM/swap sizing
consistent.

Signed-off-by: Glenn-Agent <glenn_agent@163.com>
@wscurran
Copy link
Copy Markdown
Contributor

✨ Thanks for submitting this detailed PR about updating the prerequisites Docker-driver wording in the documentation. This proposes a way to clarify hardware prerequisites and update image-building behavior when using newer Docker setups.


Related open issues:

@wscurran wscurran requested a review from miyoungc May 26, 2026 17:57
@miyoungc
Copy link
Copy Markdown
Collaborator

miyoungc commented Jun 2, 2026

The related issue is resolved with #4028. Closing this PR.

@miyoungc miyoungc closed this Jun 2, 2026
@wscurran wscurran added area: packaging Packages, images, registries, installers, or distribution bug-fix PR fixes a bug or regression platform: container Affects Docker, containerd, Podman, or images area: docs Documentation, examples, guides, or docs build and removed Docker labels Jun 3, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area: docs Documentation, examples, guides, or docs build area: packaging Packages, images, registries, installers, or distribution bug-fix PR fixes a bug or regression platform: container Affects Docker, containerd, Podman, or images

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants