Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Aura instance must be accessible from the machine running neo4j-admin #1664

Merged
merged 3 commits into from
Jun 11, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 17 additions & 14 deletions modules/ROOT/pages/tools/neo4j-admin/push-to-cloud.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,23 @@ The following table shows the compatibility between the dump version that you wa
This operation is secured and TLS encrypted end to end.
====

== Prerequisites

Before you can use the `neo4j-admin push-to-cloud` command, you must meet the following prerequisites:

* Verify that your Neo4j Aura instance is running.
* Verify that your Neo4j Aura instance is accessible from the machine running `neo4j-admin`.
Otherwise, the upload will fail with SSL errors.
* Verify that your local database is stopped.
You cannot run the `push-to-cloud` command against a source database that is currently in use.

[CAUTION]
====
The `neo4j-admin push-to-cloud` command is not compatible with instances encrypted with link:{neo4j-docs-base-uri}/aura/platform/security/#_customer_managed_keys[Customer Managed Keys].
Use `neo4j-admin database upload` in Neo4j Admin version 5 to upload data to instances encrypted with Customer Managed Keys.
For more information see link:{neo4j-docs-base-uri}/aura/auradb/importing/import-database[Neo4j Admin database upload].
====

== Syntax

----
Expand Down Expand Up @@ -98,20 +115,6 @@ Overwrite the data in the target database.
Enable verbose output.
|===

== Limitations

* A Neo4j Aura database must already be provisioned and running.
* Your local database must be stopped before you run the `push-to-cloud` command with the `--database` argument.
The `push-to-cloud` function cannot be used with a source database that is currently in use.

[CAUTION]
====
The `neo4j-admin push-to-cloud` command is not compatible with instances encrypted with link:{neo4j-docs-base-uri}/aura/platform/security/#_customer_managed_keys[Customer Managed Keys].
Use `neo4j-admin database upload` in Neo4j Admin version 5 to upload data to instances encrypted with Customer Managed Keys.
For more information see link:{neo4j-docs-base-uri}/aura/auradb/importing/import-database[Neo4j Admin database upload].
====


== Output

If the `push-to-cloud` function completes successfully, it exits with the following logline:
Expand Down
Loading