Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/examples/neo4j/autoscaler/neo4j.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ metadata:
name: neo4j-autoscale
namespace: demo
spec:
version: "2025.12.1"
version: "2026.08.1"
replicas: 3
storageType: Durable
storage:
Expand Down
2 changes: 1 addition & 1 deletion docs/examples/neo4j/configuration/neo4j-configuration.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ metadata:
name: custom-neo4j
namespace: demo
spec:
version: "2025.12.1"
version: "2026.08.1"
replicas: 3
configuration:
secretName: neo4j-configuration
Expand Down
2 changes: 1 addition & 1 deletion docs/examples/neo4j/custom-rbac/neo4j-custom-db.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ metadata:
name: quick-neo4j
namespace: demo
spec:
version: "2025.12.1"
version: "2026.08.1"
replicas: 3
storageType: Durable
podTemplate:
Expand Down
2 changes: 1 addition & 1 deletion docs/examples/neo4j/migration/sample-neo4j.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ metadata:
spec:
replicas: 3
deletionPolicy: WipeOut
version: "2025.12.1"
version: "2026.08.1"
storage:
storageClassName: "local-path"
accessModes:
Expand Down
2 changes: 1 addition & 1 deletion docs/examples/neo4j/monitoring/builtin-prom-neo4j.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ metadata:
name: builtin-prom-neo4j
namespace: demo
spec:
version: "2025.12.1"
version: "2026.08.1"
replicas: 3
deletionPolicy: WipeOut
storage:
Expand Down
2 changes: 1 addition & 1 deletion docs/examples/neo4j/monitoring/coreos-prom-neo4j.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ metadata:
spec:
replicas: 3
deletionPolicy: WipeOut
version: "2025.12.1"
version: "2026.08.1"
storage:
storageClassName: local-path
accessModes:
Expand Down
2 changes: 1 addition & 1 deletion docs/examples/neo4j/monitoring/neo4j-grafana-demo.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ metadata:
name: neo4j-grafana-demo
namespace: demo
spec:
version: "2025.11.2"
version: "2026.08.1"
replicas: 3
deletionPolicy: WipeOut
storage:
Expand Down
2 changes: 1 addition & 1 deletion docs/examples/neo4j/private-registry/pvt-reg-neo4j.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ metadata:
name: pvt-reg-neo4j
namespace: demo
spec:
version: "2025.12.1"
version: "2026.08.1"
replicas: 3
storageType: Durable
storage:
Expand Down
2 changes: 1 addition & 1 deletion docs/examples/neo4j/quickstart/neo4j.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ metadata:
spec:
replicas: 3
deletionPolicy: WipeOut
version: "2025.12.1"
version: "2026.08.1"
storage:
storageClassName: local-path
accessModes:
Expand Down
2 changes: 1 addition & 1 deletion docs/examples/neo4j/update-version/ops-request.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,4 @@ spec:
databaseRef:
name: neo4j-test
updateVersion:
targetVersion: "2025.12.1"
targetVersion: "2026.08.1"
2 changes: 1 addition & 1 deletion docs/guides/neo4j/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ metadata:
spec:
replicas: 3
deletionPolicy: WipeOut
version: "2025.12.1"
version: "2026.08.1"
storage:
storageClassName: local-path
accessModes:
Expand Down
4 changes: 2 additions & 2 deletions docs/guides/neo4j/autoscaler/compute/autoscale.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ metadata:
name: neo4j-autoscale
namespace: demo
spec:
version: "2025.12.1"
version: "2026.08.1"
replicas: 3
storageType: Durable
storage:
Expand Down Expand Up @@ -83,7 +83,7 @@ Wait for the cluster to become ready:
```bash
$ kubectl get neo4j -n demo neo4j-autoscale -w
NAME VERSION STATUS AGE
neo4j-autoscale 2025.12.1 Ready 3m
neo4j-autoscale 2026.08.1 Ready 3m
```

