Skip to content

fix(setup-spark): clarify that onboard must be re-run after setup (fixes #738)#750

Open
kagura-agent wants to merge 1 commit intoNVIDIA:mainfrom
kagura-agent:fix/setup-spark-next-step-clarity
Open

fix(setup-spark): clarify that onboard must be re-run after setup (fixes #738)#750
kagura-agent wants to merge 1 commit intoNVIDIA:mainfrom
kagura-agent:fix/setup-spark-next-step-clarity

Conversation

@kagura-agent
Copy link
Contributor

@kagura-agent kagura-agent commented Mar 23, 2026

Summary

Add post-setup guidance to nemoclaw setup-spark explaining that nemoclaw onboard must be re-run to rebuild the sandbox image with the updated Docker configuration.

Related Issue

Fixes #738.

Changes

  • scripts/setup-spark.sh: Add next-step message after Docker configuration completes, explaining why re-running onboard is needed.

Type of Change

  • Code change for a new feature, bug fix, or refactor.
  • Code change with doc updates.
  • Doc only.

Testing

  • bash -n scripts/setup-spark.sh passes (syntax check)
  • Message output verified by reading the script diff

Checklist

General

  • I have read and followed the contributing guide.
  • Single-purpose PR — one fix, one issue.

Summary by CodeRabbit

  • Documentation
    • Updated setup script output with clearer instructions for rebuilding the sandbox image after Docker configuration changes. Users who have already completed initial setup will see guidance on rerunning the necessary command.

 NVIDIA#738)

After setup-spark configures Docker for cgroupns=host, users need to
run 'nemoclaw onboard' again to rebuild the sandbox image. The script
previously ended without any next-step guidance, leaving users unsure
whether their initial onboard was sufficient.

Add clear post-setup message explaining:
- What to do next (run nemoclaw onboard)
- Why it's needed (sandbox image must be rebuilt)
- That re-running onboard is expected, not an error
@coderabbitai
Copy link

coderabbitai bot commented Mar 23, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: b841958f-146e-4d24-88e9-c2864ac7d014

📥 Commits

Reviewing files that changed from the base of the PR and between e1097a6 and 0590947.

📒 Files selected for processing (1)
  • scripts/setup-spark.sh

📝 Walkthrough

Walkthrough

The scripts/setup-spark.sh script now includes additional end-of-run informational messages. These messages clarify that users must run nemoclaw onboard to rebuild the sandbox image after the Docker default-cgroupns-mode is updated to host. A conditional note specifically instructs users who already ran nemoclaw onboard during setup to rerun it.

Changes

Cohort / File(s) Summary
Setup Script Output Messages
scripts/setup-spark.sh
Added informational messages at script completion clarifying the need to run nemoclaw onboard again to rebuild the sandbox image with updated Docker cgroupns=host configuration. Messages distinguish between new users and those who already ran onboard during initial setup.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

🐰 Ears twitching with glee!
A message so clear, no mystery to see,
"Run onboard again!" the script now does say,
Sandbox images rebuilt the proper way,
Confusion hops off—clarity wins the day! 🎉

🚥 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 and accurately summarizes the main change: clarifying onboard must be re-run after setup-spark runs, which matches the PR's core objective of reducing user confusion about the setup flow.
Linked Issues check ✅ Passed The PR addresses issue #738 by implementing the second expected resolution: updating setup-spark output to clearly state that nemoclaw onboard must be re-run to rebuild the sandbox image with new Docker configuration.
Out of Scope Changes check ✅ Passed All changes are scoped to scripts/setup-spark.sh output messages. The PR adds clarification text only and makes no alterations to control flow, configuration logic, or error handling, remaining fully aligned with issue #738's objectives.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

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

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

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

@wscurran wscurran added bug Something isn't working Getting Started Use this label to identify setup, installation, or onboarding issues. labels Mar 24, 2026
@wscurran
Copy link
Contributor

Thanks for submitting this PR, it adds post-setup guidance to clarify that onboard must be re-run, which could improve the user experience and prevent potential issues for new users.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bug Something isn't working Getting Started Use this label to identify setup, installation, or onboarding issues.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

setup-spark does not build sandbox image; confusing onboard flow

2 participants