Files
OpenShell/examples/sync-files.md
50230616d5 refactor(runtime): retire Community image dependencies (#3386)
* feat(sandbox): default to official Alpine sandbox image

default_sandbox_image() now returns docker.io/library/alpine:3.22, a generic
version-qualified official image, so a fresh install no longer depends on the
community sandbox image catalog. All compute drivers (docker, podman,
kubernetes, vm) inherit this fallback.

Part of #3116.

Signed-off-by: Akram
Signed-off-by: Akram <akram.benaissi@gmail.com>

* feat(deploy): default deployment configs to the official Alpine sandbox image

Update the shared gateway default_image, Helm chart values, the standalone
Kubernetes manifest, and the dev gateway task scripts to use
docker.io/library/alpine:3.22 instead of the community base image, consistent
with default_sandbox_image(). GPU e2e image-build base is left unchanged (CUDA
needs a glibc base).

Part of #3116.

Signed-off-by: Akram
Signed-off-by: Akram <akram.benaissi@gmail.com>

* feat(driver): default to numeric non-root identity for USER-less images

With the default sandbox image now Alpine, images that declare no OCI USER
must start instead of being rejected. When the image declares no USER and
the policy requests none, the Podman and Docker drivers now supply a numeric
non-root identity (DEFAULT_SANDBOX_UID/GID = 1000) instead of rejecting,
matching the numeric-identity behavior of the Kubernetes and VM drivers. The
supervisor's resolved-identity path runs the sandbox as a synthesized
non-root account without the account existing in the image. Images that
declare a USER keep the OCI resolution path unchanged.

Part of #3116.

Signed-off-by: Akram <akram.benaissi@gmail.com>
Signed-off-by: Evan Lezar <elezar@nvidia.com>

* test(conformance): use Alpine workload image

Signed-off-by: Evan Lezar <elezar@nvidia.com>

* refactor(policy): drop community image /app path from default policy

The restrictive default policy granted read-only access to /app, a directory
that only existed in the community base image. A generic Alpine default has no
/app, so remove it. Landlock best-effort already ignores absent paths; this
just stops advertising a community-specific layout in the default.

Part of #3116.

Signed-off-by: Akram
Signed-off-by: Akram <akram.benaissi@gmail.com>

* docs(config): document Alpine default images

Signed-off-by: Evan Lezar <elezar@nvidia.com>

* fix(podman): report early sandbox termination

Signed-off-by: Evan Lezar <elezar@nvidia.com>

* fix(podman): initialize rootless workspace ownership

Signed-off-by: Evan Lezar <elezar@nvidia.com>

* fix(sandbox): qualify NVIDIA Ubuntu default

Signed-off-by: Drew Newberry <anewberry@nvidia.com>

* fix(podman): initialize rootful default workspace

Signed-off-by: Drew Newberry <anewberry@nvidia.com>

* feat(sftp): add native sandbox adapter

Signed-off-by: Drew Newberry <anewberry@nvidia.com>

* fix(sftp): gate runtime helper support to Linux

Signed-off-by: Drew Newberry <anewberry@nvidia.com>

* fix(sftp): support standard OpenSSH file operations

Signed-off-by: Drew Newberry <anewberry@nvidia.com>

* fix(sftp): harden rename and special file handling

Signed-off-by: Drew Newberry <anewberry@nvidia.com>

* refactor(runtime): remove community image dependencies

Signed-off-by: Drew Newberry <anewberry@nvidia.com>

* test(e2e): build provider readiness tool fixture

Signed-off-by: Drew Newberry <anewberry@nvidia.com>

* fix(e2e): use a dedicated Noble fixture for Docker tests

Signed-off-by: Evan Lezar <elezar@nvidia.com>

---------

Signed-off-by: Akram
Signed-off-by: Akram <akram.benaissi@gmail.com>
Signed-off-by: Evan Lezar <elezar@nvidia.com>
Signed-off-by: Drew Newberry <anewberry@nvidia.com>
Co-authored-by: Evan Lezar <elezar@nvidia.com>
Co-authored-by: Drew Newberry <anewberry@nvidia.com>
2026-09-22 14:43:51 +02:00

74 lines
1.8 KiB
Markdown

# Syncing Files To and From a Sandbox
Move code, data, and artifacts between your local machine and an OpenShell
sandbox using `openshell sandbox upload` and `openshell sandbox download`.
## Push local files into a sandbox
Upload your current project directory into `/sandbox` on the sandbox:
```bash
openshell sandbox upload my-sandbox .
```
Push a specific directory to a custom destination:
```bash
openshell sandbox upload my-sandbox ./src /sandbox/src
```
Push a single file:
```bash
openshell sandbox upload my-sandbox ./config.yaml /sandbox/config.yaml
```
## Pull files from a sandbox
Download sandbox output to your local machine:
```bash
openshell sandbox download my-sandbox /sandbox/output ./output
```
Pull results to the current directory:
```bash
openshell sandbox download my-sandbox /sandbox/results
```
## Sync on create
Push all files in the current directory into a new sandbox automatically:
```bash
openshell sandbox create --upload . -- python main.py
```
This uploads the current directory into `/sandbox` before the command runs.
## Workflow: iterate on code in a sandbox
```bash
# Create a sandbox and upload your repo
openshell sandbox create --name dev --upload .
# Make local changes, then push them
openshell sandbox upload dev ./src /sandbox/src
# Run tests inside the sandbox
openshell sandbox connect dev
# (inside sandbox) pytest
# Pull test artifacts back
openshell sandbox download dev /sandbox/coverage ./coverage
```
## How it works
File sync uses the native OpenShell streaming file-transfer protocol. The CLI
creates and extracts tar streams in Rust, and the sandbox performs the matching
operation under the workload identity. Transfers use bounded frames with
backpressure, cancellation, and explicit completion; they do not require
`ssh`, `scp`, `rsync`, or a `tar` executable in the workload image.