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

Aperta Adatta ai principianti
#2,364 2 commenti 0 reazioni 0 assegnatari Vedi su GitHub

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

area:docs state:stale

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_uid in 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

  1. Create a minimal TOML file with the VM driver and sandbox_uid uncommented:
    [openshell]
    version = 1
    
    [openshell.gateway]
    compute_drivers = ["vm"]
    disable_tls = true
    
    [openshell.drivers.vm]
    sandbox_uid = 20001
    
  2. Run openshell gateway --config /path/to/file.toml
  3. 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

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di NVIDIA/OpenShell

Tutte le issue di NVIDIA/OpenShell

Issue simili

Altre issue su Rust

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.