Skip to content

sandbox-backends.md

Latest commit

 

History

History
49 lines (33 loc) · 3.77 KB

sandbox-backends.md

File metadata and controls

49 lines (33 loc) · 3.77 KB
Raw
title Choose a sandbox backend

Compare microsandbox and E2B, then select one in Web. This guide is for operators who finished Install Core and Web and need compute for Core-hosted Sessions.

The installer selects no backend. One installation uses one backend. To change it later, reset the deployment first; see Change the sandbox configuration.

Compare the backends

microsandbox E2B
Where sandboxes run A microVM on your Linux nodes E2B's cloud
Nodes to add Yes None
You provide Linux amd64 hosts with systemd and /dev/kvm An E2B API key and a template; a public HTTPS URL for Core
Isolation Each sandbox has its own kernel E2B's
Idle sandboxes suspend and resume Yes, with checkpoints Yes, paused in place by E2B
Workspace storage Required, on NFS Own disk
Disk limits Root disk and workspace quota Set by the template

The field-level differences are in the deployment contract. Host requirements for nodes are in Add and manage nodes.

Sandbox nodes run on Linux amd64. When Core runs on macOS or Windows, connect a Linux node or use E2B. Applications can also run self-hosted Sessions on their own machines, with no backend.

Select the backend in Web

  1. Open Settings → Sandbox and scheduling. The setup wizard asks Where should sandboxes run?: Own machines (microsandbox) or E2B.
  2. For Own machines, choose the sandbox size. Web proposes the default size the Provider declares as Standard, and Advanced settings on the review page holds the exact CPU, memory and disk values. E2B declares no default size, so its review page has no Advanced settings.
  3. Choose Save configuration. The choice is stored in Core's database.

For Own machines, continue with Add and manage nodes. For microsandbox, first Set up workspace storage. For checkpoint recovery across microsandbox nodes, see Checkpoint recovery across nodes.

Use E2B

E2B needs no nodes, but its sandboxes call Core from E2B's cloud, so Core needs a public HTTPS URL that is not loopback; see Configure the public address.

  1. Build a template from the Runtime image with Build a template. Its output records the immutable templateID:build_UUID value.
  2. In the setup wizard, choose E2B. Under Connect E2B, pick a Service or enter a custom Sandbox API URL and Sandbox data-plane domain, enter the API key, then select the Template build from the list Web loads with that key, template first and then its ready build. The key must belong to the team that owns the template.
  3. Choose Save configuration. Core stores the key encrypted and never returns it.

When you edit a saved E2B configuration, leave the API key blank to keep the saved key. The Template build then stays an editable text field holding the saved templateID:build_UUID. Entering a key makes Web load the list again.

The key and template rules, including key replacement, are in Initial setup and same-provider changes.

Next steps