diff --git a/modules/ROOT/content-nav.adoc b/modules/ROOT/content-nav.adoc index 3670d9fe7..0db201c1c 100644 --- a/modules/ROOT/content-nav.adoc +++ b/modules/ROOT/content-nav.adoc @@ -10,8 +10,12 @@ Generic Start ** xref:visual-tour/index.adoc[Visual tour] * Quick start -** xref:getting-started/quick-start-guide.adoc[Quick start guide] -** xref:cloud-providers.adoc[Cloud provider marketplaces] +** xref:getting-started/create-account.adoc[Create an account] +** xref:getting-started/create-instance.adoc[Create an instance] +** xref:getting-started/connect-instance.adoc[Connect to an instance] +** xref:getting-started/migrate-metadata.adoc[Migrate metadata from Workspace] + +* xref:cloud-providers.adoc[Cloud provider marketplaces] * Manage instances ** xref:managing-instances/instance-actions.adoc[Instance actions] diff --git a/modules/ROOT/images/connectionbanner.png b/modules/ROOT/images/connectionbanner.png index 83830e1c1..215eb4498 100644 Binary files a/modules/ROOT/images/connectionbanner.png and b/modules/ROOT/images/connectionbanner.png differ diff --git a/modules/ROOT/images/connectionbanner1.png b/modules/ROOT/images/connectionbanner1.png new file mode 100644 index 000000000..9b144b6c1 Binary files /dev/null and b/modules/ROOT/images/connectionbanner1.png differ diff --git a/modules/ROOT/images/connectionmodal.png b/modules/ROOT/images/connectionmodal.png index 2dbb388d3..9aef938cc 100644 Binary files a/modules/ROOT/images/connectionmodal.png and b/modules/ROOT/images/connectionmodal.png differ diff --git a/modules/ROOT/images/connectionmodalnonremote.png b/modules/ROOT/images/connectionmodalnonremote.png new file mode 100644 index 000000000..48bf75379 Binary files /dev/null and b/modules/ROOT/images/connectionmodalnonremote.png differ diff --git a/modules/ROOT/pages/getting-started/connect-instance.adoc b/modules/ROOT/pages/getting-started/connect-instance.adoc new file mode 100644 index 000000000..2a29a9325 --- /dev/null +++ b/modules/ROOT/pages/getting-started/connect-instance.adoc @@ -0,0 +1,39 @@ +[[connect-to-instance]] += Connect to an instance +:description: This page describes how to connect to an instance in the new Neo4j Aura console. + +To interact with a database in an instance, you need to establish a connection. + +. Go to *Import*, *Explore* or *Query*. +. Select *Status* and from there you can connect to an instance. +. You may need your *Username* and *Password* credentials. + +[.shadow] +.Connection banner +image::connectionbanner1.png[] + +[.shadow] +.Connection modal +image::connectionmodalnonremote.png[width=300] + +[cols="20%,80%"] +|=== +| Field | Description + +|Connection method +|The protocol is used for the communication between the Neo4j database server and the client application or tool. +The default is `neo4j+s//`. +// For more information about connection schemes, see link:https://neo4j.com/docs/operations-manual/current/configuration/connectors/[Operations Manual -> Configure network connectors] and link:https://neo4j.com/docs/bolt/current/bolt/[Bolt Protocol]. + +// |Connection URL +// |You can get this from your instance details + +|Single sign-on +|If this is set up, you can use SSO. + +|Database user +|Neo4j by default + +|Password +|You are given the password when you initially create the instance +|=== \ No newline at end of file diff --git a/modules/ROOT/pages/getting-started/create-account.adoc b/modules/ROOT/pages/getting-started/create-account.adoc new file mode 100644 index 000000000..c39bbac76 --- /dev/null +++ b/modules/ROOT/pages/getting-started/create-account.adoc @@ -0,0 +1,11 @@ +[[aura-create-account]] +:description: This page describes how to create a Neo4j Aura account. + += Create an account + +To access Neo4j Aura, you need to have an Aura account. +Navigate to link:https://console.neo4j.io[Neo4j Aura console] and follow the instructions for registration. +Once you have accepted the terms and conditions and verified your email address, you can start using the console. + +The console exists in two versions,the new console, and the classic experience, as mentioned in xref:index.adoc[About Neo4j Aura console]. +You can toggle between the different versions, via the account dropdown in the top right corner. \ No newline at end of file diff --git a/modules/ROOT/pages/getting-started/create-instance.adoc b/modules/ROOT/pages/getting-started/create-instance.adoc new file mode 100644 index 000000000..553c47df6 --- /dev/null +++ b/modules/ROOT/pages/getting-started/create-instance.adoc @@ -0,0 +1,27 @@ +[[create-instance]] += Create an instance +:description: This page describes how to create an instance in the new Neo4j Aura console. + +There are two types of Aura instances: + +* **AuraDB** (the default Aura instance type) +* **AuraDS** (the xref:graph-analytics/index.adoc#aura-ds[fully managed version] of Neo4j Graph Data Science) + +Select the type of instance using the switch on the top right, then choose the plan that best suits your needs. +You can upgrade your plan later if your needs change. + +You can optionally enable additional features: + +* xref:graph-analytics/index.adoc#aura-gds-plugin[Graph Analytics plugin] to add graph analytics capabilities (**AuraDB Professional only**) +* xref:managing-instances/instance-details.adoc#aura-vector-optimization[Vector optimization] to enhance performance for vector-based operations + +After selecting **Next**, your instance is created. +A password is generated for the instance, ensure to either copy or download it, as it will **not** be recoverable after. +The password is required to access your instance later. + +[NOTE] +==== +You can only create **one Free instance** per account. +To create more instances, you need to upgrade your plan. +See link:https://neo4j.com/pricing/[Neo4j Pricing] for more information on the different plans. +==== \ No newline at end of file diff --git a/modules/ROOT/pages/getting-started/migrate-metadata.adoc b/modules/ROOT/pages/getting-started/migrate-metadata.adoc new file mode 100644 index 000000000..3507315f6 --- /dev/null +++ b/modules/ROOT/pages/getting-started/migrate-metadata.adoc @@ -0,0 +1,51 @@ +[[aura-migrate-metadata]] += Migrate metadata from Workspace +:description: This describes how to migrate metadata from Neo4j Workspace to the new Neo4j Aura Console. + +If you have an Aura instance created in the classic Aura console (refer to xref:new-console.adoc[New Neo4j Aura console] for comparison), you can migrate the metadata from Workspace to the new console and continue working with your data in the new experience. +The metadata includes the data model and saved Cypher queries. + +== Data model + +From the *Import* tab in Workspace, open the more menu (*...*) and download the model, with or without data. + +[.shadow] +image::export-model.png[width=300] + +Then navigate to the new console and select *Import* -> *Graph models*. +Once you select *New graph model*, you access the more menu (*...*), similar to Workspace, and select *Open model* with or without data. + +[.shadow] +image::import-model.png[width=600] + +Note that if you have downloaded your data with the model, you can also go a different route via *Import* -> *Data sources* and select *New data source* and then import locally from files. +This leads you to the same *Import* frame as the first route and you can use the more menu (*...*) to open the model *with* your data. + +== Saved Cypher + +Any saved Cypher snippets can be downloaded from the *Query* tab in Workspace. +From the Saved Cypher drawer, use the *Export* button to download selected queries as a _.csv_ file. + +[.shadow] +image::export-saved-cypher.png[width=300] + +In the new console, navigate to the *Query* tab and open the *Saved Cypher* drawer. +Use the *Import* button and select the _.csv_ file you downloaded from Workspace. + +[.shadow] +image::import-saved-cypher.png[width=400] + +== Perspectives + +Perspectives, except for the default Perspective (which is automatically re-created in the new console), can be exported from the Perspective drawer in Workspace. +Use the *Export* option on the Perspective you want to save. +It is exported as a _.json_ file. + +[.shadow] +image::export-perspective.png[width=300] + +In the new console, navigate to the *Explore* tab and open the *Perspective* drawer. +Use the *Import* option and select the _.json_ file you downloaded from Workspace. + +[.shadow] +image::import-perspective.png[width=600] diff --git a/modules/ROOT/pages/getting-started/quick-start-guide.adoc b/modules/ROOT/pages/getting-started/quick-start-guide.adoc deleted file mode 100644 index ae9484ba8..000000000 --- a/modules/ROOT/pages/getting-started/quick-start-guide.adoc +++ /dev/null @@ -1,138 +0,0 @@ -[[aura-quick-start-guide]] -= Quick start guide -:description: This page describes how to create a Neo4j Aura account, a new instance and connect to existing instances. - -== Create an account - -To access Neo4j Aura, you need to have an Aura account. -Navigate to link:https://console.neo4j.io[Neo4j Aura console] and follow the instructions for registration. -Once you have accepted the terms and conditions and verified your email address, you can start using the console. - -The console exists in two versions, the classic experience, and the early access new console, as mentioned in xref:index.adoc[About Neo4j Aura console]. -You can toggle between the different versions, via the account dropdown in the top right corner. - -[[create-instance]] -== Create an instance - -There are two types of Aura instances: - -* **AuraDB** (the default Aura instance type) -* **AuraDS** (the xref:graph-analytics/index.adoc#aura-ds[fully managed version] of Neo4j Graph Data Science) - -Select the type of instance using the switch on the top right, then choose the plan that best suits your needs. -You can upgrade your plan later if your needs change. - -You can optionally enable additional features: - -* xref:graph-analytics/index.adoc#aura-gds-plugin[Graph Analytics plugin] to add graph analytics capabilities (**AuraDB Professional only**) -* xref:managing-instances/instance-details.adoc#aura-vector-optimization[Vector optimization] to enhance performance for vector-based operations - -After selecting **Next**, your instance is created. -A password is generated for the instance, ensure to either copy or download it, as it will **not** be recoverable after. -The password is required to access your instance later. - -[NOTE] -==== -You can only create **one Free instance** per account. -To create more instances, you need to upgrade your plan. -See link:https://neo4j.com/pricing/[Neo4j Pricing] for more information on the different plans. -==== - -[[connect-to-instance]] -== Connect to an instance - -To interact with a database in an instance, you need to establish a connection. - -. Go to *Import*, *Explore* or *Query*. -. Select *Status* and from there you can connect to an instance. -. You may need your *Username* and *Password* credentials. - -[.shadow] -.Connection banner -image::connectionbanner.png[] - -[.shadow] -.Connection modal -image::connectionauthentication.png[] - -[cols="20%,80%"] -|=== -| Field | Description - -|Protocol -|The protocol is used for the communication between the Neo4j database server and the client application or tool. -If you are a new user, you can use the default the default `neo4j+s//`. -For more information about connection schemes, see link:https://neo4j.com/docs/operations-manual/current/configuration/connectors/[Operations Manual -> Configure network connectors] and link:https://neo4j.com/docs/bolt/current/bolt/[Bolt Protocol]. - -|Connection URL -|You can get this from your instance details - -|Database user -|Neo4j by default - -|Password -|You are given the password when you initially create the instance - -|Single sign-on -|If this is set up, you can use SSO. - -|=== - -== Migrate metadata from Workspace - -If you have an existing Aura instance, you can migrate the metadata from Workspace to the new console and continue working with your data in the new experience. -The metadata includes the data model and saved Cypher queries. -//Add Perspectives and Scenes when they are available. - -=== Data model - -From the *Import* tab in Workspace, open the more menu (*...*) and download the model, with or without data. - -[.shadow] -image::export-model.png[width=300] - -Then navigate to the new console and select *Import* -> *Graph models*. -Once you select *New graph model*, you access the more menu (*...*), similar to Workspace, and select *Open model* with or without data. - -[.shadow] -image::import-model.png[width=600] - -Note that if you have downloaded your data with the model, you can also go a different route via *Import* -> *Data sources* and select *New data source* and then import locally from files. -This leads you to the same *Import* frame as the first route and you can use the more menu (*...*) to open the model *with* your data. - -=== Saved Cypher - -Any saved Cypher snippets can be downloaded from the *Query* tab in Workspace. -From the Saved Cypher drawer, use the *Export* button to download selected queries as a _.csv_ file. - -[.shadow] -image::export-saved-cypher.png[width=300] - -In the new console, navigate to the *Query* tab and open the *Saved Cypher* drawer. -Use the *Import* button and select the _.csv_ file you downloaded from Workspace. - -[.shadow] -image::import-saved-cypher.png[width=400] - -=== Perspectives - -Perspectives, except for the default Perspective (which is automatically re-created in the new console), can be exported from the Perspective drawer in Workspace. -Use the *Export* option on the Perspective you want to save. -It is exported as a _.json_ file. - -[.shadow] -image::export-perspective.png[width=300] - -In the new console, navigate to the *Explore* tab and open the *Perspective* drawer. -Use the *Import* option and select the _.json_ file you downloaded from Workspace. - -[.shadow] -image::import-perspective.png[width=600] - - - - - - - - diff --git a/modules/ROOT/pages/managing-instances/instance-actions.adoc b/modules/ROOT/pages/managing-instances/instance-actions.adoc index 9e6440622..cfabeb5ee 100644 --- a/modules/ROOT/pages/managing-instances/instance-actions.adoc +++ b/modules/ROOT/pages/managing-instances/instance-actions.adoc @@ -135,7 +135,7 @@ You cannot clone from a Neo4j latest version instance to a Neo4j version 4 insta . From the more menu (*...*) on the instance you want to clone, select *Clone to* and then *New instance* from the contextual menu. . Set your desired settings for the new database. -For more information on AuraDB database creation, see xref:getting-started/quick-start-guide.adoc#create-instance[Create an instance]. +For more information on AuraDB database creation, see xref:getting-started/create-instance.adoc[Create an instance]. . Check the *I accept* box and select *Create*. + [WARNING] @@ -182,10 +182,10 @@ label:AuraDB-Business-Critical[] Admins can mark a database instance as `production` in AuraDB Virtual Dedicated Cloud and AuraDB Business Critical. -When Neo4j updates Aura Database versions, instances marked as `production` are last to have the Aura Database version updated. +When Neo4j updates Aura Database versions, instances marked as `production` are last to have the Aura Database version updated. Because updates are applied to these database instances after other database instances receive updates, you can monitor any potential impact on less critical instances first. -After marking the instance as `production` the label is applied immediately, and all instance actions (such as pause or clone) are temporarily unavailable while the instance is set to `production` in the Neo4j backend. +After marking the instance as `production` the label is applied immediately, and all instance actions (such as pause or clone) are temporarily unavailable while the instance is set to `production` in the Neo4j backend. Use the more menu (*...*) on the instance card to mark it as `production`. diff --git a/modules/ROOT/pages/new-console.adoc b/modules/ROOT/pages/new-console.adoc index 6236879d9..6a958375e 100644 --- a/modules/ROOT/pages/new-console.adoc +++ b/modules/ROOT/pages/new-console.adoc @@ -1,5 +1,5 @@ :description: This page highlights the main differences between the new and classic concoles. -= Neo4j Aura console += New Neo4j Aura console The new console is an evolution of the classic Aura console, updated to enhance the experience with Neo4j Aura. It integrates the features and functionalities of various tools, services, and operations from the Neo4j catalog. diff --git a/modules/ROOT/pages/user-management.adoc b/modules/ROOT/pages/user-management.adoc index 59a024afe..66f0a260c 100644 --- a/modules/ROOT/pages/user-management.adoc +++ b/modules/ROOT/pages/user-management.adoc @@ -36,32 +36,32 @@ The following roles are available at the org level and these are assigned via in | {check-mark} | -| Add projects +| Invite users to projects | {check-mark} | {check-mark} | -| List existing SSO configs +| List existing organization settings | {check-mark} | {check-mark} | -| Add SSO configs +| Add organization settings | {check-mark} | {check-mark} | -| List SSO configs on project-level +| List organization settings on project-level | {check-mark} | {check-mark} | -| Update SSO configs on project-level +| Update organization settings on project-level | {check-mark} | {check-mark} | -| Delete SSO configs on project-level +| Delete organization settings on project-level | {check-mark} | {check-mark} | @@ -131,10 +131,10 @@ The following roles are available at the org level and these are assigned via in Each project can have multiple users with individual accounts allowing access to the same environment. -The users with access to a project can be viewed and managed from the *Users* page. +The users with access to a project can be viewed and managed from the *Users* page. Access the Users page by selecting Users from the sidebar menu of the console. -The project you're currently viewing is displayed in the header of the console. +The project you're currently viewing is displayed in the header of the console. You can select the project name to open the project dropdown menu, allowing you to view all the projects that you have access to and switch between them. Additionally, you can perform the following actions from the *Project Settings* page. @@ -148,7 +148,7 @@ You can access the **Settings** page by selecting **Settings** from the sidebar Each project can have multiple users with individual accounts allowing access to the same environment. -The users with access to a project can be viewed and managed from the **Users** page. +The users with access to a project can be viewed and managed from the **Users** page. You can access the **Users** page by selecting **Users** from the sidebar menu of the console. === Roles @@ -168,7 +168,7 @@ Users within a project can be assigned one of the following roles: | Capability | Admin | Member | Viewer | View users and their roles | {check-mark} | {check-mark} | {check-mark} | View and open instances | {check-mark} | {check-mark} | {check-mark} -| Access the Neo4j Customer Support Portal | {check-mark} | {check-mark} | {check-mark} +| Access the Neo4j Customer Support Portal | {check-mark} | {check-mark} | {check-mark} | Perform all actions on instances footnote:[Actions include creating, deleting, pausing, resuming, and editing instances.] | {check-mark} | {check-mark} | | Clone data to new and existing instances | {check-mark} | {check-mark} | | Take on-demand snapshots | {check-mark} | {check-mark} | @@ -225,13 +225,13 @@ As an _Admin_, to delete an existing user: === Accepting an invite -When invited to a project, you will receive an email with a link to accept the invite. +When invited to a project, you will receive an email with a link to accept the invite. This link will direct you to the Aura console, where a **Project invitation** modal will appear. -You can select the project(s) you have been invited to and choose to accept or decline the invite(s). +You can select the project(s) you have been invited to and choose to accept or decline the invite(s). // You can also close the **Project invitation** modal without accepting or declining the invite(s) and later manually re-open the modal by selecting the **Pending invites** envelope icon in the console header. [TIP] ==== -User management within the Aura console does not replace built-in roles or fine-grained RBAC at the database level. +User management within the Aura console does not replace built-in roles or fine-grained RBAC at the database level. ==== diff --git a/modules/ROOT/pages/visual-tour/index.adoc b/modules/ROOT/pages/visual-tour/index.adoc index 4162071e6..e083199a3 100644 --- a/modules/ROOT/pages/visual-tour/index.adoc +++ b/modules/ROOT/pages/visual-tour/index.adoc @@ -34,7 +34,7 @@ image::breadcrumbs.png[Breadcrumb navigation] === Organizations -Organizations are a layer in the Aura account hierarchy that sits above Projects. +Organizations are a layer in the Aura account hierarchy that sits above Projects. This allows you to organize and manage multiple projects under a single organization. Management at this level allows control over all Projects within an Organization and, thus, instances within Projects and lets Organization owners roll out Project-level settings for all Projects simultaneously. @@ -51,7 +51,7 @@ image::enable-copilot.png[] == Data Services This section contains your instances and the Import service. -To access your data, navigate to a project and xref:getting-started/quick-start-guide.adoc#connect-to-instance[connect to an instance]. +To access your data, navigate to a project and xref:getting-started/connect-instance.adoc[connect to an instance]. === Instances