Crafting Sandbox Documentation
Welcome to the Crafting Sandbox documentation. Crafting Sandbox is a cloud-based platform for managing self-contained, isolated, on-demand development environments for modern cloud applications.
Introduction
An overview of what Crafting Sandbox is, who it is for, and how to get started.
Concepts
Core building blocks of the Crafting Sandbox system.
| Document | Description |
|---|---|
| Sandbox | The fundamental unit: workloads, networking, and storage |
| Template | Reusable sandbox definitions for teams |
| Snapshot | Point-in-time filesystem capture for fast environment restoration |
| Sandbox Pool | Pre-warming sandboxes for instant availability |
| Org and User | Organizational model, roles, and membership |
| Secret | Secure storage for credentials, tokens, and keypairs |
| Service Account | Machine identities for automation and CI/CD |
| Connected Infra | Connecting external Kubernetes clusters |
| Endpoint Alias | Stable org-level DNS names for webhooks and integrations |
Guides
Step-by-step guides for getting started with Crafting Sandbox.
Org Admin Guides
| Document | Description |
|---|---|
| Setting Up the Crafting System | Onboarding guide for org admins: from first sandbox to full team deployment |
Developer Guides
| Document | Description |
|---|---|
| Developer Onboard Guide | Getting started for developers: CLI setup, first sandbox, daily workflow |
Features
In-depth reference documentation for individual Crafting Sandbox features.
Workspace Features
| Document | Description |
|---|---|
| Workspace Automation | Start sequences, checkouts, daemons, jobs, and setup scripts |
| Workspace Snapshots | Base, home, and personal snapshots |
| Workspace SSH Access | SSH access and remote IDE connections |
| Workspace Web Access | Web Terminal, Web IDE, and Remote Desktop from the browser |
| Remote Desktop | X Window-based remote desktop via RDP |
| Workspace Port Forward | Mapping workload ports to localhost within the sandbox |
Snapshot Features
| Document | Description |
|---|---|
| Dependency Snapshot | Snapshots for dependency service data (databases, etc.) |
| Container Snapshot | Snapshots for container workload volumes |
Access and Identity
| Document | Description |
|---|---|
| Managed SSH Keypair | System-managed SSH keypair for each account |
| GitHub App | GitHub App integration for seamless repository access |
| Sandbox Sharing Mode | Controlling who can access a sandbox |
| Restriction Mode | Admin-only workspace access for privileged operations |
| Lockdown | Hardening policies for AI agent workloads |
| User Preference | Personalized workspace customizations per user |
Networking
| Document | Description |
|---|---|
| Endpoints | Exposing sandbox services to the external network |
| Sandbox Networking | Private networking, DNS, NAT, and Service Gateway |
| Service Linking | Automatic service discovery environment variables |
| Hybrid Port Forward | Local development connected to sandbox services |
Operations and Lifecycle
| Document | Description |
|---|---|
| Lifecycle | Sandbox lifecycle events and states |
| Auto Suspension | Idle detection and automatic suspension |
| Workload Restart or Rebuild | Restart, refresh snapshot, and rebuild operations |
| Sandbox Resync | Syncing a sandbox back to its template |
| Readiness and Wait For | Coordinating startup across workloads |
| Log View | Viewing logs from workloads and background processes |
| Workload Remote Exec | Running commands in any workload remotely |
| External Resources | Managing cloud resources tied to sandbox lifecycle |
Infrastructure (Enterprise Edition)
| Document | Description |
|---|---|
| Node Pool | Compute node group configuration and auto-scaling |
| Schedule Specification | Assigning workloads to specific node pools |
| Dynamic Resource Control | Continuous memory and swap resource management |
| System Admin Dashboard | System-wide configuration and observability |
| Multi Region and Multi Cloud | Running sandboxes across multiple regions and clouds |
AI and Agentic Features
| Document | Description |
|---|---|
| LLM Config | Central configuration of LLM providers and models |
| Agentic Sessions | Interactive and autonomous LLM agent sessions |
| MCP Servers | Centrally managed MCP servers for all sandboxes |
Kubernetes Integration
| Document | Description |
|---|---|
| Kubernetes Development Experience | Network bridging, traffic interception, and pod mirroring |
Information
| Document | Description |
|---|---|
| Security | Data encryption, vulnerability scanning, availability, and security controls |
References
Detailed schema and field references.
| Document | Description |
|---|---|
| Sandbox Definition | Complete field reference for the sandbox definition YAML schema |