Skip to content

Commit 7c30ad5

Browse files
committed
editorial updates
1 parent 5cf42bf commit 7c30ad5

File tree

1 file changed

+29
-27
lines changed

1 file changed

+29
-27
lines changed

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

Lines changed: 29 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -14,28 +14,30 @@ For more information, see xref:kubernetes/accessing-neo4j.adoc[Accessing Neo4j].
1414
Neo4j's Helm chart supports two backup modes:
1515

1616
=== Cloud provider mode
17-
Uses Neo4j's native cloud storage integration with direct upload to create immutable backup objects:
1817

19-
* **Supported providers**: AWS S3, Google Cloud Storage, Azure Blob Storage
20-
* **Benefits**: No persistent volume requirements, supports differential backups, immutable backup objects
21-
* **Configuration**: Set `cloudProvider` to `aws`, `gcp`, or `azure`
18+
Cloud provider mode uses Neo4j's native cloud storage integration with direct upload to create immutable backup objects.
2219

23-
=== Local mode
24-
Creates local backups in `/backups` mount:
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`.
2523

26-
* **Requirements**: Persistent storage for large databases (configured via `tempVolume`)
27-
* **Configuration**: Leave `cloudProvider` empty
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.
2830

2931
[[kubernetes-cloud-native-features]]
3032
== Cloud-native backup features
3133

3234
When using cloud providers, Neo4j's native backup provides:
3335

34-
* **Direct cloud storage upload** - No intermediate local storage required
35-
* **Differential backup chains** with `preferDiffAsParent: true`
36-
* **Immutable backup objects** in cloud storage
37-
* **Support for S3-compatible endpoints**
38-
* **Enhanced S3 configuration** including custom CA certificates and endpoint settings
36+
* **Direct cloud storage upload** - No intermediate local storage required.
37+
* **Differential backup chains** with `preferDiffAsParent: true`.
38+
* **Immutable backup objects** in cloud storage.
39+
* **Support for S3-compatible endpoints**.
40+
* **Enhanced S3 configuration** including custom CA certificates and endpoint settings.
3941

4042
[[kubernetes-differential-backups]]
4143
== Differential backups
@@ -54,17 +56,17 @@ backup:
5456

5557
**How it works:**
5658

57-
1. First backup creates a FULL backup in cloud storage
58-
2. Subsequent backups create DIFF backups that reference the cloud-stored FULL backup
59-
3. No local storage of previous backups required
59+
1. First backup creates a FULL backup in cloud storage.
60+
2. Subsequent backups create DIFF backups that reference the cloud-stored FULL backup.
61+
3. No local storage of previous backups is required.
6062

6163
[NOTE]
6264
====
6365
**`preferDiffAsParent` is fully supported and eliminates the need for persistent volumes!**
6466
65-
* **Helm Value**: `backup.preferDiffAsParent: true`
66-
* **Cloud-Native**: DIFF backups reference cloud-stored FULL backups directly
67-
* **No PV Required**: Previous backups don't need to be stored locally
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.
6870
====
6971

7072
[[kubernetes-neo4j-backup-cloud]]
@@ -476,18 +478,18 @@ backup:
476478

477479
=== S3 CA certificate setup
478480

479-
For S3 endpoints with custom CA certificates:
481+
For S3 endpoints with custom CA certificates, you can either provide the CA certificate directly in the _backup-values.yaml_ file or use a Kubernetes secret to manage the CA certificate.
480482

481483
==== Using Kubernetes secrets
482484

483-
1. **Create the CA certificate secret:**
485+
. Create the CA certificate secret:
484486
+
485487
[source, bash]
486488
----
487489
kubectl create secret generic s3-ca-cert --from-file=ca.crt=/path/to/your/ca.crt
488490
----
489491

490-
2. **Configure the backup job:**
492+
. Configure the backup job:
491493
+
492494
[source, yaml]
493495
----
@@ -1085,11 +1087,11 @@ To restore the `system` database, follow the steps described in xref:kubernetes/
10851087

10861088
To migrate from persistent volume-based backups to cloud-native:
10871089

1088-
1. **Perform final traditional backup**
1089-
2. **Upload existing backups to cloud storage** (if needed)
1090-
3. **Update configuration** to use cloud provider
1091-
4. **Remove persistent volume configuration**
1092-
5. **Enable `preferDiffAsParent`** for future differential backups
1090+
. Perform final traditional backup.
1091+
. Upload existing backups to cloud storage (if needed).
1092+
. Update configuration to use cloud provider.
1093+
. Remove persistent volume configuration.
1094+
. Enable `preferDiffAsParent` for future differential backups.
10931095

10941096
.Example migration
10951097
[source, yaml]

0 commit comments

Comments
 (0)