centralcloud/oncall-engine
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

[DOCS] fix column ordering in RBAC roles tables (#3715)

Browse source 
# Which issue(s) this PR fixes

Column ordering was mixed up.

**Before**
<img width="1345" alt="Screenshot 2024-01-18 at 11 10 25"
src="https://github.com/grafana/oncall/assets/9406895/106774df-be36-48df-be71-6ebe67d155d1">

**After**
<img width="818" alt="Screenshot 2024-01-18 at 11 16 07"
src="https://github.com/grafana/oncall/assets/9406895/adca446b-5ab4-47e8-8ff3-0956f6a6b8ec">
This commit is contained in:
Joey Orlando 2024-01-18 16:28:53 -05:00 • committed by GitHub
parent ddd71a81d7
commit 15a9a6cd69
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 32 additions and 32 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

62
docs/sources/user-and-team-management/_index.md
View file

@ -60,37 +60,37 @@ objects specific groups of users can see (see ["Manage Teams in Grafana OnCall"]
<!-- markdownlint-disable MD033 -->
| Role | Description | Granted Actions | Basic Roles Granted To |
| ---------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| Admin | Read/write access to everything in OnCall | Grafana Admin, Admin | `grafana-oncall-app.alert-groups:read`<br /><br />`grafana-oncall-app.alert-groups:write`<br /><br />`grafana-oncall-app.alert-groups:direct-paging`<br /><br />`grafana-oncall-app.integrations:read`<br /><br />`grafana-oncall-app.integrations:write`<br /><br />`grafana-oncall-app.integrations:test`<br /><br />`grafana-oncall-app.escalation-chains:read`<br /><br />`grafana-oncall-app.escalation-chains:write`<br /><br />`grafana-oncall-app.schedules:read`<br /><br />`grafana-oncall-app.schedules:write`<br /><br />`grafana-oncall-app.schedules:export`<br /><br />`grafana-oncall-app.chatops:read`<br /><br />`grafana-oncall-app.chatops:write`<br /><br />`grafana-oncall-app.chatops:update-settings`<br /><br />`grafana-oncall-app.outgoing-webhooks:read`<br /><br />`grafana-oncall-app.outgoing-webhooks:write`<br /><br />`grafana-oncall-app.maintenance:read`<br /><br />`grafana-oncall-app.maintenance:write`<br /><br />`grafana-oncall-app.api-keys:read`<br /><br />`grafana-oncall-app.api-keys:write`<br /><br />`grafana-oncall-app.notifications:read`<br /><br />`grafana-oncall-app.notification-settings:read`<br /><br />`grafana-oncall-app.notification-settings:write`<br /><br />`grafana-oncall-app.user-settings:read`<br /><br />`grafana-oncall-app.user-settings:write`<br /><br />`grafana-oncall-app.user-settings:admin`<br /><br />`grafana-oncall-app.other-settings:read`<br /><br />`grafana-oncall-app.other-settings:write` |
| Editor | Similar to the Admin role, minus the abilities to: create Integrations, create Escalation Chains, create Outgoing Webhooks, update ChatOps settings, update other user's settings, and update general OnCall setings. | Editor | `grafana-oncall-app.alert-groups:read`<br /><br />`grafana-oncall-app.alert-groups:write`<br /><br />`grafana-oncall-app.alert-groups:direct-paging`<br /><br />`grafana-oncall-app.integrations:read`<br /><br />`grafana-oncall-app.integrations:test`<br /><br />`grafana-oncall-app.escalation-chains:read`<br /><br />`grafana-oncall-app.schedules:read`<br /><br />`grafana-oncall-app.schedules:write`<br /><br />`grafana-oncall-app.schedules:export`<br /><br />`grafana-oncall-app.chatops:read`<br /><br />`grafana-oncall-app.chatops:write`<br /><br />`grafana-oncall-app.outgoing-webhooks:read`<br /><br />`grafana-oncall-app.maintenance:read`<br /><br />`grafana-oncall-app.maintenance:write`<br /><br />`grafana-oncall-app.notifications:read`<br /><br />`grafana-oncall-app.notification-settings:read`<br /><br />`grafana-oncall-app.notification-settings:write`<br /><br />`grafana-oncall-app.user-settings:read`<br /><br />`grafana-oncall-app.user-settings:write`<br /><br />`grafana-oncall-app.other-settings:read` |
| Reader | Read-only access to everything in OnCall | Viewer | `grafana-oncall-app.alert-groups:read`<br /><br />`grafana-oncall-app.integrations:read`<br /><br />`grafana-oncall-app.escalation-chains:read`<br /><br />`grafana-oncall-app.schedules:read`<br /><br />`grafana-oncall-app.chatops:read`<br /><br />`grafana-oncall-app.outgoing-webhooks:read`<br /><br />`grafana-oncall-app.maintenance:read`<br /><br />`grafana-oncall-app.notification-settings:read`<br /><br />`grafana-oncall-app.user-settings:read`<br /><br />`grafana-oncall-app.other-settings:read` |
| Notifications Receiver | Grants the ability to receive OnCall alert notifications. By virtue, also grants the user the ability to edit their own OnCall settings. | N/A | `grafana-oncall-app.notifications:read`<br /><br />`grafana-oncall-app.user-settings:write` |
| OnCaller | Grants read access to everything in OnCall. In addition, grants edit access to Alert Groups and Schedules | N/A | `grafana-oncall-app.alert-groups:read`<br /><br />`grafana-oncall-app.alert-groups:write`<br /><br />`grafana-oncall-app.integrations:read`<br /><br />`grafana-oncall-app.escalation-chains:read`<br /><br />`grafana-oncall-app.schedules:read`<br /><br />`grafana-oncall-app.schedules:write`<br /><br />`grafana-oncall-app.chatops:read`<br /><br />`grafana-oncall-app.outgoing-webhooks:read`<br /><br />`grafana-oncall-app.maintenance:read`<br /><br />`grafana-oncall-app.notifications:read`<br /><br />`grafana-oncall-app.notification-settings:read`<br /><br />`grafana-oncall-app.user-settings:read`<br /><br />`grafana-oncall-app.other-settings:read` |
| Alert Groups Reader | Read-only access to OnCall Alert Groups | N/A | `grafana-oncall-app.alert-groups:read` |
| Alert Groups Editor | Read access to OnCall Alert Groups + ability to act on Alert Groups (ie. ack, resolve, etc) | N/A | `grafana-oncall-app.alert-groups:read`<br /><br />`grafana-oncall-app.alert-groups:write` |
| Alert Groups Direct Paging | Grants the ability to be able to manually create new Alert Groups (aka Direct Paging) | N/A | `grafana-oncall-app.alert-groups:direct-paging` |
| Integrations Reader | Read-only access to OnCall Integrations | N/A | `grafana-oncall-app.integrations:read` |
| Integrations Editor | Read/write access to OnCall Integrations | N/A | `grafana-oncall-app.integrations:read`<br /><br />`grafana-oncall-app.integrations:write`<br /><br />`grafana-oncall-app.integrations:test` |
| Escalation Chains Reader | Read-only access to OnCall Escalation Chains | N/A | `grafana-oncall-app.escalation-chains:read` |
| Escalation Chains Editor | Read/write access to OnCall Escalation Chains | N/A | `grafana-oncall-app.escalation-chains:read`<br /><br />`grafana-oncall-app.escalation-chains:write` |
| Schedules Reader | Read-only access to OnCall Schedules | N/A | `grafana-oncall-app.schedules:read` |
| Schedules Editor | Read/write access to OnCall Schedules | N/A | `grafana-oncall-app.schedules:read`<br /><br />`grafana-oncall-app.schedules:write`<br /><br />`grafana-oncall-app.schedules:export` |
| ChatOps Reader | Read-only access to OnCall ChatOps | N/A | `grafana-oncall-app.chatops:read` |
| ChatOps Editor | Read/write access to OnCall ChatOps | N/A | `grafana-oncall-app.chatops:read`<br /><br />`grafana-oncall-app.chatops:write`<br /><br />`grafana-oncall-app.chatops:update-settings` |
| Outgoing Webhooks Reader | Read-only access to OnCall Outgoing Webhooks | N/A | `grafana-oncall-app.outgoing-webhooks:read` |
| Outgoing Webhooks Editor | Read/write access to OnCall Outgoing Webhooks | N/A | `grafana-oncall-app.outgoing-webhooks:read`<br /><br />`grafana-oncall-app.outgoing-webhooks:write` |
| Maintenance Reader | Read-only access to OnCall Maintenance | N/A | `grafana-oncall-app.maintenance:read` |
| Maintenance Editor | Read/write access to OnCall Maintenance | N/A | `grafana-oncall-app.maintenance:read`<br /><br />`grafana-oncall-app.maintenance:write` |
| API Keys Reader | Read-only access to OnCall API Keys | N/A | `grafana-oncall-app.api-keys:read` |
| API Keys Editor | Read/write access to OnCall API Keys. Also grants access to be able to consume the API. | N/A | `grafana-oncall-app.api-keys:read`<br /><br />`grafana-oncall-app.api-keys:write` |
| Notification Settings Reader | Read-only access to OnCall Notification Settings | N/A | `grafana-oncall-app.notification-settings:read` |
| Notification Settings Editor | Read/write access to OnCall Notification Settings | N/A | `grafana-oncall-app.notification-settings:read`<br /><br />`grafana-oncall-app.notification-settings:write` |
| User Settings Reader | Read-only access to own OnCall User Settings | N/A | `grafana-oncall-app.user-settings:read` |
| User Settings Editor | Read/write access to own OnCall User Settings + ability to view basic information about other OnCall users | N/A | `grafana-oncall-app.user-settings:read`<br /><br />`grafana-oncall-app.user-settings:write` |
| User Settings Admin | Read/write access to your own, plus other's OnCall User Settings | N/A | `grafana-oncall-app.user-settings:read`<br /><br />`grafana-oncall-app.user-settings:write`<br /><br />`grafana-oncall-app.user-settings:admin` |
| Settings Reader | Read-only access to OnCall Settings | N/A | `grafana-oncall-app.other-settings:read` |
| Settings Editor | Read/write access to OnCall Settings | N/A | `grafana-oncall-app.other-settings:read`<br /><br />`grafana-oncall-app.other-settings:write` |
| Role | Description | Granted Actions | Basic Roles Granted To |
| ---------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------- |
| Admin | Read/write access to everything in OnCall | `grafana-oncall-app.alert-groups:read`<br /><br />`grafana-oncall-app.alert-groups:write`<br /><br />`grafana-oncall-app.alert-groups:direct-paging`<br /><br />`grafana-oncall-app.integrations:read`<br /><br />`grafana-oncall-app.integrations:write`<br /><br />`grafana-oncall-app.integrations:test`<br /><br />`grafana-oncall-app.escalation-chains:read`<br /><br />`grafana-oncall-app.escalation-chains:write`<br /><br />`grafana-oncall-app.schedules:read`<br /><br />`grafana-oncall-app.schedules:write`<br /><br />`grafana-oncall-app.schedules:export`<br /><br />`grafana-oncall-app.chatops:read`<br /><br />`grafana-oncall-app.chatops:write`<br /><br />`grafana-oncall-app.chatops:update-settings`<br /><br />`grafana-oncall-app.outgoing-webhooks:read`<br /><br />`grafana-oncall-app.outgoing-webhooks:write`<br /><br />`grafana-oncall-app.maintenance:read`<br /><br />`grafana-oncall-app.maintenance:write`<br /><br />`grafana-oncall-app.api-keys:read`<br /><br />`grafana-oncall-app.api-keys:write`<br /><br />`grafana-oncall-app.notifications:read`<br /><br />`grafana-oncall-app.notification-settings:read`<br /><br />`grafana-oncall-app.notification-settings:write`<br /><br />`grafana-oncall-app.user-settings:read`<br /><br />`grafana-oncall-app.user-settings:write`<br /><br />`grafana-oncall-app.user-settings:admin`<br /><br />`grafana-oncall-app.other-settings:read`<br /><br />`grafana-oncall-app.other-settings:write` | Grafana Admin, Admin |
| Editor | Similar to the Admin role, minus the abilities to: create Integrations, create Escalation Chains, create Outgoing Webhooks, update ChatOps settings, update other user's settings, and update general OnCall setings. | `grafana-oncall-app.alert-groups:read`<br /><br />`grafana-oncall-app.alert-groups:write`<br /><br />`grafana-oncall-app.alert-groups:direct-paging`<br /><br />`grafana-oncall-app.integrations:read`<br /><br />`grafana-oncall-app.integrations:test`<br /><br />`grafana-oncall-app.escalation-chains:read`<br /><br />`grafana-oncall-app.schedules:read`<br /><br />`grafana-oncall-app.schedules:write`<br /><br />`grafana-oncall-app.schedules:export`<br /><br />`grafana-oncall-app.chatops:read`<br /><br />`grafana-oncall-app.chatops:write`<br /><br />`grafana-oncall-app.outgoing-webhooks:read`<br /><br />`grafana-oncall-app.maintenance:read`<br /><br />`grafana-oncall-app.maintenance:write`<br /><br />`grafana-oncall-app.notifications:read`<br /><br />`grafana-oncall-app.notification-settings:read`<br /><br />`grafana-oncall-app.notification-settings:write`<br /><br />`grafana-oncall-app.user-settings:read`<br /><br />`grafana-oncall-app.user-settings:write`<br /><br />`grafana-oncall-app.other-settings:read` | Editor |
| Reader | Read-only access to everything in OnCall | `grafana-oncall-app.alert-groups:read`<br /><br />`grafana-oncall-app.integrations:read`<br /><br />`grafana-oncall-app.escalation-chains:read`<br /><br />`grafana-oncall-app.schedules:read`<br /><br />`grafana-oncall-app.chatops:read`<br /><br />`grafana-oncall-app.outgoing-webhooks:read`<br /><br />`grafana-oncall-app.maintenance:read`<br /><br />`grafana-oncall-app.notification-settings:read`<br /><br />`grafana-oncall-app.user-settings:read`<br /><br />`grafana-oncall-app.other-settings:read` | Viewer |
| Notifications Receiver | Grants the ability to receive OnCall alert notifications. By virtue, also grants the user the ability to edit their own OnCall settings. | `grafana-oncall-app.notifications:read`<br /><br />`grafana-oncall-app.user-settings:write` | N/A |
| OnCaller | Grants read access to everything in OnCall. In addition, grants edit access to Alert Groups, Schedules and own settings | `grafana-oncall-app.alert-groups:read`<br /><br />`grafana-oncall-app.alert-groups:write`<br /><br />`grafana-oncall-app.alert-groups:direct-paging`<br /><br />`grafana-oncall-app.integrations:read`<br /><br />`grafana-oncall-app.escalation-chains:read`<br /><br />`grafana-oncall-app.schedules:read`<br /><br />`grafana-oncall-app.schedules:write`<br /><br />`grafana-oncall-app.chatops:read`<br /><br />`grafana-oncall-app.outgoing-webhooks:read`<br /><br />`grafana-oncall-app.maintenance:read`<br /><br />`grafana-oncall-app.notifications:read`<br /><br />`grafana-oncall-app.notification-settings:read`<br /><br />`grafana-oncall-app.user-settings:read`<br /><br />`grafana-oncall-app.user-settings:write`<br /><br />`grafana-oncall-app.other-settings:read` | N/A |
| Alert Groups Reader | Read-only access to OnCall Alert Groups | `grafana-oncall-app.alert-groups:read` | N/A |
| Alert Groups Editor | Read access to OnCall Alert Groups + ability to act on Alert Groups (ie. ack, resolve, etc) | `grafana-oncall-app.alert-groups:read`<br /><br />`grafana-oncall-app.alert-groups:write` | N/A |
| Alert Groups Direct Paging | Grants the ability to be able to manually create new Alert Groups (aka Direct Paging) | `grafana-oncall-app.alert-groups:direct-paging` | N/A |
| Integrations Reader | Read-only access to OnCall Integrations | `grafana-oncall-app.integrations:read` | N/A |
| Integrations Editor | Read/write access to OnCall Integrations | `grafana-oncall-app.integrations:read`<br /><br />`grafana-oncall-app.integrations:write`<br /><br />`grafana-oncall-app.integrations:test` | N/A |
| Escalation Chains Reader | Read-only access to OnCall Escalation Chains | `grafana-oncall-app.escalation-chains:read` | N/A |
| Escalation Chains Editor | Read/write access to OnCall Escalation Chains | `grafana-oncall-app.escalation-chains:read`<br /><br />`grafana-oncall-app.escalation-chains:write` | N/A |
| Schedules Reader | Read-only access to OnCall Schedules | `grafana-oncall-app.schedules:read` | N/A |
| Schedules Editor | Read/write access to OnCall Schedules | `grafana-oncall-app.schedules:read`<br /><br />`grafana-oncall-app.schedules:write`<br /><br />`grafana-oncall-app.schedules:export` | N/A |
| ChatOps Reader | Read-only access to OnCall ChatOps | `grafana-oncall-app.chatops:read` | N/A |
| ChatOps Editor | Read/write access to OnCall ChatOps | `grafana-oncall-app.chatops:read`<br /><br />`grafana-oncall-app.chatops:write`<br /><br />`grafana-oncall-app.chatops:update-settings` | N/A |
| Outgoing Webhooks Reader | Read-only access to OnCall Outgoing Webhooks | `grafana-oncall-app.outgoing-webhooks:read` | N/A |
| Outgoing Webhooks Editor | Read/write access to OnCall Outgoing Webhooks | `grafana-oncall-app.outgoing-webhooks:read`<br /><br />`grafana-oncall-app.outgoing-webhooks:write` | N/A |
| Maintenance Reader | Read-only access to OnCall Maintenance | `grafana-oncall-app.maintenance:read` | N/A |
| Maintenance Editor | Read/write access to OnCall Maintenance | `grafana-oncall-app.maintenance:read`<br /><br />`grafana-oncall-app.maintenance:write` | N/A |
| API Keys Reader | Read-only access to OnCall API Keys | `grafana-oncall-app.api-keys:read` | N/A |
| API Keys Editor | Read/write access to OnCall API Keys. Also grants access to be able to consume the API. | `grafana-oncall-app.api-keys:read`<br /><br />`grafana-oncall-app.api-keys:write` | N/A |
| Notification Settings Reader | Read-only access to OnCall Notification Settings | `grafana-oncall-app.notification-settings:read` | N/A |
| Notification Settings Editor | Read/write access to OnCall Notification Settings | `grafana-oncall-app.notification-settings:read`<br /><br />`grafana-oncall-app.notification-settings:write` | N/A |
| User Settings Reader | Read-only access to own OnCall User Settings | `grafana-oncall-app.user-settings:read` | N/A |
| User Settings Editor | Read/write access to own OnCall User Settings + ability to view basic information about other OnCall users | `grafana-oncall-app.user-settings:read`<br /><br />`grafana-oncall-app.user-settings:write` | N/A |
| User Settings Admin | Read/write access to your own, plus other's OnCall User Settings | `grafana-oncall-app.user-settings:read`<br /><br />`grafana-oncall-app.user-settings:write`<br /><br />`grafana-oncall-app.user-settings:admin` | N/A |
| Settings Reader | Read-only access to OnCall Settings | `grafana-oncall-app.other-settings:read` | N/A |
| Settings Editor | Read/write access to OnCall Settings | `grafana-oncall-app.other-settings:read`<br /><br />`grafana-oncall-app.other-settings:write` | N/A |
<!-- markdownlint-enable MD033 -->

2
docs/sources/user-and-team-management/convert_plugin_json_rbac_roles_into_markdown_table.py
View file

@ -35,6 +35,6 @@ with open("../../../grafana-plugin/src/plugin.json") as ifp:
if idx != num_permissions:
permissions += "<br /><br />"
txt += f"| {role['name']} | {role['description']} | {basic_role_grants} | {permissions}\n"
txt += f"| {role['name']} | {role['description']} | {permissions} | {basic_role_grants}\n"
subprocess.run("pbcopy", text=True, input=txt)