Skip to main content

​
Prerequisites

  • Access to run kubectl commands in the cluster’s context (kubectl can reach the target cluster).
  • helm is installed.
  • Your Kubernetes user can create namespaces, CRDs, RBAC resources, and workloads.
  • At least 3 worker nodes with 4 CPU and 16 GB of memory each.
  • Outbound access from the cluster to pull images: registry.falkordb.cloud (Enterprise images, credentials required), docker.io, apecloud-registry.cn-zhangjiakou.cr.aliyuncs.com, registry.k8s.io, and ghcr.io — or registry.falkordb.cloud alone, since every image is also mirrored there (see Private registries).
Verify the active context before installing:

​
Install

Install with the default release and namespaces:
By default, the installer:
  • Installs or updates KubeBlocks in kb-system.
  • Installs or updates Snapshot Controller in kb-system.
  • Installs FalkorDB Enterprise in falkordb-system.
  • Exposes the Admin UI and Admin Server on a single origin through the chart’s gateway Ingress on new installs when no custom values, ingress, service host, or service URL settings are provided. The installer uses the cluster’s default IngressClass when one exists, and otherwise installs ingress-nginx into the ingress-nginx namespace.
  • Sets adminServer.env.cookieSecure=false because quick access endpoints are plain HTTP. Because the UI and API share one origin, the auth cookie keeps the default SameSite=Lax policy. Use --no-ingress to fall back to two LoadBalancer services on separate origins, which additionally sets adminServer.env.cookieSameSite=none.
  • Disables the embedded KubeBlocks and snapshot-controller subcharts in the Enterprise release because those platform components are managed as separate releases.
  • Generates or reuses adminServer.secret.jwtSecret.
  • Creates the bootstrap local admin user unless disabled with Helm values.
The script prints an install plan and asks for confirmation. Use --yes for non-interactive installs:

​
Install into specific namespaces

​
Dry run

Render the chart without changing the cluster:
In dry-run mode, the script skips CRD apply, KubeBlocks install, Snapshot Controller install, image pull Secret creation, and stale definition cleanup. It still renders the Enterprise chart with helm template.

​
Validate the install

Check the Helm releases:
Check pods:
For a default quick install, the installer prints the external Admin UI URL after the ingress address is assigned. You can also retrieve it with:
Open the Admin UI URL in your browser and sign in with the bootstrap local admin user. The Admin Server API is served from the same origin under /api. If your Kubernetes environment does not support LoadBalancer services (used by the ingress controller), use port-forwarding instead. Check Admin Server health inside the cluster:
Check Admin UI locally:
The default bootstrap local admin user is configured in Helm values as admin@falkordb.local with password Test123!@#. Change this for any shared or production environment.

​
Local chart development

From a checked-out repository, use the local chart: