Skip to content

Getting Started

This guide walks through installing the operator and deploying a minimal Superset instance using dev mode.

Prerequisites

  • Kubernetes v1.28+ cluster
  • Helm 3
  • A PostgreSQL database accessible from the cluster

1. Install the operator

helm install superset-operator \
  oci://ghcr.io/apache/superset-kubernetes-operator/charts/superset-operator \
  --version 0.0.0-dev \
  --namespace superset-operator-system \
  --create-namespace \
  --set image.pullPolicy=Always

2. Deploy Superset

Create a minimal Superset instance in dev mode (inline credentials for simplicity):

kubectl apply -f - <<'EOF'
apiVersion: superset.apache.org/v1alpha1
kind: Superset
metadata:
  name: my-superset
spec:
  environment: Development
  secretKey: thisIsNotSecure_changeInProduction!
  metastore:
    uri: postgresql+psycopg2://superset:superset@postgres:5432/superset
  webServer: {}
  lifecycle:
    migrate: {}
    init:
      adminUser: {}
      loadExamples: true
EOF

The operator runs database migrations and initialization, then deploys the web server.

3. Watch it come up

kubectl get superset my-superset -w

Wait for PHASE: Running. You can also watch the lifecycle tasks:

kubectl get supersetlifecycletasks

4. Access Superset

kubectl port-forward svc/my-superset-web-server 8088:8088

Open http://localhost:8088 and log in with admin / admin.

Next steps