docs(gateway-config): remove invalid sandbox_uid from VM driver example#2367
Open
Bobbins228 wants to merge 1 commit into
Open
docs(gateway-config): remove invalid sandbox_uid from VM driver example#2367Bobbins228 wants to merge 1 commit into
Bobbins228 wants to merge 1 commit into
Conversation
VmComputeConfig uses deny_unknown_fields and has no sandbox_uid field. Uncommenting the example line crashes the gateway at startup. The field exists on the internal VmDriverConfig subprocess, not the gateway TOML. Fixes NVIDIA#2364 Signed-off-by: Bobbins228 <mcampbel@redhat.com>
Bobbins228
requested review from
a team,
derekwaynecarr,
maxamillion and
mrunalp
as code owners
July 20, 2026 15:22
|
All contributors have signed the DCO ✍️ ✅ |
Author
|
I have read the DCO document and I hereby sign the DCO. |
Author
|
recheck |
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
sandbox_uidfield from the VM driver TOML example indocs/reference/gateway-config.mdxVmComputeConfigusesdeny_unknown_fields— uncommenting the line crashes the gateway with "unknown fieldsandbox_uid"VmDriverConfigsubprocess (crates/openshell-driver-vm/src/driver.rs:231), set via--sandbox-uidCLI arg, not through the gateway TOMLRelated Issue
Fixes #2364
Changes
Removed 3 lines (comment block + commented-out field) from the VM driver example in
docs/reference/gateway-config.mdx. The Kubernetes driver example correctly retainssandbox_uidsinceKubernetesComputeConfigaccepts it.Testing
openshell-driver-vmsubprocess via--sandbox-uidmise run pre-commitpasses (markdown lint, license check, helm lint)Checklist