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
21 changes: 7 additions & 14 deletions modules/ROOT/pages/auradb/managing-databases/advanced-metrics.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,8 @@
= Advanced metrics
:description: This section describes advanced metrics.
:page-aliases: all-metrics.adoc
:page-role: aura-db-professional aura-db-business-critical aura-db-dedicated

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

Advanced metrics is a feature that enables access to a broad range of different instance and database metrics.

Expand Down Expand Up @@ -39,11 +37,9 @@ When viewing metrics, you can select from the following time intervals:
Memory and storage charts can be toggled between absolute and relative values using the *%* toggle.
====

=== Toggle data series

label:AuraDB-Professional[]
label:AuraDB-Business-Critical[]
label:AuraDB-Virtual-Dedicated-Cloud[]
[role=label--aura-db-professional label--aura-db-business-critical label--aura-db-dedicated]
=== Toggle data series

To hide or show individual data series, select the corresponding data series in the legend below the chart.

Expand All @@ -68,10 +64,9 @@ For some metrics it also provides hints about possible actions to take if that m

* *Reset zoom* - If the zoom level has been altered by selecting and dragging across a chart, *Reset zoom* resets the zoom back to the selected interval.

== Aggregations

label:AuraDB-Business-Critical[]
label:AuraDB-Virtual-Dedicated-Cloud[]
[role=label--aura-db-business-critical label--aura-db-dedicated]
== Aggregations

Most metrics will have several values for a given timestamp because of the following reasons:

Expand All @@ -88,11 +83,9 @@ The possible aggregations are:
* *Average* - The average value of the metric across all cluster members.
* *Sum* - The sum of the metric across all cluster members.

== Detail view

label:AuraDB-Professional[]
label:AuraDB-Business-Critical[]
label:AuraDB-Virtual-Dedicated-Cloud[]
[role=label--aura-db-professional label--aura-db-business-critical label--aura-db-dedicated]
== Detail view

An Aura instance can run on multiple servers to achieve availability and workload scalability.
These servers are deployed across different Cloud Provider availability zones in the user-selected region.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,11 +22,9 @@ Snapshots are available for 7 days for AuraDB Professional instances, 30 days f

== Snapshot types

=== Scheduled

label:AuraDB-Professional[]
label:AuraDB-Business-Critical[]
label:AuraDB-Virtual-Dedicated-Cloud[]
[role=label--aura-db-professional label--aura-db-business-critical label--aura-db-dedicated]
=== Scheduled

A *Scheduled* snapshot is a snapshot that is automatically triggered when you first create an instance, when changes to the underlying system occur (for example, a new patch release), and at a cadence depending on your plan type.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,8 @@
[[aura-custom-endpoints]]
= Custom endpoints
:description: This section describes custom endpoints.
:page-role: aura-db-professional aura-db-business-critical aura-db-dedicated

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

Custom endpoints can be used for database management and migration.

Expand Down
17 changes: 7 additions & 10 deletions modules/ROOT/pages/auradb/managing-databases/database-actions.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,9 @@ To rename an instance:
. Enter a new name for the instance.
. Select *Rename*.

== Reset an instance

label:AuraDB-Free[]
label:AuraDB-Professional[]
[role=label--aura-db-professional label--aura-db-free]
== Reset an instance

You can clear all data in an instance using the *Reset to blank* action.

Expand Down Expand Up @@ -59,11 +58,11 @@ To upgrade a Business Critical instance:
For more information on AuraDB instance creation settings, see xref:auradb/getting-started/create-database.adoc[].
. Tick the *I understand* checkbox and select *Upgrade Instance*.


[role=label--aura-db-professional label--aura-db-dedicated label--aura-db-business-critical]
== Resize an instance

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


You can change the size of an existing instance using the *Resize* action.

Expand All @@ -78,11 +77,9 @@ An instance remains available during the resize operation.

Downward resizing to any size is supported as long as the selected instance size has enough storage capacity for the data.

== Pause an instance

label:AuraDB-Professional[]
label:AuraDB-Virtual-Dedicated-Cloud[]
label:AuraDB-Business-Critical[]
[role=label--aura-db-professional label--aura-db-dedicated label--aura-db-business-critical]
== Pause an instance

[NOTE]
====
Expand Down
9 changes: 2 additions & 7 deletions modules/ROOT/pages/auradb/managing-databases/monitoring.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,8 @@
= Monitoring
:description: This section describes the metrics available in Aura.
:page-aliases: managing-instances/instance-resources.adoc
:page-role: aura-db-professional aura-db-dedicated aura-db-business-critical

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

You can monitor the following metrics of an AuraDB instance from the *Metrics* tab:

Expand All @@ -14,10 +12,7 @@ You can monitor the following metrics of an AuraDB instance from the *Metrics* t
* *Out of Memory Errors* - The number of Out of Memory (OOM) errors encountered by the instance.
* *Garbage Collection Time (%)* - The amount of time the instance spends reclaiming heap space as a percentage.
* *Page Cache Evictions* - The number of times the instance has replaced data in memory.

label:AuraDB-Virtual-Dedicated-Cloud[]

* *Heap Usage (%)* _Only available on AuraDB Virtual Dedicated Cloud_ - The amount of Java Virtual Machine (JVM) memory used by the instance as a percentage.
* label:AuraDB-Virtual-Dedicated-Cloud[] *Heap Usage (%)* _Only available on AuraDB Virtual Dedicated Cloud_ - The amount of Java Virtual Machine (JVM) memory used by the instance as a percentage.

[NOTE]
====
Expand Down
5 changes: 1 addition & 4 deletions modules/ROOT/pages/auradb/managing-databases/regions.adoc
Original file line number Diff line number Diff line change
@@ -1,12 +1,9 @@
[[aura-regions]]
= Regions
:description: This page lists all regions Aura supports deployment in, sorted by subscription plan.
:page-role: aura-db-professional aura-db-business-critical aura-db-dedicated


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

Aura supports the following regions based on your subscription plan:

== Amazon Web Services (AWS)
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
[[auradb-secondaries]]
= Secondaries
:description: This section introduces secondaries for scaling out read workloads.

label:AuraDB-Virtual-Dedicated-Cloud[]
:page-role: aura-db-dedicated

A secondary is a read-only copy of your Aura database.
Secondaries help you scale the read query workload your AuraDB instance is able to serve, by spreading the load evenly across multiple copies of the data.
Expand Down
4 changes: 1 addition & 3 deletions modules/ROOT/pages/aurads/managing-instances/regionsDS.adoc
Original file line number Diff line number Diff line change
@@ -1,9 +1,7 @@
[[regions]]
= Regions
:description: This page lists all regions Aura supports deployment in, sorted by subscription plan.

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


Aura supports the following regions based on your subscription plan:
Expand Down
3 changes: 1 addition & 2 deletions modules/ROOT/pages/platform/api/overview.adoc
Original file line number Diff line number Diff line change
@@ -1,9 +1,8 @@
[[aura-api-overview]]
= Overview
:description: This page introduces the Aura API.
:page-role: aura-db-dedicated aura-ds-enterprise

label:AuraDB-Virtual-Dedicated-Cloud[]
label:AuraDS-Enterprise[]

The Aura API allows you to programmatically perform actions on your Aura instances without the need to log in to the Console.

Expand Down
11 changes: 4 additions & 7 deletions modules/ROOT/pages/platform/cloud-providers.adoc
Original file line number Diff line number Diff line change
@@ -1,11 +1,9 @@
[[aura-cloud-providers]]
= Aura with cloud provider marketplaces

== AuraDB Virtual Dedicated Cloud, AuraDS Enterprise, and AuraDB Business Critical

label:AuraDB-Virtual-Dedicated-Cloud[]
label:AuraDS-Enterprise[]
label:AuraDB-Business-Critical[]
[role=label--aura-db-dedicated label--AuraDS-Enterprise label--aura-db-business-critical]
== AuraDB Virtual Dedicated Cloud, AuraDS Enterprise, and AuraDB Business Critical

You can purchase AuraDB Virtual Dedicated Cloud, AuraDS Enterprise, and AuraDB Business Critical via private offer through the following cloud provider marketplaces:

Expand All @@ -15,10 +13,9 @@ You can purchase AuraDB Virtual Dedicated Cloud, AuraDS Enterprise, and AuraDB B

mailto:[email protected][Contact us] to discuss private offers.

== Aura Professional

label:AuraDB-Professional[]
label:AuraDS-Professional[]
[role=label--aura-db-professional label--AuraDS-Professional]
== Aura Professional

You can purchase Neo4j Aura Professional on a pay-as-you-go basis through the following cloud provider marketplaces:

Expand Down
3 changes: 1 addition & 2 deletions modules/ROOT/pages/platform/consumption-report.adoc
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
[[aura-consumption-report]]
= Consumption report
:description: Consumption reporting allows Virtual Dedicated Cloud customers to closely monitor their consumption.

label:AuraDB-Virtual-Dedicated-Cloud[]
:page-role: aura-db-dedicated

Virtual Dedicated Cloud services are offered through prepaid consumption plans.
Billing is based on usage, with credits deducted from the available balance each month.
Expand Down
5 changes: 2 additions & 3 deletions modules/ROOT/pages/platform/logging/download-logs.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -114,10 +114,9 @@ Downloaded query logs take the form of a zipped JSON file that, when extracted,

|===

== Security logs

label:AuraDB-Virtual-Dedicated-Cloud[]
label:AuraDS-Enterprise[]
[role=label--aura-db-dedicated label--AuraDS-Enterprise]
== Security logs

A security log provides a log of all the security events that have occurred on an instance within a specified time range.

Expand Down
3 changes: 1 addition & 2 deletions modules/ROOT/pages/platform/logging/log-forwarding.adoc
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
[[aura-query-logs]]
= Security log forwarding
:page-role: aura-db-dedicated aura-ds-enterprise

label:AuraDB-Virtual-Dedicated-Cloud[]
label:AuraDS-Enterprise[]

With security log forwarding, you can stream security logs directly to a cloud project owned by your organization, in real time.

Expand Down
4 changes: 1 addition & 3 deletions modules/ROOT/pages/platform/logging/query-log-analyzer.adoc
Original file line number Diff line number Diff line change
@@ -1,9 +1,7 @@
[[aura-monitoring]]
= Query log analyzer
:page-role: aura-db-professional aura-db-business-critical aura-db-dedicated

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

Query log analyzer is a feature that provides a UI to review the queries executed on an Aura instance.

Expand Down
4 changes: 1 addition & 3 deletions modules/ROOT/pages/platform/metrics-integration.adoc
Original file line number Diff line number Diff line change
@@ -1,10 +1,8 @@
[aura-customer-metrics-integration]
= Customer Metrics Integration (CMI)
:table-caption!:
:page-role: aura-db-dedicated aura-ds-enterprise aura-db-business-critical

label:AuraDB-Virtual-Dedicated-Cloud[]
label:AuraDS-Enterprise[]
label:AuraDB-Business-Critical[]

An application performance monitoring system can be configured to fetch metrics of AuraDB instances of types:

Expand Down
5 changes: 2 additions & 3 deletions modules/ROOT/pages/platform/security/encryption.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,9 @@ This ensures all your data stored in any one of these cloud providers uses 256-b
In addition to Aura’s default encryption for data at rest, Customer Managed Keys enable security-conscious enterprises to manage encryption keys through their Cloud Service Provider's Key Management Services (KMS) on Aura, granting control over data protection and access management, including the ability to revoke access from Neo4j.
This allows adherence to strict security policies alongside Aura's default enterprise-grade security measures.

== Customer Managed Keys

label:AuraDB-Virtual-Dedicated-Cloud[]
label:AuraDS-Enterprise[]
[role=label--aura-db-dedicated label--AuraDS-Enterprise]
== Customer Managed Keys

A Customer Managed Key (CMK) gives you more control over key operations than the standard Neo4j encryption.
These are created and managed using a supported cloud key management service (KMS).
Expand Down
24 changes: 10 additions & 14 deletions modules/ROOT/pages/platform/security/secure-connections.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,9 @@
= Secure connections
:description: VPC boundaries enable you to operate within an isolated section of the service.

== VPC isolation

label:AuraDB-Virtual-Dedicated-Cloud[]
label:AuraDS-Enterprise[]
[role=label--aura-db-dedicated label--AuraDS-Enterprise]
== VPC isolation

AuraDB Virtual Dedicated Cloud and AuraDS Enterprise run in a dedicated AWS cloud account, Azure subscription, or GCP project to achieve complete isolation for your deployment.
Additional Virtual Private Cloud (VPC) boundaries enable you to operate within an isolated section of the service, where your processing, networking, and storage are further protected.
Expand Down Expand Up @@ -52,10 +51,9 @@ A single private link connection applies to all instances in a region.
So if you've set one up for `us-east-1` then those network connections will apply to all instances in that region.
You can set up a second private link connection to applications that are hosted in a second region (for example `us-west-1`) but still housed inside the same Aura project.

