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/clustering/databases.adoc
+89-33Lines changed: 89 additions & 33 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -438,27 +438,13 @@ The seed can be either a backup or a dump from an existing database.
438
438
The sources of seeds are called _seed providers_.
439
439
440
440
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).
441
-
The product has built-in support for seed from a mounted file system (file), FTP server, HTTP/HTTPS server and Amazon S3.
441
+
The product has built-in support for seed from a mounted file system (file), FTP server, HTTP/HTTPS server, Amazon S3, Google Cloud Storage (from Neo4j 5.25), and Azure Cloud Storage (from Neo4j 5.25).
442
442
443
443
[NOTE]
444
444
====
445
-
S3 is supported by default, but the other providers require configuration of xref:configuration/configuration-settings.adoc#config_dbms.databases.seed_from_uri_providers[`dbms.databases.seed_from_uri_providers`].
446
-
Neo4j 5 comes bundled with necessary libraries for AWS S3 connectivity and thus, `aws cli` is not required.
445
+
Amazon S3, Google Cloud Storage, and Azure Cloud Storage are supported by default, but the other providers require configuration of xref:configuration/configuration-settings.adoc#config_dbms.databases.seed_from_uri_providers[`dbms.databases.seed_from_uri_providers`].
447
446
====
448
447
449
-
The `URLConnectionSeedProvider` supports the following:
450
-
451
-
** file:
452
-
** ftp:
453
-
** http:
454
-
** https:
455
-
** URIs
456
-
457
-
Accordingly, the `S3SeedProviders` supports:
458
-
459
-
** S3:
460
-
** URIs
461
-
462
448
The URI of the seed is specified when the `CREATE DATABASE` command is issued:
463
449
464
450
[source, cypher, role="noplay"]
@@ -481,7 +467,26 @@ neo4j@neo4j> SHOW DATABASES;
481
467
482
468
To determine the cause of the problem, it is recommended to look at the `debug.log`.
483
469
484
-
Certain seed providers, such as S3, may require additional configuration.
470
+
==== Seed providers
471
+
472
+
The `URLConnectionSeedProvider` supports the following:
473
+
474
+
** `file:`
475
+
** `ftp:`
476
+
** `http:`
477
+
** `https:`
478
+
479
+
The `S3SeedProvider` supports:
480
+
481
+
** `s3:`
482
+
483
+
[NOTE]
484
+
====
485
+
Neo4j 5 comes bundled with necessary libraries for AWS S3 connectivity.
486
+
Therefore, if you use `S3SeedProvider`,`aws cli` is not required but can be used with the `CloudSeedProvider`.
487
+
====
488
+
489
+
The `S3SeedProvider` requires additional configuration.
485
490
This is specified with the `seedConfig` option.
486
491
This option expects a comma-separated list of configurations.
487
492
Each configuration value is specified as a name followed by `=` and the value, as such:
@@ -491,25 +496,68 @@ Each configuration value is specified as a name followed by `=` and the value, a
* `s3:` - use this to specify the path to your S3 bucket.
501
-
For example, `seedURI: 's3:/myBucket/myBackup.backup'`
502
-
* `region:` - use this together with `s3:` to set the AWS region that hosts the S3 bucket.
503
-
For example, `seedConfig: 'region=eu-west-1'`.
504
-
505
-
Some seed providers may also want to pass credentials into the provider.
499
+
`S3SeedProvider` also requires passing in credentials.
506
500
These are specified with the `seedCredentials` option.
507
501
Seed credentials are securely passed from the Cypher command to each server hosting the database.
508
502
For this to work, Neo4j on each server in the cluster must be configured with identical keystores.
509
503
This is identical to the configuration required by remote aliases, see xref:database-administration/aliases/remote-database-alias-configuration.adoc#remote-alias-config-DBMS_admin-A[Configuration of DBMS with remote database alias].
510
-
If this configuration is not performed, the `seedCredential` option fails.
504
+
If this configuration is not performed, the `seedCredentials` option fails.
For example, in the case of `S3SeedProvider`(the default provider), `seedCredentials: [accessKey];[secretKey]` where `accessKey` and `secretKey` are provided by AWS.
513
561
514
562
==== Seed provider reference
515
563
@@ -535,9 +583,17 @@ For example, in the case of `S3SeedProvider`(the default provider), `seedCredent
0 commit comments