Skip to content

docs: document volume mounting & toolchain sharing for sbx and gVisor#6335

Merged
lpcox merged 4 commits into
mainfrom
docs-volume-mounting
Jul 17, 2026
Merged

docs: document volume mounting & toolchain sharing for sbx and gVisor#6335
lpcox merged 4 commits into
mainfrom
docs-volume-mounting

Conversation

@lpcox

@lpcox lpcox commented Jul 17, 2026

Copy link
Copy Markdown
Collaborator

What

Adds a volume mounting / filesystem sharing section to both integration docs, closing a gap where neither doc explained how the workspace and toolchains actually reach the sandbox.

docs/sbx-integration.md — "Volume mounting & toolchain sharing"

  • Explains the microVM's host-path == guest-path positional mount model (no chroot), contrasting it with compose mode's /host bind-mount + chroot.
  • Documents exactly what createSandbox() shares: the workspace (rw), --volume extra mounts (with the container-path segment discarded), and the three always-added mounts /usr/local/bin, /tmp, $HOME.
  • Adds a side-by-side comparison table (path model, system libraries, toolchain binaries, workspace, home) vs the compose agent.
  • Adds a toolchain portability caveat: system libraries come from the sbx guest image, not the host — the key thing to plan for in a future KVM microVM backend.

docs/gvisor-integration.md — "Volume mounting & filesystem access (the Gofer)"

  • Notes gVisor reuses the standard compose agent, so the bind-mount + chroot set is identical to default Docker mode (including the /host/tmp/awf-runner-bin toolchain path).
  • Explains the gVisor-specific twist: all filesystem I/O is proxied by the per-sandbox Gofer process (LISAFS/9P) rather than raw host FDs, with the resulting isolation and compatibility implications.

Verification

  • markdownlint passes on both files.
  • Details verified against src/sbx-manager.ts, src/commands/main-action.ts, and src/services/agent-volumes/system-mounts.ts.

Docs-only change.

sbx: add a 'Volume mounting & toolchain sharing' section explaining the
host-path==guest-path positional mount model (no chroot), what
createSandbox shares (workspace, extra mounts, /tmp, /usr/local/bin,
$HOME), a comparison table vs the compose chroot model, and a toolchain
portability caveat for a future KVM microVM backend.

gVisor: add a 'Volume mounting & filesystem access (the Gofer)' section
noting it reuses the standard compose agent bind-mount + chroot set, and
that all filesystem I/O is proxied by gVisor's per-sandbox Gofer process,
with the resulting isolation and compatibility implications.

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Copilot-Session: 23717692-af7a-4e03-a156-5b696c3f01bd
Copilot AI review requested due to automatic review settings July 17, 2026 22:48
@github-actions

github-actions Bot commented Jul 17, 2026

Copy link
Copy Markdown
Contributor

Documentation Preview

Documentation build failed for this PR. View logs.

Built from commit 931acd2

Copilot AI left a comment

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.

Pull request overview

Documents filesystem and toolchain sharing for the sbx and gVisor runtimes.

Changes:

  • Explains sbx positional mounts and portability constraints.
  • Documents compose mounts and gVisor filesystem mediation.
Show a summary per file
File Description
docs/sbx-integration.md Adds sbx volume and toolchain-sharing guidance.
docs/gvisor-integration.md Adds gVisor mount and Gofer filesystem guidance.

Review details

Tip

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

  • Files reviewed: 2/2 changed files
  • Comments generated: 3
  • Review effort level: Medium

Comment thread docs/sbx-integration.md Outdated
Comment thread docs/gvisor-integration.md Outdated
Comment thread docs/gvisor-integration.md Outdated
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
@github-actions

Copy link
Copy Markdown
Contributor

✅ Copilot review passed with no inline comments.

@lpcox Add the ready-for-aw label to this PR to trigger agentic CI smoke tests.

lpcox and others added 2 commits July 17, 2026 15:52
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
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