Repository navigation
[code-documentation] Document the sandbox workload identity option - #247
Merged
Pedro Henrique Penna (ppenna) merged 1 commit intoSep 29, 2026
Conversation
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Copilot started reviewing on behalf of
Pedro Henrique Penna (ppenna)
September 29, 2026 05:36
View session
Contributor
There was a problem hiding this comment.
Copilot review overview
🟢 Approval recommended
The documentation accurately matches the parser default, validation, and runtime behavior.
Review effort: Balanced
Findings: None
What changed in this PR
Documents the existing sandbox workload identity option in the CLI reference.
Changes:
- Adds
--workload-user UID:GIDto the sandbox synopsis. - Documents its default and applicable operations.
| File | Description |
|---|---|
doc/usage.md |
Documents the sandbox workload identity option. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Pedro Henrique Penna (ppenna)
marked this pull request as ready for review
September 29, 2026 14:27
Pedro Henrique Penna (ppenna)
deleted the
code-documentation/sandbox-workload-user-36526354851-7c8c9710a8207424
branch
September 29, 2026 14:40
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
Documents the existing
sandbox --workload-user UID:GIDoption in the command synopsis and option table, including its65534:65534default and its use byrunandprovision.Evidence
The
doc/usage.md### sandboxsection previously omitted this option from both the synopsis and table.scripts/nvx.pydefines--workload-useras a fixed non-root workload identity, defaults it to65534:65534, and applies it when constructingrunorprovisionlaunches;python3 scripts/nvx.py sandbox --helpconfirms the same public CLI contract.This does not duplicate the merged lifecycle documentation in #242 or the benchmark option documentation in #246. Searches for
workload-userand sandbox identity documentation found no issue or active pull request tracking this omission. Active PRs #110 and #121 change otherdoc/usage.mdsections; closed PR #222 concerned live virtio-fs mounts, and #229 tracks sandbox test coverage rather than this reference entry.Scope
doc/usage.mdonly.scripts/nvx.py; no new path or link was added.Validation
python3 scripts/nvx.py sandbox --help— passed; lists--workload-user UID:GIDand default65534:65534.test -f doc/usage.md— passed.grep -n -- '"--workload-user"' scripts/nvx.py— passed; found the parser definition.git diff --check— passed.git diff --numstat—2 0 doc/usage.md.git diff --raw— one regular Markdown file; no gitlink change.No dependency, public API/CLI/ABI, gitlink, or OpenVMM change was made.