Skip to content

docs(gateway-config): remove invalid sandbox_uid from VM driver example#2367

Open
Bobbins228 wants to merge 1 commit into
NVIDIA:mainfrom
Bobbins228:2364-fix-vm-driver-sandbox-uid-docs/mcampbel
Open

docs(gateway-config): remove invalid sandbox_uid from VM driver example#2367
Bobbins228 wants to merge 1 commit into
NVIDIA:mainfrom
Bobbins228:2364-fix-vm-driver-sandbox-uid-docs/mcampbel

Conversation

@Bobbins228

Copy link
Copy Markdown

Summary

  • Remove the commented-out sandbox_uid field from the VM driver TOML example in docs/reference/gateway-config.mdx
  • VmComputeConfig uses deny_unknown_fields — uncommenting the line crashes the gateway with "unknown field sandbox_uid"
  • The field exists on the internal VmDriverConfig subprocess (crates/openshell-driver-vm/src/driver.rs:231), set via --sandbox-uid CLI arg, not through the gateway TOML

Related 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 retains sandbox_uid since KubernetesComputeConfig accepts it.

Testing

  • Verified uncommenting the field causes gateway startup crash
  • Verified the field is accepted on the openshell-driver-vm subprocess via --sandbox-uid
  • mise run pre-commit passes (markdown lint, license check, helm lint)

Checklist

  • Conventional commit format
  • DCO sign-off
  • No unrelated changes

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>
@copy-pr-bot

copy-pr-bot Bot commented Jul 20, 2026

Copy link
Copy Markdown

This pull request requires additional validation before any workflows can run on NVIDIA's runners.

Pull request vetters can view their responsibilities here.

Contributors can view more details about this message here.

@github-actions

github-actions Bot commented Jul 20, 2026

Copy link
Copy Markdown

All contributors have signed the DCO ✍️ ✅
Posted by the DCO Assistant Lite bot.

@Bobbins228

Copy link
Copy Markdown
Author

I have read the DCO document and I hereby sign the DCO.

@Bobbins228

Copy link
Copy Markdown
Author

recheck

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.

docs(gateway-config): VM driver example lists sandbox_uid but VmComputeConfig rejects it

1 participant