Skip to content

Commit 1c6663d

Browse files
st-grclaude
andcommitted
docs(arch): add External compute runtime to compute-runtimes.md
Adds a row to the Runtime Summary table describing the new `--compute-driver-socket=<path>` flag and how the External arm relates to the existing in-tree drivers (operator-managed driver process, Unix domain socket, identical proto contract to the VM driver, same trust boundary). Keeps the rest of the document untouched — the per-runtime implementation notes (e.g. which driver crate README to read) are intentionally NOT extended for `External` because external drivers ship their own documentation in their own repos. The reference implementation lives at: https://github.com/st-gr/openshell-driver-kyma Co-Authored-By: Claude Opus 4.7 (1M context) <[email protected]> Signed-off-by: st-gr <[email protected]>
1 parent 307ade5 commit 1c6663d

1 file changed

Lines changed: 1 addition & 0 deletions

File tree

‎architecture/compute-runtimes.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@ reason strings.
3030
| Podman | Rootless or single-machine deployments. | Container plus nested sandbox namespace. | Uses the Podman REST API, OCI image volumes, and CDI GPU devices when available. |
3131
| Kubernetes | Cluster deployment through Helm. | Pod plus nested sandbox namespace. | Uses Kubernetes API objects, service accounts, secrets, PVC-backed workspace storage, and GPU resources. |
3232
| VM | Experimental microVM isolation. | Per-sandbox libkrun VM. | Gateway spawns `openshell-driver-vm` as a subprocess over a private, state-local Unix socket. The VM driver boots a cached bootstrap `rootfs.ext4`, prepares requested OCI images inside a bootstrap VM with `umoci`, attaches the prepared image disk read-only, and gives each sandbox a writable `overlay.ext4` for merged-root changes and runtime material. The driver persists each accepted launch request beside the overlay and restarts those VMs on driver startup without recreating the overlay. |
33+
| External | Out-of-tree compute drivers. | Defined by the operator-supplied driver. | Gateway connects a `tonic::Channel` to a Unix domain socket served by an external driver process speaking the existing `compute_driver.proto` contract. Activated by `--compute-driver-socket=<path>` (env `OPENSHELL_COMPUTE_DRIVER_SOCKET`); skips both the `--drivers` list and auto-detection. The operator is responsible for the driver process lifecycle and the socket's filesystem permissions, mirroring the trust boundary of `--drivers vm`. |
3334

3435
Per-sandbox CPU and memory values currently enter the driver layer through
3536
template resource limits. Docker and Podman apply them as runtime limits.

0 commit comments

Comments
 (0)