Skip to content

Commit 8717d17

Browse files
author
Ambient Code Bot
committed
Document ForkCell runtime fork
1 parent 9c07de4 commit 8717d17

2 files changed

Lines changed: 53 additions & 0 deletions

File tree

FORKCELL.md

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
# ForkCell Runtime Fork
2+
3+
This repository is BeforeWire's pinned OpenShell runtime fork for ForkCell.
4+
5+
ForkCell is the control plane for governed agent execution cells: checkpoint,
6+
governed run, receipt, then accept, restore, or fork. OpenShell remains the
7+
runtime enforcement layer for sandbox lifecycle, filesystem/process policy,
8+
egress/L7 policy, credentials, and OCSF/log events.
9+
10+
## Pinned Runtime
11+
12+
- Branch: `forkcell-workspace-substrate`
13+
- Runtime tag: recorded in `beforewire/forkcell/patches/openshell.lock`
14+
- Runtime commit: recorded in `beforewire/forkcell/patches/openshell.lock`
15+
- ForkCell repo: `https://github.com/beforewire/forkcell`
16+
- Upstream base: `f23c2c8e84193beac5c35af8cd80276b60b8dbd4`
17+
18+
## Patch Scope
19+
20+
The ForkCell patch adds a typed Docker workspace substrate contract:
21+
22+
- accepts `docker.workspace` config with `type: forkcell_overlay`;
23+
- mounts a named workspace backing volume at a private runtime path;
24+
- passes workspace substrate metadata to the supervisor;
25+
- prepares/chowns overlay runtime directories before privilege drop;
26+
- keeps OpenShell policy, egress, credential, and OCSF paths unchanged.
27+
28+
## Non-goals
29+
30+
- This fork does not replace upstream OpenShell.
31+
- This fork does not add business-semantic policy evaluation.
32+
- This fork does not claim full sandbox lifecycle latency is `0ms`.
33+
- This fork only enables ForkCell's fast workspace restore substrate.
34+
35+
## Validation
36+
37+
ForkCell's public-preview docs report:
38+
39+
- native overlay `restore_sync_ms`: `0ms` for validated profiles;
40+
- correctness matrix: `7/7` cases passed;
41+
- policy smoke: deny host, allow GET, and L7 deny passed;
42+
- README-path tiny demo: checkpoint mark `0ms`, restore duration `0ms`,
43+
total restore path `783ms` including OpenShell sandbox lifecycle and log
44+
collection.
45+
46+
See `beforewire/forkcell` for the user-facing README, receipts, and preview
47+
testing plan.

README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,11 @@
11
# NVIDIA OpenShell
22

3+
> **BeforeWire ForkCell runtime fork.** This branch is pinned by
4+
> `beforewire/forkcell` and carries a narrow workspace-substrate patch for
5+
> ForkCell's fast checkpoint/restore path. For the ForkCell-specific scope,
6+
> pinned commit, and non-goals, see [`FORKCELL.md`](FORKCELL.md). For general
7+
> OpenShell usage, prefer the upstream NVIDIA project and release channels.
8+
39
[![License](https://img.shields.io/badge/License-Apache_2.0-blue)](https://github.com/NVIDIA/OpenShell/blob/main/LICENSE)
410
[![PyPI](https://img.shields.io/badge/PyPI-openshell-orange?logo=pypi)](https://pypi.org/project/openshell/)
511
[![Security Policy](https://img.shields.io/badge/Security-Report%20a%20Vulnerability-red)](SECURITY.md)

0 commit comments

Comments
 (0)