Skip to content

Commit e8811a6

Browse files
committed
docs: reorganize navigation around core concepts
Signed-off-by: Drew Newberry <anewberry@nvidia.com>
1 parent 4107bb3 commit e8811a6

3 files changed

Lines changed: 169 additions & 14 deletions

File tree

‎docs/extensibility/drivers.mdx‎

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
---
2+
# SPDX-FileCopyrightText: Copyright (c) 2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
3+
# SPDX-License-Identifier: Apache-2.0
4+
title: "Drivers"
5+
description: "Understand the compute and credential driver extension points in OpenShell."
6+
keywords: "OpenShell Extensions, Compute Drivers, Credential Drivers, Extensibility"
7+
---
8+
9+
OpenShell uses drivers to connect the gateway to workload runtimes and
10+
credential stores. Drivers implement a stable capability boundary while the
11+
gateway owns the public API, authorization, workspace scoping, and resource
12+
lifecycle.
13+
14+
## Compute Drivers
15+
16+
Compute drivers create, inspect, and delete sandbox workloads. OpenShell ships
17+
drivers for Kubernetes, Docker, Podman, virtual machines, and Windows MXC. An
18+
external compute driver communicates with the gateway over a Unix domain
19+
socket and negotiates its protocol version and capabilities before serving
20+
requests.
21+
22+
For built-in driver configuration and behavior, refer to
23+
[Compute Drivers](/reference/sandbox-compute-drivers).
24+
25+
## Credential Drivers
26+
27+
Credential drivers store provider credentials behind opaque handles. The
28+
gateway resolves those handles when a provider is attached without persisting
29+
the secret value in the provider record. OpenShell includes database,
30+
Kubernetes Secret, and Vault-compatible credential drivers.
31+
32+
Configure the active credential driver in the
33+
[Gateway Configuration](/reference/gateway-config#credential-drivers).
34+
35+
## Compatibility
36+
37+
Drivers exchange peer metadata with the gateway and advertise their extension
38+
family capability. Upgrade both peers together when the protocol version
39+
changes. Refer to [Extensibility Overview](/extensibility/extension-negotiation)
40+
for the negotiation contract.
Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
---
2+
# SPDX-FileCopyrightText: Copyright (c) 2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
3+
# SPDX-License-Identifier: Apache-2.0
4+
title: "Isolation Backends"
5+
description: "Understand the runtime boundary used to launch and supervise sandboxed workloads."
6+
keywords: "OpenShell Extensions, Isolation Backends, Sandbox Runtime, Extensibility"
7+
---
8+
9+
An isolation backend connects the OpenShell supervisor to the runtime that
10+
launches and controls a sandboxed workload. It defines how the supervisor
11+
starts processes, attaches terminal streams, forwards signals, reports exit
12+
status, and applies runtime-specific isolation.
13+
14+
OpenShell separates this interface from compute drivers. A compute driver
15+
provisions the workload environment, while the isolation backend controls
16+
process execution inside that environment. This boundary lets runtimes evolve
17+
without changing the gateway API or policy model.
18+
19+
The OpenShell runtime backend implements the authenticated OpenShell Sandbox
20+
Protocol used by the supervisor and `openshell-sandbox`. Backend selection and
21+
capabilities remain internal to the workload runtime; users create and manage
22+
sandboxes through the same gateway API.
23+
24+
For the deployment-level runtime architecture, refer to
25+
[Sandbox Runtime](/kubernetes/sandbox-runtime). For driver-specific workload
26+
behavior, refer to [Compute Drivers](/reference/sandbox-compute-drivers).

‎docs/index.yml‎

Lines changed: 103 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -6,29 +6,118 @@ landing-page:
66
path: index.mdx
77

88
navigation:
9-
- folder: about
10-
title: "About NVIDIA OpenShell"
11-
- section: "Get Started"
12-
slug: get-started
9+
- section: "About NVIDIA OpenShell"
10+
slug: about
11+
contents:
12+
- page: "Why OpenShell"
13+
path: about/overview.mdx
14+
- page: "Architecture"
15+
path: about/how-it-works.mdx
16+
- page: "Installation"
17+
path: about/installation.mdx
18+
- page: "Run an Agent"
19+
path: about/run-an-agent.mdx
20+
- page: "Support Matrix"
21+
path: reference/support-matrix.mdx
22+
- section: "Tutorials"
23+
slug: tutorials
1324
contents:
1425
- page: "Quickstart"
1526
path: get-started/quickstart.mdx
1627
- folder: get-started/tutorials
1728
skip-slug: true
18-
- folder: sandboxes
19-
title: "Manage OpenShell"
20-
- folder: providers
21-
title: "Providers"
22-
- folder: extensibility
23-
title: "Extensibility"
29+
- section: "Manage OpenShell"
30+
slug: manage
31+
contents:
32+
- section: "Gateways"
33+
slug: gateways
34+
contents:
35+
- page: "Overview"
36+
path: sandboxes/manage-gateways.mdx
37+
- page: "Authentication"
38+
path: reference/gateway-auth.mdx
39+
- page: "Configuration"
40+
path: reference/gateway-config.mdx
41+
- page: "Container Deployment"
42+
path: reference/container-gateway.mdx
43+
- section: "Workspaces"
44+
slug: workspaces
45+
contents:
46+
- page: "Overview"
47+
path: sandboxes/manage-workspaces.mdx
48+
- section: "Sandboxes"
49+
slug: sandboxes
50+
contents:
51+
- page: "Overview"
52+
path: sandboxes/manage-sandboxes.mdx
53+
- page: "Compute Drivers"
54+
path: reference/sandbox-compute-drivers.mdx
55+
- section: "Providers"
56+
slug: providers
57+
contents:
58+
- page: "Overview"
59+
path: sandboxes/manage-providers.mdx
60+
- page: "Profiles"
61+
path: providers/profiles.mdx
62+
- page: "AWS"
63+
path: providers/aws-sigv4.mdx
64+
- section: "Google"
65+
slug: google
66+
contents:
67+
- page: "Google Cloud"
68+
path: providers/google-cloud.mdx
69+
- page: "Google Vertex AI"
70+
path: providers/google-vertex-ai.mdx
71+
- section: "Policies"
72+
slug: policies
73+
contents:
74+
- page: "Overview"
75+
path: sandboxes/policies.mdx
76+
- page: "Advisor"
77+
path: sandboxes/policy-advisor.mdx
78+
- page: "Schema"
79+
path: reference/policy-schema.mdx
80+
- page: "Prover"
81+
path: reference/policy-prover.mdx
82+
- page: "Base Image Policy"
83+
path: reference/default-policy.mdx
84+
- section: "Inference"
85+
slug: inference
86+
contents:
87+
- page: "Overview"
88+
path: sandboxes/inference-routing.mdx
89+
- section: "Extensibility"
90+
slug: extensibility
91+
contents:
92+
- page: "Overview"
93+
path: extensibility/extension-negotiation.mdx
94+
- page: "Middleware"
95+
path: extensibility/supervisor-middleware.mdx
96+
- page: "Interceptors"
97+
path: extensibility/gateway-interceptors.mdx
98+
- page: "Drivers"
99+
path: extensibility/drivers.mdx
100+
- page: "Isolation Backends"
101+
path: extensibility/isolation-backends.mdx
24102
- folder: observability
25103
title: "Observability"
26104
- folder: kubernetes
27105
title: "Kubernetes"
28-
- folder: sdk
29-
title: "SDK Reference"
30-
- folder: reference
31-
title: "Reference"
106+
- section: "SDK Reference"
107+
slug: sdk
108+
contents:
109+
- page: "Go"
110+
path: sdk/go.mdx
111+
- page: "Rust"
112+
path: sdk/rust.mdx
113+
- page: "Python"
114+
path: sdk/python.mdx
115+
- page: "TypeScript"
116+
path: sdk/typescript.mdx
117+
- page: "API Errors"
118+
path: reference/api-errors.mdx
119+
- page: "Protobuf Time Types"
120+
path: reference/protobuf-time-types.mdx
32121
- folder: security
33122
title: "Security"
34123
- section: "Upgrade Guides"

0 commit comments

Comments
 (0)