Skip to content

Commit e01fcbd

Browse files
change tenant to project except for aws, gcp, azure tenants (#484)
1 parent 207b79b commit e01fcbd

10 files changed

+130
-82
lines changed

README.adoc

+3-3
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ NOTE: The script requires Python 3.
3030
1. Activate the virtual environment (if not already active): `source venv/bin/activate` (`venv\Scripts\activate` on Windows).
3131
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.
3232
- 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.
3434
- Run `python scripts/manage_instances.py --help` for more details on the usage.
3535

3636
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
3939

4040
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`.
4141

42-
NOTE: The script requires Python 3.
42+
NOTE: The script requires Python 3.
4343

4444
NOTE: AuraDS credentials must be available in an `aura.env` file.
4545

@@ -58,7 +58,7 @@ NOTE: AuraDS credentials must be available in an `aura.env` file.
5858

5959
== Replace partials in an AsciiDoc file
6060

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

6363
NOTE: The script requires Python 3.
6464

modules/ROOT/images/process.svg

+30
Loading

modules/ROOT/pages/platform/api/authentication.adoc

+3-3
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@ The Aura API uses OAuth 2.0 for API authentication.
88

99
[NOTE]
1010
====
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.
1313
====
1414

1515
. 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
7474
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.
7575
====
7676

77-
==== Request examples
77+
==== Request examples
7878

7979
[.tabbed-example]
8080
====

modules/ROOT/pages/platform/consumption-report.adoc

+5-5
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,13 @@
44

55
label:AuraDB-Virtual-Dedicated-Cloud[]
66

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

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.
1111
It displays RAM usage in GB-hours and the equivalent cost in prepaid credits.
1212

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.
1414
Note that it includes primary database usage but **not** secondary database usage.
1515

1616
== Monitor consumption in real-time
@@ -21,7 +21,7 @@ The consumption report shows the billing status, which can be `running` meaning
2121

2222
=== Billing status
2323

24-
Billing status can be `ongoing` or `ended`.
24+
Billing status can be `ongoing` or `ended`.
2525

2626
=== Usage (GB-hours)
2727

@@ -32,7 +32,7 @@ The total usage for the selected period is displayed in GB-hours, along with the
3232
== Filters
3333

3434
* 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.
3636
* Filter by `Last 24 hours`, `Last 7 days`, `Last 30 days`, `Last 90 days` or a `Custom range`.
3737

3838
.Consumption report visual

modules/ROOT/pages/platform/logging/log-forwarding.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ To access *Log forwarding*:
1111
. Navigate to the https://console.neo4j.io/[Neo4j Aura Console] in your browser.
1212
. Select *Log forwarding* from the sidebar menu.
1313

14-
This will display a list of currently configured log forwarding processes for the active tenant.
14+
This will display a list of currently configured log forwarding processes for the active project.
1515

1616
If no log forwarding process is set up, a button to do so is displayed in the center of the page.
1717

modules/ROOT/pages/platform/metrics-integration.adoc

+28-22
Original file line numberDiff line numberDiff line change
@@ -23,24 +23,24 @@ Analyzing the metrics data allows users to:
2323
[aura-cmi-process-overview]
2424
== Process overview
2525

26-
image::process.png[]
26+
image::process.svg[]
2727

2828
[aura-cmi-steps]
2929
== Detailed steps
3030

31-
. Log in to Aura as tenant admin.
31+
. Log in to Aura as project admin.
3232
. Make sure there is a dedicated Aura user to use for fetching metrics.
3333
You can either:
3434
** Create a new user:
3535
... In https://console.neo4j.io/#user-management["User Management"^] of Neo4j Aura, invite a new user, selecting "Metrics Integration Reader" as a role.
3636
image:invite_user.png[]
3737
... Follow the invitation link and log in to Neo4j Aura.
38-
... Confirm the tenant membership.
38+
... Confirm the project membership.
3939
** Or you can find an existing user in https://console.neo4j.io/#user-management["User Management"^] and change its role to "Metrics Integration Reader" +
4040
+
4141
[NOTE]
4242
====
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.
4444
====
4545
. Ensure you are logged in to Aura as the user selected in the previous step.
4646
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
5858

5959
* `Authorization` header of the metrics request contains a valid token.
6060
* 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.
6363

6464
[CAUTION]
6565
====
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.
6868
====
6969

7070
[aura-cmi-revoke-access-to-metrics]
7171
.Revoke access to metrics
7272

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

7676
[NOTE]
7777
====
@@ -203,26 +203,32 @@ For details, see link:https://docs.datadoghq.com/agent/?tab=Linux[Datadog Agent
203203
.Aura API for Metrics Integration
204204

205205
* Aura API supports fetching metrics integration endpoints using:
206-
** endpoint `+/tenants/{tenantId}/metrics-integration+` (for tenant metrics)
206+
** endpoint `+/tenants/{tenantId}/metrics-integration+` (for project metrics)
207207
** JSON property `metrics_integration_url` as part of `+/instances/{instanceId}+` response (for instance metrics)
208208
* Reference: link:https://neo4j.com/docs/aura/platform/api/specification/[Aura API Specification^]
209209

210+
[NOTE]
211+
====
212+
_Project_ replaces _Tenant_ in the console UI and documentation.
213+
However, in the API, `tenant` remains the nomenclature.
214+
====
215+
210216
[aura-cmi-cli-for-metrics-integration]
211217
.Aura CLI for Metrics Integration
212218

213-
* Aura CLI has a subcommand for `tenants` command to fetch tenant metrics endpoint:
219+
* Aura CLI has a subcommand for `tenants` command to fetch project metrics endpoint:
214220
+
215221
[source]
216222
----
217-
aura tenants get-metrics-integration --tenant-id <YOUR_TENANT_ID>
223+
aura projects get-metrics-integration --tenant-id <YOUR_PROJECT_ID>
218224
219225
# example output
220226
{
221-
endpoint: "https://customer-metrics-api.neo4j.io/api/v1/<YOUR_TENANT_ID>/metrics"
227+
endpoint: "https://customer-metrics-api.neo4j.io/api/v1/<YOUR_PROJECT_ID>/metrics"
222228
}
223229
224230
# extract endpoint
225-
aura tenants get-metrics-integration --tenant-id <YOUR_TENANT_ID> | jq '.endpoint'
231+
aura projects get-metrics-integration --project-id <YOUR_PROJECT_ID> | jq '.endpoint'
226232
----
227233

228234
* For instance metrics endpoint, Aura CLI `instances get` command JSON output includes a new property `metrics_integration_url`:
@@ -236,10 +242,10 @@ aura instances get --instance-id <YOUR_INSTANCE_ID>
236242
"id": "id",
237243
"name": "Production",
238244
"status": "running",
239-
"tenant_id": "YOUR_TENANT_ID",
245+
"tenant_id": "YOUR_PROJECT_ID",
240246
"cloud_provider": "gcp",
241247
"connection_url": "YOUR_CONNECTION_URL",
242-
"metrics_integration_url": "https://customer-metrics-api.neo4j.io/api/v1/<YOUR_TENANT_ID>/<YOUR_INSTANCE_ID>/metrics",
248+
"metrics_integration_url": "https://customer-metrics-api.neo4j.io/api/v1/<YOUR_PROJECT_ID>/<YOUR_INSTANCE_ID>/metrics",
243249
"region": "europe-west1",
244250
"type": "enterprise-db",
245251
"memory": "8GB",
@@ -257,20 +263,20 @@ aura instances get --instance-id <YOUR_INSTANCE_ID> | jq '.metrics_integration_u
257263

258264
The metrics returned by the integration endpoint are grouped based on the labels provided: `aggregation`, `instance_id`, and `database`.
259265

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

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.
264270
This view can be enabled on demand.
265271

266272
[NOTE]
267273
====
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.
269275
====
270276

271277
[NOTE]
272278
====
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.
274280
This is because of the way 'availability zone' data is collected.
275281
====
276282

modules/ROOT/pages/platform/security/secure-connections.adoc

+8-8
Original file line numberDiff line numberDiff line change
@@ -15,26 +15,26 @@ The Aura Console runs in a separate VPC, separate from the rest of Aura.
1515

1616
== Network access
1717

18-
An Aura instance can be publicly available, completely private, or both.
18+
An Aura instance can be publicly available, completely private, or both.
1919
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.
2020
This includes the ability to connect over the cloud provider's private link and private endpoint.
2121

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

2424
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.
2626

2727
To select network access settings go to *Aura Console* > *Security* > *Network Access*.
2828

2929
== Private endpoints
3030

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.
3333
By design they are not exposed to the public internet, ensuring that critical services are accessible only through private, secure networks.
3434

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

3939
=== AWS private endpoints
4040

modules/ROOT/pages/platform/security/single-sign-on.adoc

+11-6
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,8 @@ label:AuraDB-Business-Critical[]
88

99
== SSO levels
1010

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+
1213
SSO is a log-in method and access, roles, and permissions are dictated by role-based access control (RBAC).
1314

1415
* *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
2021
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).
2122
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.
2223

24+
2325
=== SSO Org level roles
2426

2527
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
144146
|
145147
|===
146148

149+
147150
== Log-in methods
148151

149152
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.
158161

159162
An organization's administrator can add Aura as a log-in from a tile in an organization's Apps Dashboard.
160163

161-
*Tenant SSO supports:*
164+
*Project SSO supports:*
162165

163166
* User/password
164167
* Okta
165168
* Microsoft Entra ID
166169

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

170173
== Setup requirements
171174

@@ -188,6 +191,8 @@ Support can assist with:
188191

189192
If you require support assistance, visit link:https://support.neo4j.com/[Customer Support] and raise a support ticket including the following information:
190193

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__.
197+
193198
. The name of your IdP

0 commit comments

Comments
 (0)