Skip to content

Commit 62a6851

Browse files
authored
update docs per new dev prs (#238)
1 parent 66c0f7d commit 62a6851

6 files changed

Lines changed: 28 additions & 20 deletions

File tree

architecture/build-containers.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -268,7 +268,7 @@ The chart deploys a **StatefulSet** (not a Deployment) with a `volumeClaimTempla
268268

269269
The StatefulSet always mounts TLS secrets as volumes and sets environment variables for the server to use `rustls` with mTLS:
270270

271-
- **Volumes**: `tls-cert` (from `navigator-server-tls` secret, mounted at `/etc/navigator-tls/server/`) and `tls-client-ca` (from `navigator-server-client-ca` secret, mounted at `/etc/navigator-tls/client-ca/`).
271+
- **Volumes**: `tls-cert` (from `navigator-server-tls` secret, mounted at `/etc/openshell-tls/server/`) and `tls-client-ca` (from `navigator-server-client-ca` secret, mounted at `/etc/openshell-tls/client-ca/`).
272272
- **Environment**: `OPENSHELL_TLS_CERT`, `OPENSHELL_TLS_KEY`, `OPENSHELL_TLS_CLIENT_CA` pointing to the mounted files.
273273
- **Client TLS secret name**: `OPENSHELL_CLIENT_TLS_SECRET_NAME` set to the `clientTlsSecretName` value, used by the server to inject TLS volume mounts into sandbox pod specs.
274274
- **gRPC endpoint**: `https://navigator.navigator.svc.cluster.local:8080` so sandbox pods connect over mTLS.

architecture/gateway-security.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -85,33 +85,33 @@ Secret names are defined as constants in `crates/navigator-bootstrap/src/constan
8585

8686
### Gateway Mounts
8787

88-
The Helm StatefulSet (`deploy/helm/navigator/templates/statefulset.yaml`) mounts:
88+
The Helm StatefulSet (`deploy/helm/openshell/templates/statefulset.yaml`) mounts:
8989

9090
| Volume | Mount Path | Source Secret |
9191
|---|---|---|
92-
| `tls-cert` | `/etc/navigator-tls/server/` (read-only) | `navigator-server-tls` |
93-
| `tls-client-ca` | `/etc/navigator-tls/client-ca/` (read-only) | `navigator-server-client-ca` |
92+
| `tls-cert` | `/etc/openshell-tls/server/` (read-only) | `navigator-server-tls` |
93+
| `tls-client-ca` | `/etc/openshell-tls/client-ca/` (read-only) | `navigator-server-client-ca` |
9494

9595
Environment variables point the gateway binary to these paths:
9696

9797
```
98-
OPENSHELL_TLS_CERT=/etc/navigator-tls/server/tls.crt
99-
OPENSHELL_TLS_KEY=/etc/navigator-tls/server/tls.key
100-
OPENSHELL_TLS_CLIENT_CA=/etc/navigator-tls/client-ca/ca.crt
98+
OPENSHELL_TLS_CERT=/etc/openshell-tls/server/tls.crt
99+
OPENSHELL_TLS_KEY=/etc/openshell-tls/server/tls.key
100+
OPENSHELL_TLS_CLIENT_CA=/etc/openshell-tls/client-ca/ca.crt
101101
```
102102

103103
### Sandbox Pod Mounts
104104

105105
When the gateway creates a sandbox pod (`crates/navigator-server/src/sandbox/mod.rs:681`), it injects:
106106

107107
- A volume backed by the `navigator-client-tls` secret.
108-
- A read-only mount at `/etc/navigator-tls/client/` on the agent container.
108+
- A read-only mount at `/etc/openshell-tls/client/` on the agent container.
109109
- Environment variables for the sandbox gRPC client:
110110

111111
```
112-
OPENSHELL_TLS_CA=/etc/navigator-tls/client/ca.crt
113-
OPENSHELL_TLS_CERT=/etc/navigator-tls/client/tls.crt
114-
OPENSHELL_TLS_KEY=/etc/navigator-tls/client/tls.key
112+
OPENSHELL_TLS_CA=/etc/openshell-tls/client/ca.crt
113+
OPENSHELL_TLS_CERT=/etc/openshell-tls/client/tls.crt
114+
OPENSHELL_TLS_KEY=/etc/openshell-tls/client/tls.key
115115
OPENSHELL_ENDPOINT=https://navigator.navigator.svc.cluster.local:8080
116116
```
117117

@@ -120,7 +120,7 @@ OPENSHELL_ENDPOINT=https://navigator.navigator.svc.cluster.local:8080
120120
The CLI's copy of the client certificate bundle is written to:
121121

122122
```
123-
$XDG_CONFIG_HOME/openshell/clusters/<cluster-name>/mtls/
123+
$XDG_CONFIG_HOME/openshell/gateways/<gateway-name>/mtls/
124124
├── ca.crt
125125
├── tls.crt
126126
└── tls.key
@@ -221,9 +221,9 @@ Sandbox pods connect back to the gateway at startup to fetch their policy and pr
221221

222222
| Env Var | Value |
223223
|---|---|
224-
| `OPENSHELL_TLS_CA` | `/etc/navigator-tls/client/ca.crt` |
225-
| `OPENSHELL_TLS_CERT` | `/etc/navigator-tls/client/tls.crt` |
226-
| `OPENSHELL_TLS_KEY` | `/etc/navigator-tls/client/tls.key` |
224+
| `OPENSHELL_TLS_CA` | `/etc/openshell-tls/client/ca.crt` |
225+
| `OPENSHELL_TLS_CERT` | `/etc/openshell-tls/client/tls.crt` |
226+
| `OPENSHELL_TLS_KEY` | `/etc/openshell-tls/client/tls.key` |
227227

228228
These are used to build a `tonic::transport::ClientTlsConfig` with:
229229
- `ca_certificate()` -- verifies the server's certificate against the cluster CA.

architecture/sandbox-custom-containers.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ The `--from` flag accepts four kinds of input:
88

99
| Input | Example | Behavior |
1010
|-------|---------|----------|
11-
| **Community sandbox name** | `--from openclaw` | Resolves to `d1i0nduu2f6qxk.cloudfront.net/openshell-community/sandboxes/openclaw:latest` |
11+
| **Community sandbox name** | `--from openclaw` | Resolves to `ghcr.io/nvidia/openshell-community/sandboxes/openclaw:latest` |
1212
| **Dockerfile path** | `--from ./Dockerfile` | Builds the image, pushes it into the cluster, then creates the sandbox |
1313
| **Directory with Dockerfile** | `--from ./my-sandbox/` | Uses the directory as the build context |
1414
| **Full image reference** | `--from myregistry.com/img:tag` | Uses the image directly |
@@ -22,7 +22,7 @@ The CLI classifies the value in this order:
2222
3. **Contains `/`, `:`, or `.`** — treated as a full container image reference.
2323
4. **Otherwise** — treated as a community sandbox name, expanded to `{OPENSHELL_COMMUNITY_REGISTRY}/{name}:latest`.
2424

25-
The community registry prefix defaults to `d1i0nduu2f6qxk.cloudfront.net/openshell-community/sandboxes` and can be overridden with the `OPENSHELL_COMMUNITY_REGISTRY` environment variable.
25+
The community registry prefix defaults to `ghcr.io/nvidia/openshell-community/sandboxes` and can be overridden with the `OPENSHELL_COMMUNITY_REGISTRY` environment variable.
2626

2727
### Dockerfile build flow
2828

docs/reference/cli.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ openshell
5353
│ ├── create
5454
│ ├── get [name]
5555
│ ├── list
56-
│ ├── delete <name...>
56+
│ ├── delete <name...> [--all]
5757
│ ├── connect [name]
5858
│ ├── upload [name]
5959
│ ├── download [name]
@@ -115,7 +115,7 @@ Create and manage isolated agent execution environments.
115115
| `openshell sandbox create` | Create a new sandbox. Refer to the flag reference below. |
116116
| `openshell sandbox get [name]` | Show detailed information about a sandbox. |
117117
| `openshell sandbox list` | List all sandboxes in the active cluster. |
118-
| `openshell sandbox delete <name...>` | Delete one or more sandboxes by name. |
118+
| `openshell sandbox delete <name...>` | Delete one or more sandboxes by name. Use `--all` to delete every sandbox in the active gateway. |
119119
| `openshell sandbox connect [name]` | Open an interactive SSH session into a running sandbox. |
120120
| `openshell sandbox upload [name]` | Upload files from the host into a sandbox. |
121121
| `openshell sandbox download [name]` | Download files from a sandbox to the host. |
@@ -242,3 +242,5 @@ $ openshell sandbox --help
242242
$ openshell sandbox create --help
243243
$ openshell gateway --help
244244
```
245+
246+
Help output groups flags under distinct headings: `FLAGS` for command-specific options, `GATEWAY FLAGS` for `--gateway` and `--gateway-endpoint`, and `GLOBAL FLAGS` for `--verbose`, `--help`, and `--version`.

docs/reference/support-matrix.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ OpenShell uses several container images that are pulled automatically during gat
5454
| Cluster | ghcr.io | `ghcr.io/nvidia/openshell/cluster:latest` | `openshell gateway start` |
5555
| Server | ghcr.io | `ghcr.io/nvidia/openshell/server:latest` | Cluster startup (via Helm chart) |
5656
| Sandbox | ghcr.io | `ghcr.io/nvidia/openshell/sandbox:latest` | First sandbox creation (via Helm chart) |
57-
| Community sandboxes | CloudFront CDN | `d1i0nduu2f6qxk.cloudfront.net/openshell-community/sandboxes/{name}:latest` | `openshell sandbox create --from <name>` |
57+
| Community sandboxes | GHCR | `ghcr.io/nvidia/openshell-community/sandboxes/{name}:latest` | `openshell sandbox create --from <name>` |
5858

5959
The cluster image is based on `rancher/k3s:v1.35.2-k3s1` and bundles the Helm charts and Kubernetes manifests required to bootstrap the control plane. The server and sandbox images are pulled separately at runtime.
6060

docs/sandboxes/create-and-manage.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -174,6 +174,12 @@ Delete a sandbox by name:
174174
$ openshell sandbox delete my-sandbox
175175
```
176176

177+
Delete all sandboxes in the active gateway:
178+
179+
```console
180+
$ openshell sandbox delete --all
181+
```
182+
177183
## Next Steps
178184

179185
Explore related topics:

0 commit comments

Comments
 (0)