You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@devlake.apache.org by he...@apache.org on 2023/01/09 02:12:32 UTC

[incubator-devlake-website] 01/01: docs: add doc on how to manage dashboard access

This is an automated email from the ASF dual-hosted git repository.

hez pushed a commit to branch grafana-access-control
in repository https://gitbox.apache.org/repos/asf/incubator-devlake-website.git

commit bcfc23b505ca6113fa715cda4f938c3162ce3f8e
Author: Hezheng Yin <he...@merico.dev>
AuthorDate: Sun Jan 8 18:12:00 2023 -0800

    docs: add doc on how to manage dashboard access
---
 docs/UserManuals/Dashboards/AccessControl.md       |  44 +++++++++++++++++++++
 static/img/Grafana/add-team-permission.png         | Bin 0 -> 133353 bytes
 .../Grafana/after-remove-default-permissions.png   | Bin 0 -> 103921 bytes
 static/img/Grafana/create-new-folder.png           | Bin 0 -> 77975 bytes
 static/img/Grafana/folder-permission.png           | Bin 0 -> 115416 bytes
 5 files changed, 44 insertions(+)

diff --git a/docs/UserManuals/Dashboards/AccessControl.md b/docs/UserManuals/Dashboards/AccessControl.md
new file mode 100644
index 000000000..2b089b02e
--- /dev/null
+++ b/docs/UserManuals/Dashboards/AccessControl.md
@@ -0,0 +1,44 @@
+---
+title: "Dashboard Access Control"
+sidebar_position: 2
+description: >
+  Dashboard Access Control
+---
+
+
+# Dashboard Access Control
+
+This tutorial shows how to leverage Grafana's role-based access control (RBAC) to manage what dashboards a user has access to. If you're setting up a single DevLake instance to be shared by multiple teams in your organization, this tutorial can help you achieve data segregation between teams.
+
+## Example solution: one folder for each team
+
+One of the simplest solutions is to create one Grafana folder for each team and assign permissions to teams at the folder level. Below is a step-by-step walk through.
+
+1. Sign in as Grafana admin and create a new folder
+
+![create-new-folder](/img/Grafana/create-new-folder.png)
+
+2. Click "Permissions" tab and remove the default access of "Editor (Role)"" and "Viewer (Role)"
+
+![folder-permission](/img/Grafana/folder-permission.png)
+
+After removing default permissions:
+
+![after-remove-default-permissions](/img/Grafana/after-remove-default-permissions.png)
+
+
+3. Add "View" permission to the target team (you'll need to create this team in Grafana first)
+
+![add-team-permission](/img/Grafana/add-team-permission.png)
+
+4. Copy/move dashboards into this folder (you may need to edit the dashboard so that it only shows data belongs to this team)
+
+## Reference
+
+1. [Manage dashboard permissions by Grafana](https://grafana.com/docs/grafana/latest/administration/user-management/manage-dashboard-permissions/#grant-dashboard-folder-permissions)
+
+
+
+
+
+
diff --git a/static/img/Grafana/add-team-permission.png b/static/img/Grafana/add-team-permission.png
new file mode 100644
index 000000000..1185e8d05
Binary files /dev/null and b/static/img/Grafana/add-team-permission.png differ
diff --git a/static/img/Grafana/after-remove-default-permissions.png b/static/img/Grafana/after-remove-default-permissions.png
new file mode 100644
index 000000000..f828a81eb
Binary files /dev/null and b/static/img/Grafana/after-remove-default-permissions.png differ
diff --git a/static/img/Grafana/create-new-folder.png b/static/img/Grafana/create-new-folder.png
new file mode 100644
index 000000000..0e984a381
Binary files /dev/null and b/static/img/Grafana/create-new-folder.png differ
diff --git a/static/img/Grafana/folder-permission.png b/static/img/Grafana/folder-permission.png
new file mode 100644
index 000000000..591f6a618
Binary files /dev/null and b/static/img/Grafana/folder-permission.png differ