The Neo4j container initially requests and limits `500m` CPU and `2Gi` memory. Neo4j needs enough memory for the JVM, page cache, and native allocations; limits that are too small can cause the process to be OOM-killed.
Expand Down
4 changes: 2 additions & 2 deletions docs/guides/neo4j/autoscaler/storage/autoscale.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ metadata:
name: neo4j-autoscale
namespace: demo
spec:
version: "2025.12.1"
version: "2026.08.1"
replicas: 3
storageType: Durable
storage:
Expand Down Expand Up @@ -89,7 +89,7 @@ neo4j.kubedb.com/neo4j-autoscale created

$ kubectl get neo4j -n demo neo4j-autoscale -w
NAME VERSION STATUS AGE
neo4j-autoscale 2025.12.1 Ready 3m
neo4j-autoscale 2026.08.1 Ready 3m
```

Confirm the initial PVC capacities:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ metadata:
name: sample-neo4j
namespace: demo
spec:
version: 2025.12.1
version: 2026.08.1
replicas: 3
storageType: Durable
storage:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ metadata:
name: remote-neo4j
namespace: demo
spec:
version: 2025.12.1
version: 2026.08.1
replicas: 3
storageType: Durable
storage:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ metadata:
name: restored-neo4j
namespace: demo
spec:
version: 2025.12.1
version: 2026.08.1
replicas: 3
configuration:
remoteAliasKeystore:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ metadata:
name: source-neo4j
namespace: demo
spec:
version: 2025.12.1
version: 2026.08.1
replicas: 3
configuration:
remoteAliasKeystore:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ This guide shows you how to back up and restore physical databases, composite da

- Prepare a Kubernetes cluster and configure `kubectl` to access it.
- Install [KubeDB](/docs/setup/README.md), [KubeStash](https://kubestash.com/docs/latest/setup/install/kubestash), and the [KubeStash kubectl plugin](https://kubestash.com/docs/latest/setup/install/kubectl-plugin/).
- Use a KubeDB-supported Neo4j Enterprise version that supports composite databases. This guide uses `2025.12.1`.
- Use a KubeDB-supported Neo4j Enterprise version that supports composite databases. This guide uses `2026.08.1`.
- Prepare an S3-compatible bucket and its access credentials.
- Install a Java Development Kit that provides `keytool` on the machine where you run the setup commands.
- Make sure the source and restore-target Neo4j deployments can reach the remote Neo4j Bolt endpoint.
Expand Down Expand Up @@ -114,7 +114,7 @@ metadata:
name: source-neo4j
namespace: demo
spec:
version: 2025.12.1
version: 2026.08.1
replicas: 3
configuration:
remoteAliasKeystore:
Expand Down Expand Up @@ -150,7 +150,7 @@ metadata:
name: remote-neo4j
namespace: demo
spec:
version: 2025.12.1
version: 2026.08.1
replicas: 3
storageType: Durable
storage:
Expand Down Expand Up @@ -414,7 +414,7 @@ metadata:
name: restored-neo4j
namespace: demo
spec:
version: 2025.12.1
version: 2026.08.1
replicas: 3
configuration:
remoteAliasKeystore:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ metadata:
spec:
init:
waitForInitialRestore: true
version: 2025.12.1
version: 2026.08.1
replicas: 3
storageType: Durable
storage:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ metadata:
name: sample-neo4j
namespace: demo
spec:
version: 2025.12.1
version: 2026.08.1
replicas: 3
storageType: Durable
storage:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ metadata:
name: sample-neo4j
namespace: demo
spec:
version: 2025.12.1
version: 2026.08.1
replicas: 3
storageType: Durable
storage:
Expand All @@ -93,7 +93,7 @@ Let's check if the database is ready to use,
```bash
$ kubectl get neo4j -n demo sample-neo4j
NAME VERSION STATUS AGE
sample-neo4j 2025.12.1 Ready 5m1s
sample-neo4j 2026.08.1 Ready 5m1s
```

The database is `Ready`. Verify that KubeDB has created a `Secret` and a `Service` for this database using the following commands,
Expand All @@ -120,7 +120,7 @@ Verify that the `AppBinding` has been created successfully using the following c
```bash
$ kubectl get appbindings -n demo
NAME TYPE VERSION AGE
sample-neo4j kubedb.com/Neo4j 2025.12.1-enterprise 86s
sample-neo4j kubedb.com/Neo4j 2026.08.1-enterprise 86s
```

Let's check the YAML of the above `AppBinding`,
Expand All @@ -135,7 +135,7 @@ kind: AppBinding
metadata:
annotations:
kubectl.kubernetes.io/last-applied-configuration: |
{"apiVersion":"kubedb.com/v1alpha2","kind":"Neo4j","metadata":{"annotations":{},"name":"sample-neo4j","namespace":"demo"},"spec":{"deletionPolicy":"WipeOut","replicas":3,"storage":{"accessModes":["ReadWriteOnce"],"resources":{"requests":{"storage":"2Gi"}}},"storageType":"Durable","version":"2025.12.1"}}
{"apiVersion":"kubedb.com/v1alpha2","kind":"Neo4j","metadata":{"annotations":{},"name":"sample-neo4j","namespace":"demo"},"spec":{"deletionPolicy":"WipeOut","replicas":3,"storage":{"accessModes":["ReadWriteOnce"],"resources":{"requests":{"storage":"2Gi"}}},"storageType":"Durable","version":"2026.08.1"}}
creationTimestamp: "2026-06-22T05:50:48Z"
generation: 1
labels:
Expand Down Expand Up @@ -168,7 +168,7 @@ spec:
secret:
name: sample-neo4j-auth
type: kubedb.com/Neo4j
version: 2025.12.1-enterprise
version: 2026.08.1-enterprise
```

KubeStash uses the `AppBinding` CR to connect with the target database. It requires the following fields to be set in the AppBinding's `.spec` section.
Expand Down Expand Up @@ -452,7 +452,7 @@ apiVersion: storage.kubestash.com/v1alpha1
kind: Snapshot
metadata:
annotations:
kubedb.com/db-version: 2025.12.1-enterprise
kubedb.com/db-version: 2026.08.1-enterprise
creationTimestamp: "2026-06-22T06:11:20Z"
finalizers:
- kubestash.com/cleanup
Expand Down Expand Up @@ -550,7 +550,7 @@ metadata:
name: restored-neo4j
namespace: demo
spec:
version: 2025.12.1
version: 2026.08.1
replicas: 3
storageType: Durable
storage:
Expand All @@ -574,7 +574,7 @@ Let's wait for the database to be ready to use,
```bash
$ kubectl get neo4j -n demo restored-neo4j
NAME VERSION STATUS AGE
restored-neo4j 2025.12.1 Ready 5m1s
restored-neo4j 2026.08.1 Ready 5m1s
```

The database is `Ready`. Now, we are going to restore the backed up data into this database.
Expand Down Expand Up @@ -656,7 +656,7 @@ At first, check if the database has gone into **`Ready`** state by the following
```bash
$ kubectl get neo4j -n demo restored-neo4j
NAME VERSION STATUS AGE
restored-neo4j 2025.12.1 Ready 6m31s
restored-neo4j 2026.08.1 Ready 6m31s
```

Now, find out the database `Pod` by the following command,
Expand Down
4 changes: 2 additions & 2 deletions docs/guides/neo4j/clustering/architecture-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ metadata:
namespace: demo
spec:
replicas: 3
version: "2025.12.1"
version: "2026.08.1"
storage:
storageClassName: local-path
accessModes:
Expand All @@ -114,7 +114,7 @@ When applied:
```bash
$ kubectl get neo4j -n demo neo4j-test
NAME VERSION STATUS AGE
neo4j-test 2025.12.1 Ready 3m
neo4j-test 2026.08.1 Ready 3m

$ kubectl get pods -n demo -l app.kubernetes.io/instance=neo4j-test
NAME READY STATUS RESTARTS AGE
Expand Down
2 changes: 1 addition & 1 deletion docs/guides/neo4j/concepts/appbinding.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ spec:
secret:
name: neo4j-test-auth
type: kubedb.com/Neo4j
version: 2025.12.1-enterprise
version: 2026.08.1-enterprise
```

