Skip to content

CMI: Fix role names and add a note about permissions for editing config #591

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.

Sign up for GitHub

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

Merged
merged 3 commits into from
Feb 3, 2025
Merged

CMI: Fix role names and add a note about permissions for editing config #591

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
631634d
fix role names and add a note about permissions
alexnb Jan 31, 2025
dcdf361
be consistent with role names
alexnb Jan 31, 2025
2a1368d
use "Metrics Reader" because the UI shows "METRICS_READER"
alexnb Jan 31, 2025
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
2 changes: 1 addition & 1 deletion modules/ROOT/pages/metrics/metrics-integration/introduction.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ Detailed Aura CMI setup steps & APM integration examples are described in next c
Metrics for a Neo4j Aura instance are only returned if all the following are true:

* `Authorization` header of the metrics request contains a valid token.
* The token was issued for an Aura user with "Metrics Integration Reader" role.
* The token was issued for an Aura user with _Metrics Reader_ role.
* Project has instances of types `Enterprise (Virtual Dedicated Cloud)` or `Business Critical`.
* The specified instance belongs to the specified project.

Expand Down
11 changes: 8 additions & 3 deletions modules/ROOT/pages/metrics/metrics-integration/process.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,17 +18,17 @@ Metrics integration is a two step process:
. Make sure there is a dedicated Aura user to use for fetching metrics.
You can either:
** Create a new user:
... Invite a new user, selecting "Metrics Integration Reader" as a role in `Project > Users`.
... Invite a new user, selecting _Metrics Reader_ as a role in `Project > Users`.
... Follow the invitation link and log in to Neo4j Aura.
... Confirm the project membership.
** Or you can find an existing user in `Project > Users` and change its role to "Metrics Integration Reader"
** Or you can find an existing user in `Project > Users` and change its role to _Metrics Reader_
. Ensure you are logged in to Aura as the user selected in the previous step.
In `Account > API Keys`, create new Aura API credentials.
Save client secret.

[NOTE]
====
Capabilities of users with the role "Metrics Integration Reader" are limited to fetching the metrics and getting a read-only view of the project.
Capabilities of users with the role _Metrics Reader_ are limited to fetching the metrics and getting a read-only view of the project.
====

[aura-cmi-apm-integration]
Expand All @@ -45,6 +45,11 @@ image::cmi_apm_config_input.png[]
[[cmi-endpoint-config]]
== Metrics endpoint configuration

[NOTE]
====
To change the metrics endpoint configuration, you need to have the _Project Admin_ role in the project.
====

Aura Metrics Integration setup offers two types of metrics endpoints to endpoint Aura instance metrics:

- **Project metrics endpoint** - A single endpoint with Project level endpoint configuration that allows selecting which instance metrics to include.
Expand Down
2 changes: 1 addition & 1 deletion modules/ROOT/pages/user-management.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ Users within a project can be assigned one of the following roles:
* _Project Admin_
* _Project Member_
* _Project Viewer_
* _Project Metrics Integration Reader_
* _Metrics Reader_

:check-mark: icon:check[]

Expand Down