README.md

Neo4j Enterprise Operator Documentation

Welcome to the documentation for the Neo4j Enterprise Operator for Kubernetes.

📖 User Guide

The User Guide is for users of the Neo4j Enterprise Operator. It contains all the information you need to deploy, manage, and operate Neo4j clusters on Kubernetes.

• Getting Started: A quickstart guide to get you up and running in minutes.
• Deployment Guide: Complete deployment reference with local and registry-based options.
• Operator Modes: Complete guide to production and development modes, caching strategies, and performance tuning.
• Installation: Detailed installation instructions via git clone and make commands.
• Configuration: Comprehensive configuration options.
• External Access: Expose Neo4j outside Kubernetes using LoadBalancer, NodePort, or Ingress.
• Topology Placement: Configure zone distribution, anti-affinity, and advanced placement strategies.
• Property Sharding: Horizontal scaling for large datasets with property sharding
• Guides: In-depth guides on specific topics, such as:
  • Configuration Best Practices - Neo4j 5.26+ configuration guidelines and seed URI best practices
  • Backup and Restore - Comprehensive backup and restore operations including PITR
  • Backup & Restore Troubleshooting - Troubleshooting guide for backup/restore issues
  • Security
  • Performance
  • Monitoring
  • Upgrades
  • Troubleshooting - Including seed URI troubleshooting

👨‍💻 Developer Guide

The Developer Guide is for contributors and developers who want to work on the Neo4j Enterprise Operator itself.

• Development: How to set up your development environment and get started with contributing.
• Architecture: An overview of the operator's architecture.
• Testing: How to run the test suite.

📋 Quick Reference

Need something fast? Check out our quick reference materials:

• Operator Modes Cheat Sheet: Essential commands, flags, and troubleshooting for production and development modes

📄 API Reference

The API Reference contains detailed information about the operator's Custom Resource Definitions (CRDs).

• Neo4jEnterpriseCluster
• Neo4jEnterpriseStandalone
• Neo4jBackup
• Neo4jRestore
• Neo4jDatabase - Enhanced with IF NOT EXISTS, WAIT/NOWAIT, topology support, and seed URI functionality
• Neo4jPlugin - Smart plugin management with Neo4j 5.26+ compatibility
• Neo4jShardedDatabase - Property sharding for horizontal scaling

🚀 End-to-End Examples

Complete deployment examples demonstrating real-world scenarios:

• Complete Production Deployment - Full production setup with TLS, monitoring, and automated backups
• Disaster Recovery - Backup strategies, PITR, and cross-region recovery
• Development Workflow - Local development, migrations, and CI/CD integration
• Multi-Tenancy - Shared clusters with tenant isolation
• Property Sharding - Horizontal scaling with property sharding for large datasets

🆕 What's New

Latest Features (Neo4j 5.26+ and 2025.x)

• Database Management: Create databases with IF NOT EXISTS, WAIT/NOWAIT options
• 🆕 Seed URI Functionality: Create databases directly from existing backups stored in cloud storage
• 🆕 Property Sharding: Horizontal scaling for large datasets with separate graph and property shards
• Topology Constraints: Specify primary/secondary distribution for databases
• Version Detection: Automatic adaptation for Neo4j 5.26.x (SemVer) and 2025.x (CalVer)
• Cypher Language: Support for Cypher 25 in Neo4j 2025.x
• Backup Improvements: FULL/DIFF/AUTO backup types, backup from secondaries
• Point-in-Time Recovery: Restore to specific timestamps with --restore-until
• Centralized Backup: Single backup StatefulSet per cluster for resource efficiency

🚀 Seed URI Database Creation

Create Neo4j databases directly from existing backups stored in cloud storage - perfect for migrations, disaster recovery, and environment setup.

Quick Example

apiVersion: neo4j.neo4j.com/v1alpha1
kind: Neo4jDatabase
metadata:
  name: migrated-production-db
spec:
  clusterRef: production-cluster
  name: production

  # Create from S3 backup with point-in-time recovery
  seedURI: "s3://my-neo4j-backups/production-2025-01-15.backup"
  seedConfig:
    restoreUntil: "2025-01-15T10:30:00Z"  # Neo4j 2025.x only
    config:
      compression: "gzip"
      validation: "strict"

  # Database topology
  topology:
    primaries: 2
    secondaries: 2

  wait: true
  ifNotExists: true

Supported Features

• ☁️ Multi-Cloud Support: S3, Google Cloud Storage, Azure Blob Storage
• 🌐 HTTP/FTP: Support for HTTP/HTTPS and FTP sources
• 🔒 Flexible Authentication: System-wide (IAM roles, workload identity) or explicit credentials
• ⏰ Point-in-Time Recovery: Restore to specific timestamps (Neo4j 2025.x)
• 📊 Topology Control: Specify database distribution across cluster servers
• ⚡ Performance Optimized: Support for .backup format with compression options

Examples and Documentation

• Database Seed URI Examples - Complete examples for all cloud providers
• Seed URI Feature Guide - Comprehensive guide with authentication, troubleshooting, and best practices
• Neo4jDatabase API Reference - Full API documentation with seed URI fields