Skip to content

Flexible storage #653

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

Open
wants to merge 24 commits into
base: console
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
24 commits
Select commit Hold shift + click to select a range
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
Binary file added modules/ROOT/images/adjust_storage.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
5 changes: 3 additions & 2 deletions modules/ROOT/pages/getting-started/create-instance.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,15 @@
: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:

* **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.

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

You can optionally enable additional features:

Expand Down
27 changes: 22 additions & 5 deletions modules/ROOT/pages/managing-instances/instance-actions.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -58,17 +58,34 @@ image::instanceactions.png[]
// . Tick the *I understand* checkbox and select *Upgrade Instance*.

== Resize an instance

Resizing an instance means changing the memory, CPU and storage size.
Note that this option is not available for Free instances.

// label:AuraDB-Professional[]
// label:AuraDB-Enterprise[]
// label:AuraDB-Business-Critical[]

You can change the size of an existing instance using the *Resize* button on the instance you want to resize.
Resizing an instance means changing the memory, CPU and storage size.
Note that this option is *not available* for *Free instances*.

You can change the size of an existing instance using the *Configure* button on the instance you want to resize.
An instance remains available during the resize operation.

== Adjust storage

[NOTE]
====
Available for AuraDB prepaid billing on GCP, Neo4j latest version.
====

Adjust the storage size of your instance at any time.
Each AuraDB instance includes a standard storage allocation and configuration; additional storage is chargeable.

To select the storage size during instance creation, select the desired value in the *Storage (Adjustable)* column.

To adjust an existing instance's storage, use the *Configure* button on the instance card and select a new value for the storage size.

[.shadow]
.Adjust storage size
image::adjust_storage.png[adjust storage screenshot,540,380]

== Pause an instance

Pausing a Neo4j instance temporarily stops the database, which means:
Expand Down
7 changes: 5 additions & 2 deletions modules/ROOT/pages/managing-instances/instance-details.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -49,8 +49,11 @@ See xref:managing-instances/custom-endpoints.adoc[Custom endpoints] for more inf
It runs on container technology and this allows for the AuraDB Instance to allocate dedicated CPU resources.

|Storage
|Neo4j Aura automates the backup process (you can also create your own on-demand snapshots), storing your data securely in the cloud.
Backups are saved in the storage bucket of the cloud provider in the same region as your Neo4j Aura instance.
|Backups, automated and manual, are stored separately from your instance's allocated storage.
These are saved in the cloud provider's storage bucket in the same region as your Aura instance.

Options for adjustable storage are available for AuraDB pre-paid billing on GCP, Neo4j latest version.
See xref:managing-instances/instance-actions.adoc#_adjustable_storage[Adjustable storage] for more information.

|Encryption key
|Neo4j Managed Key encrypts your data
Expand Down
9 changes: 6 additions & 3 deletions modules/ROOT/pages/managing-instances/instance-resources.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -14,12 +14,15 @@ If this metric is constantly spiking or at its limits, select `resize` on the in

== Storage

Amount of disk space reserved to store user database data, in bytes.
Amount of disk space reserved to store data, in gigabytes (GB).
Ideally, the database should all fit into memory (page cache) for the best performance.
Keep an eye on this metric to make sure you have enough storage for today and for future growth.
Keep an eye on storage metrics to make sure you have enough storage for future growth.
This metric is available in *Metrics > Resources > Storage*.
Check this metric with page cache usage to see if the data is too large for the memory and consider increasing the size of your instance in this case.

Storage is adjustable independent of memory for AuraDB pre-paid plans on GCP, Neo4j latest version. See xref:managing-instances/instance-actions.adoc#_adjustable_storage[Adjustable storage] for more information.

== Query Executions

The total number of Out of Memory Errors for the instance.
Consider increasing the size of the instance if any OOM errors.
Consider increasing the size of the instance if any OOM errors.