You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.adoc
+3-3
Original file line number
Diff line number
Diff line change
@@ -30,7 +30,7 @@ NOTE: The script requires Python 3.
30
30
1. Activate the virtual environment (if not already active): `source venv/bin/activate` (`venv\Scripts\activate` on Windows).
31
31
2. Run `python scripts/manage_instances.py --create INSTANCE_NAME` to create an Aura instance with name _INSTANCE_NAME_, or `python scripts/manage_instances.py --destroy INSTANCE_NAME` to destroy it.
32
32
- You can use the optional parameter `--instance-type` together with `--create` to select the instance type to create (the default is `enterprise-ds`).
33
-
- You can use different tenants using the optional parameter `--tenant` together with `--create` (the default is `gcp`). Every tenant is used with a default region.
33
+
- You can use different projects using the optional parameter `--project` together with `--create` (the default is `gcp`). Every project is used with a default region.
34
34
- Run `python scripts/manage_instances.py --help` for more details on the usage.
35
35
36
36
The script creates an _INSTANCE_NAME_.env file containing the Aura instance credentials.
@@ -39,7 +39,7 @@ The script creates an _INSTANCE_NAME_.env file containing the Aura instance cred
39
39
40
40
This script can be used to extract runnable code (Python or Cypher statements) from a doc HTML page. This means that the docset has to be built first, for example by running `npm run build`.
41
41
42
-
NOTE: The script requires Python 3.
42
+
NOTE: The script requires Python 3.
43
43
44
44
NOTE: AuraDS credentials must be available in an `aura.env` file.
45
45
@@ -58,7 +58,7 @@ NOTE: AuraDS credentials must be available in an `aura.env` file.
58
58
59
59
== Replace partials in an AsciiDoc file
60
60
61
-
Some applications cannot use Asciidoc files that use partials. The `replace_partials.py` script can be used to preprocess an Asciidoc file and replace the `include::partial` lines with the actual content of the referenced partials.
61
+
Some applications cannot use Asciidoc files that use partials. The `replace_partials.py` script can be used to preprocess an Asciidoc file and replace the `include::partial` lines with the actual content of the referenced partials.
Copy file name to clipboardExpand all lines: modules/ROOT/pages/platform/api/authentication.adoc
+3-3
Original file line number
Diff line number
Diff line change
@@ -8,8 +8,8 @@ The Aura API uses OAuth 2.0 for API authentication.
8
8
9
9
[NOTE]
10
10
====
11
-
AuraDB Virtual Dedicated Cloud users, and AuraDS Enterprise users have unrestricted access to creating API credentials.
12
-
However, users with Free and Professional instances must have entered billing information or be a member of a marketplace tenant before they can create API credentials.
11
+
AuraDB Virtual Dedicated Cloud users, and AuraDS Enterprise users have unrestricted access to creating API credentials.
12
+
However, users with Free and Professional instances must have entered billing information or be a member of a marketplace project before they can create API credentials.
13
13
====
14
14
15
15
. Navigate to the https://console.neo4j.io/#account[Neo4j Aura Console Account Details page] in your browser.
@@ -74,7 +74,7 @@ Both the request and response contain sensitive information and must be kept sec
74
74
You are responsible for keeping the client credentials and access tokens confidential, whether in transit (by specifying HTTPS), if stored at rest, in log files, etc.
Copy file name to clipboardExpand all lines: modules/ROOT/pages/platform/consumption-report.adoc
+5-5
Original file line number
Diff line number
Diff line change
@@ -4,13 +4,13 @@
4
4
5
5
label:AuraDB-Virtual-Dedicated-Cloud[]
6
6
7
-
Virtual Dedicated Cloud services are offered through prepaid consumption plans.
7
+
Virtual Dedicated Cloud services are offered through prepaid consumption plans.
8
8
Billing is based on usage, with credits deducted from the available balance each month.
9
9
10
-
The consumption report, accessible in the Aura console’s Billing section, provides real-time insights into resource usage for the current tenant, including both running and paused states.
10
+
The consumption report, accessible in the Aura console’s Billing section, provides real-time insights into resource usage for the current project, including both running and paused states.
11
11
It displays RAM usage in GB-hours and the equivalent cost in prepaid credits.
12
12
13
-
Available to Admins, the report helps you track usage patterns over time and make informed resource allocation decisions.
13
+
Available to Admins, the report helps you track usage patterns over time and make informed resource allocation decisions.
14
14
Note that it includes primary database usage but **not** secondary database usage.
15
15
16
16
== Monitor consumption in real-time
@@ -21,7 +21,7 @@ The consumption report shows the billing status, which can be `running` meaning
21
21
22
22
=== Billing status
23
23
24
-
Billing status can be `ongoing` or `ended`.
24
+
Billing status can be `ongoing` or `ended`.
25
25
26
26
=== Usage (GB-hours)
27
27
@@ -32,7 +32,7 @@ The total usage for the selected period is displayed in GB-hours, along with the
32
32
== Filters
33
33
34
34
* Filter the usage data by predefined and custom date intervals.
35
-
* Look back for a period of up to 3 months.
35
+
* Look back for a period of up to 3 months.
36
36
* Filter by `Last 24 hours`, `Last 7 days`, `Last 30 days`, `Last 90 days` or a `Custom range`.
Copy file name to clipboardExpand all lines: modules/ROOT/pages/platform/metrics-integration.adoc
+28-22
Original file line number
Diff line number
Diff line change
@@ -23,24 +23,24 @@ Analyzing the metrics data allows users to:
23
23
[aura-cmi-process-overview]
24
24
== Process overview
25
25
26
-
image::process.png[]
26
+
image::process.svg[]
27
27
28
28
[aura-cmi-steps]
29
29
== Detailed steps
30
30
31
-
. Log in to Aura as tenant admin.
31
+
. Log in to Aura as project admin.
32
32
. Make sure there is a dedicated Aura user to use for fetching metrics.
33
33
You can either:
34
34
** Create a new user:
35
35
... In https://console.neo4j.io/#user-management["User Management"^] of Neo4j Aura, invite a new user, selecting "Metrics Integration Reader" as a role.
36
36
image:invite_user.png[]
37
37
... Follow the invitation link and log in to Neo4j Aura.
38
-
... Confirm the tenant membership.
38
+
... Confirm the project membership.
39
39
** Or you can find an existing user in https://console.neo4j.io/#user-management["User Management"^] and change its role to "Metrics Integration Reader" +
40
40
+
41
41
[NOTE]
42
42
====
43
-
Capabilities of users with the role "Metrics Integration Reader" are limited to fetching the metrics and getting a read-only view of the tenant.
43
+
Capabilities of users with the role "Metrics Integration Reader" are limited to fetching the metrics and getting a read-only view of the project.
44
44
====
45
45
. Ensure you are logged in to Aura as the user selected in the previous step.
46
46
In https://console.neo4j.io/#account["Account Details"^], create new Aura API credentials.
@@ -58,20 +58,20 @@ Metrics for a Neo4j Aura instance are only returned if all the following are tru
58
58
59
59
* `Authorization` header of the metrics request contains a valid token.
60
60
* The token was issued for an Aura user with "Metrics Integration Reader" role.
61
-
* Tenant has instances of types `Enterprise (Virtual Dedicated Cloud)` or `Business Critical`.
62
-
* The specified instance belongs to the specified tenant.
61
+
* Project has instances of types `Enterprise (Virtual Dedicated Cloud)` or `Business Critical`.
62
+
* The specified instance belongs to the specified project.
63
63
64
64
[CAUTION]
65
65
====
66
-
The legacy term `Enterprise` is still used within the codebase and API.
67
-
However, in the Aura console and documentation, the AuraDB Enterprise tenant type is now known as AuraDB Virtual Dedicated Cloud.
66
+
The legacy term `Enterprise` is still used within the codebase and API.
67
+
However, in the Aura console and documentation, the AuraDB Enterprise project type is now known as AuraDB Virtual Dedicated Cloud.
68
68
====
69
69
70
70
[aura-cmi-revoke-access-to-metrics]
71
71
.Revoke access to metrics
72
72
73
-
To revoke a user's access to metrics of a specific tenant, remove the user from that tenant in https://console.neo4j.io/#user-management["User Management"^].
74
-
After that, the user still exists but its connection to the tenant is removed.
73
+
To revoke a user's access to metrics of a specific project, remove the user from that project in https://console.neo4j.io/#user-management["User Management"^].
74
+
After that, the user still exists but its connection to the project is removed.
75
75
76
76
[NOTE]
77
77
====
@@ -203,26 +203,32 @@ For details, see link:https://docs.datadoghq.com/agent/?tab=Linux[Datadog Agent
203
203
.Aura API for Metrics Integration
204
204
205
205
* Aura API supports fetching metrics integration endpoints using:
The metrics returned by the integration endpoint are grouped based on the labels provided: `aggregation`, `instance_id`, and `database`.
259
265
260
-
An Aura instance typically runs on multiple servers to achieve availability and workload scalability.
261
-
These servers are deployed across different Cloud Provider availability zones in the user-selected region.
266
+
An Aura instance typically runs on multiple servers to achieve availability and workload scalability.
267
+
These servers are deployed across different Cloud Provider availability zones in the user-selected region.
262
268
263
-
Metrics Integration supports a more granular view of the Aura instance metrics with additional data points for availability zone & instance mode combinations.
269
+
Metrics Integration supports a more granular view of the Aura instance metrics with additional data points for availability zone & instance mode combinations.
264
270
This view can be enabled on demand.
265
271
266
272
[NOTE]
267
273
====
268
-
Contact link:https://support.neo4j.com/[Customer Support] to enable more granular metrics of instances for your tenant.
274
+
Contact link:https://support.neo4j.com/[Customer Support] to enable more granular metrics of instances for your project.
269
275
====
270
276
271
277
[NOTE]
272
278
====
273
-
There may be a delay in more granular metrics being available when a new Aura instance is created.
279
+
There may be a delay in more granular metrics being available when a new Aura instance is created.
274
280
This is because of the way 'availability zone' data is collected.
Copy file name to clipboardExpand all lines: modules/ROOT/pages/platform/security/secure-connections.adoc
+8-8
Original file line number
Diff line number
Diff line change
@@ -15,26 +15,26 @@ The Aura Console runs in a separate VPC, separate from the rest of Aura.
15
15
16
16
== Network access
17
17
18
-
An Aura instance can be publicly available, completely private, or both.
18
+
An Aura instance can be publicly available, completely private, or both.
19
19
To configure this, you need to be authorized to access the part of the infrastructure that runs and handles these instances as well as the networking used to establish secure connections between the database and the application's VPC.
20
20
This includes the ability to connect over the cloud provider's private link and private endpoint.
21
21
22
-
If your Aura instances are public, traffic to them is allowed to traverse the public internet and they are accessible with the correct username and password.
22
+
If your Aura instances are public, traffic to them is allowed to traverse the public internet and they are accessible with the correct username and password.
23
23
24
24
For your instance to be completely private, turn public traffic off, use the cloud provider's network, and create a private endpoint inside your VPC, which gives you a private connection to Aura.
25
-
The only way to connect to your database is from inside your network (your VPC in your AWS/Azure/GCP account) using an internal IP address you choose and DNS records you create.
25
+
The only way to connect to your database is from inside your network (your VPC in your AWS/Azure/GCP account) using an internal IP address you choose and DNS records you create.
26
26
27
27
To select network access settings go to *Aura Console* > *Security* > *Network Access*.
28
28
29
29
== Private endpoints
30
30
31
-
Private endpoints are network interfaces inside your own VPC, which can only be accessed within your private network.
32
-
The cloud provider connects them over their network to Neo4j Aura.
31
+
Private endpoints are network interfaces inside your own VPC, which can only be accessed within your private network.
32
+
The cloud provider connects them over their network to Neo4j Aura.
33
33
By design they are not exposed to the public internet, ensuring that critical services are accessible only through private, secure networks.
34
34
35
-
A single private link connection applies to all instances in a region.
36
-
So if you've set one up for `us-east-1` then those network connections will apply to all instances in that region.
37
-
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 tenant.
35
+
A single private link connection applies to all instances in a region.
36
+
So if you've set one up for `us-east-1` then those network connections will apply to all instances in that region.
37
+
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.
Copy file name to clipboardExpand all lines: modules/ROOT/pages/platform/security/single-sign-on.adoc
+11-6
Original file line number
Diff line number
Diff line change
@@ -8,7 +8,8 @@ label:AuraDB-Business-Critical[]
8
8
9
9
== SSO levels
10
10
11
-
Organization admins can configure organization level SSO (org SSO) and tenant level SSO (tenant SSO).
11
+
Organization admins can configure organization level SSO (org SSO) and project level SSO (project SSO).
12
+
12
13
SSO is a log-in method and access, roles, and permissions are dictated by role-based access control (RBAC).
13
14
14
15
* *Org SSO:* Allows org admins to restrict how users log in when they are trying to access the org.
@@ -20,6 +21,7 @@ It depends on RBAC if the user can access and view or modify data within the dat
20
21
For this level, the role mapping may be used to grant users different levels of access based on a role in their identity provider (IdP).
21
22
It *does not* give access to edit the project settings, for example to edit the project name, network access, or to edit the instance settings such as to rename an instance, or pause and resume.
22
23
24
+
23
25
=== SSO Org level roles
24
26
25
27
The following roles are available at the org level and these are assigned via invitation:
@@ -144,6 +146,7 @@ The following roles are available at the org level and these are assigned via in
144
146
|
145
147
|===
146
148
149
+
147
150
== Log-in methods
148
151
149
152
Log-in methods are different for each SSO level.
@@ -158,14 +161,14 @@ Administrators can configure a combination of one or more of the log-in methods.
158
161
159
162
An organization's administrator can add Aura as a log-in from a tile in an organization's Apps Dashboard.
160
163
161
-
*Tenant SSO supports:*
164
+
*Project SSO supports:*
162
165
163
166
* User/password
164
167
* Okta
165
168
* Microsoft Entra ID
166
169
167
-
However, at the tenant level you cannot disable user/password,
168
-
but at the org level you can disable email/password and Google SSO as long as you have at least one other custom SSO provider configured.
170
+
171
+
However, at the project level you cannot disable user/password, but at the org level you can disable email/password and Google SSO as long as you have at least one other custom SSO provider configured.
169
172
170
173
== Setup requirements
171
174
@@ -188,6 +191,8 @@ Support can assist with:
188
191
189
192
If you require support assistance, visit link:https://support.neo4j.com/[Customer Support] and raise a support ticket including the following information:
190
193
191
-
. The _Tenant ID_ of the tenants you want to use SSO for.
192
-
See xref:platform/user-management.adoc#_tenants[Tenants] for more information on how to find your __Tenant ID__.
194
+
195
+
. The _Project ID_ of the projects you want to use SSO for.
196
+
See xref:platform/user-management.adoc#_projects[Projects] for more information on how to find your __Project ID__.
0 commit comments