Skip to content

Commit e00cfa4

Browse files
committed
docs: focus resource guidance on supported user settings
Signed-off-by: Shiju <[email protected]>
1 parent c26ca9c commit e00cfa4

2 files changed

Lines changed: 2 additions & 13 deletions

File tree

‎docs/reference/sandbox-compute-drivers.mdx‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -137,8 +137,7 @@ CPU, memory, and GPU requests use the typed
137137
- `gpu` indicates a GPU request and can include an optional count.
138138

139139
Reusable workload templates use this same message at
140-
`SandboxWorkloadConfig.resources`. The gateway copies those typed requirements
141-
into the resolved sandbox spec when a sandbox is created from a template.
140+
`SandboxWorkloadConfig.resources`.
142141

143142
| Driver | CPU and memory behavior |
144143
|---|---|

‎docs/sandboxes/manage-sandboxes.mdx‎

Lines changed: 1 addition & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -86,8 +86,7 @@ openshell sandbox create --cpu 2 --memory 4Gi -- claude
8686
CPU values use Kubernetes-style quantities such as `500m`, `1`, or `2.5`.
8787
Memory values use byte quantities such as `512Mi`, `4Gi`, or `8G`.
8888
89-
OpenShell stores these values as typed portable resource requirements. Docker
90-
and Podman apply them as runtime limits. Kubernetes uses each quantity as its
89+
Docker and Podman apply these values as runtime limits. Kubernetes uses each quantity as its
9190
limit and, unless its driver configuration provides a request, as its request.
9291
The VM and MXC drivers reject
9392
CPU or memory requirements because they do not currently support per-sandbox
@@ -271,15 +270,6 @@ Create a sandbox from a template:
271270
openshell sandbox create --template gpu-kata --provider github -- claude
272271
```
273272
274-
When the gateway creates a sandbox from a template, it resolves the template's
275-
CPU, memory, and GPU settings into the sandbox's typed `resource_requirements`.
276-
The reusable template field `SandboxWorkloadConfig.resources` uses the same
277-
`ResourceRequirements` message as `SandboxSpec.resource_requirements`, so API
278-
and SDK callers use `cpu.quantity`, `memory.quantity`, and `gpu` in both places.
279-
When loading a reusable template stored with the earlier `cpu`, `memory`, and
280-
`gpu` shape, the gateway converts it to the current typed requirements before
281-
returning or using the template.
282-
283273
The `--template` flag cannot be combined with inline workload flags such as `--from`, `--cpu`, `--memory`, `--gpu`, `--env`, or `--driver-config-json`. Put those values on the template instead. Create-time policy and provider attachments remain part of the sandbox request, so each sandbox can keep its own access boundary.
284274
285275
Inspect and manage templates:

0 commit comments

Comments
 (0)