Skip to content

docs: document sandbox class differences and fix stale passages - #3468

Merged
Dmitry Berkovich (dberkov) merged 2 commits into
agent-substrate:mainfrom
nybidari:docs-sandbox-classes
Oct 30, 2026
Merged

Dmitry Berkovich (dberkov) merged 2 commits into
agent-substrate:mainfrom
nybidari:docs-sandbox-classes

Conversation

@nybidari

@nybidari nybidari commented Oct 29, 2026 •

Copy link
Copy Markdown
Collaborator

Part of #3226

Add docs/reference/sandbox-classes.md comparing the gvisor and microvm sandbox classes across CPU sizing, memory limits, per-container limits, NET_RAW capabilities, system mounts, VOLUMES/ROOTFS snapshots and gVisor fscheckpoint compatibility requirement for cross-version filesystem restores. Update stale references across architecture, glossary, quickstart, and guides.

AI use:
AI-assisted, I reviewed and tested it.

  • Tests pass
  • Docs updated

@nybidari
nybidari force-pushed the docs-sandbox-classes branch 4 times, most recently from 9cc5abd to 90ef049 Compare October 30, 2026 00:57
@nybidari
nybidari force-pushed the docs-sandbox-classes branch 2 times, most recently from 8fbbca7 to 930bc6f Compare October 30, 2026 01:34
Comment thread docs/reference/api-guide.md Outdated
Comment on lines +498 to +499
A snapshot without `sandboxRuntime` or with `SNAPSHOT_FIDELITY_ROOTFS` or
`SNAPSHOT_FIDELITY_VOLUMES` imposes no runtime placement constraint. Because a
`SNAPSHOT_FIDELITY_VOLUMES` imposes no runtime placement constraint. On gVisor,

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

🤖 should-fix 🟡 – "No runtime placement constraint" is only true of the runtime version. The scheduler still pins every fidelity to the snapshot's sandbox class (cmd/ateapi/internal/scheduling/scheduling.go:35-41), which is what sandbox-classes.md says above. As written, this sentence reads as contradicting it.

Suggest: "imposes no runtime-version placement constraint, though it still runs on a worker of the snapshot's sandbox class."

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

Done, also rebased.

@nybidari
nybidari force-pushed the docs-sandbox-classes branch 2 times, most recently from 105bd15 to bbca727 Compare October 30, 2026 02:01
Add docs/reference/sandbox-classes.md comparing the gvisor and microvm sandbox classes across CPU sizing, memory limits, per-container limits, NET_RAW capabilities, system mounts, and VOLUMES/ROOTFS snapshots. Document the gVisor fscheckpoint compatibility requirement for cross-version filesystem restores, the runsc CPU count floor of 2, and NET_RAW stripping in the API guide and version skew policy. Update stale references across architecture, glossary, overview, quickstart, and guides.

Signed-off-by: Nayana Bidari <[email protected]>
Update the API guide about imposing no runtime placement constraint.

Signed-off-by: Nayana Bidari <[email protected]>
@nybidari
nybidari force-pushed the docs-sandbox-classes branch from bbca727 to dd4d113 Compare October 30, 2026 02:03
@dberkov
Dmitry Berkovich (dberkov) added this pull request to the merge queue Oct 30, 2026
Merged via the queue into agent-substrate:main with commit 46b6ea9 Oct 30, 2026
7 checks passed
Dmitry Berkovich (dberkov) pushed a commit that referenced this pull request Nov 2, 2026
Part of #3226

Add docs/reference/sandbox-classes.md comparing the gvisor and microvm
sandbox classes across CPU sizing, memory limits, per-container limits,
NET_RAW capabilities, system mounts, VOLUMES/ROOTFS snapshots and gVisor
fscheckpoint compatibility requirement for cross-version filesystem
restores. Update stale references across architecture, glossary,
quickstart, and guides.

AI use:
AI-assisted, I reviewed and tested it.

- [ ] Tests pass
- [x] Docs updated

---------

Signed-off-by: Nayana Bidari <[email protected]>
(cherry picked from commit 46b6ea9)
Signed-off-by: Eitan Yarmush <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants