Skip to content
Merged
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
12 changes: 6 additions & 6 deletions modules/ROOT/pages/aura-cli/auradb-instances.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -19,10 +19,10 @@ Create an AuraDB instance with:

[source, shell]
----
aura-cli instance create --name YOUR\_INSTANCE\_NAME --type free-db --await
aura-cli instance create --name YOUR\_INSTANCE\_NAME --type free-db --await
----

For other Aura plans, provide the following:
For other Aura tiers, provide the following:

* Instance name
* Memory
Expand All @@ -35,7 +35,7 @@ Once you have them, proceed with:

[source, shell]
----
aura-cli instance create --name YOUR_INSTANCE_NAME --cloud-provider YOUR_CLOUD_PROVIDER --region CLOUD_REGION --memory MEMORY --type AURA_INSTANCE_TYPE --tenant-id YOUR_TENANT_ID
aura-cli instance create --name YOUR_INSTANCE_NAME --cloud-provider YOUR_CLOUD_PROVIDER --region CLOUD_REGION --memory MEMORY --type AURA_INSTANCE_TYPE --tenant-id YOUR_TENANT_ID
----

You can skip `--tenant-id` if you have set a default tenant.
Expand All @@ -57,7 +57,7 @@ Use the table format output option to improve readability:

[source, shell]
----
aura-cli instance list --output table
aura-cli instance list --output table
----

From the list, you can then use the ID for an AuraDB instance to get detailed information about it, including the URL to use for metrics:
Expand Down Expand Up @@ -209,7 +209,7 @@ See xref:managing-instances/backup-restore-export.adoc#export-create[Export / Cr
+
[source, shell]
----
aura-cli instance get DESTINATION_INSTANCE_ID
aura-cli instance get DESTINATION_INSTANCE_ID
----

When the status is "Running" the overwrite is completed.
Expand Down Expand Up @@ -237,7 +237,7 @@ aura-cli instance overwrite DESTINATION_INSTANCE_ID --source-instance-id SOURCE_
+
[source, shell]
----
aura-cli instance get DESTINATION_INSTANCE_ID
aura-cli instance get DESTINATION_INSTANCE_ID
----

When the status is "Running" the overwrite is completed.
Expand Down
2 changes: 1 addition & 1 deletion modules/ROOT/pages/dashboards/managing-dashboards.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ In Neo4j Aura, use **Dashboards** under **Tools** in the left-side navigation to

[NOTE]
====
The number of dashboards you can create depends on your Aura subscription plan:
The number of dashboards you can create depends on your Aura tier:
* AuraDB Free: three dashboards
* AuraDB Professional: 25 dashboards
Expand Down
10 changes: 5 additions & 5 deletions modules/ROOT/pages/getting-started/create-instance.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,14 @@
:description: This page describes how to create an instance in the new Neo4j Aura console.
:page-aliases: auradb/getting-started/create-database.adoc, aurads/create-instance.adoc

There are two types of Aura instances:
There are two types of Aura product 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.
Select the type of instance using the switch on the top right, then choose the tier that best suits your needs.

For AuraDB, you can upgrade your plan, and resize your instance's memory and storage later if your needs change.
For AuraDB, you can upgrade your tier, and resize your instance's memory and storage later if your needs change.
For pre-paid AuraDB instances on GCP, adjustable storage independent of memory is available, see xref:managing-instances/instance-actions.adoc#_adjust_storage[Adjust storage] for more information.

You can optionally enable additional features:
Expand All @@ -25,6 +25,6 @@ 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.
To create more instances, you need to upgrade your tier.
See link:https://neo4j.com/pricing/[Neo4j Pricing] for more information on the different tiers.
====
24 changes: 16 additions & 8 deletions modules/ROOT/pages/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -24,16 +24,24 @@ Aura includes AuraDB, a fully managed graph database, and AuraDS, a fully manage
The documentation is based on AuraDB unless specified otherwise.
See xref:graph-analytics/index.adoc[] for more information about AuraDS and graph analytics.

== Plans
== Products and tiers

Aura offers the following subscription plans:
Aura offers the following products and tiers:

** *AuraDB Free*
** *AuraDB Professional*
** *AuraDB Business Critical*
** *AuraDB Virtual Dedicated Cloud*
** *AuraDS Professional*
** *AuraDS Enterprise*
*Products:*

** AuraDB
** AuraDS
** Aura Graph Analytics

*Tiers and subscription plans:*

** AuraDB Free
** AuraDB Professional
** AuraDB Business Critical
** AuraDB Virtual Dedicated Cloud
** AuraDS Professional
** AuraDS Enterprise

The full list of features available with each plan is available on the link:https://neo4j.com/pricing/[Neo4j Pricing page].

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ A snapshot is a copy of the data in an instance at a specific point in time.
The *Snapshots* tab within an Aura instance card shows a list of available snapshots.
You can find the *Snapshots* tab via *Inspect* in the more menu (*...*) on the instance card.

There are different kinds of snapshots taken at different intervals with different lifecycles depending on your plan.
There are different kinds of snapshots taken at different intervals with different lifecycles depending on your tier.
See <<snapshot-details>> for more information.


Expand All @@ -27,7 +27,7 @@ label:AuraDB-Virtual-Dedicated-Cloud[]
label:AuraDS-Professional[]
label:AuraDS-Enterprise[]

A *Scheduled* snapshot is a snapshot that is automatically triggered at a cadence depending on your plan type.
A *Scheduled* snapshot is a snapshot that is automatically triggered at a cadence depending on your tier.

For Professional instances running the latest version, scheduled snapshots are run automatically once a day, same for both AuraDS Professional and for AuraDS Enterprise instances, For Business Critical and Virtual Dedicated Cloud instances, they run once an hour.
See <<snapshot-details>> further on for information about frequency, restorability, and exportability of scheduled snapshots, as well snapshots on instances running version 4.x.
Expand Down Expand Up @@ -84,7 +84,7 @@ If not, you can create a new instance from the snapshot instead, as described in

[cols="^,^,^,^,^,^,^",options="header"]
|===
| Plan
| Tier
| Aura version
2+| Frequency of snapshots
2+| Scheduled snapshots
Expand Down
4 changes: 2 additions & 2 deletions modules/ROOT/pages/managing-instances/regions.adoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[[regions]]
= Regions
:description: This page lists all regions Aura supports deployment in, sorted by subscription plan.
:description: This page lists all regions Aura supports deployment in, sorted by tier.
:page-aliases: auradb/managing-databases/regions.adoc

label:AuraDB-Professional[]
Expand All @@ -9,7 +9,7 @@ label:AuraDB-Business-Critical[]
label:AuraDS-Enterprise[]
label:AuraDB-Virtual-Dedicated-Cloud[]

Aura supports the following regions based on your subscription plan:
Aura supports the following regions based on your tier:

== Amazon Web Services (AWS)

Expand Down
44 changes: 23 additions & 21 deletions modules/ROOT/pages/security/single-sign-on.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -9,21 +9,23 @@ label:AuraDS-Enterprise[]

[NOTE]
====
If you're planning to use Single Sign-On (SSO), it's best to set it up early in your Aura journey. SSO does not retroactively apply to existing instances. It only applies to instances created after SSO is configured.
If you're planning to use Single Sign-On (SSO), keep in mind that SSO does not retroactively apply to existing instances.
It only applies to instances created after SSO is configured.
Therefore, plan accordingly.
====

Single Sign-On (SSO) enables organization owners and organization admins to use your organization’s identity provider (IdP) to authenticate users so they can access the Aura console and Aura instances.

Aura supports SSO authentication and authorization using https://learn.microsoft.com/en-us/entra/identity-platform/v2-protocols-oidc[Microsoft Entra] and link:https://developer.okta.com/docs/guides/oin-sso-overview/[Okta] as IdPs, implementing the OpenID Connect (OIDC) protocol.

As the service provider, Neo4j Aura redirects authentication requests to the configured IdP using the OpenID Connect (OIDC) protocol.
As the service provider, Neo4j Aura redirects authentication requests to the configured IdP using the OpenID Connect (OIDC) protocol.
Aura also supports authenticating with Google as the identity provider.
When a user attempts to log in, Aura generates a redirect URL with authentication parameters and sends the user to the IdP for authentication.
When a user attempts to log in, Aura generates a redirect URL with authentication parameters and sends the user to the IdP for authentication.
After successful authentication, the IdP redirects the user back to Aura with a secure token, allowing Aura to establish an authenticated session.

== Required roles

The person setting up SSO needs an `Organization Owner` or `Organization Admin` role.
The person setting up SSO needs an `Organization Owner` or `Organization Admin` role.
For information on how to assign roles see xref:/aura/user-management/[User management].

== SSO levels
Expand Down Expand Up @@ -70,7 +72,7 @@ To create an SSO Configuration, either a Discovery URI or a combination of Issue

. From the *Organization settings*, go to *Single Sign-On* to set up a new SSO configuration.

. The checkboxes *Use as a log in for the Organization* and *Use as login method for instances with projects in this Org* define whether SSO should be only on organization-level, only on project-level, or both.
. The checkboxes *Use as a log in for the Organization* and *Use as login method for instances with projects in this Org* define whether SSO should be only on organization-level, only on project-level, or both.

. The required basic SSO configuration information can be retrieved from the IdP.
Entering the Discovery URI pre-fills the fields below.
Expand Down Expand Up @@ -122,25 +124,25 @@ Customer support can assist with:
To request assistance, contact Support and raise a ticket using the following template:

[source]
----
Instance ID (Aura-only): [Insert]
Project ID (Aura-only): [Insert]
IdP name: [e.g., Okta, Azure]
SSO update for existing instance? Yes / No
Role mappings? Yes / No
If yes: [Insert details]
Custom claim? Yes / No
----
Instance ID (Aura-only): [Insert]
Project ID (Aura-only): [Insert]
IdP name: [e.g., Okta, Azure]
SSO update for existing instance? Yes / No
Role mappings? Yes / No
If yes: [Insert details]
Custom claim? Yes / No
If yes: [Insert details]
----

Instance ID (also known as DBID) can be found at xref:managing-instances/instance-details.adoc[instance details].
Project ID can be found at xref:visual-tour/index.adoc#_settings[project settings].

== Microsoft Entra ID SSO
== Microsoft Entra ID SSO

. In the *Azure Portal*, go to *App Registrations* and then *New Registration*.

. Add a name for the new app registration and select *Register*.
. Add a name for the new app registration and select *Register*.
Skip redirect URI’s for now.

. On the app overview page, take note of the Application (client) ID.
Expand All @@ -153,7 +155,7 @@ Skip redirect URI’s for now.

. Under *Authentication* in the left-hand navigation, setup redirect URLs:

.. Adding a new Web platform
.. Adding a new Web platform
.. Enter `https://login.neo4j.com/login/callback` as the redirect URI.

. In the Aura console, go to *Organization Settings* > *Security* > *Single Sign On* > *New configuration*
Expand Down Expand Up @@ -192,20 +194,20 @@ Skip redirect URI’s for now.

When requesting the token from Azure, the scopes Aura sends are:

* `openid` access to a unique identifier to identify the user.
* `openid` access to a unique identifier to identify the user.

* `profile` access to basic profile information.

* `email` contains the user's email address.

This will result in Azure asking for consent to display details related to these scopes.
This will result in Azure asking for consent to display details related to these scopes.
For more information, see link:https://auth0.com/docs/get-started/apis/scopes/openid-connect-scopes#standard-claims[OpenID Connect Scopes]

== Okta SSO
== Okta SSO

. In the *Okta admin portal* go to *Applications* and then *Create App Integration*.

. For *Sign-in method* select *OIDC - OpenID Connect*.
. For *Sign-in method* select *OIDC - OpenID Connect*.

. For *Application type* select *Web Application*.

Expand Down Expand Up @@ -262,6 +264,6 @@ No, users must be granted the role on the organization via Aura console invites

*Why am I unable to connect to the instance after completing the SSO login, the connection is showing as unconnected?*

Ensure that the email field is provided on your user in Microsoft Entra ID.
Ensure that the email field is provided on your user in Microsoft Entra ID.
If it already is, contact support for further assistance.

16 changes: 8 additions & 8 deletions modules/ROOT/pages/tutorials/migration-free.adoc
Original file line number Diff line number Diff line change
@@ -1,28 +1,28 @@
= Migrating your AuraDB Free instance to another AuraDB plan
:description: This section describes migrating your Neo4j AuraDB Free Instance to another AuraDB plan
= Migrating your AuraDB Free instance to another AuraDB tier
:description: This section describes migrating your Neo4j AuraDB Free Instance to another AuraDB tier.
:page-aliases:platform/tutorials/migration-free.adoc

== AuraDB Professional or AuraDB Virtual Dedicated Cloud

Upgrading your plan to AuraDB Professional or AuraDB Virtual Dedicated Cloud gives you access to additional resources and functionalities to support production workloads and applications with demanding storage and processing needs.
Upgrading your tier to AuraDB Professional or AuraDB Virtual Dedicated Cloud gives you access to additional resources and functionalities to support production workloads and applications with demanding storage and processing needs.

*Migration options*

* Upgrade to AuraDB Professional
* Clone to new (Works for AuraDB Professional and AuraDS Professional)
* Upgrade to AuraDB Professional
* Clone to new (Works for AuraDB Professional and AuraDS Professional)
* Manual process

== Upgrade to AuraDB Professional

You can upgrade an instance to the Professional plan directly from the console.
You can upgrade an instance to the Professional tier directly from the console.

On the instance card, click the button that says *Upgrade*.
On the instance card, click the button that says *Upgrade*.

Verify that the cloud provider and region are correct and select the instance size you need, add the extra details and select *Create*.

== Clone (Works for AuraDB Professional and AuraDS)

The other way is to _clone_ your existing instance to the Professional plan.
The other way is to _clone_ your existing instance to the Professional tier.

* Click the three dots (*...*) on an instance card
* Select either: *Clone to new instance* or create a new *Clone to existing instance* (the current content will be overwritten)
Expand Down