Requirements
- Kubernetes 1.33 or later
- A full Quor Helm deployment with the vector database enabled
- Nodes with enough CPU, memory, and ephemeral storage for active sandboxes
- A URL that sandbox pods can use to reach the Quor API
kubernetes, when SANDBOX_API_SERVER_URL is empty,
or when sandbox push authentication is not configured.
Prepare sandbox nodes
By default, sandbox pods select nodes with this label:sandboxPod.nodeSelector with a selector that matches your cluster.
Create the sandbox push Secret
Sandbox uses an Ed25519 key to authenticate file and history pushes into sandbox pods. Generate a key and store it in the Quor namespace:Configure Helm
Add the following settings to the values file used by your existing Quor deployment. IfconfigMap or auth is already present,
merge these entries under the existing keys rather than adding a second block.
values.yaml
SANDBOX_API_SERVER_URL can be the public Quor URL or a cluster-internal URL.
Use a scheme and hostname that resolve from the sandbox proxy and route to the Quor API.
Install or upgrade Quor with your complete deployment values:
onyx-values.yaml with the path to the values file used by your deployment.
Alternatively, save only the Sandbox settings in a separate craft-values.yaml overlay.
Pass your existing deployment values first and the Sandbox overlay second so Helm combines them:
Plan sandbox capacity
Each active user receives a sandbox pod. The main sandbox container has these defaults:
The pod also includes initialization and sidecar containers for network setup, file transfer, snapshots, and restore.
To change the main container resources, merge these
configMap entries into your deployment values or Sandbox overlay:
sandboxPod.nodeSelector, sandboxPod.tolerations, and sandboxPod.affinity to control placement.
The proxy and Scheduled Task worker have separate resource settings under sandboxProxy.resources and
celery_worker_scheduled_tasks.resources.
Verify the deployment
Confirm the proxy, sandbox template, and Scheduled Task worker exist:Network configuration
Sandbox pods can send traffic only to DNS and the sandbox proxy. The proxy handles external requests, App policies, and credential injection. Most clusters work with the chart defaults. Two cluster layouts require additional values:Troubleshooting
Helm rejects the Sandbox configuration
Helm rejects the Sandbox configuration
Read the render error first. Confirm Kubernetes 1.33 or later,
SANDBOX_BACKEND: "kubernetes",
a non-empty SANDBOX_API_SERVER_URL, and auth.sandboxPushSecret.enabled: true with a populated Secret.Sandbox pods remain Pending
Sandbox pods remain Pending
Run
kubectl -n onyx-sandboxes describe pod <pod-name>.
Confirm at least one node matches sandboxPod.nodeSelector, accepts the configured taints and tolerations,
and has enough CPU, memory, and ephemeral storage.A sandbox fails during initialization
A sandbox fails during initialization
Inspect the
sandbox-init container logs and the proxy pods.
DNS must resolve the proxy before the sandbox firewall is installed.
Clusters using NodeLocal DNS usually need its listener CIDR under craft.dnsExtraCIDRs.Sandbox cannot reach the Quor API
Sandbox cannot reach the Quor API
Verify
SANDBOX_API_SERVER_URL, DNS, TLS trust, and routing from the proxy.
Do not point it at a Service name from another cluster or an address the proxy cannot resolve.The sandbox proxy is not Ready
The sandbox proxy is not Ready
Run
kubectl -n onyx logs -l app.kubernetes.io/component=sandbox-proxy --tail=200 and check its access to
PostgreSQL, Redis, the Quor API, and external destinations. On dual-stack clusters,
enable sandboxProxy.egressAllowIPv6.Sandbox deployment overview
Compare the Kubernetes and Docker Compose paths.
Managing Sandbox
Configure models and user access after deployment.