Skip to content

Commit cde20dc

Browse files
authored
docs: weekly documentation refresh (ai-openshell#993)
* docs(release-notes): refresh weekly documentation Signed-off-by: Miyoung Choi <miyoungc@nvidia.com> * docs(release-notes): remove weekly refresh entry Signed-off-by: Miyoung Choi <miyoungc@nvidia.com> --------- Signed-off-by: Miyoung Choi <miyoungc@nvidia.com>
1 parent aee7443 commit cde20dc

2 files changed

Lines changed: 24 additions & 1 deletion

File tree

‎docs/sandboxes/manage-sandboxes.mdx‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,21 @@ openshell sandbox create --from my-registry.example.com/my-image:latest
5151

5252
The CLI resolves community names against the [OpenShell Community](https://github.com/NVIDIA/OpenShell-Community) catalog, pulls the bundled Dockerfile and policy, builds the image locally, and creates the sandbox. For the full catalog and how to contribute your own, refer to [Community Sandboxes](/sandboxes/community-sandboxes).
5353

54+
### Label a Sandbox
55+
56+
Attach labels when you create a sandbox to track ownership, environment, or workflow grouping:
57+
58+
```shell
59+
openshell sandbox create --label env=dev --label team=platform -- claude
60+
```
61+
62+
List only the sandboxes that match a label selector:
63+
64+
```shell
65+
openshell sandbox list --selector env=dev
66+
openshell sandbox list --selector env=dev,team=platform
67+
```
68+
5469
## Connect to a Sandbox
5570

5671
Open an SSH session into a running sandbox:
@@ -110,6 +125,12 @@ List all sandboxes:
110125
openshell sandbox list
111126
```
112127

128+
Filter the list by labels when you want a narrower view:
129+
130+
```shell
131+
openshell sandbox list --selector team=platform
132+
```
133+
113134
Get detailed information about a specific sandbox. The output lists **Policy source** (`sandbox` or `global`), **Revision** (the active policy’s row version for that source), and the formatted active policy YAML:
114135

115136
```shell
@@ -186,6 +207,8 @@ Upload files from your host into the sandbox:
186207
openshell sandbox upload my-sandbox ./src /sandbox/src
187208
```
188209

210+
When the local path is a named directory, OpenShell preserves that basename at the destination, matching `scp -r` and `cp -r`. The example above creates `/sandbox/src/src`.
211+
189212
Download files from the sandbox to your host:
190213

191214
```shell

‎docs/security/best-practices.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,7 @@ This enables credential injection and L7 inspection without explicit configurati
106106

107107
| Aspect | Detail |
108108
|---|---|
109-
| Default | Auto-detect and terminate. OpenShell generates the sandbox CA at startup and injects it into the process trust stores (`NODE_EXTRA_CA_CERTS`, `SSL_CERT_FILE`, `REQUESTS_CA_BUNDLE`, `CURL_CA_BUNDLE`). |
109+
| Default | Auto-detect and terminate. OpenShell generates the sandbox CA at startup and injects it into the process trust stores (`NODE_EXTRA_CA_CERTS`, `SSL_CERT_FILE`, `REQUESTS_CA_BUNDLE`, `CURL_CA_BUNDLE`, `GIT_SSL_CAINFO`). |
110110
| What you can change | Set `tls: skip` on an endpoint to disable TLS detection and termination for that endpoint. Use this for client-certificate mTLS to upstream or non-standard binary protocols. |
111111
| Risk if relaxed | `tls: skip` disables credential injection and L7 inspection for that endpoint. The proxy relays encrypted traffic without seeing the contents. |
112112
| Recommendation | Use auto-detect (the default) for most endpoints. Use `tls: skip` only when the upstream requires the client's own TLS certificate (mTLS) or uses a non-HTTP protocol. |

0 commit comments

Comments
 (0)