You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: modules/ROOT/pages/kubernetes/operations/backup-restore.adoc
+52-15Lines changed: 52 additions & 15 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,25 +8,67 @@ For performing backups, Neo4j uses the _Admin Service_, which is only available
8
8
For more information, see xref:kubernetes/accessing-neo4j.adoc[Accessing Neo4j].
9
9
====
10
10
11
-
[[kubernetes-backup-storage-options]]
12
-
== Backup storage options
11
+
[[kubernetes-backup-modes]]
12
+
== Backup modes
13
13
14
-
Neo4j's Helm chart supports both full and differential backups and can be configured to use cloud providers or local storage.
14
+
Neo4j's Helm chart supports two backup modes:
15
15
16
-
=== Cloud storage
16
+
=== Cloud provider mode
17
17
18
-
Neo4j Helm chart uses Neo4j's native cloud storage integration with direct upload to create immutable backup objects.
19
-
This allows you to back up your Neo4j databases directly to cloud storage without the need for persistent volumes.
20
-
The chart can be configured to use cloud providers, such as AWS S3, Google Cloud Storage, and Azure Blob Storage, by setting the `cloudProvider` parameter to `aws`, `gcp`, or `azure` in the _backup-values.yaml_ file.
18
+
Cloud provider mode uses Neo4j's native cloud storage integration with direct upload to create immutable backup objects.
21
19
22
-
The following features are supported:
20
+
* *Supported providers*: AWS S3, Google Cloud Storage, and Azure Blob Storage.
21
+
* *Benefits*: No persistent volume requirements. Supports differential backups and immutable backup objects.
22
+
* *Configuration*: Set `cloudProvider` to `aws`, `gcp`, or `azure`.
23
+
24
+
=== Local mode
25
+
26
+
Local mode creates local backups in `/backups` mount.
27
+
28
+
* *Requirements*: Persistent storage for large databases (configured via `tempVolume`).
29
+
* *Configuration*: Leave `cloudProvider` empty.
30
+
31
+
[[kubernetes-cloud-native-features]]
32
+
== Cloud-native backup features
33
+
34
+
When using cloud providers, Neo4j's native backup provides:
23
35
24
36
* *Direct cloud storage upload* - No intermediate local storage required.
25
37
* *Differential backup chains* with `preferDiffAsParent: true`.
26
38
* *Immutable backup objects* in cloud storage.
27
39
* *Support for S3-compatible endpoints*.
28
40
* *Enhanced S3 configuration* including custom CA certificates and endpoint settings.
29
41
42
+
[[kubernetes-differential-backups]]
43
+
== Differential backups
44
+
45
+
For cloud providers, differential backups eliminate the need for persistent volumes:
46
+
47
+
[source, yaml, subs="attributes+,+macros"]
48
+
----
49
+
backup:
50
+
cloudProvider: "aws"
51
+
bucketName: "my-backups"
52
+
preferDiffAsParent: true
53
+
type: "AUTO" # First backup will be FULL, subsequent ones DIFF
54
+
fallbackToFull: true # Fallback to FULL if DIFF fails
55
+
----
56
+
57
+
**How it works:**
58
+
59
+
. The first backup creates a full backup in the cloud storage.
60
+
. Subsequent backups create differential backups that reference the cloud-stored full backup.
61
+
. No local storage of previous backups is required.
62
+
63
+
[NOTE]
64
+
====
65
+
`preferDiffAsParent` is fully supported and eliminates the need for persistent volumes.
0 commit comments