docs(gateway-config): VM driver example lists sandbox_uid but VmComputeConfig rejects it
Nessuno ha ancora preso questa issue.
Valutazione
- Difficoltà
- 1/5
- Tempo stimato
- Meno di un'ora
- Idoneità per principianti
- 82/100
- Tipo di issue
- Documentazione
- Chiarezza
- Specificata chiaramente
- Stato di attività
- Tranquilla
- Stack tecnologico
- rust
- Ambito
- documentation
Direzione di ricerca
Inizia con l’esempio del driver VM in docs/reference/gateway-config.mdx intorno alle righe 423–425, quindi confronta i suoi campi con VmComputeConfig in crates/openshell-server/src/compute/vm.rs:65. Controlla la definizione autonoma del driver in crates/openshell-driver-vm/src/driver.rs:231 e verifica che l’esempio contenga solo campi accettati dal parser del gateway; riproduci la configurazione TOML minima per confermare che non fallisca più.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
Agent Diagnostic
- Skills loaded: create-github-issue
- OpenShell version tested: main @ 8cf2673c
- Latest release checked: unable to verify
- Known fixes reviewed: #1959 (sandbox UID injection feature) and #2335 (Docker/Podman identity injection PR) are in-flight but neither addresses this docs bug
- Possible duplicates reviewed: searched open issues for
sandbox_uid— no existing report for this docs problem - Findings: uncommenting
sandbox_uidin the VM driver TOML example crashes the gateway at startup - Remaining reason for filing: the docs example advertises a field that the gateway TOML parser rejects
Description
Actual behavior: The VM driver example in docs/reference/gateway-config.mdx (lines 423–425) shows:
# sandbox_uid = 20001
Uncommenting this line causes the gateway to crash at config parse time:
Error: configuration error: invalid [openshell.drivers.vm] table: unknown field
`sandbox_uid`, expected one of `state_dir`, `driver_dir`, `default_image`,
`grpc_endpoint`, `bootstrap_image`, `krun_log_level`, `vcpus`, `mem_mib`,
`overlay_disk_mib`, `guest_tls_ca`, `guest_tls_cert`, `guest_tls_key`
VmComputeConfig in crates/openshell-server/src/compute/vm.rs:65 uses #[serde(deny_unknown_fields)] and has no sandbox_uid field.
Expected behavior: The docs example should only show fields that the gateway TOML parser accepts. sandbox_uid exists on VmDriverConfig in the standalone openshell-driver-vm subprocess (crates/openshell-driver-vm/src/driver.rs:231), where it is set via --sandbox-uid / OPENSHELL_VM_SANDBOX_UID CLI args — not through the gateway TOML file.
Reproduction Steps
- Create a minimal TOML file with the VM driver and
sandbox_uiduncommented:[openshell] version = 1 [openshell.gateway] compute_drivers = ["vm"] disable_tls = true [openshell.drivers.vm] sandbox_uid = 20001 - Run
openshell gateway --config /path/to/file.toml - Observe the "unknown field
sandbox_uid" error
Proposed Fix
Remove lines 423–425 (the sandbox_uid comment block) from the VM driver example in docs/reference/gateway-config.mdx. The Kubernetes driver example at line 294 correctly shows sandbox_uid because KubernetesComputeConfig does accept it.
Environment
- OS: macOS Darwin 25.5.0
- OpenShell: main branch (8cf2673c)
- Lingua principale
- Rust
- Stelle
- 8.7k
- Fork
- 1.3k
- Merge medio
- 2g 7h
- PR unite (30g)
- 243
Guida per i contributori
Apri la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Altre issue di NVIDIA/OpenShell
-
area:docs
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 88/100
-
state:triage-needed
Difficoltà 2/5 1-3 ore Idoneità per principianti 82/100
-
area:cli state:validated
Difficoltà 2/5 1-3 ore Idoneità per principianti 72/100
-
state:triage-needed
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 90/100
-
area:build spike state:review-ready state:stale
Difficoltà 2/5 Mezza giornata Idoneità per principianti 68/100
Tutte le issue di NVIDIA/OpenShell
Issue simili
-
risk:low runtime status:in-progress type:test
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 92/100
zeroclaw-labs/zeroclaw#11023 ·
-
good first issue refactor
Difficoltà 2/5 1-3 ore Idoneità per principianti 72/100
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 84/100
EricSpencer00/Resilient#4835 · 1 commento ·
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 74/100
bisq-network/bisq-musig#204 ·
-
agent:ready documentation
Difficoltà 2/5 1-3 ore Idoneità per principianti 88/100
cesarferreira/stax#890 ·