docs(gateway-config): VM driver example lists sandbox_uid but VmComputeConfig rejects it
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 1/5
- Tiempo estimado
- Menos de una hora
- Aptitud para principiantes
- 82/100
- Tipo de issue
- Documentación
- Claridad
- Bien especificado
- Estado de actividad
- Tranquilo
- Stack tecnológico
- rust
- Área
- documentation
Línea de trabajo
Comienza con el ejemplo del controlador VM en docs/reference/gateway-config.mdx alrededor de las líneas 423–425 y, a continuación, compara sus campos con VmComputeConfig en crates/openshell-server/src/compute/vm.rs:65. Comprueba la definición independiente del controlador en crates/openshell-driver-vm/src/driver.rs:231 y verifica que el ejemplo contenga únicamente campos aceptados por el analizador del gateway; reproduce la configuración TOML mínima para confirmar que ya no falla.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
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)
- Lenguaje dominante
- Rust
- Estrellas
- 8.7k
- Forks
- 1.3k
- Merge medio
- 2 d 6 h
- PR fusionados (30 d)
- 236
Guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Más de NVIDIA/OpenShell
-
area:docs
Dificultad 1/5 Menos de una hora Aptitud para principiantes 88/100
-
state:triage-needed
Dificultad 2/5 1-3 horas Aptitud para principiantes 82/100
-
area:cli state:validated
Dificultad 2/5 1-3 horas Aptitud para principiantes 72/100
-
state:triage-needed
Dificultad 1/5 Menos de una hora Aptitud para principiantes 90/100
-
area:build spike state:review-ready state:stale
Dificultad 2/5 Medio día Aptitud para principiantes 68/100
Todos los issues de NVIDIA/OpenShell
Issues similares
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 84/100
Eynzof/Hermes-CN-Desktop#610 ·
-
bug
Dificultad 2/5 1-3 horas Aptitud para principiantes 68/100
gitbutlerapp/gitbutler#15998 · 1 comentario ·
-
bug triage:deciding
Dificultad 1/5 Menos de una hora Aptitud para principiantes 88/100
open-telemetry/otel-arrow#4132 ·
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 88/100
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 84/100