Add seed docs for Azure (#1743)

fabiim · renetapopova · web-flow · commit 585f4ca1fc78 · 2024-09-04T11:10:19.000+01:00
Co-authored-by: Reneta Popova &lt;reneta.popova@neo4j.com&gt;
diff --git a/modules/ROOT/pages/backup-restore/aggregate.adoc b/modules/ROOT/pages/backup-restore/aggregate.adoc
@@ -166,4 +166,18 @@ The example assumes that you have a backup chain located in the `myBucket/myDire
 bin/neo4j-admin database aggregate-backup --from-path=gs://myBucket/myDirectory/myBackup.backup mydatabase
 ----
 ======
-=====
+
+[.include-with-Azure-cloud-storage]
+======
+
+include::partial$/azb-credentials.adoc[]
+
+. Then, use the following command to aggregate the backup chain located in a given folder in your Azure blob storage container.
+The example assumes that you have a backup chain located with a `myStorageAccount/myContainer/myDirectory` folder identifiable by the file `myBackup.backup`:
++
+[source,shell]
+----
+bin/neo4j-admin database aggregate-backup --from-path=azb://myStorageAccount/myContainer/myDirectory/myBackup.backup mydatabase
+----
+======
+=====
diff --git a/modules/ROOT/pages/backup-restore/offline-backup.adoc b/modules/ROOT/pages/backup-restore/offline-backup.adoc
@@ -156,4 +156,17 @@ include::partial$/gcs-credentials.adoc[]
 bin/neo4j-admin database dump mydatabase --to-path=gs://myBucket/myDirectory/
 ----
 ======
-=====
+
+[.include-with-Azure-cloud-storage]
+======
+
+include::partial$/azb-credentials.adoc[]
+
+. Run `neo4j-admin database dump` command to dump your database into your Azure container:
++
+[source,shell]
+----
+bin/neo4j-admin database dump mydatabase --to-path=azb://myStorageAccount/myContainer/myDirectory/
+----
+======
+=====
diff --git a/modules/ROOT/pages/backup-restore/online-backup.adoc b/modules/ROOT/pages/backup-restore/online-backup.adoc
@@ -417,4 +417,16 @@ include::partial$/gcs-credentials.adoc[]
 bin/neo4j-admin database backup --to-path=gs://myBucket/myDirectory/ mydatabase
 ----
 ======
+[.include-with-Azure-cloud-storage]
+======
+
+include::partial$/azb-credentials.adoc[]
+
+. Run `neo4j-admin database backup` command to back up your database to your Azure container:
++
+[source,shell]
+----
+bin/neo4j-admin database backup --to-path=azb://myStorageAccount/myContainer/myDirectory/ mydatabase
+----
+======
 =====
diff --git a/modules/ROOT/pages/backup-restore/restore-backup.adoc b/modules/ROOT/pages/backup-restore/restore-backup.adoc
@@ -257,6 +257,20 @@ The example assumes that you have backup artifacts located in the `myBucket/myDi
 bin/neo4j-admin database restore --to-path=gs://myBucket/myDirectory/myBackup.backup mydatabase
 ----
 ======
+
+[.include-with-Azure-cloud-storage]
+======
+
+include::partial$/azb-credentials.adoc[]
+
+. Run the `neo4j-admin database restore` command to restore the database located in a given folder in your Azure blob storage container.
+The example assumes that you have backup artifacts located in the `myStorageAccount/myContainer/myDirectory` folder.
++
+[source,shell]
+----
+bin/neo4j-admin database restore --to-path=azb://myStorageAccount/myContainer/myDirectory/myBackup.backup mydatabase
+----
+======
 =====
 
 === Restore a database backup in a cluster
diff --git a/modules/ROOT/pages/backup-restore/restore-dump.adoc b/modules/ROOT/pages/backup-restore/restore-dump.adoc
@@ -195,5 +195,18 @@ The example assumes that you have dump artifacts located in the `myBucket/myDire
 bin/neo4j-admin database load mydatabase --from-path=gs://myBucket/myDirectory/ --overwrite-destination=true
 ----
 ======
+[.include-with-Azure-cloud-storage]
+======
+
+include::partial$/azb-credentials.adoc[]
+
+. Run the `neo4j-admin database load` command to load a dump from your Azure blob storage container.
+The example assumes that you have dump artifacts located in the `myStorageAccount/myContainer/myDirectory` folder in your Azure account.
++
+[source,shell]
+----
+bin/neo4j-admin database load mydatabase --from-path=azb://myStorageAccount/myContainer/myDirectory --overwrite-destination=true
+----
+======
 =====
 
diff --git a/modules/ROOT/pages/tools/neo4j-admin/consistency-checker.adoc b/modules/ROOT/pages/tools/neo4j-admin/consistency-checker.adoc
@@ -242,4 +242,18 @@ The example assumes that you have backup or dump artifacts located in the `myBuc
 bin/neo4j-admin database check mydatabase --from-path=gs://myBucket/myDirectory/
 ----
 ======
-=====
+
+[.include-with-Azure-cloud-storage]
+======
+
+include::partial$/azb-credentials.adoc[]
+
+. Run the `bin/neo4j-admin database check` command to check the consistency of your database located in your Azure blob storage container.
+The example assumes that you have backup or dump artifacts located in the `myStorageAccount/myContainer/myDirectory` folder in Azure.
++
+[source,shell]
+----
+bin/neo4j-admin database check mydatabase --from-path=azb://myStorageAccount/myContainer/myDirectory/
+----
+======
+=====
diff --git a/modules/ROOT/pages/tools/neo4j-admin/neo4j-admin-import.adoc b/modules/ROOT/pages/tools/neo4j-admin/neo4j-admin-import.adoc
@@ -478,8 +478,21 @@ The example assumes that you have data stored in the `myBucket/data` folder in y
 bin/neo4j-admin database import full --nodes gs://myBucket/data/nodes.csv --relationships gs://myBucket/data/relationships.csv newdb
 ----
 ======
-=====
 
+[.include-with-Azure-cloud-storage]
+======
+
+include::partial$/azb-credentials.adoc[]
+
+. Run the `neo4j-admin database import` command to import your data from your Azure blob storage container.
+The example assumes that you have data stored in the `myStorageAccount/myContainer/data` folder in your container.
++
+[source,shell]
+----
+bin/neo4j-admin database import full --nodes azb://myStorageAccount/myContainer/data/nodes.csv --relationships azb://myStorageAccount/myContainer/data/relationships.csv newdb
+----
+======
+=====
 
 [role=label--enterprise-edition]
 [[import-tool-incremental]]
diff --git a/modules/ROOT/partials/azb-credentials.adoc b/modules/ROOT/partials/azb-credentials.adoc
@@ -0,0 +1,29 @@
+. Ensure you have an Azure account, an Azure storage account, and a blob container.
+.. You can create a storage account using the Azure portal. +
+For more information, see the Azure official documentation on link:https://learn.microsoft.com/en-us/azure/storage/common/storage-account-create?tabs=azure-portal[Create a storage account].
+.. Create a blob container in the Azure portal. +
+For more information, see the Azure official documentation on link:https://learn.microsoft.com/en-us/azure/storage/blobs/storage-quickstart-blobs-portal[Quickstart: Upload, download, and list blobs with the Azure portal].
+. Install the Azure CLI by following the instructions in the Azure official documentation -- link:https://docs.microsoft.com/en-us/cli/azure/install-azure-cli[Azure official documentation].
+. Authenticate the neo4j or neo4j-admin process against Azure using the default Azure credentials. +
+See the Azure official documentation on link:https://learn.microsoft.com/en-us/java/api/com.azure.identity.defaultazurecredential?view=azure-java-stable[default Azure credentials] for more information. +
++
+[source,shell]
+----
+az login
+----
++
+Then you should be ready to use Azure URLs in either neo4j or neo4j-admin.
+
+. To validate that you have access to the container with your login credentials, run the following commands:
++
+[source,shell]
+----
+# Upload a file:
+az storage blob upload --file someLocalFile  --account-name accountName - --container someContainer --name remoteFileName  --auth-mode login
+
+# Download the file
+az storage blob download  --account-name accountName --container someContainer --name remoteFileName --file downloadedFile --auth-mode login
+
+# List container files
+az storage blob list  --account-name someContainer --container someContainer  --auth-mode login
+----
