Repository navigation
[mount-docs] Correct sbx mount policy consumers and extra-mount flag in mount docs - #11619
Merged
Merged
Conversation
- 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>
Contributor
There was a problem hiding this comment.
🟢 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
--volumeflag with the supported-v, --mountoption. - Documents the credential backup directory's randomized
mkdtempsuffix instead of a process ID. - Updates mount-policy consumer references from
sbx-manager.tsto 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)
Contributor
Author
|
✅ Copilot review passed with no inline comments. @github-actions[bot] Add the |
Contributor
Author
Documentation PreviewDocumentation has been built for this PR. To view locally:
Built from commit a228e7b |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Three verified documentation corrections to mount guides, based on the implementation at audited commit
e0ab1b3ba287770a4fb4da07b863d90040098292(main).Discrepancies and corrections
docs/mount-policy.mdnames the wrong sbx policy consumer. The table listssbx-manager.tsas consuminghome.toolSubdirs,home.narrowPaths, andcredentials.entries.sbx-manager.tsonly delegates tosrc/sbx/; the policy is consumed bysrc/sbx/sandbox-create.ts(HOME_TOOL_PATHS mounts) andsrc/sbx/credential-scrub.ts(credential move-aside). Corrected to those files.src/sbx-manager.tsL10 imports onlyCredentialScrubHandleandcreateSandboxInternalsrc/sbx/sandbox-create.tsL157for (const toolPath of HOME_TOOL_PATHS)src/sbx/credential-scrub.tsL136credentialEntriesUnderMountedPathsdocs/sbx-integration.mdcites a nonexistent--volumeflag. The extra-mounts step saysconfig.volumeMountscomes from--volume. The only CLI flag is-v, --mount <host_path:container_path[:mode]>. Corrected.src/cli-options.tsL273'-v, --mount <host_path:container_path[:mode]>'docs/sbx-integration.mdmisdescribes the credential backup directory name. It says.awf-sbx-cred-backup-<pid>. The code creates it withfs.mkdtempSync(path.join(homePath, '.awf-sbx-cred-backup-')), which appends a random suffix, not the PID. Corrected.src/sbx/credential-scrub.tsL191What was checked
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.src/config/mount-policy.ts,sandbox-mount-policy.json.src/cloud-hypervisor/exports.ts(no$HOMEexport confirmed),enclave-export-plan.ts, NVXguest-config-layer.ts(copy exclusions confirmed).config-writer.ts(0o700),dind-probe.ts,fs-utils.ts,chroot-home-setup.ts,log-directory-setup.ts.MicrovmWorkspaceImagehas no production caller, consistent with the doc. The debug-artifact isolation guard insrc/enclave/mount-policy.tsis called frommain-action.ts.Limitations
.copilotsession-state/logs0755wording 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.