Skip to content

Commit a8e3ae4

Browse files
committed
Update kubernetes operations backup section
1 parent 96ec53d commit a8e3ae4

File tree

1 file changed

+52
-15
lines changed

1 file changed

+52
-15
lines changed

modules/ROOT/pages/kubernetes/operations/backup-restore.adoc

Lines changed: 52 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -8,25 +8,67 @@ For performing backups, Neo4j uses the _Admin Service_, which is only available
88
For more information, see xref:kubernetes/accessing-neo4j.adoc[Accessing Neo4j].
99
====
1010

11-
[[kubernetes-backup-storage-options]]
12-
== Backup storage options
11+
[[kubernetes-backup-modes]]
12+
== Backup modes
1313

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:
1515

16-
=== Cloud storage
16+
=== Cloud provider mode
1717

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.
2119

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:
2335

2436
* *Direct cloud storage upload* - No intermediate local storage required.
2537
* *Differential backup chains* with `preferDiffAsParent: true`.
2638
* *Immutable backup objects* in cloud storage.
2739
* *Support for S3-compatible endpoints*.
2840
* *Enhanced S3 configuration* including custom CA certificates and endpoint settings.
2941

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.
66+
67+
* *Helm Value*: `backup.preferDiffAsParent: true`.
68+
* *Cloud-Native*: DIFF backups reference cloud-stored FULL backups directly.
69+
* *No PV Required*: Previous backups don't need to be stored locally.
70+
====
71+
3072
=== Local storage
3173

3274
Local storage creates local backups in the `/backups` mount.
@@ -472,7 +514,6 @@ backup:
472514
s3EndpointTLS: true # Automatically set when s3CASecretName is provided
473515
----
474516

475-
476517
[[kubernetes-neo4j-backup-on-prem]]
477518
== Prepare to back up a database(s) to on-premises storage
478519

@@ -482,6 +523,7 @@ When configuring the _backup-values.yaml_ file, keep the “cloudProvider” fie
482523
[NOTE]
483524
====
484525
You need to create the persistent volume and persistent volume claim before installing the _neo4j-admin_ Helm chart only when using local storage.
526+
When using cloud providers, persistent volumes are not required for differential backups.
485527
For more information, see xref:kubernetes/persistent-volumes.adoc[Volume mounts and persistent volumes].
486528
====
487529

@@ -993,12 +1035,7 @@ cypher-shell -u neo4j -p <password> -d system
9931035
----
9941036
DROP DATABASE neo4j;
9951037
----
996-
. Exit the Cypher Shell command-line console:
997-
+
998-
[source, shell, role='noheader']
999-
----
1000-
:exit;
1001-
----
1038+
. Exit the Cypher Shell command-line console by typing `:exit;`.
10021039

10031040
=== Restore the database backup
10041041

0 commit comments

Comments
 (0)