Quick Start

# 1. Create your values file (see Configuration below)
# 2. Install the chart
helm install rulebricks oci://ghcr.io/rulebricks/charts/stack \
  --namespace rulebricks \
  --create-namespace \
  -f your-values.yaml
 
# 3. Follow the on-screen instructions for DNS setup
# 4. Enable TLS once DNS is configured
helm upgrade rulebricks oci://ghcr.io/rulebricks/charts/stack \
  --namespace rulebricks \
  --reuse-values \
  --set global.tlsEnabled=true

Single-Phase Installation (with external-dns)

If you're on AWS, GCP, or Azure and want fully automated DNS:

helm install rulebricks oci://ghcr.io/rulebricks/charts/stack \
  --namespace rulebricks \
  --create-namespace \
  -f your-values.yaml \
  --set external-dns.enabled=true \
  --set global.externalDnsEnabled=true \
  --set global.tlsEnabled=true

See Deployment Modes for minimal configurations required for different deployment scenarios, and visit Configuration Reference for a complete breakdown of all available options in values.yaml.

What am I deploying?

You're deploying a complete Rulebricks stack to your existing Kubernetes cluster. The chart installs multiple integrated services, pre-configured for production workloads.

Components Deployed

Database Options

Self-hosted (default): PostgreSQL runs in your cluster with persistent storage. You have full control and data never leaves your infrastructure.

Managed Supabase: Use Supabase Cloud instead. Set supabase.enabled: false and provide your project credentials. The chart automatically configures your managed project.

Troubleshooting

# Check pod status
kubectl get pods -n rulebricks
 
# View events for issues
kubectl get events -n rulebricks --sort-by='.lastTimestamp'
 
# Check specific component logs
kubectl logs -n rulebricks -l app.kubernetes.io/name=rulebricks --tail=100
 
# Check migration job status
kubectl get jobs -n rulebricks
kubectl logs job/rulebricks-db-migrate-1 -n rulebricks

Common Issues

Pods stuck in Pending:

• Check node resources: kubectl describe nodes
• Verify StorageClass exists: kubectl get storageclass

Certificate not issuing:

• Verify DNS resolves to your LoadBalancer
• Check cert-manager logs: kubectl logs -n cert-manager -l app=cert-manager
• View certificate status: kubectl describe certificate -n rulebricks

Database connection errors:

• Wait for PostgreSQL to be ready (can take 2-3 minutes)
• Check database pod: kubectl logs -n rulebricks -l app.kubernetes.io/name=supabase-db

Clean Reinstall

# Uninstall and clean up
helm uninstall rulebricks -n rulebricks
kubectl delete pvc --all -n rulebricks
 
# Reinstall
helm install rulebricks oci://ghcr.io/rulebricks/charts/stack \
  --namespace rulebricks \
  -f your-values.yaml

Caveats & Limits

Cluster Requirements

The Helm chart deploys to your existing Kubernetes cluster. You're responsible for:

• Cluster provisioning and scaling
• Node pool configuration
• Storage provisioner (e.g., AWS EBS CSI driver)
• Network policies and security

See example-min-cluster.yaml (opens in a new tab) for minimum EKS cluster specifications.

Air-Gapped Deployments

Rulebricks can run nearly air-gapped with these exceptions:

Installing Updates

Rule engines usually take critical roles, so we don't release updates continuously. We make upgrades easy with zero downtime, but you control when they happen:

First, visit our Changelog, and find the rulebricks/app tag containing the fixes/features you need in your upgrade.

Then, edit rulebricks.app.image.tag in your values.yaml file accordingly.

Finally, run:

# Upgrade to latest version
helm upgrade rulebricks oci://ghcr.io/rulebricks/charts/stack \
  --namespace rulebricks \
  -f your-values.yaml