docs(gateway-config): VM driver example lists sandbox_uid but VmComputeConfig rejects it
まだ誰も着手していません。
評価
- 難易度
- 1/5
- 見積もり時間
- 1時間未満
- 初心者へのやさしさ
- 82/100
- issue の種類
- ドキュメント
- 明瞭さ
- 明確に書かれている
- 活発さ
- 静か
- 技術スタック
- rust
調査の方向性
docs/reference/gateway-config.mdx の 423–425 行付近にある VM ドライバーの例から始め、次にそのフィールドを crates/openshell-server/src/compute/vm.rs:65 の VmComputeConfig と比較します。crates/openshell-driver-vm/src/driver.rs:231 のスタンドアロンドライバー定義を確認し、例に gateway パーサーが受け付けるフィールドだけが含まれていることを検証します。最小限の TOML 設定を再現して、もはや失敗しないことを確認します。
索引モデルが issue の本文から書いたものです。
説明
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)
- 主要言語
- Rust
- スター
- 8.7k
- フォーク
- 1.3k
- 平均マージ
- 2日 7時間
- マージ済み PR(30日)
- 243
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
NVIDIA/OpenShell のほかの issue
-
area:docs
難易度 1/5 1時間未満 初心者へのやさしさ 88/100
-
state:triage-needed
難易度 2/5 1〜3時間 初心者へのやさしさ 82/100
-
area:cli state:validated
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
-
state:triage-needed
難易度 1/5 1時間未満 初心者へのやさしさ 90/100
-
area:build spike state:review-ready state:stale
難易度 2/5 半日 初心者へのやさしさ 68/100
NVIDIA/OpenShell の issue をすべて見る
似ている issue
-
risk:low runtime status:in-progress type:test
難易度 1/5 1時間未満 初心者へのやさしさ 92/100
zeroclaw-labs/zeroclaw#11023 ·
-
good first issue refactor
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
-
難易度 2/5 1〜3時間 初心者へのやさしさ 86/100
kwakseongjae/auto-hwp#319 ·
-
area:cli bug filter-quality good first issue priority:medium
難易度 2/5 1〜3時間 初心者へのやさしさ 84/100
-
難易度 1/5 1時間未満 初心者へのやさしさ 72/100
bevyengine/bevy#25861 ·