Skip to content

Commit

Permalink
Merge branch 'console' into console-backup
Browse files Browse the repository at this point in the history
  • Loading branch information
AlexicaWright authored Feb 13, 2025
2 parents f85a378 + 9976461 commit 1f73796
Show file tree
Hide file tree
Showing 6 changed files with 187 additions and 56 deletions.
5 changes: 4 additions & 1 deletion modules/ROOT/content-nav.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ Generic Start

* Introduction
** xref:index.adoc[About Aura]
** xref:graph-analytics/index.adoc[]
** xref:visual-tour/index.adoc[Visual tour]
* Quick start
** xref:getting-started/quick-start-guide.adoc[Quick start guide]
Expand Down Expand Up @@ -59,7 +60,6 @@ Generic Start
*** xref:explore/explore-features/slicer.adoc[Slicer]
** xref:explore/explore-default-actions.adoc[Default actions and shortcuts]
* Query data
** xref:query/introduction.adoc[What is Query?]
** xref:query/visual-tour.adoc[Visual tour]
Expand All @@ -84,9 +84,12 @@ Generic Start
* Security
** xref:security/single-sign-on.adoc[Single sign-on]
** xref:security/encryption.adoc[Encryption]
* xref:user-management.adoc[User management]
* xref:billing.adoc[Billing]
* Connecting applications
** xref:connecting-applications/overview.adoc[Drivers and libraries]
////
Expand Down
Binary file added modules/ROOT/images/consumptionreport.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
43 changes: 43 additions & 0 deletions modules/ROOT/pages/billing.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
[[aura-Billing]]
= Billing
:description: Consumption reporting allows Virtual Dedicated Cloud customers to closely monitor their consumption.

label:Aura-DB-Professional[]
label:AuraDB-Business-Critical[]
label:AuraDB-Virtual-Dedicated-Cloud[]

Virtual Dedicated Cloud services are offered through prepaid consumption plans.
Billing is based on usage, with credits deducted from the available balance each month.

== Consumption report

The consumption report, accessible in the Billing section, provides real-time insights into resource usage for the current project, including both running and paused states.
It displays RAM usage in GB-hours and the equivalent cost in prepaid credits.
You can also Export a CSV file containing usage in a selected period.

Available to Admins, the consumption report helps track usage patterns over time to make informed resource allocation decisions.
The usage data is also exportable.

=== Product name and pricing

For more information, refer to link:https://console-preview.neo4j.io/pricing[Aura Pricing] for the specific product names and their prices.
If a database is paused, its charge is reduced to 20% of the standard hourly rate.

=== Billing status

Can be `ongoing` (currently being billed) or `ended` (historical usage).

=== Units of measure

Units of measure are displayed in the specified unit of measure.
GB-hours usage is calculated by multiplying the number of hours a database is running (whether actively used or not) by the memory size in gigabytes (GB).

== Filters

* Filter the usage data by predefined and custom date intervals.
* Look back for a period of up to one year.
* Filter by `Last 24 hours`, `Last 7 days`, `Last 30 days`, `Last 90 days` or a `Custom range`.

.Consumption report example
[.shadow]
image::consumptionreport.png[]
14 changes: 12 additions & 2 deletions modules/ROOT/pages/getting-started/quick-start-guide.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,20 @@ You can toggle between the different versions, via the account dropdown in the t
[[create-instance]]
== Create an instance

The first step is to select the plan that best suits your needs.
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.

Once you've selected a plan, your instance is created.
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.

Expand Down
64 changes: 64 additions & 0 deletions modules/ROOT/pages/graph-analytics/index.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
[[graph-analytics-aura]]
= Graph analytics on Aura
:description: This page describes how to run graph analytics on Aura.

There are two ways to run graph analytics on Aura:

* Create an AuraDB Professional instance with the <<aura-gds-plugin>>, or enable the plugin on an existing AuraDB Professional instance.
* Create an <<aura-ds, AuraDS instance>>.

[[aura-gds-plugin]]
== Graph Analytics plugin

label:AuraDB-Professional[]

The Graph Analytics plugin allows you to use the link:https://neo4j.com/docs/graph-data-science/current/introduction/[Graph Data Science library] in any AuraDB Professional instance with the following requirements:

* Neo4j version 5 or later
* 4 GB of memory or more
* Any supported cloud providers and regions

You can enable or disable the plugin when necessary.

[[aura-ds]]
== AuraDS

label:AuraDS-Professional[] label:AuraDS-Enterprise[]

AuraDS is the fully managed version of the link:https://neo4j.com/docs/graph-data-science/current/introduction/[Graph Data Science library].

AuraDS instances have the following features:

* Upgrades and patches are automatically applied.
* Can be seamlessly scaled up or down.
* Can be paused to reduce costs.

=== Plans

AuraDS offers the AuraDS Professional and AuraDS Enterprise subscription plans.
The full list of features for each plan is available on the link:https://neo4j.com/pricing/#graph-data-science[Neo4j Pricing page].

=== Updates and upgrades

AuraDS updates and upgrades are handled by the platform, and as such do not require user intervention.
Security patches and new versions of GDS and Neo4j are installed within short time windows during which the affected instances are unavailable.

The operations are non-destructive, so graph projections, models, and data present on an instance are not affected.
No operation is applied until all the running GDS algorithms have completed.

== Comparison

There are important operational differences between the Graph Analytics plugin on AuraDB Professional and AuraDS.

[opts="header", cols="1,1"]
|===
|AuraDB Pro + Graph Analytics plugin
|AuraDS

|Rolling updates clear all projections.
|Rolling updates save projections to disk and restore them upon restart.

|Backup files do not include projections.
|Backup files include all projections.

|===
Loading

0 comments on commit 1f73796

Please sign in to comment.