Here, we describe the important sections of this AppBinding.
Expand Down
14 changes: 8 additions & 6 deletions docs/guides/neo4j/concepts/catalog.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,13 +28,13 @@ The value of `Neo4j.spec.version` must correspond to a valid `Neo4jVersion` reso
apiVersion: catalog.kubedb.com/v1alpha1
kind: Neo4jVersion
metadata:
name: 2025.11.2
name: 2026.08.1
spec:
db:
image: docker.io/library/neo4j:2025.11.2-enterprise
image: docker.io/library/neo4j:2026.08.1-enterprise
securityContext:
runAsUser: 7474
version: 2025.11.2-enterprise
version: 2026.08.1-enterprise
```

## Key fields
Expand All @@ -50,9 +50,11 @@ spec:
```bash
$ kubectl get neo4jversions
NAME VERSION DB_IMAGE DEPRECATED AGE
2025.10.1 2025.10.1-enterprise docker.io/library/neo4j:2025.10.1-enterprise 12d
2025.11.2 2025.11.2-enterprise docker.io/library/neo4j:2025.11.2-enterprise 12d
2025.12.1 2025.12.1-enterprise docker.io/library/neo4j:2025.12.1-enterprise 12d
2026.05.0 2026.05.0-enterprise docker.io/library/neo4j:2026.05.0-enterprise 14d
2026.06.0 2026.06.0-enterprise docker.io/library/neo4j:2026.06.0-enterprise 14d
2026.07.1 2026.07.1-enterprise docker.io/library/neo4j:2026.07.1-enterprise 14d
2026.08.1 2026.08.1-enterprise docker.io/library/neo4j:2026.08.1-enterprise 14d
5.26.28 5.26.28-enterprise docker.io/library/neo4j:5.26.28-enterprise 14d
```

If the `DEPRECATED` column shows `true` for a version you are currently using, upgrade to a supported version via [UpdateVersion](/docs/guides/neo4j/update-version/versionupgrading/).
Expand Down
10 changes: 6 additions & 4 deletions docs/guides/neo4j/concepts/neo4j.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ metadata:
name: neo4j-test
namespace: demo
spec:
version: "2025.12.1"
version: "2026.08.1"
replicas: 3
storageType: Durable
configuration:
Expand Down Expand Up @@ -76,9 +76,11 @@ To see available versions in your cluster:
```bash
$ kubectl get neo4jversions
NAME VERSION DB_IMAGE DEPRECATED AGE
2025.10.1 2025.10.1-enterprise docker.io/library/neo4j:2025.10.1-enterprise 12d
2025.11.2 2025.11.2-enterprise docker.io/library/neo4j:2025.11.2-enterprise 12d
2025.12.1 2025.12.1-enterprise docker.io/library/neo4j:2025.12.1-enterprise 12d
2026.05.0 2026.05.0-enterprise docker.io/library/neo4j:2026.05.0-enterprise 14d
2026.06.0 2026.06.0-enterprise docker.io/library/neo4j:2026.06.0-enterprise 14d
2026.07.1 2026.07.1-enterprise docker.io/library/neo4j:2026.07.1-enterprise 14d
2026.08.1 2026.08.1-enterprise docker.io/library/neo4j:2026.08.1-enterprise 14d
5.26.28 5.26.28-enterprise docker.io/library/neo4j:5.26.28-enterprise 14d
```

### spec.replicas
Expand Down
2 changes: 1 addition & 1 deletion docs/guides/neo4j/concepts/opsrequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ spec:
databaseRef:
name: neo4j-test
updateVersion:
targetVersion: 2025.12.1
targetVersion: 2026.08.1
```

**Sample `Neo4jOpsRequest` for vertical scaling:**
Expand Down
Loading
Loading