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
DOC-11529 Docs for sec/authz: refine Roles on CC console (Metrics viewer role on CockroachDB Cloud) (#20329)
- In authorization.md, added sections for Cluster Monitor and Metrics Viewer with limited access note.
- In cloud-roles-table.md, added columns for Cluster Monitor and Metrics Viewer with limited access note, row for View sql activity, and links in column headers.
- In export-metrics-advanced.md, export-metrics.md, export-logs-advanced.md and export-logs.md, added link to Metrics Viewer.
- In insights-page.md, jobs-page.md, sessions-page.md, statements-page.md, transactions-page.md, added link to Cluster Monitor.
- In metrics.md, added link to Metrics Viewer.
- In cockroachdb-feature-availability, added section under limited access for Metrics Viewer and Cluster Monitor roles.
||[Org. Member]({% link cockroachcloud/authorization.md %}#organization-member) |[Org. Admin]({% link cockroachcloud/authorization.md %}#organization-admin) |[Billing Coord.]({% link cockroachcloud/authorization.md %}#billing-coordinator) |[Cluster Creator]({% link cockroachcloud/authorization.md %}#cluster-creator) |[Cluster Operator]({% link cockroachcloud/authorization.md %}#cluster-operator) |[Cluster Admin]({% link cockroachcloud/authorization.md %}#cluster-admin) |[Cluster Developer]({% link cockroachcloud/authorization.md %}#cluster-developer) |[Cluster Monitor]({% link cockroachcloud/authorization.md %}#cluster-monitor)<supid="fnref1"><ahref="#fn1">1</a></sup> |[Metrics Viewer]({% link cockroachcloud/authorization.md %}#metrics-viewer)<supid="fnref1"><ahref="#fn1">1</a></sup> |[Folder Admin]({% link cockroachcloud/authorization.md %}#folder-admin) |[Folder Mover]({% link cockroachcloud/authorization.md %}#folder-mover)|
<aid="fn1"><sup>1</sup></a>**This feature is in [limited access]({% link {{ site.current_cloud_version }}/cockroachdb-feature-availability.md %})** and is only available to enrolled organizations. To enroll your organization, contact your Cockroach Labs account team. This feature is subject to change.
45
47
46
48
Some roles can be assigned to users at specific levels of scope to provide more granular permission control:
|`Organization`| Applies to the entire CockroachDB {{ site.data.products.cloud }} organization, including all clusters and folders |`Cluster Operator`, `Cluster Admin`, `Cluster Creator`, `Cluster Developer`, `Billing Coordinator`, `Organization Admin`, `Folder Admin`, `Folder Mover`|
51
-
|`Folder`| Applies to clusters within a specific [folder]({% link cockroachcloud/folders.md %}). Only available as a selectable scope if folders have been created within the organization by a user with the `Folder Admin` role |`Cluster Operator`, `Cluster Admin`, `Cluster Creator`, `Cluster Developer`, `Folder Admin`, `Folder Mover`|
52
-
|`Cluster`| Applies to a specific cluster |`Cluster Operator`, `Cluster Admin`, `Cluster Developer`|
52
+
|`Organization`| Applies to the entire CockroachDB {{ site.data.products.cloud }} organization, including all clusters and folders |`Cluster Operator`, `Cluster Admin`, `Cluster Creator`, `Cluster Developer`, `Cluster Monitor`, `Metrics Viewer`, `Billing Coordinator`, `Organization Admin`, `Folder Admin`, `Folder Mover`|
53
+
|`Folder`| Applies to clusters within a specific [folder]({% link cockroachcloud/folders.md %}). Only available as a selectable scope if folders have been created within the organization by a user with the `Folder Admin` role |`Cluster Operator`, `Cluster Admin`, `Cluster Creator`, `Cluster Developer`, `Cluster Monitor`, `Metrics Viewer`, `Folder Admin`, `Folder Mover`|
54
+
|`Cluster`| Applies to a specific cluster |`Cluster Operator`, `Cluster Admin`, `Cluster Developer`, `Cluster Monitor`, `Metrics Viewer`|
53
55
54
-
{% if page.name != 'authorization.md' %}For more information on these roles and the specific permissions given, see [Organization user roles]({% link cockroachcloud/authorization.md %}#organization-member).{% endif %}
56
+
{% if page.name != 'authorization.md' %}For more information on these roles and the specific permissions given, see [Organization user roles]({% link cockroachcloud/authorization.md %}#organization-member).{% endif %}
Copy file name to clipboardExpand all lines: src/current/cockroachcloud/authorization.md
+28-1Lines changed: 28 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -132,10 +132,37 @@ This role can be assigned at the scope of the organization or on a folder. If as
132
132
133
133
### Cluster Developer
134
134
135
-
The **Cluster Developer** role allows users view cluster details and access the [DB Console]({% link cockroachcloud/network-authorization.md %}#db-console), allowing them to [export a connection string from the cluster page UI]({% link cockroachcloud/authentication.md %}#the-connection-string), although they will still need a Cluster Admin to [provision their SQL credentials]({% link cockroachcloud/managing-access.md %}#manage-sql-users-on-a-cluster) for the cluster.
135
+
The **Cluster Developer** role allows users to view cluster details and access the [DB Console]({% link cockroachcloud/network-authorization.md %}#db-console), allowing them to [export a connection string from the cluster page UI]({% link cockroachcloud/authentication.md %}#the-connection-string), although they will still need a Cluster Admin to [provision their SQL credentials]({% link cockroachcloud/managing-access.md %}#manage-sql-users-on-a-cluster) for the cluster.
136
136
137
137
This role can be assigned at the scope of the organization, on an individual cluster, or on a folder. If assigned to a folder, it is inherited on the folder's clusters, descendent folders, and their descendants.
138
138
139
+
### Cluster Monitor
140
+
141
+
{{site.data.alerts.callout_info}}
142
+
{% include feature-phases/limited-access.md %}
143
+
{{site.data.alerts.end}}
144
+
145
+
The **Cluster Monitor** role provides read‑only visibility into SQL activity and workload health without broader administrative privileges. Users with this role can view the SQL Activity pages ([Sessions]({% link cockroachcloud/sessions-page.md %}), [Statements]({% link cockroachcloud/statements-page.md %}), and [Transactions]({% link cockroachcloud/transactions-page.md %})), the [Jobs page]({% link cockroachcloud/jobs-page.md %}), and the [Insights page]({% link cockroachcloud/insights-page.md %}).
146
+
147
+
This role can be assigned at the scope of the organization, on an individual cluster, or on a folder. If assigned to a folder, it is inherited on the folder's clusters, descendent folders, and their descendants.
148
+
149
+
### Metrics Viewer
150
+
151
+
{{site.data.alerts.callout_info}}
152
+
{% include feature-phases/limited-access.md %}
153
+
{{site.data.alerts.end}}
154
+
155
+
The **Metrics Viewer** role grants read‑only access to observability metrics for a cluster without any administrative or data‑manipulation privileges.
156
+
157
+
- Users with this role can view a cluster's Metrics from the [Metrics page]({% link cockroachcloud/metrics.md %}#cockroachdb-cloud-console-metrics-page).
158
+
- Service accounts with this role can access the [metrics export API]({% link cockroachcloud/export-metrics.md %}#the-metricexport-endpoint) and the [log export API]({% link cockroachcloud/export-logs.md %}#the-logexport-endpoint) to integrate with external observability systems.
159
+
160
+
This role can be assigned at the scope of the organization, on an individual cluster, or on a folder. If assigned to a folder, it is inherited on the folder's clusters, descendent folders, and their descendants.
161
+
162
+
{{site.data.alerts.callout_info}}
163
+
To give a developer the ability to both connect to a cluster and monitor performance with least privilege, combine [**Cluster Developer**](#cluster-developer) with **Metrics Viewer** (and optionally [**Cluster Monitor**](#cluster-monitor)).
164
+
{{site.data.alerts.end}}
165
+
139
166
### Folder Admin
140
167
141
168
{% capture folder_admin_docs %}{% include cockroachcloud/org-roles/folder-admin.md %}{% endcapture %}
Access to the `metricexport` endpoints requires a valid CockroachDB {{ site.data.products.cloud }} [service account]({% link cockroachcloud/managing-access.md %}#manage-service-accounts) with the appropriate permissions (`admin` privilege, Cluster Admin role, or Cluster Operator role).
30
+
Access to the `metricexport` endpoints requires a valid CockroachDB {{ site.data.products.cloud }} [service account]({% link cockroachcloud/managing-access.md %}#manage-service-accounts) assigned one of the following [roles]({% link cockroachcloud/managing-access.md %}#edit-roles-on-a-service-account):
31
+
32
+
-[Metrics Viewer]({% link cockroachcloud/authorization.md %}#metrics-viewer)
33
+
-[Cluster Operator]({% link cockroachcloud/authorization.md %}#cluster-operator)
34
+
-[Cluster Admin]({% link cockroachcloud/authorization.md %}#cluster-admin)
31
35
32
36
The following methods are available for use with the `metricexport` endpoints, and require the listed service account permissions:
Access to the `metricexport` endpoints requires a valid CockroachDB {{ site.data.products.cloud }} [service account]({% link cockroachcloud/managing-access.md %}#manage-service-accounts) with the appropriate permissions (`admin` privilege or Cluster Admin role).
29
+
Access to the `metricexport` endpoints requires a valid CockroachDB {{ site.data.products.cloud }} [service account]({% link cockroachcloud/managing-access.md %}#manage-service-accounts) assigned one of the following [roles]({% link cockroachcloud/managing-access.md %}#edit-roles-on-a-service-account):
30
+
31
+
-[Metrics Viewer]({% link cockroachcloud/authorization.md %}#metrics-viewer)
32
+
-[Cluster Operator]({% link cockroachcloud/authorization.md %}#cluster-operator)
33
+
-[Cluster Admin]({% link cockroachcloud/authorization.md %}#cluster-admin)
30
34
31
35
The following methods are available for use with the `metricexport` endpoints, and require the listed service account permissions:
0 commit comments