Skip to content

Commit 8b4cae0

Browse files
recrwplayfiquick
andauthored
Replace labels with roles and add roles-labels extension (#848)
Co-authored-by: Fi Quick <[email protected]>
1 parent 5ae66c4 commit 8b4cae0

32 files changed

+99
-157
lines changed

modules/ROOT/pages/billing.adoc

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,7 @@
11
[[aura-Billing]]
22
= Billing
33
:description: Consumption reporting allows customers to monitor their billing and credit consumption.
4-
5-
label:Aura-DB-Professional[]
6-
label:AuraDB-Business-Critical[]
7-
label:AuraDB-Virtual-Dedicated-Cloud[]
4+
:page-role: aura-db-professional aura-db-business-critical aura-db-dedicated
85

96
Neo4j offers cloud services through two billing models. Prepaid consumption plans, where credits are deducted from the available balance each month.
107
Or pay-as-you-go, where usage is invoiced and charged on your credit card monthly in arrears.

modules/ROOT/pages/cloud-providers.adoc

Lines changed: 6 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,8 @@
22
= Aura with cloud provider marketplaces
33
:description: This page proved information about Neo4j Aura with cloud marketplaces.
44
:page-aliases: platform/cloud-providers.adoc
5+
// :page-role: aura-db-dedicated aura-ds-enterprise aura-db-business-critical
56

6-
// label:AuraDB-Virtual-Dedicated-Cloud[]
7-
// label:AuraDS-Enterprise[]
8-
// label:AuraDB-Business-Critical[]
97

108
You can subscribe to Neo4j Aura from cloud provider marketplaces.
119
Your subscription gets billed together with other services that you're already using, and can contribute towards your spend commitment with cloud providers.
@@ -24,8 +22,7 @@ Credits from cloud marketplace providers cannot be used for payment towards Neo4
2422
====
2523

2624

27-
label:AuraDB-Professional[]
28-
25+
[role=label--aura-db-professional]
2926
== AWS Marketplace
3027

3128
=== Pay-as-you-go
@@ -60,8 +57,7 @@ You need to ensure that the marketplace organization is selected before you star
6057
mailto:[email protected][Contact us] to discuss private offers.
6158

6259

63-
label:AuraDB-Professional[]
64-
60+
[role=label--aura-db-professional]
6561
== Azure Marketplace
6662

6763
=== Pay-as-you-go
@@ -93,9 +89,7 @@ You need to ensure that the marketplace organization is selected before you star
9389

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

96-
label:AuraDB-Professional[]
97-
label:AuraDB-Business-Critical[]
98-
92+
[role=label--aura-db-professional label--aura-db-business-critical]
9993
== Google Cloud Marketplace
10094

10195
=== Pay-as-you-go
@@ -121,8 +115,8 @@ After signing up to Neo4j Aura, two organizations are provisioned for you: a mar
121115
You need to ensure that the marketplace organization is selected before you start to deploy Neo4j.
122116
====
123117

124-
label:AuraDB-Professional[]
125118
[[legacy-subscription]]
119+
[role=label--aura-db-professional]
126120
=== Legacy pay-as-you-go subscriptions
127121

128122
If you subscribed to Neo4j Aura on the Google Cloud marketplace prior to September 19, 2025, you are running on a legacy marketplace subscription.
@@ -133,8 +127,8 @@ You can still log into the link:https://console.neo4j.io[Neo4j Aura console] dir
133127
Note that new users who need access to your existing Neo4j Aura GCP marketplace organization need to be added from the xref:user-management.adoc[User Management] settings within the Aura console.
134128
New users *cannot* be added directly via _Manage on provider_ from the Google Cloud console from the legacy GCP marketplace listing.
135129

136-
label:AuraDB-Professional[]
137130
[[update-legacy]]
131+
[role=label--aura-db-professional]
138132
=== Update your legacy subscriptions
139133

140134
. Subscribe to the new link:https://console.cloud.google.com/marketplace/product/neo4j-mp-public/neo4j-aura[Neo4j Aura marketplace listing on Google Cloud]

modules/ROOT/pages/graph-analytics/index.adoc

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,11 @@ If your data is in Aura or you plan to move it to Aura, you have several options
1212

1313
If your data is in a self-managed Neo4j DBMS or a non-Neo4j data source, you can still use <<aura-gds-serverless, Aura Graph Analytics>>.
1414

15+
1516
[[aura-gds-plugin]]
17+
[role=label--aura-db-professional]
1618
== Graph Analytics plugin
1719

18-
label:AuraDB-Professional[]
19-
2020
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:
2121

2222
* Neo4j version 5 or later
@@ -28,6 +28,7 @@ It can also be changed with the link:https://neo4j.com/docs/aura/platform/api/sp
2828

2929
The plugin shares compute and memory resources with the AuraDB server, so you do not incur any additional costs when you enable it.
3030

31+
3132
[[get-started-plugin]]
3233
=== Getting started
3334

@@ -36,6 +37,7 @@ With the Graph Analytics plugin enabled:
3637
* If you use the Neo4j Browser or run Cypher queries through a Neo4j driver, start with the link:{neo4j-docs-base-uri}/graph-data-science/current/getting-started/[Graph Data Science] tutorials.
3738
* If you use Python, start with the link:{neo4j-docs-base-uri}/graph-data-science-client/current/tutorials/tutorials/[Python client tutorials].
3839

40+
3941
[[aura-gds-serverless]]
4042
== Aura Graph Analytics
4143

@@ -45,9 +47,9 @@ It runs in Aura as a link:{gds-sessions-page}[dedicated service] optimised for a
4547
You can enable, disable, and configure Aura Graph Analytics on the organization level in the xref:visual-tour/index.adoc#graph-analytics-org-settings[organization settings].
4648
The details on any running sessions are available in the xref:visual-tour/index.adoc#graph-analytics-page[Graph Analytics] page.
4749

48-
=== From an AuraDB instance
4950

50-
label:AuraDB-Professional[] label:AuraDB-Business-Critical[] label:AuraDB-Virtual-Dedicated-Cloud[]
51+
[role=label--aura-db-professional label--aura-db-business-critical label--aura-db-dedicated]
52+
=== From an AuraDB instance
5153

5254
[IMPORTANT]
5355
====
@@ -70,11 +72,11 @@ With the Aura API credentials available:
7072
* If you use Python, start with one of the Python client tutorials depending on whether your data is in
7173
link:{neo4j-docs-base-uri}/graph-data-science-client/current/tutorials/graph-analytics-serverless/[AuraDB], in a link:{neo4j-docs-base-uri}//graph-data-science-client/current/tutorials/graph-analytics-serverless-self-managed/[self-managed Neo4j database], or a link:{neo4j-docs-base-uri}//graph-data-science-client/current/tutorials/graph-analytics-serverless-standalone/[non-Neo4j data source].
7274

75+
7376
[[aura-ds]]
77+
[role=label--aura-ds-professional label--aura-ds-enterprise]
7478
== AuraDS
7579

76-
label:AuraDS-Professional[] label:AuraDS-Enterprise[]
77-
7880
AuraDS is the fully managed version of the Graph Data Science library where the <<aura-gds-plugin>> is deployed by default.
7981

8082
In an AuraDS instance, Graph Analytics is always on.

modules/ROOT/pages/logging/download-logs.adoc

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -114,10 +114,9 @@ Downloaded query logs take the form of a zipped JSON file that, when extracted,
114114

115115
|===
116116

117-
== Security logs
118117

119-
label:AuraDB-Enterprise[]
120-
label:AuraDS-Enterprise[]
118+
[role=label--AuraDB-Enterprise label--aura-ds-enterprise]
119+
== Security logs
121120

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

modules/ROOT/pages/logging/log-downloads.adoc

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,7 @@
77
:max-request-hours: 24
88
:role-project-admin: Project Admin
99
:role-project-member: Project Member
10-
11-
label:AuraDB-Professional[]
12-
label:AuraDB-Virtual-Dedicated-Cloud[]
10+
:page-role: aura-db-professional aura-db-dedicated
1311

1412
Downloading logs requires a role of either _{role-project-admin}_ or _{role-project-member}_.
1513

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

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,8 @@
11
[[aura-query-logs]]
22
= Log forwarding
33
:page-aliases: platform/logging/log-forwarding.adoc
4+
:page-role: aura-db-business-critical aura-db-dedicated aura-ds-enterprise
45

5-
label:AuraDB-Business-Critical[]
6-
label:AuraDB-Virtual-Dedicated-Cloud[]
7-
label:AuraDS-Enterprise[]
86

97
With log forwarding, you can stream logs directly to a cloud project owned by your organization, in real time.
108
The following types of logs are available:
@@ -48,9 +46,9 @@ Exhaustive instructions are provided in the wizard which appears by following th
4846

4947
. Navigate to the *Log forwarding* page as described above.
5048
. Use *Configure log forwarding* and select the scope for log forwarding.
51-
* label:AuraDB-Business-Critical[] A specific instance will have its logs forwarded.
52-
* label:AuraDB-Virtual-Dedicated-Cloud[] All instances in the selected region will have their logs forwarded.
53-
* label:AuraDS-Enterprise[] All instances in the selected region will have their logs forwarded.
49+
* label:AuraDB-business-critical[] A specific instance will have its logs forwarded.
50+
* label:AuraDB-virtual-dedicated-cloud[] All instances in the selected region will have their logs forwarded.
51+
* label:AuraDS-enterprise[] All instances in the selected region will have their logs forwarded.
5452
. Select the type of logs to forward: *Security logs* or *Query logs*.
5553
* For query logs, it is possible to apply certain filters to decrease the volume of forwarded data.
5654
. Follow the instructions specific to your cloud provider.

modules/ROOT/pages/logging/query-log-analyzer.adoc

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,7 @@
44
:page-alisases: platform/logging/query-log-analyzer.adoc
55
:log-retention-days: 30
66
:max-request-hours: 24
7-
8-
label:AuraDB-Professional[]
9-
label:AuraDB-Business-Critical[]
10-
label:AuraDB-Virtual-Dedicated-Cloud[]
7+
:page-role: aura-db-professional aura-db-business-critical aura-db-dedicated
118

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

modules/ROOT/pages/logging/security-log-analyzer.adoc

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,9 @@
1-
:log-retention-days: 30
2-
:max-request-hours: 24
3-
41
[[aura-monitoring]]
52
= Security log analyzer
3+
:log-retention-days: 30
4+
:max-request-hours: 24
5+
:page-role: aura-db-professional aura-db-business-critical aura-db-dedicated
66

7-
label:AuraDB-Professional[]
8-
label:AuraDB-Business-Critical[]
9-
label:AuraDB-Virtual-Dedicated-Cloud[]
107

118
Security log analyzer is a feature that provides a UI to review the security events on an Aura instance.
129

modules/ROOT/pages/managing-instances/advanced-metrics.adoc

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
11
[[aura-monitoring]]
22
= Advanced metrics
3+
:page-role: AuraDB-Enterprise aura-db-professional
34

4-
label:AuraDB-Professional[]
5-
label:AuraDB-Enterprise[]
65

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

@@ -36,24 +35,27 @@ When viewing metrics, you can select from the following time intervals:
3635
Memory and storage charts can be toggled between absolute and relative values using the *%* toggle.
3736
====
3837

39-
=== Toggle data series
4038

41-
label:AuraDB-Enterprise[]
39+
[role=label--AuraDB-Enterprise]
40+
=== Toggle data series
4241

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

44+
4545
=== Zoom
4646

4747
To zoom in to a narrower time interval, select and drag inside any chart to select your desired time interval.
4848
The data will automatically update to match the increased resolution.
4949

5050
To reset zoom, double-click anywhere inside the chart or use the option in the context menu.
5151

52+
5253
=== Expand
5354

5455
Any chart can be expanded to take up all the available screen estate by clicking the *expand* button (shown as two opposing arrows).
5556
To exit this mode, click the *x* button on the expanded view.
5657

58+
5759
=== Context menu
5860

5961
To access the chart context menu, select the *...* button on any chart.
@@ -63,9 +65,9 @@ For some metrics it also provides hints about possible actions to take if that m
6365

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

66-
== Aggregations
6768

68-
label:AuraDB-Enterprise[]
69+
[role=label--AuraDB-Enterprise]
70+
== Aggregations
6971

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

@@ -82,12 +84,15 @@ The possible aggregations are:
8284
* *Average* - The average value of the metric across all cluster members.
8385
* *Sum* - The sum of the metric across all cluster members.
8486

87+
8588
== Store size metrics
8689

90+
8791
=== Resources tab
8892

8993
The chart on the _Resources_ tab shows the allocated store size metric for the selected database either as a percentage of the available storage assigned for the database or as absolute values.
9094

95+
9196
=== Database tab
9297

9398
The _Database_ tab provides a chart that shows the store size and the portion of the allocated space that the database is actively utilizing.

modules/ROOT/pages/managing-instances/backup-restore-export.adoc

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -17,32 +17,31 @@ See <<snapshot-details>> for more information.
1717
Aura stores the data securely in encrypted cloud storage buckets.
1818
Backups are stored in the same Cloud Service Provider and region as the instance they are associated with.
1919

20+
2021
== Snapshot types
2122

22-
=== Scheduled
2323

24-
label:AuraDB-Professional[]
25-
label:AuraDB-Business-Critical[]
26-
label:AuraDB-Virtual-Dedicated-Cloud[]
27-
label:AuraDS-Professional[]
28-
label:AuraDS-Enterprise[]
24+
[role=label--aura-db-professional label--aura-db-business-critical label--aura-db-dedicated label--aura-ds-professional label--aura-ds-enterprise]
25+
=== Scheduled
2926

3027
A *Scheduled* snapshot is a snapshot that is automatically triggered at a cadence depending on your tier.
3128

3229
For Professional instances running the latest version, scheduled snapshots are run automatically once a day, same for both AuraDS Professional and for AuraDS Enterprise instances, For Business Critical and Virtual Dedicated Cloud instances, they run once an hour.
3330
See <<snapshot-details>> further on for information about frequency, restorability, and exportability of scheduled snapshots, as well snapshots on instances running version 4.x.
3431

32+
3533
=== On Demand
3634

3735
An *On Demand* snapshot is a snapshot that you manually trigger with the *Take snapshot* button.
3836
This type of snapshot is the only snapshot available for Free instances.
3937

38+
4039
== Snapshot actions
4140

4241
image::snapshot-actions.png[width=400]
4342

44-
[[export-create]]
4543

44+
[[export-create]]
4645
=== Export / Create
4746

4847
From the more menu (...) next to an existing snapshot, you can:

0 commit comments

Comments
 (0)