opensandbox-server Helm Chart

OpenSandbox Lifecycle API server: provides sandbox create/delete and other lifecycle APIs, typically used with BatchSandbox/Pool on Kubernetes.

Prerequisites

• Kubernetes 1.21.1+
• Helm 3.0+
• OpenSandbox CRDs installed (deploy opensandbox-controller first)

Install

# Server only (default namespace opensandbox-system)
helm install opensandbox-server ./kubernetes/charts/opensandbox-server \
  --namespace opensandbox-system \
  --create-namespace

# With custom image and config
helm install opensandbox-server ./kubernetes/charts/opensandbox-server \
  --set server.image.repository=your-registry/opensandbox/server \
  --set server.image.tag=v0.1.0 \
  --namespace opensandbox-system \
  --create-namespace

Deploy server and ingress-gateway together

To run both the Lifecycle API server and the ingress gateway (components/ingress) in one release, set server.gateway.enabled=true. The chart will deploy the server and the gateway (Deployment, Service, RBAC), and write server config [ingress] mode = "gateway" so the server returns the correct gateway address to clients.

helm install opensandbox-server ./kubernetes/charts/opensandbox-server \
  --namespace opensandbox-system \
  --create-namespace \
  --set server.gateway.enabled=true \
  --set server.gateway.host=gateway.example.com

Optional: override gateway image, replicas, or resources (see server.gateway.* in Configuration).

Configuration

Parameter	Description	Default
server.image.repository	Server image repository	sandbox-registry.../opensandbox/server
server.image.tag	Server image tag	Chart appVersion
server.replicaCount	Server replicas	2
server.resources	CPU/memory requests and limits	See values.yaml
namespaceOverride	Deployment namespace	opensandbox-system
configToml	config.toml content ([ingress] block generated from server.gateway)	See values.yaml
server.gateway.enabled	When true: set server config to gateway and deploy components/ingress gateway	false
server.gateway.host	config gateway.address (address returned to clients)	opensandbox.example.com
server.gateway.gatewayRouteMode	server config and gateway route mode (header/uri)	header
server.gateway.*	Gateway image, replicas, port, dataplaneNamespace, providerType, resources	See values.yaml

Gateway: When server.gateway.enabled=true, the chart writes [ingress] mode = "gateway" in config.toml and deploys components/ingress Deployment/Service/RBAC; gateway --mode matches config. External access must be configured separately.

Set [kubernetes].namespace in config for the sandbox workload namespace. Override api_key via Secret or values in production.

Upgrade and uninstall

helm upgrade opensandbox-server ./kubernetes/charts/opensandbox-server -n opensandbox-system
helm uninstall opensandbox-server -n opensandbox-system

References

• OpenSandbox
• Helm deployment docs

---

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