Install and deploy Kaveon
Choose a hosting shape, install the same Kaveon contracts, verify the request path, and then hand off to operations.
A Kaveon deployment has an Engine coordinator, optional Engine workers, the API and Studio. Table data stays in Parquet, Delta or Iceberg storage; KaveonDB stores the platform records transactionally. Studio is portable: it can run on Vercel for managed frontend hosting or inside the same AKS or VM deployment as the API and Engine.
Choose a deployment
| Target | Use it for | Start here |
|---|---|---|
| Docker Compose | Local development, demos and a single host | Quickstart · Deployment |
| Linux VM | A small, controlled deployment with Docker and a reverse proxy | Deployment · Operations |
| Kubernetes with Helm | Worker replacement, autoscaling and repeatable releases | Deployment |
| Kaveon CLI | Interactive SQL and scripts from another machine | Engine |
Docker Compose
Docker is the shortest path. It starts the coordinator, workers, API and Studio without requiring PostgreSQL.
git clone https://github.com/PruthviProdduturi/Kaveon.git
cd Kaveon
./scripts/kaveon-up.sh
# Studio http://localhost:3000
# API health http://localhost:8082/api/health
# Engine http://localhost:8081/healthUse ./scripts/kaveon-up.sh --data /path/to/lake to mount a local lake read-only. See the self-hosting guide for storage, backups and sign-in.
Linux VM
Use the same Compose stack on a Linux VM, bind the public entry point to a TLS reverse proxy, and keep the Engine and API private. A VM is the simplest persistent cloud deployment and is independent of Kubernetes.
Kubernetes with Helm
The Helm charts pin every image by immutable digest. The production-shaped Azure template creates kaveon-aks with one system node and a worker pool autoscaled from one to four nodes. It preserves the existing ADLS account and ACR; it does not change subscription policies.
az aks get-credentials --resource-group kaveon-rg --name kaveon-aks --overwrite-existing
kubelogin convert-kubeconfig -l azurecli
helm upgrade --install kaveon infra/helm/kaveon-engine --namespace kaveon --create-namespace `
--set image.repository=kaveonacr.azurecr.io/kaveon-engine `
--set image.digest=sha256:<immutable-digest>Use the Azure deployment guide for the Bicep workflow, workload identity, secrets, TLS and autoscaler verification. The chart is deliberately separate from infrastructure creation so credentials never enter source control.
Studio hosting choices
Vercel is optional managed frontend hosting for previews, CDN delivery and a low-operations public site. It does not replace the API or Engine, and its Hobby tier has provider usage and commercial limits. The same Studio image can run inside AKS with the portal Helm chart, alongside the API and Engine, when one cluster should own the complete product surface.
helm upgrade --install kaveon-portal infra/helm/kaveon-platform \
--namespace kaveon --create-namespace \
--set images.studio.repository=<registry>/kaveon-studio \
--set images.studio.digest=sha256:<immutable-digest> \
--set images.api.repository=<registry>/kaveon-api \
--set images.api.digest=sha256:<immutable-digest> \
--set secrets.portalAuth=kaveon-portal-authVercel and AKS can coexist during migration. Switch traffic only after the AKS ingress, OAuth callbacks, API health, catalog restore and dashboard smoke tests pass. Continue with Deployment topology, then Operations.
After installation
- Open Catalog and register a Parquet, Delta or Iceberg location.
- Run
ANALYZEso the planner can use exact source statistics. - Run a bounded SQL query from SQL Lab or the CLI.
- Configure authentication before exposing Studio to other users.