Skip to content

Commit a2f28f2

Browse files
Rewrite disaster recovery based on recreate and status check (#1890)
This PR rewrites the disaster recovery docs based on the new recreate and status check procedures. With regards to the functional changes there are three major things to note. 1. The recovery of the system database is the same as before, even though the way we check if the system db is write available or not has changed. 2. The step which removes lost servers now also includes recreating some databases. It was decided this mixing of recovering servers and databases is necessary to get recreate into the guide in the best way we could see. 3. Previously it was not clear how to handle quarantined databases, even though the guide mentioned them in the intro. Now, it is more explicitly discussed how they are supposed to be handles during disaster recovery. In the past, we have also gotten feedback that the disaster recovery docs are hard to follow. Therefore, this PR also includes refactoring which introduces a new guide structure. This new structure provides more explanations of why we are asking the user to do a certain thing. --------- Co-authored-by: NataliaIvakina <[email protected]>
1 parent 70a6ec3 commit a2f28f2

File tree

2 files changed

+268
-124
lines changed

2 files changed

+268
-124
lines changed

modules/ROOT/pages/clustering/databases.adoc

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -268,8 +268,8 @@ Neo4j 5.24 introduces the xref:procedures.adoc#procedure_dbms_cluster_recreateDa
268268
* To change the database store to a specified backup, while keeping all the associated privileges for the database.
269269

270270
* To make your database write-available again after it has been lost (for example, due to a disaster).
271-
// See xref:clustering/disaster-recovery.adoc[] for more information.
272-
271+
See xref:clustering/disaster-recovery.adoc[Disaster recovery] for more information.
272+
273273
[CAUTION]
274274
====
275275
The recreate procedure works only for real user databases and not for composite databases, or the `system` database.
@@ -468,7 +468,7 @@ SHOW DATABASE foo;
468468
=== Seed from URI
469469

470470
This method seeds all servers with an identical seed from an external source, specified by the URI.
471-
The seed can either be a full backup, a differential backup (xref:clustering/databases.adoc#cloud-seed-provider[`CloudSeedProvider`], introduced in Neo4j 5.26), or a dump from an existing database.
471+
The seed can either be a full backup, a differential backup (xref:clustering/databases.adoc#cloud-seed-provider[`CloudSeedProvider`], introduced in Neo4j 5.26), or a dump from an existing database.
472472
The sources of seeds are called _seed providers_.
473473

474474
The mechanism is pluggable, allowing new sources of seeds to be supported (see link:https://www.neo4j.com/docs/java-reference/current/extending-neo4j/project-setup/#extending-neo4j-plugin-seed-provider[Java Reference -> Implement custom seed providers] for more information).
@@ -506,7 +506,7 @@ To determine the cause of the problem, it is recommended to look at the `debug.l
506506

507507
label:new[Introduced in 5.26], the `FileSeedProvider` supports:
508508

509-
** `file:`
509+
** `file:`
510510

511511
[[url-connection-seed-provider]]
512512
==== URLConnectionSeedProvider
@@ -523,8 +523,8 @@ The `URLConnectionSeedProvider` supports the following:
523523

524524
label:new[Introduced in 5.25], the `CloudSeedProvider` supports:
525525

526-
** `s3:`
527-
** `gs:`
526+
** `s3:`
527+
** `gs:`
528528
** `azb:`
529529

530530
Starting from Neo4j 5.26, the `CloudSeedProvider` supports using xref:backup-restore/modes.adoc#differential-backup[differential backup] files as seeds.
@@ -539,7 +539,7 @@ include::partial$/aws-s3-overrides.adoc[]
539539

540540
include::partial$/aws-s3-credentials.adoc[]
541541

542-
. Create database from `myBackup.backup`.
542+
. Create database from `myBackup.backup`.
543543
+
544544
[source,shell, role="nocopy"]
545545
----
@@ -552,7 +552,7 @@ CREATE DATABASE foo OPTIONS { existingData: 'use', seedURI: 's3:/myBucket/myBack
552552

553553
include::partial$/gcs-credentials.adoc[]
554554

555-
. Create database from `myBackup.backup`.
555+
. Create database from `myBackup.backup`.
556556
+
557557
[source,shell]
558558
----
@@ -564,7 +564,7 @@ CREATE DATABASE foo OPTIONS { existingData: 'use', seedURI: 'gs:/myBucket/myBack
564564

565565
include::partial$/azb-credentials.adoc[]
566566

567-
. Create database from `myBackup.backup`.
567+
. Create database from `myBackup.backup`.
568568
+
569569
[source,shell]
570570
----
@@ -578,7 +578,7 @@ CREATE DATABASE foo OPTIONS { existingData: 'use', seedURI: 'azb://myStorageAcco
578578

579579
The `S3SeedProvider` supports:
580580

581-
** `s3:` label:deprecated[Deprecated in 5.26]
581+
** `s3:` label:deprecated[Deprecated in 5.26]
582582

583583

584584
[NOTE]
@@ -621,7 +621,7 @@ Where `accessKey` and `secretKey` are provided by AWS.
621621

622622
| `file:`
623623
| `URLConnectionSeedProvider` label:deprecated[Deprecated in 5.26], +
624-
`FileSeedProvider` label:new[Introduced in 5.26]
624+
`FileSeedProvider` label:new[Introduced in 5.26]
625625
| `file:/tmp/backup1.backup`
626626

627627
| `ftp:`
@@ -638,15 +638,15 @@ Where `accessKey` and `secretKey` are provided by AWS.
638638

639639
| `s3:`
640640
| `S3SeedProvider` label:deprecated[Deprecated in 5.26], +
641-
`CloudSeedProvider` label:new[Introduced in 5.25]
641+
`CloudSeedProvider` label:new[Introduced in 5.25]
642642
| `s3://mybucket/backups/backup1.backup`
643643

644644
| `gs:`
645-
| `CloudSeedProvider` label:new[Introduced in 5.25]
645+
| `CloudSeedProvider` label:new[Introduced in 5.25]
646646
| `gs://mybucket/backups/backup1.backup`
647647

648648
| `azb:`
649-
| `CloudSeedProvider` label:new[Introduced in 5.25]
649+
| `CloudSeedProvider` label:new[Introduced in 5.25]
650650
| `azb://mystorageaccount.blob/backupscontainer/backup1.backup`
651651
|===
652652

0 commit comments

Comments
 (0)