=== AWS private endpoints

label:AuraDB-Virtual-Dedicated-Cloud[]
label:AuraDS-Enterprise[]
[role=label--aura-db-dedicated label--AuraDS-Enterprise]
=== AWS private endpoints

AuraDB Virtual Dedicated Cloud and AuraDS Enterprise support private endpoints on AWS using https://aws.amazon.com/privatelink[AWS PrivateLink].

Expand Down Expand Up @@ -114,10 +112,9 @@ To enable private endpoints using AWS PrivateLink:
You will need an AWS account with permissions to create, modify, describe and delete endpoints.
Please see the https://docs.aws.amazon.com/vpc/latest/privatelink/vpc-endpoints.html[AWS Documentation] for more information.

=== GCP private endpoints

label:AuraDB-Virtual-Dedicated-Cloud[]
label:AuraDS-Enterprise[]
[role=label--aura-db-dedicated label--AuraDS-Enterprise]
=== GCP private endpoints

AuraDB Virtual Dedicated Cloud and AuraDS Enterprise support private endpoints on GCP using https://cloud.google.com/vpc/docs/private-service-connect[GCP Private Service Connect].

Expand Down Expand Up @@ -172,10 +169,9 @@ To enable private endpoints using GCP Private Service Connect:

Please see the https://cloud.google.com/vpc/docs/configure-private-service-connect-services[GCP Documentation] for required roles and permissions.

=== Azure private endpoints

label:AuraDB-Virtual-Dedicated-Cloud[]
label:AuraDS-Enterprise[]
[role=label--aura-db-dedicated label--AuraDS-Enterprise]
=== Azure private endpoints

AuraDB Virtual Dedicated Cloud and AuraDS Enterprise support private endpoints on Azure using https://azure.microsoft.com/en-us/products/private-link/#overview[Azure Private Link].

Expand Down Expand Up @@ -259,9 +255,9 @@ image::azure_privatelink_03_browser_bloom_over_vpn.png["Accessing Browser and Bl

Please see the link:https://learn.microsoft.com/en-us/azure/private-link/rbac-permissions#private-endpoint[Azure Documentation] for required roles and permissions.

== Private links

label:AuraDB-Virtual-Dedicated-Cloud[]
[role=label--aura-db-dedicated]
== Private links

This private link section is cloud-agnostic and therefore applicable to all clouds.
A private link provides secure network connectivity between your application and AuraDB without exposing traffic to the public internet.
Expand Down
3 changes: 1 addition & 2 deletions modules/ROOT/pages/platform/security/single-sign-on.adoc
Original file line number Diff line number Diff line change
@@ -1,9 +1,8 @@
[[aura-reference-security]]
= Single Sign-On (SSO)
:description: SSO allows you to log in to the Aura Console using their company IdP credentials.
:page-role: aura-db-dedicated aura-ds-enterprise

label:AuraDB-Virtual-Dedicated-Cloud[]
label:AuraDS-Enterprise[]

== SSO levels

Expand Down
1 change: 1 addition & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@
"@neo4j-antora/antora-add-notes": "^0.3.1",
"@neo4j-antora/antora-modify-sitemaps": "^0.4.4",
"@neo4j-antora/antora-table-footnotes": "^0.3.2",
"@neo4j-antora/roles-labels": "^0.1.2",
"@neo4j-documentation/macros": "^1.0.2",
"@neo4j-documentation/remote-include": "^1.0.0",
"antora": "3.1.14",
Expand Down
1 change: 1 addition & 0 deletions preview.yml
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ antora:
- require: "@neo4j-antora/antora-modify-sitemaps"
sitemap_version: 'classic'
move_sitemaps_to_components: true
- "@neo4j-antora/roles-labels"

asciidoc:
extensions:
Expand Down
1 change: 1 addition & 0 deletions publish.yml
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ antora:
- require: "@neo4j-antora/antora-modify-sitemaps"
sitemap_version: '~'
move_sitemaps_to_components: true
- "@neo4j-antora/roles-labels"

asciidoc:
extensions:
Expand Down