New to KubeDB? Please start here.

Overview

KubeDB supports graph database deployment with Neo4j using the Neo4j CRD.

Supported Neo4j Features

Supported Ops Requests

• Reconfigure
• HorizontalScaling
• VerticalScaling
• VolumeExpansion
• StorageMigration
• UpdateVersion
• ReconfigureTLS
• RotateAuth
• Restart

Example Neo4j Manifest

apiVersion: kubedb.com/v1alpha2
kind: Neo4j
metadata:
  name: neo4j-test
  namespace: demo
spec:
  replicas: 3
  deletionPolicy: WipeOut
  version: "2025.12.1"
  storage:
    storageClassName: local-path
    accessModes:
      - ReadWriteOnce
    resources:
      requests:
        storage: 2Gi

User Guide

Getting Started

• Quickstart Neo4j — deploy your first Neo4j cluster with KubeDB.
• Cluster Architecture Overview — understand cluster topology, Raft consensus, and fault tolerance.
• RBAC Permissions — RBAC resources KubeDB creates for Neo4j pods.

Concepts

• Neo4j CRD — full reference for all Neo4j spec fields.
• Neo4jVersion CRD — image and version catalog.
• Neo4jOpsRequest CRD — day-2 operations reference with sample manifests.
• AppBinding CRD — how KubeDB exposes connection details for backup tools.

Configuration & Infrastructure

• Custom Configuration — pass Neo4j settings via a Kubernetes Secret.
• Private Registry — pull Neo4j images from a private Docker registry.
• Custom RBAC — provide your own ServiceAccount and Role instead of the auto-generated ones.

Monitoring

• Monitoring Overview — how KubeDB exposes Neo4j metrics.
• Builtin Prometheus — scrape metrics without the Prometheus Operator.
• Prometheus Operator — use a ServiceMonitor with the Prometheus Operator.

Day-2 Operations

• TLS — How It Works — how KubeDB provisions TLS certificates via cert-manager.
• Configure TLS — enable TLS on a new or existing cluster.
• Reconfigure — How It Works — how KubeDB applies config changes internally.
• Reconfigure — change Neo4j settings at runtime.
• Reconfigure TLS — How It Works — how KubeDB rotates or removes TLS.
• Reconfigure TLS — add, rotate, change issuer, or remove TLS.
• Restart — rolling restart of all Neo4j pods.
• Rotate Auth — How It Works — how KubeDB rotates credentials.
• Rotate Auth — rotate Neo4j passwords with or without a user-provided Secret.
• Update Version — How It Works — how KubeDB performs rolling version upgrades.
• Update Version — upgrade to a newer Neo4j release.
• Horizontal Scaling — How It Works — how KubeDB adds or removes cluster members.
• Horizontal Scaling — add or remove Neo4j server pods.
• Vertical Scaling — How It Works — how KubeDB adjusts pod resources.
• Vertical Scaling — resize CPU and memory for Neo4j pods.
• Volume Expansion — How It Works — how KubeDB expands PVCs.
• Volume Expansion — increase persistent storage size online or offline.
• StorageClass Migration — migrate Neo4j data to a different StorageClass.