From 2d6a18636ec7a0867ee395f9dd28ca79bfdd20c6 Mon Sep 17 00:00:00 2001 From: Jack Waudby Date: Thu, 24 Oct 2024 13:13:23 +0100 Subject: [PATCH 01/10] Add deprecations and FileSeedProvider --- modules/ROOT/pages/clustering/databases.adoc | 85 +++++++++++--------- 1 file changed, 46 insertions(+), 39 deletions(-) diff --git a/modules/ROOT/pages/clustering/databases.adoc b/modules/ROOT/pages/clustering/databases.adoc index 8da2f6807..1abdc6907 100644 --- a/modules/ROOT/pages/clustering/databases.adoc +++ b/modules/ROOT/pages/clustering/databases.adoc @@ -469,50 +469,23 @@ To determine the cause of the problem, it is recommended to look at the `debug.l ==== Seed providers +The `FileSeedProvider` label:new[introduced in 5.26] supports: + +** `file:` + The `URLConnectionSeedProvider` supports the following: -** `file:` +** `file:` label:deprecated[deprecated in 5.26] ** `ftp:` ** `http:` ** `https:` -The `S3SeedProvider` supports: -** `s3:` -[NOTE] -==== -Neo4j 5 comes bundled with necessary libraries for AWS S3 connectivity. -Therefore, if you use `S3SeedProvider`,`aws cli` is not required but can be used with the `CloudSeedProvider`. -==== +The `CloudSeedProvider` label:new[introduced in 5.25] supports: -The `S3SeedProvider` requires additional configuration. -This is specified with the `seedConfig` option. -This option expects a comma-separated list of configurations. -Each configuration value is specified as a name followed by `=` and the value, as such: - -[source, cypher, role="noplay"] ----- -CREATE DATABASE foo OPTIONS { existingData: 'use', seedURI: 's3:/myBucket/myBackup.backup', seedConfig: 'region=eu-west-1' } ----- - -`S3SeedProvider` also requires passing in credentials. -These are specified with the `seedCredentials` option. -Seed credentials are securely passed from the Cypher command to each server hosting the database. -For this to work, Neo4j on each server in the cluster must be configured with identical keystores. -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]. -If this configuration is not performed, the `seedCredentials` option fails. - -[source, cypher, role="noplay"] ----- -CREATE DATABASE foo OPTIONS { existingData: 'use', seedURI: 's3:/myBucket/myBackup.backup', seedConfig: 'region=eu-west-1', seedCredentials: [accessKey];[secretKey] } ----- -Where `accessKey` and `secretKey` are provided by AWS. - -The `CloudSeedProvider` supports: - -** `s3:` -** `gs:` +** `s3:` +** `gs:` ** `azb:` [.tabbed-example] @@ -558,6 +531,40 @@ CREATE DATABASE foo OPTIONS { existingData: 'use', seedURI: 'azb://myStorageAcco ====== ===== +The `S3SeedProvider` supports: + +** `s3:` label:deprecated[deprecated in 5.26] + + +[NOTE] +==== +Neo4j 5 comes bundled with necessary libraries for AWS S3 connectivity. +Therefore, if you use `S3SeedProvider`,`aws cli` is not required but can be used with the `CloudSeedProvider`. +==== + +The `S3SeedProvider` requires additional configuration. +This is specified with the `seedConfig` option. +This option expects a comma-separated list of configurations. +Each configuration value is specified as a name followed by `=` and the value, as such: + +[source, cypher, role="noplay"] +---- +CREATE DATABASE foo OPTIONS { existingData: 'use', seedURI: 's3:/myBucket/myBackup.backup', seedConfig: 'region=eu-west-1' } +---- + +`S3SeedProvider` also requires passing in credentials. +These are specified with the `seedCredentials` option. +Seed credentials are securely passed from the Cypher command to each server hosting the database. +For this to work, Neo4j on each server in the cluster must be configured with identical keystores. +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]. +If this configuration is not performed, the `seedCredentials` option fails. + +[source, cypher, role="noplay"] +---- +CREATE DATABASE foo OPTIONS { existingData: 'use', seedURI: 's3:/myBucket/myBackup.backup', seedConfig: 'region=eu-west-1', seedCredentials: [accessKey];[secretKey] } +---- +Where `accessKey` and `secretKey` are provided by AWS. + ==== Seed provider reference @@ -568,7 +575,7 @@ CREATE DATABASE foo OPTIONS { existingData: 'use', seedURI: 'azb://myStorageAcco | URI example | `file:` -| `URLConnectionSeedProvider` +| `URLConnectionSeedProvider` label:deprecated[deprecated in 5.26], `FileSeedProvider` label:new[introduced in 5.26] | `file:/tmp/backup1.backup` | `ftp:` @@ -584,15 +591,15 @@ CREATE DATABASE foo OPTIONS { existingData: 'use', seedURI: 'azb://myStorageAcco | `\https://myhttp.com/backups/backup1.backup` | `s3:` -| `S3SeedProvider`, `CloudSeedProvider` +| `S3SeedProvider` label:deprecated[deprecated in 5.26], `CloudSeedProvider` label:new[introduced in 5.25] | `s3://mybucket/backups/backup1.backup` | `gs:` -| `CloudSeedProvider` +| `CloudSeedProvider` label:new[introduced in 5.25] | `gs://mybucket/backups/backup1.backup` | `azb:` -| `CloudSeedProvider` +| `CloudSeedProvider` label:new[introduced in 5.25] | `azb://mystorageaccount.blob/backupscontainer/backup1.backup` |=== From 5147a4b65d4bf190970926d093cb2de1d0b4dad6 Mon Sep 17 00:00:00 2001 From: Jack Waudby <33488812+jackwaudby@users.noreply.github.com> Date: Wed, 30 Oct 2024 08:50:52 +0000 Subject: [PATCH 02/10] Update modules/ROOT/pages/clustering/databases.adoc Co-authored-by: NataliaIvakina <82437520+NataliaIvakina@users.noreply.github.com> --- modules/ROOT/pages/clustering/databases.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/ROOT/pages/clustering/databases.adoc b/modules/ROOT/pages/clustering/databases.adoc index 1abdc6907..f77e13a1c 100644 --- a/modules/ROOT/pages/clustering/databases.adoc +++ b/modules/ROOT/pages/clustering/databases.adoc @@ -475,7 +475,7 @@ The `FileSeedProvider` label:new[introduced in 5.26] supports: The `URLConnectionSeedProvider` supports the following: -** `file:` label:deprecated[deprecated in 5.26] +** `file:` label:deprecated[Deprecated in 5.26] ** `ftp:` ** `http:` ** `https:` From 2cc83f1b8c2f62d8327ca96c0ef97037d91643b5 Mon Sep 17 00:00:00 2001 From: Jack Waudby <33488812+jackwaudby@users.noreply.github.com> Date: Wed, 30 Oct 2024 08:50:57 +0000 Subject: [PATCH 03/10] Update modules/ROOT/pages/clustering/databases.adoc Co-authored-by: NataliaIvakina <82437520+NataliaIvakina@users.noreply.github.com> --- modules/ROOT/pages/clustering/databases.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/ROOT/pages/clustering/databases.adoc b/modules/ROOT/pages/clustering/databases.adoc index f77e13a1c..6aef3bebe 100644 --- a/modules/ROOT/pages/clustering/databases.adoc +++ b/modules/ROOT/pages/clustering/databases.adoc @@ -533,7 +533,7 @@ CREATE DATABASE foo OPTIONS { existingData: 'use', seedURI: 'azb://myStorageAcco The `S3SeedProvider` supports: -** `s3:` label:deprecated[deprecated in 5.26] +** `s3:` label:deprecated[Deprecated in 5.26] [NOTE] From 3a5a2cd155b2933dd330475bfd9e7b7aaeca84ed Mon Sep 17 00:00:00 2001 From: Jack Waudby <33488812+jackwaudby@users.noreply.github.com> Date: Wed, 30 Oct 2024 08:51:04 +0000 Subject: [PATCH 04/10] Update modules/ROOT/pages/clustering/databases.adoc Co-authored-by: NataliaIvakina <82437520+NataliaIvakina@users.noreply.github.com> --- modules/ROOT/pages/clustering/databases.adoc | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/modules/ROOT/pages/clustering/databases.adoc b/modules/ROOT/pages/clustering/databases.adoc index 6aef3bebe..078dde147 100644 --- a/modules/ROOT/pages/clustering/databases.adoc +++ b/modules/ROOT/pages/clustering/databases.adoc @@ -575,7 +575,8 @@ Where `accessKey` and `secretKey` are provided by AWS. | URI example | `file:` -| `URLConnectionSeedProvider` label:deprecated[deprecated in 5.26], `FileSeedProvider` label:new[introduced in 5.26] +| `URLConnectionSeedProvider` label:deprecated[Deprecated in 5.26], + +`FileSeedProvider` label:new[Introduced in 5.26] | `file:/tmp/backup1.backup` | `ftp:` From 4c470e87e5af18ee3d9a9acd77a1e31384700f17 Mon Sep 17 00:00:00 2001 From: Jack Waudby <33488812+jackwaudby@users.noreply.github.com> Date: Wed, 30 Oct 2024 08:51:10 +0000 Subject: [PATCH 05/10] Update modules/ROOT/pages/clustering/databases.adoc Co-authored-by: NataliaIvakina <82437520+NataliaIvakina@users.noreply.github.com> --- modules/ROOT/pages/clustering/databases.adoc | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/modules/ROOT/pages/clustering/databases.adoc b/modules/ROOT/pages/clustering/databases.adoc index 078dde147..89b3bb7d1 100644 --- a/modules/ROOT/pages/clustering/databases.adoc +++ b/modules/ROOT/pages/clustering/databases.adoc @@ -592,7 +592,8 @@ Where `accessKey` and `secretKey` are provided by AWS. | `\https://myhttp.com/backups/backup1.backup` | `s3:` -| `S3SeedProvider` label:deprecated[deprecated in 5.26], `CloudSeedProvider` label:new[introduced in 5.25] +| `S3SeedProvider` label:deprecated[Deprecated in 5.26], + +`CloudSeedProvider` label:new[Introduced in 5.25] | `s3://mybucket/backups/backup1.backup` | `gs:` From e02abcf96607540b1c590823a213b36f1ad5e1d6 Mon Sep 17 00:00:00 2001 From: Jack Waudby <33488812+jackwaudby@users.noreply.github.com> Date: Wed, 30 Oct 2024 08:51:18 +0000 Subject: [PATCH 06/10] Update modules/ROOT/pages/clustering/databases.adoc Co-authored-by: NataliaIvakina <82437520+NataliaIvakina@users.noreply.github.com> --- modules/ROOT/pages/clustering/databases.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/ROOT/pages/clustering/databases.adoc b/modules/ROOT/pages/clustering/databases.adoc index 89b3bb7d1..038010170 100644 --- a/modules/ROOT/pages/clustering/databases.adoc +++ b/modules/ROOT/pages/clustering/databases.adoc @@ -597,7 +597,7 @@ Where `accessKey` and `secretKey` are provided by AWS. | `s3://mybucket/backups/backup1.backup` | `gs:` -| `CloudSeedProvider` label:new[introduced in 5.25] +| `CloudSeedProvider` label:new[Introduced in 5.25] | `gs://mybucket/backups/backup1.backup` | `azb:` From dd32db2bc0db174b0b1836c0085772c08d174fb4 Mon Sep 17 00:00:00 2001 From: Jack Waudby <33488812+jackwaudby@users.noreply.github.com> Date: Wed, 30 Oct 2024 08:51:22 +0000 Subject: [PATCH 07/10] Update modules/ROOT/pages/clustering/databases.adoc Co-authored-by: NataliaIvakina <82437520+NataliaIvakina@users.noreply.github.com> --- modules/ROOT/pages/clustering/databases.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/ROOT/pages/clustering/databases.adoc b/modules/ROOT/pages/clustering/databases.adoc index 038010170..134de7110 100644 --- a/modules/ROOT/pages/clustering/databases.adoc +++ b/modules/ROOT/pages/clustering/databases.adoc @@ -601,7 +601,7 @@ Where `accessKey` and `secretKey` are provided by AWS. | `gs://mybucket/backups/backup1.backup` | `azb:` -| `CloudSeedProvider` label:new[introduced in 5.25] +| `CloudSeedProvider` label:new[Introduced in 5.25] | `azb://mystorageaccount.blob/backupscontainer/backup1.backup` |=== From 3e066849d6e34b92bb2ecc20f2f2fbbc391f7e08 Mon Sep 17 00:00:00 2001 From: Jack Waudby <33488812+jackwaudby@users.noreply.github.com> Date: Wed, 30 Oct 2024 08:51:27 +0000 Subject: [PATCH 08/10] Update modules/ROOT/pages/clustering/databases.adoc Co-authored-by: NataliaIvakina <82437520+NataliaIvakina@users.noreply.github.com> --- modules/ROOT/pages/clustering/databases.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/ROOT/pages/clustering/databases.adoc b/modules/ROOT/pages/clustering/databases.adoc index 134de7110..b53a1c845 100644 --- a/modules/ROOT/pages/clustering/databases.adoc +++ b/modules/ROOT/pages/clustering/databases.adoc @@ -469,7 +469,7 @@ To determine the cause of the problem, it is recommended to look at the `debug.l ==== Seed providers -The `FileSeedProvider` label:new[introduced in 5.26] supports: +label:new[Introduced in 5.26], the `FileSeedProvider` supports: ** `file:` From 6da526f0d2284d9b744ffb5b34fb3f4d6b711afb Mon Sep 17 00:00:00 2001 From: Jack Waudby <33488812+jackwaudby@users.noreply.github.com> Date: Wed, 30 Oct 2024 08:51:33 +0000 Subject: [PATCH 09/10] Update modules/ROOT/pages/clustering/databases.adoc Co-authored-by: NataliaIvakina <82437520+NataliaIvakina@users.noreply.github.com> --- modules/ROOT/pages/clustering/databases.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/ROOT/pages/clustering/databases.adoc b/modules/ROOT/pages/clustering/databases.adoc index b53a1c845..4af8d7a5f 100644 --- a/modules/ROOT/pages/clustering/databases.adoc +++ b/modules/ROOT/pages/clustering/databases.adoc @@ -482,7 +482,7 @@ The `URLConnectionSeedProvider` supports the following: -The `CloudSeedProvider` label:new[introduced in 5.25] supports: +label:new[Introduced in 5.25], the `CloudSeedProvider` supports: ** `s3:` ** `gs:` From 3dc7a77eeef9c242b6975c819a77f5827eb91c97 Mon Sep 17 00:00:00 2001 From: Jack Waudby Date: Thu, 31 Oct 2024 11:10:08 +0000 Subject: [PATCH 10/10] Make providers titles --- modules/ROOT/pages/clustering/databases.adoc | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/modules/ROOT/pages/clustering/databases.adoc b/modules/ROOT/pages/clustering/databases.adoc index 4af8d7a5f..884c2379b 100644 --- a/modules/ROOT/pages/clustering/databases.adoc +++ b/modules/ROOT/pages/clustering/databases.adoc @@ -467,12 +467,16 @@ neo4j@neo4j> SHOW DATABASES; To determine the cause of the problem, it is recommended to look at the `debug.log`. -==== Seed providers +[[file-seed-provider]] +==== FileSeedProvider label:new[Introduced in 5.26], the `FileSeedProvider` supports: ** `file:` +[[url-connection-seed-provider]] +==== URLConnectionSeedProvider + The `URLConnectionSeedProvider` supports the following: ** `file:` label:deprecated[Deprecated in 5.26] @@ -480,7 +484,8 @@ The `URLConnectionSeedProvider` supports the following: ** `http:` ** `https:` - +[[cloud-seed-provider]] +==== CloudSeedProvider label:new[Introduced in 5.25], the `CloudSeedProvider` supports: @@ -531,6 +536,9 @@ CREATE DATABASE foo OPTIONS { existingData: 'use', seedURI: 'azb://myStorageAcco ====== ===== +[[s3-seed-provider]] +==== S3SeedProvider + The `S3SeedProvider` supports: ** `s3:` label:deprecated[Deprecated in 5.26]