feat: define annotation namespaces and gateway-enforced ownership
維護者通常 1 天內回覆
還沒有人認領這個 Issue。
評估
- 難度
- 5/5
- 預估耗時
- 一週以上
- 新手友好度
- 35/100
- Issue 類型
- 功能
- 描述清晰度
- 基本清楚
- 活躍度
- 活躍
- 技術堆疊
- grpc, rust
研究方向
Start by inventorying annotation writers and readers at the cited gateway validation and sandbox creation paths, compute and session constants, UpdateConfig contract, and policy tests. Then define the ownership contract and trace every client-facing annotation write path, including retention and provenance compatibility. Done means documented namespaces, consistent gateway enforcement, and tests confirming allowed metadata, rejected writes, and preserved lifecycle and provenance behavior.
由索引模型根據 Issue 內容生成。
描述
User Story
As an OpenShell client developer or operator, I want a consistent annotation namespace and ownership contract enforced by the gateway, so that CLI, SDK, and direct API clients receive the same behavior and caller metadata remains usable.
Problem Statement
Review of PR #4325 identified that checking reserved annotation keys only in the CLI does not establish a contract across all clients. The review recommendation is to remove the CLI-only reserved-key check and its associated test and documentation claims from that PR, and address namespace consistency and any required reservation separately here.
Existing annotations use both openshell.nvidia.com/ and internal.openshell.ai/. These prefixes do not currently imply the same ownership rules: retention is supplied by the CLI and interpreted by the gateway, internal runtime/session annotations are gateway-managed, and existing policy-update tests accept caller/interceptor-supplied provenance under openshell.nvidia.com/.
Impact / Why This Matters
A CLI-only restriction produces different annotation behavior for otherwise equivalent clients. Blocking an entire prefix without defining its ownership can also reject existing provenance workflows while leaving a different namespace of gateway-managed metadata unrestricted.
Today, client developers must infer ownership from individual writers and readers and implement their own conventions. That workaround cannot guarantee consistency across clients or future annotation write paths.
Proposed Design
Inventory existing annotation keys and classify their intended writers and readers. Define and document consistent prefixes for caller metadata, gateway-managed state, and provenance supplied by integrations. Decide which prefixes or individual keys require reservation, rather than assuming every existing prefixed annotation must become reserved.
Where reservation applies, enforce it at gateway boundaries for every client-facing write path, including sandbox creation and sandbox-scoped configuration/policy updates. Define any supported trusted-integration behavior explicitly. Clients should receive a clear, consistent error when writing metadata they do not own.
Preserve ephemeral sandbox creation and existing supported provenance workflows, or document and test an explicit compatibility transition. Retention currently travels as an annotation from the CLI, so a blanket gateway rejection needs a replacement contract or a deliberate exception.
This is a follow-up to #4325 and #4303; it does not require implementing annotation ownership policy in the creation-time CLI flag change.
Acceptance Criteria
- Existing annotation keys, prefixes, and intended ownership are inventoried, including retention, internal runtime/session state, and integration provenance.
- A consistent annotation namespace and ownership contract is documented, identifying which keys/prefixes are reserved, if applicable.
- Any reserved-key rules are enforced by the gateway on all applicable caller-facing annotation write paths, with the same behavior for CLI, SDK, and direct RPC clients.
- Tests exercise gateway rejection of disallowed writes and acceptance of supported caller and integration metadata.
- Ephemeral sandbox lifecycle and supported policy provenance remain functional; any intentional compatibility change has documented migration guidance and tests.
- Public API documentation, user documentation, and related skills reflect the resulting contract.
Alternatives Considered
- CLI-only reservation: Gives early feedback but produces inconsistent behavior across clients and misses other write paths.
- Reserve all of
openshell.nvidia.com/immediately: Conflicts with existing provenance examples and CLI-supplied retention unless compatibility is addressed. - Leave all annotation ownership implicit: Avoids compatibility changes but perpetuates inconsistent namespaces and uncertainty about which metadata callers may write.
Agent Investigation
Source references are pinned to PR #4325 head ef959bc0eadca999e4dfae160165532a4dad97d0:
- PR CLI restriction rejects
openshell.nvidia.com/. - Gateway annotation validation checks syntax and size; sandbox creation copies request annotations into metadata.
- Compute annotation constants and session annotation constants use
internal.openshell.ai/. - UpdateConfig contract describes caller-provided opaque annotations and projection into sandbox metadata; tests supply
openshell.nvidia.com/policy-signatureandopenshell.nvidia.com/policy-provenance.
- 主要語言
- Rust
- 星號
- 15.4k
- 分支
- 1.7k
- 平均合併
- 2 天 22 分鐘
- 30 天內合併 PR
- 352
環境準備
- 沒有 Dockerfile 或 Docker Compose 檔案
- 有 Pull Request 範本
- 閱讀貢獻指南
從這裡開始
- 先讀完整個 Issue,再讀專案的貢獻指南。
- 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
- Fork 儲存庫,在一個分支上完成修改。
- 送出 Pull Request,並在描述裡引用這個 Issue 編號。
NVIDIA/OpenShell 的其他 Issue
-
state:triage-needed
難度 2/5 1-3 小時 新手友好度 76/100
維護者通常 1 天內回覆
-
state:triage-needed
難度 2/5 1-3 小時 新手友好度 65/100
維護者通常 1 天內回覆
-
state:triage-needed
難度 2/5 1-3 小時 新手友好度 70/100
維護者通常 1 天內回覆
-
docs: document workspace and provider label capabilities可能已有人在做 @johntmyers 於 6 天前認領。 未關閉area:docs
難度 2/5 1-3 小時 新手友好度 72/100
NVIDIA/OpenShell#4250 · 2 則留言 ·
維護者通常 1 天內回覆
-
bug(driver-mxc): test helper fails to compile after gateway-name argument可能已有人在做 @feloy 於 8 天前認領。 未關閉state:triage-needed
難度 1/5 1 小時以內 新手友好度 88/100
維護者通常 1 天內回覆
相似的 Issue
-
難度 1/5 1 小時以內 新手友好度 63/100
pop-os/cosmic-files#2117 ·
維護者通常 2 天內回覆
-
L: java:gradle L: java:maven L: ruby:bundler T: bug 🐞
難度 2/5 1-3 小時 新手友好度 76/100
dependabot/dependabot-core#16547 ·
維護者通常 1 天內回覆
-
bug status:ready-for-test
難度 2/5 1-3 小時 新手友好度 78/100
UniClipboard/UniClipboard#1985 · 1 則留言 ·
維護者通常 1 天內回覆
-
難度 1/5 1 小時以內 新手友好度 75/100
RustCrypto/SSH#596 ·
-
area:breg rust
難度 2/5 1-3 小時 新手友好度 76/100
registrystack/registry-stack#2034 ·
維護者通常 1 天內回覆