Skip to content

Commit 121142e

Browse files
committed
docs: move the experimental supervisor topology under an Experimental section
Signed-off-by: Drew Newberry <anewberry@nvidia.com>
1 parent d5fc1df commit 121142e

1 file changed

Lines changed: 21 additions & 17 deletions

File tree

‎docs/how-it-works/gateways/configuration.mdx‎

Lines changed: 21 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -854,23 +854,6 @@ Kubernetes configurations set `namespace`, `service_account_name`, and `enable_u
854854

855855
### Kubernetes
856856

857-
For experimental deployment plumbing, set
858-
`[openshell.drivers.kubernetes].experimental_supervisor_topology = "gateway"`.
859-
With Helm, use the existing gateway configuration:
860-
861-
```yaml
862-
gatewayConfig:
863-
openshell.drivers.kubernetes:
864-
experimental_supervisor_topology: gateway
865-
```
866-
867-
The chart deploys one idle supervisor in the gateway namespace for all workspace
868-
modes (`shared`, `managed`, and `operator`). Its health checks report process
869-
health only. It does not accept sandbox sessions; sandboxes retain their dedicated
870-
supervisors. Omit the field to disable the experiment. The `workspace` value is
871-
reserved and currently returns an unsupported error. Helm owns this Deployment;
872-
setting the field in a standalone TOML file does not provision infrastructure.
873-
874857
The gateway runs as a Pod and creates paired workload and supervisor Pods in another namespace. The gateway CA is projected from a Kubernetes Secret into supervisor Pods; user client certificate and key entries in that Secret are not exposed to either Pod.
875858

876859
```toml
@@ -1543,3 +1526,24 @@ Replace the executable and configuration paths with your installation's paths, a
15431526
The command reports each selected executable path and version. Each tool receives only `-V`, with a five-second deadline and an 8 KiB output limit per stream. Missing, non-executable, outdated, or failing tools return a nonzero exit status with corrective guidance and the selected tool's error. The checks create no gateway state or images and do not start a driver or VM. Version checks confirm the installation; they do not test image creation or filesystem recovery.
15441527

15451528
Other drivers do not require these VM tools. A VM configuration table alone does not select the VM driver. When a remote driver socket is configured, preflight reports that host tool checks were not performed; run the check on that host in the driver service's environment with a local VM configuration.
1529+
1530+
## Experimental
1531+
1532+
### Kubernetes supervisor topology
1533+
1534+
For experimental deployment plumbing, set
1535+
`[openshell.drivers.kubernetes].experimental_supervisor_topology = "gateway"`.
1536+
With Helm, use the existing gateway configuration:
1537+
1538+
```yaml
1539+
gatewayConfig:
1540+
openshell.drivers.kubernetes:
1541+
experimental_supervisor_topology: gateway
1542+
```
1543+
1544+
The chart deploys one idle supervisor in the gateway namespace for all workspace
1545+
modes (`shared`, `managed`, and `operator`). Its health checks report process
1546+
health only. It does not accept sandbox sessions; sandboxes retain their dedicated
1547+
supervisors. Omit the field to disable the experiment. The `workspace` value is
1548+
reserved and currently returns an unsupported error. Helm owns this Deployment;
1549+
setting the field in a standalone TOML file does not provision infrastructure.

0 commit comments

Comments
 (0)