Skip to content

EN Concepts Architecture

lkmavi edited this page Sep 24, 2026 · 1 revision

Architecture

CLI / SDK  ──►  gateway (optional)  ──►  secrets + registry + proposals
                 │
                 ▼
         compute provider (Docker | Podman)
                 │
     ┌───────────┴───────────┐
     ▼                       ▼
 sandbox container      proxy sidecar
 (agent + workspace)    (policy egress)

Planes

Plane Components
Control CLI, gateway HTTP API, encrypted secrets, proposals
Data Sandbox container, workspace bind, agent process
Enforcement Proxy sidecar, Landlock/seccomp via whaleshell-init

Create path

  1. CLI resolves image, policy, providers, soft defaults.
  2. Driver ensures Engine images (sandbox + slim proxy).
  3. Driver creates internal network, proxy, sandbox, volumes.
  4. Gateway registers the sandbox when configured.
  5. Guest traffic uses HTTP(S)_PROXY toward the sidecar.

Modules

Module Role
whaleshell-cli User CLI
whaleshell-core Policy schema + engine
whaleshell-driver Docker / Podman / stubs
whaleshell-proxy Egress sidecar + policy.local
whaleshell-gateway Control plane
whaleshell-runtime Init, images, agent helpers
whaleshell-providers Credential profiles

Hub map: MODULES.md · ARCHITECTURE.md.

→ New docs site

whaleshell

English

Русский

Clone this wiki locally