Skip to content

Commit 3c4a38e

Browse files
Return the section on S3SeedProvider
1 parent 8f3499d commit 3c4a38e

File tree

1 file changed

+39
-0
lines changed

1 file changed

+39
-0
lines changed

modules/ROOT/pages/clustering/databases.adoc

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -601,6 +601,45 @@ CREATE DATABASE foo OPTIONS { existingData: 'use', seedURI: 's3:/myBucket/myBack
601601

602602
This will seed the database with transactions up to, but not including transaction 123.
603603

604+
[role=label--deprecated]
605+
[[s3-seed-provider]]
606+
==== S3SeedProvider
607+
608+
// When Cypher 25 is released, we have to label this section 'Cypher 5' as this functionality is only available in Cypher 5.
609+
610+
The `S3SeedProvider` supports:
611+
612+
** `s3:`
613+
614+
615+
[NOTE]
616+
====
617+
Neo4j 5 comes bundled with necessary libraries for AWS S3 connectivity.
618+
Therefore, if you use `S3SeedProvider`,`aws cli` is not required but can be used with the `CloudSeedProvider`.
619+
====
620+
621+
The `S3SeedProvider` requires additional configuration.
622+
This is specified with the `seedConfig` option.
623+
This option expects a comma-separated list of configurations.
624+
Each configuration value is specified as a name followed by `=` and the value, as such:
625+
626+
[source, cypher, role="noplay"]
627+
----
628+
CREATE DATABASE foo OPTIONS { existingData: 'use', seedURI: 's3:/myBucket/myBackup.backup', seedConfig: 'region=eu-west-1' }
629+
----
630+
631+
`S3SeedProvider` also requires passing in credentials.
632+
These are specified with the `seedCredentials` option.
633+
Seed credentials are securely passed from the Cypher command to each server hosting the database.
634+
For this to work, Neo4j on each server in the cluster must be configured with identical keystores.
635+
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].
636+
If this configuration is not performed, the `seedCredentials` option fails.
637+
638+
[source, cypher, role="noplay"]
639+
----
640+
CREATE DATABASE foo OPTIONS { existingData: 'use', seedURI: 's3:/myBucket/myBackup.backup', seedConfig: 'region=eu-west-1', seedCredentials: [accessKey];[secretKey] }
641+
----
642+
Where `accessKey` and `secretKey` are provided by AWS.
604643
==== Seed provider reference
605644

606645
[cols="1,2,2",options="header"]

0 commit comments

Comments
 (0)