OpenSandbox

English

简体中文

English

简体中文

Appearance

OpenSandbox (All-in-One) ​

This Helm chart bundles both the OpenSandbox Controller and OpenSandbox Server into a single deployment for simplified installation.

Prerequisites ​

  • Kubernetes 1.21.1+
  • Helm 3.0+

Quick Start ​

bash
# Add repo (if published)
helm repo add opensandbox https://your-helm-repo.example.com

# Install all components in one command
helm install opensandbox opensandbox/opensandbox \
  --namespace opensandbox-system \
  --create-namespace

Or install from local source:

bash
cd kubernetes/charts

# Build dependencies (downloads sub-charts from local paths)
helm dependency build opensandbox

# Install
helm install opensandbox ./opensandbox \
  --namespace opensandbox-system \
  --create-namespace

Note: The charts/ directory containing packaged sub-charts is generated by helm dependency build and should not be committed to Git.

Components Included ​

This chart installs:

  1. OpenSandbox Controller (opensandbox-controller)

    • Manages Pool and BatchSandbox CRDs
    • Handles resource pooling and batch delivery
    • Runs as a Kubernetes operator

  2. OpenSandbox Server (opensandbox-server)

    • Provides REST API for sandbox lifecycle management
    • Connects to the controller for resource orchestration
    • Optional ingress gateway support

Configuration ​

Most configuration is inherited from the sub-charts. See individual chart documentation:

Override Sub-chart Values ​

You can customize values for each component using the sub-chart name as prefix:

yaml
# values.yaml
opensandbox-controller:
  controller:
    logLevel: debug
    replicaCount: 2

opensandbox-server:
  server:
    replicaCount: 2
    gateway:
      enabled: true
      host: gateway.example.com

Then install with:

bash
# Ensure dependencies are built first
helm dependency build opensandbox

helm install opensandbox ./opensandbox -f values.yaml

Upgrade ​

bash
# Ensure dependencies are up to date
helm dependency build opensandbox

helm upgrade opensandbox ./opensandbox -n opensandbox-system

Uninstall ​

bash
helm uninstall opensandbox -n opensandbox-system

Note: CRDs are kept by default. To remove them:

bash
kubectl delete crd batchsandboxes.sandbox.opensandbox.io
kubectl delete crd pools.sandbox.opensandbox.io

License ​

Apache 2.0

This page is sourced from: kubernetes/charts/opensandbox/README.md