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
+17-48Lines changed: 17 additions & 48 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,66 +8,30 @@ 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-modes]]
12
-
== Backup modes
11
+
[[kubernetes-backup-storage-options]]
12
+
== Backup storage options
13
13
14
-
Neo4j's Helm chart supports two backup modes:
14
+
Neo4j's Helm chart supports both full and differential backups and can be configured to use cloud providers or local storage.
15
15
16
-
=== Cloud provider mode
16
+
=== Cloud storage
17
17
18
-
Cloud provider mode uses Neo4j's native cloud storage integration with direct upload to create immutable backup objects.
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.
19
21
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:
22
+
The following features are supported:
35
23
36
24
* *Direct cloud storage upload* - No intermediate local storage required.
37
25
* *Differential backup chains* with `preferDiffAsParent: true`.
38
26
* *Immutable backup objects* in cloud storage.
39
27
* *Support for S3-compatible endpoints*.
40
28
* *Enhanced S3 configuration* including custom CA certificates and endpoint settings.
41
29
42
-
[[kubernetes-differential-backups]]
43
-
== Differential backups
30
+
=== Local storage
44
31
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.
* *Cloud-Native*: DIFF backups reference cloud-stored FULL backups directly.
69
-
* *No PV Required*: Previous backups don't need to be stored locally.
70
-
====
32
+
Local storage creates local backups in the `/backups` mount.
33
+
This mount must be configured to use a persistent storage for large databases using `tempVolume`.
34
+
The `cloudProvider` must be empty.
71
35
72
36
[[kubernetes-neo4j-backup-cloud]]
73
37
== Prepare to back up a database(s) to a cloud provider (AWS, GCP, and Azure) bucket
@@ -516,6 +480,7 @@ When configuring the _backup-values.yaml_ file, keep the “cloudProvider” fie
516
480
[NOTE]
517
481
====
518
482
You need to create the persistent volume and persistent volume claim before installing the _neo4j-admin_ Helm chart only when using local storage.
483
+
When using cloud providers, persistent volumes are not required for differential backups.
519
484
For more information, see xref:kubernetes/persistent-volumes.adoc[Volume mounts and persistent volumes].
520
485
====
521
486
@@ -1090,6 +1055,10 @@ To migrate from persistent volume-based backups to cloud-native backups, you nee
1090
1055
. Perform a final traditional backup to ensure you have the latest data.
1091
1056
For more information, see <<kubernetes-neo4j-backup-on-prem, Prepare to back up a database(s) to on-premises storage>> and <<kubernetes-neo4j-backup, Back up your databases>>.
1092
1057
. Upload existing backups to the cloud storage bucket if needed.
1058
+
You can use cloud provider CLI tools to transfer your backup files:
1059
+
** For AWS S3: `aws s3 cp /path/to/backups s3://your-bucket/backups --recursive`
1060
+
** For Google Cloud Storage: `gsutil cp -r /path/to/backups gs://your-bucket/backups`
0 commit comments