Skip to content
Open
Show file tree
Hide file tree
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
64 changes: 35 additions & 29 deletions modules/ROOT/pages/managing-instances/instance-actions.adoc
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
[[instance-actions]]
= Instance actions
:description: This page describes the following instance actions - rename, reset, upgrade, resize, pause, resume, clone to a new database, clone to an existing database, or delete an instance.
Expand Down Expand Up @@ -171,54 +171,60 @@

== Clone an instance

You can clone an existing instance to create a new instance with the same data.
You can clone across regions, and from Neo4j version 4 to Neo4j latest version.

There are two options to clone an instance:

* Clone to a new instance
* Clone to an existing instance

You can access all the cloning options from the more menu *[...]* on the instance.
You can clone data from an Aura instance to another existing instance or a new instance.

[NOTE]
====
You cannot clone from a Neo4j latest version instance to a Neo4j version 4 instance.
You can move your data to a new region by cloning to a new instance and selecting the required options under *Cloud provider & region*.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This requires also that the user deletes the instance in the "old" region, or else it defeats the purpose. I think it would be better to say:
To move your instance to a different region, you can clone to a new instance in the desired region and then delete your original instance.

====

== Clone to a new instance
Note that you have to use the Aura console to clone, it is not supported via Aura API.

The time it takes depends on the amount of data (and factors such as number of indexes and constraints, or the capacity of the destination instance).

. From the more menu (*...*) on the instance you want to clone, select *Clone to* and then *New instance*.
. Set your desired settings for the new instance.
For more information see xref:getting-started/create-instance.adoc[Create an instance].
. Check the *I accept* box and select *Create*.
You can clone from a Neo4j version 4 instance to an instance running the latest Neo4j version.
You cannot clone from latest Neo4j version to Neo4j version 4.

=== Clone to a new instance

Cloning to a new instance creates a new destination instance containing a duplicate of the source instance data.

. From the more menu *[...]* on the source instance select *Clone to* > *New instance.*
. Configure the new instance including the required options under *Cloud provider & region* and confirm with *Create instance*.
For more information, see xref:getting-started/create-instance/[Create an instance].
. Save the credentials in a safe place and *Continue*.

[WARNING]
====
Make sure that the username and password are stored safely before continuing.
Credentials cannot be recovered afterwards.
Store the username and password securely.
The credentials cannot be recovered.
====

== Clone to an existing instance
The destination instance progresses through states, including *Overwriting* and *Loading*.
When cloning is complete, the status changes to *Running* and it is ready to use.

=== Clone to an existing instance

When you clone an instance to an existing instance, the database connection URI stays the same, but the data is replaced with the data from the cloned instance.
The destination instance can be empty or contain data.

[WARNING]
====
Cloning into an existing instance will replace all existing data.
Any data in the destination instance will be overwritten by the source data during cloning.
If you want to keep the current data, take a snapshot and export it.
====

. From the more menu (*...*) on the instance you want to clone, select *Clone to* and then *Existing instance*.
. Select the existing AuraDB instance to clone to from the dropdown menu.
+
[NOTE]
====
Existing instances that are not large enough to clone into will not be available for selection.
====
+
. Check the *I understand the target instance will be overwritten* box and select *Clone*.
The destination instance connection URI and credentials are not affected.

Only instances with enough capacity for the cloned data are available for selection.

. From the more menu *[...]* on the source instance, select *Clone to* > *Existing instance*.
. Select the target AuraDB instance.
. Select the *I understand the target instance will be overwritten* checkbox.
. Select *Clone*.

When all the steps are completed, the instance will show a *Running* state and is ready to be used.

If you want to export your RBAC settings, see the tutorial at https://neo4j.com/docs/aura/tutorials/upgrade/#_recreate_users_and_roles_in_neo4j_aura[recreate users and roles in Neo4j Aura].

== Upgrade an instance

Expand Down
18 changes: 9 additions & 9 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading