Skip to content

[mount-docs] Correct sbx mount policy consumers and extra-mount flag in mount docs - #11619

Merged
lpcox merged 1 commit into
mainfrom
mount-docs/audit-e0ab1b3-8f6bc89020095bfc
Nov 15, 2026
Merged

lpcox merged 1 commit into
mainfrom
mount-docs/audit-e0ab1b3-8f6bc89020095bfc

Conversation

@github-actions

Copy link
Copy Markdown
Contributor

Summary

Three verified documentation corrections to mount guides, based on the implementation at audited commit e0ab1b3ba287770a4fb4da07b863d90040098292 (main).

Discrepancies and corrections

  1. docs/mount-policy.md names the wrong sbx policy consumer. The table lists sbx-manager.ts as consuming home.toolSubdirs, home.narrowPaths, and credentials.entries. sbx-manager.ts only delegates to src/sbx/; the policy is consumed by src/sbx/sandbox-create.ts (HOME_TOOL_PATHS mounts) and src/sbx/credential-scrub.ts (credential move-aside). Corrected to those files.

  2. docs/sbx-integration.md cites a nonexistent --volume flag. The extra-mounts step says config.volumeMounts comes from --volume. The only CLI flag is -v, --mount <host_path:container_path[:mode]>. Corrected.

  3. docs/sbx-integration.md misdescribes the credential backup directory name. It says .awf-sbx-cred-backup-<pid>. The code creates it with fs.mkdtempSync(path.join(homePath, '.awf-sbx-cred-backup-')), which appends a random suffix, not the PID. Corrected.

What was checked

  • Compose mount construction: volume-builder.ts, home-strategy.ts, home-whitelist.ts, system-mounts.ts, etc-mounts.ts, credential-hiding.ts, workspace-mounts.ts, docker-socket.ts, filesystem-write-policy.ts.
  • Policy loader and JSON: src/config/mount-policy.ts, sandbox-mount-policy.json.
  • Runtime exports: src/cloud-hypervisor/exports.ts (no $HOME export confirmed), enclave-export-plan.ts, NVX guest-config-layer.ts (copy exclusions confirmed).
  • Work-dir/log/chroot-home modes: config-writer.ts (0o700), dind-probe.ts, fs-utils.ts, chroot-home-setup.ts, log-directory-setup.ts.
  • Caller tracing: MicrovmWorkspaceImage has no production caller, consistent with the doc. The debug-artifact isolation guard in src/enclave/mount-policy.ts is called from main-action.ts.

Limitations

  • Claims were checked by source reading only. No containers were started and no mount examples were executed.
  • Some other claims in the allowed guides (for example the .copilot session-state/logs 0755 wording and the Cloud Hypervisor "does not consult this policy" statement) were reviewed but left unchanged: the evidence was mixed or the wording is defensible, so they are not corrected here.
  • Only the three items above were verified as concrete discrepancies; no other files in the allowlist were modified.

Generated by Mount Documentation Maintainer · copilot · routed: haiku55 xhigh · ~91 AIC · ⌖ ~1 AIC · ⊞ 3.5K · ◷

- mount-policy.md: sbx consumers are src/sbx/sandbox-create.ts and
  src/sbx/credential-scrub.ts, not src/sbx-manager.ts (which only
  delegates to them).
- sbx-integration.md: extra mounts come from -v, --mount (there is no
  --volume flag).
- sbx-integration.md: credential backup dir name is produced by mkdtemp
  with a random suffix, not a <pid> suffix.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@lpcox
lpcox marked this pull request as ready for review November 15, 2026 16:52
Copilot AI adaptive review requested due to automatic review settings November 15, 2026 16:52

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.

🟢 Approval recommended

No unresolved review issues are identified, and the changes address the documented mount-related discrepancies.

No open issues 🎉

What changed in this PR

Corrects three mount-related documentation discrepancies so the sbx integration and mount-policy guides accurately reflect the current implementation.

Changes:

  • Replaces the nonexistent --volume flag with the supported -v, --mount option.
  • Documents the credential backup directory's randomized mkdtemp suffix instead of a process ID.
  • Updates mount-policy consumer references from sbx-manager.ts to the actual sbx implementation modules.
File Description
docs/​sbx-integration.md Corrects the extra-mount option and credential backup directory documentation for sbx.
docs/​mount-policy.md Identifies the actual sbx modules that consume home and credential mount-policy entries.

Review effort: Lite (dynamic)

@github-actions

Copy link
Copy Markdown
Contributor Author

✅ Copilot review passed with no inline comments.

@github-actions[bot] Add the ready-for-aw label to this PR to trigger agentic CI smoke tests.

@github-actions

Copy link
Copy Markdown
Contributor Author

Documentation Preview

Documentation has been built for this PR.

Download preview artifact

To view locally:

  1. Download the docs-preview-pr-11619 artifact from the workflow run
  2. Unzip and open index.html in your browser

Built from commit a228e7b

@lpcox
lpcox merged commit 21cf578 into main Nov 15, 2026
28 of 29 checks passed
@lpcox
lpcox deleted the mount-docs/audit-e0ab1b3-8f6bc89020095bfc branch November 15, 2026 18:55
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