docs: nav updates for user, role, team management (#64965)

* text nav updates

* navigation related updates

* used Connections instead of Administration workflow for add data source steps

* wording edit

* updated data source permissions section

* Apply suggestions from code review and wording edit

* empty commit to trigger linting

* change to trigger linting
pull/62926/head^2
Isabel 2 years ago committed by GitHub
parent cc7e5ce62e
commit 0efa8c5ce1
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
  1. 89
      docs/sources/administration/data-source-management/index.md
  2. 4
      docs/sources/administration/roles-and-permissions/access-control/assign-rbac-roles/index.md
  3. 25
      docs/sources/administration/team-management/index.md
  4. 27
      docs/sources/administration/user-management/manage-dashboard-permissions/index.md
  5. 10
      docs/sources/administration/user-management/manage-org-users/index.md
  6. 23
      docs/sources/administration/user-management/user-preferences/index.md

@ -25,80 +25,52 @@ Before you can create your first dashboard, you need to add your data source.
**To add a data source:** **To add a data source:**
1. Select the cog icon on the side menu to show the configuration options. 1. Click **Connections** in the left-side menu.
1. Select **Data sources**. 1. Enter the name of a specific data source in the search dialog. You can filter by **Data source** to only see data sources.
1. Click the data source you want to add.
This opens the data sources page, which displays a list of previously configured data sources for the Grafana instance.
1. Select **Add data source** to see a list of all supported data sources.
{{< figure src="/static/img/docs/v75/add-data-source-7-5.png" max-width="600px" class="docs-image--no-shadow">}}
1. Enter the name of a specific data source in the search dialog.
You can also scroll through supported data sources grouped into time series, logging, tracing, and other categories.
1. Move the cursor over the data source you want to add.
1. Click **Select**.
This opens the data source configuration page.
1. Configure the data source following instructions specific to that data source. 1. Configure the data source following instructions specific to that data source.
For links to data source-specific documentation, see [Data sources]({{< relref "../../datasources" >}}). For links to data source-specific documentation, see [Data sources]({{< relref "../../datasources" >}}).
## Data source permissions ## Data source permissions
You can configure data source permissions to allow or deny certain users the ability to query a data source. You can configure data source permissions to allow or deny certain users the ability to query or edit a data source. Each data source’s configuration includes a Permissions tab where you can restrict data source permissions to specific users, teams, or roles.
Each data source's configuration includes a permissions page where you can enable permissions and restrict query permissions to specific **Users** and **Teams**.
> **Note:** Available in [Grafana Enterprise]({{< relref "../../introduction/grafana-enterprise/" >}}) and [Grafana Cloud Pro and Advanced](/docs/grafana-cloud). > **Note:** Available in [Grafana Enterprise]({{< relref "../../introduction/grafana-enterprise/" >}}) and [Grafana Cloud Pro and Advanced](/docs/grafana-cloud).
### Enable data source permissions By default, data sources in an organization can be queried by any user in that organization. For example, a user with the `Viewer` role can issue any possible query to a data source, not just queries that exist on dashboards to which they have access. Additionally, by default, data sources can be edited by the user who created the data source, as well as users with the `Admin` role.
By default, data sources in an organization can be queried by any user in that organization. For example, a user with the `Viewer` role can issue any possible query to a data source, not just
queries that exist on dashboards they have access to.
When permissions are enabled for a data source in an organization, the user who created the datasource can edit the datasource and in addition, viewers can query the datasource.
**Enable permissions for a data source:**
1. Navigate to **Configuration > Data Sources**.
1. Select the data source you want to enable permissions for.
1. On the Permissions tab, click **Enable**.
<div class="clearfix"></div> <div class="clearfix"></div>
> **Caution:** Enabling permissions for the default data source makes users not listed in the permissions unable to invoke queries. Panels using default data source will return `Access denied to data source` error for those users. ### Assign data source permissions to users, teams, or roles
### Allow users and teams to query a data source
After you have enabled permissions for a data source you can assign query permissions to users and teams which will allow access to query the data source. You can assign data source permissions to users, teams, and roles which will allow access to query or edit the data source.
**Assign query permission to users and teams:** 1. Navigate to **Administration > Data sources**.
1. Select the data source to which you want to assign permissions.
1. Navigate to **Configuration > Data Sources**. 1. On the Permissions tab, click **Add a permission**.
1. Select the data source you want to assign query permissions to. 1. Select **User**, **Team**, or **Role**.
1. On the **Permissions** tab, click **Add Permission**. 1. Select the entity for which you want to modify permissions.
1. Select **Team**, **User**, or **Role**.
1. Select the entity you want to modify permissions for.
1. Select the **Query** or **Edit** permission. 1. Select the **Query** or **Edit** permission.
1. Click **Save**. 1. Click **Save**.
<div class="clearfix"></div> <div class="clearfix"></div>
### Disable data source permissions ### Edit data source permissions for users, teams, or roles
If you have enabled permissions for a data source and want to return data source permissions to the default, then you can disable permissions with a click of a button. 1. Navigate to **Administration > Data sources**.
1. Select the data source for which you want to edit permissions.
1. On the Permissions tab, find the user, team, or role permission you want to update.
1. Select a different option in the **Permission** dropdown.
Note that _all_ existing permissions created for the data source will be deleted. <div class="clearfix"></div>
**Disable permissions for a data source:** ### Remove data source permissions for users, teams, or roles
1. Navigate to **Configuration > Data Sources**. 1. Navigate to **Administration > Data sources**.
1. Select the data source you want to disable permissions for. 1. Select the data source from which you want to remove permissions.
1. On the Permissions tab, click **Disable Permissions**. 1. On the Permissions tab, find the user, team, or role permission you want to remove.
1. Click the **X** next to the permission.
<div class="clearfix"></div> <div class="clearfix"></div>
@ -150,10 +122,10 @@ You must be an Org admin or Grafana admin to enable query caching for a data sou
By default, data source queries are not cached. To enable query caching for a single data source: By default, data source queries are not cached. To enable query caching for a single data source:
1. On the side menu, click Configuration > Data Sources. 1. On the left-side menu, click **Administration > Data sources**.
1. In the data source list, click the data source that you want to turn on caching for. 1. In the data source list, click the data source that you want to turn on caching for.
1. Open the Cache tab. 1. Open the Cache tab.
1. Press the Enable button. 1. Click **Enable**.
1. (Optional) Choose custom TTLs for the data source's queries and resources caching. If you skip this step, then Grafana uses the default TTL. 1. (Optional) Choose custom TTLs for the data source's queries and resources caching. If you skip this step, then Grafana uses the default TTL.
You can optionally override a data source's configured TTL for individual dashboard panels. This can be be useful when you have queries whose results change more or less often than the configured TTL. In the Edit Panel view, select the caching-enabled data source, expand the Query options, and enter your the TTL in milliseconds. You can optionally override a data source's configured TTL for individual dashboard panels. This can be be useful when you have queries whose results change more or less often than the configured TTL. In the Edit Panel view, select the caching-enabled data source, expand the Query options, and enter your the TTL in milliseconds.
@ -168,9 +140,9 @@ To configure global settings for query caching, refer to the [Query caching sect
To disable query caching for a single data source: To disable query caching for a single data source:
1. On the side menu, click Configuration > Data Sources. 1. On the left-side menu, click **Administration > Data sources**.
1. In the data source list, click the data source that you want to turn off caching for. 1. In the data source list, click the data source that you want to turn off caching for.
1. In the Cache tab, click Disable. 1. In the Cache tab, click **Disable**.
To disable query caching for an entire Grafana instance, set the `enabled` flag to `false` in the [Query caching section of Enterprise Configuration]({{< relref "../../setup-grafana/configure-grafana/enterprise-configuration/#caching" >}}). You will no longer see the Cache tab on any data sources, and no data source queries will be cached. To disable query caching for an entire Grafana instance, set the `enabled` flag to `false` in the [Query caching section of Enterprise Configuration]({{< relref "../../setup-grafana/configure-grafana/enterprise-configuration/#caching" >}}). You will no longer see the Cache tab on any data sources, and no data source queries will be cached.
@ -180,10 +152,9 @@ If you experience performance issues or repeated queries become slower to execut
> **Note:** This action impacts all cache-enabled data sources. If you are using Memcached, the system clears all data from the Memcached instance. > **Note:** This action impacts all cache-enabled data sources. If you are using Memcached, the system clears all data from the Memcached instance.
1. Sign in to Grafana and click **Settings > Data Sources**. 1. On the left-side menu, click **Administration > Data sources**.
1. Select a data source. 1. In the data source list, click the data source that you want to clear the cache for.
1. Click the **Cache** tab. 1. In the Cache tab, click **Clear cache**.
1. Click **Clear cache**.
### Sending a request without cache ### Sending a request without cache

@ -48,8 +48,8 @@ In both cases, the assignment applies only to the user, team or service account
For more information about switching organizations, refer to [Switch organizations]({{< relref "../../../user-management/user-preferences/_index.md#switch-organizations" >}}). For more information about switching organizations, refer to [Switch organizations]({{< relref "../../../user-management/user-preferences/_index.md#switch-organizations" >}}).
3. Hover your cursor over **Configuration** (the gear icon) in the left navigation menu, and click **Users** or **Teams** or **Service Accounts**. 3. In the left-side menu, click **Administration** and then **Users**, **Teams**, or **Service accounts**.
4. In the **Role** column, select the fixed role that you want to assign to the user, team or service account. 4. In the **Role** column, select the fixed role that you want to assign to the user, team, or service account.
5. Click **Update**. 5. Click **Update**.
**To assign a fixed role as a server administrator:** **To assign a fixed role as a server administrator:**

@ -41,12 +41,12 @@ A user can belong to multiple teams.
To create a team: To create a team:
1. Sign in to Grafana as an organization administrator or team administrator. 1. Sign in to Grafana as an organization administrator or team administrator.
1. Hover your cursor over the **Configuration** (gear) icon in the side menu and click **Teams**. 1. Click **Administration** in the left-side menu and select **Teams**.
1. Click **New Team**. 1. Click **New Team**.
1. Complete the fields and click **Create**. 1. Complete the fields and click **Create**.
1. Click **Add member**. 1. Click **Add member**.
1. In the **Add team member** field, locate and select a user. 1. In the **Add member** field, locate and select a user.
1. Click **Add to team**. 1. Click **Save**.
## Add a team member ## Add a team member
@ -55,11 +55,11 @@ Add a team member to an existing team whenever you want to provide access to tea
To add a team member: To add a team member:
1. Sign in to Grafana as an organization administrator. 1. Sign in to Grafana as an organization administrator.
1. Hover your cursor over the **Configuration** (gear) icon in the side menu and click **Teams**. 1. Click **Administration** in the left-side menu and select **Teams**.
1. Click the name of the team to which you want to add members, and click **Add member**. 1. Click the name of the team to which you want to add members, and click **Add member**.
1. Locate and select a user. 1. Locate and select a user.
1. Choose if you want to add the user as a team Member or an Admin. 1. Choose if you want to add the user as a team Member or an Admin.
1. Click **Add to team**. 1. Click **Save**.
## Grant team member permissions ## Grant team member permissions
@ -68,10 +68,10 @@ Complete this task when you want to add or modify team member permissions.
To grant team member permissions: To grant team member permissions:
1. Sign in to Grafana as an organization administrator or a team administrator. 1. Sign in to Grafana as an organization administrator or a team administrator.
1. Hover your cursor over the **Configuration** (gear) icon in the side menu and click **Teams**. 1. Click **Administration** in the left-side menu and select **Teams**.
1. Click the name of the team for which you want to add or modify team member permissions. 1. Click the name of the team for which you want to add or modify team member permissions.
1. In the team member list, find and click the user that you want to change. You can use the search field to filter the list if necessary. 1. In the team member list, find and click the user that you want to change. You can use the search field to filter the list if necessary.
1. Click the **Permission** list, and then click the new user permission level. 1. In the Permission column, select the new user permission level.
## Remove a team member ## Remove a team member
@ -80,10 +80,9 @@ You can remove a team member when you no longer want to apply team permissions t
To remove a team member: To remove a team member:
1. Sign in to Grafana as an organization administrator or team administrator. 1. Sign in to Grafana as an organization administrator or team administrator.
1. Hover your cursor over the **Configuration** (gear) icon in the side menu and click **Teams**. 1. Click **Administration** in the left-side menu and select **Teams**.
1. Click a team from which you want to remove a user. 1. Click a team from which you want to remove a user.
1. Click the **X** next to the name of the user. 1. Click the **X** next to the name of the user.
1. Click **Delete**.
## Delete a team ## Delete a team
@ -92,7 +91,7 @@ Delete a team when you no longer need it. This action permanently deletes the te
To delete a team: To delete a team:
1. Sign in to Grafana as an organization administrator. 1. Sign in to Grafana as an organization administrator.
1. Hover your cursor over the **Configuration** (gear) icon in the side menu and click **Teams**. 1. Click **Administration** in the left-side menu and select **Teams**.
1. Click the **X** next to the name of the team. 1. Click the **X** next to the name of the team.
1. Click **Delete**. 1. Click **Delete**.
@ -103,7 +102,7 @@ See the complete list of teams in your Grafana organization.
To view a list of teams: To view a list of teams:
1. Sign in to Grafana as an organization administrator or a team administrator. 1. Sign in to Grafana as an organization administrator or a team administrator.
1. Hover your cursor over the **Configuration** (gear) icon in the side menu and click **Teams**. 1. Click **Administration** in the left-side menu and select **Teams**.
The role you use to sign in to Grafana determines how you see team lists. The role you use to sign in to Grafana determines how you see team lists.
@ -111,10 +110,10 @@ The role you use to sign in to Grafana determines how you see team lists.
The following example shows a list as it appears to an organization administrator. The following example shows a list as it appears to an organization administrator.
![Team list](/static/img/docs/manage-users/org-admin-team-list-7-3.png) ![Team list view for org admin](/media/docs/grafana/screenshot-org-admin-team-list.png)
## Team administrator view ## Team administrator view
The following example shows a list as it appears to a team administrator. The following example shows a list as it appears to a team administrator.
![Team list](/static/img/docs/manage-users/team-admin-team-list-7-3.png) ![Team list view for team admin](/media/docs/grafana/screenshot-team-admin-team-list.png)

@ -24,15 +24,12 @@ When you grant user permissions for folders, that setting applies to all dashboa
**To grant dashboard folder permissions**: **To grant dashboard folder permissions**:
1. Sign in to Grafana as an organization administrator. 1. Sign in to Grafana as an organization administrator.
2. In the sidebar, hover your mouse over the **Dashboards** (squares) icon and click **Browse**. 1. In the left-side menu, click **Dashboards**.
3. Hover your mouse cursor over a folder and click **Go to folder**. 1. Hover your mouse cursor over a folder and click **Go to folder**.
4. Click the **Permissions** tab, and then click **Add Permission**. 1. Click the **Permissions** tab, and then click **Add a permission**.
5. In the **Add Permission For** dropdown menu, select **User**, **Team**, or one of the role options. 1. In the **Add Permission For** dropdown menu, select **User**, **Team**, or **Role**.
6. Select the user or team. 1. Select the user, team, or role.
1. Select the permission and click **Save**.
If you select a role option, you do not select a user or team.
7. Select the permission and click **Save**.
## Grant dashboard permissions ## Grant dashboard permissions
@ -52,12 +49,12 @@ Grant dashboard permissions when you want to restrict or enhance dashboard acces
**To grant dashboard permissions**: **To grant dashboard permissions**:
1. Sign in to Grafana as an organization administrator. 1. Sign in to Grafana as an organization administrator.
1. In the sidebar, hover your mouse over the **Dashboards** (squares) icon and click **Browse**. 1. In the left-side menu, click **Dashboards**.
1. Open a dashboard. 1. Open a dashboard.
1. In the top right corner of the dashboard, click **Dashboard settings** (the cog icon). 1. In the top right corner of the dashboard, click **Dashboard settings** (the cog icon).
1. Click **Permissions** and then click **Add Permission**. 1. Click **Permissions** in left-side menu, and then **Add a permission**.
1. In the **Add Permission For** dropdown menu, select **User** or **Team**. 1. In the **Add Permission For** dropdown menu, select **User**, **Team**, or **Role**.
1. Select the user or team. 1. Select the user, team, or role.
1. Select the permission and click **Save**. 1. Select the permission and click **Save**.
## Enable viewers to edit (but not save) dashboards and use Explore ## Enable viewers to edit (but not save) dashboards and use Explore
@ -94,10 +91,10 @@ Edit dashboard permissions when you are want to enhance or restrict a user's acc
**To edit dashboard permissions**: **To edit dashboard permissions**:
1. Sign in to Grafana as an organization administrator. 1. Sign in to Grafana as an organization administrator.
1. In the sidebar, hover your mouse over the **Dashboards** (squares) icon and click **Browse**. 1. In the left-side menu, click **Dashboards**.
1. Open a dashboard. 1. Open a dashboard.
1. In the top-right corner of the dashboard, click **Dashboard settings** (the cog icon). 1. In the top-right corner of the dashboard, click **Dashboard settings** (the cog icon).
1. Click **Permissions**. 1. Click **Permissions** in left-side menu.
1. In the dropdown, update the permissions, and click **Save**. 1. In the dropdown, update the permissions, and click **Save**.
## Restrict access to dashboards ## Restrict access to dashboards

@ -30,7 +30,7 @@ You can see a list of users with accounts in your Grafana organization. If neces
**To view a list of organization users**: **To view a list of organization users**:
1. Sign in to Grafana as an organization administrator. 1. Sign in to Grafana as an organization administrator.
1. Hover your cursor over the **Configuration** (gear) icon in the side menu and click **Users**. 1. Navigate to **Administration > Users**.
> **Note:** If you have [server administrator]({{< relref "../../roles-and-permissions/#grafana-server-administrators" >}}) permissions, you can also [view a global list of users]({{< relref "../server-user-management#view-a-list-of-users" >}}) in the Server Admin section of Grafana. > **Note:** If you have [server administrator]({{< relref "../../roles-and-permissions/#grafana-server-administrators" >}}) permissions, you can also [view a global list of users]({{< relref "../server-user-management#view-a-list-of-users" >}}) in the Server Admin section of Grafana.
@ -45,7 +45,7 @@ Update user permissions when you want to enhance or restrict a user's access to
**To change the organization role of a user**: **To change the organization role of a user**:
1. Sign in to Grafana as an organization administrator. 1. Sign in to Grafana as an organization administrator.
1. Hover your cursor over the **Configuration** (gear) icon in the side menu and click **Users**. 1. Navigate to **Administration > Users**.
1. Find the user account for which you want to change the role. 1. Find the user account for which you want to change the role.
If necessary, use the search field to filter the list. If necessary, use the search field to filter the list.
@ -78,7 +78,7 @@ When you invite users to join an organization, you assign the **Admin**, **Edito
> **Note**: It might be that you are currently in the proper organization and don't need to switch organizations. > **Note**: It might be that you are currently in the proper organization and don't need to switch organizations.
1. Hover your cursor over the **Configuration** (gear) icon in the side menu and click **Users**. 1. Navigate to **Administration > Users**.
1. Click **Invite**. 1. Click **Invite**.
1. Enter the following information: 1. Enter the following information:
@ -106,7 +106,7 @@ Periodically review invitations you have sent so that you can see a list of user
**To manage a pending invitation**: **To manage a pending invitation**:
1. Sign in to Grafana as an organization administrator. 1. Sign in to Grafana as an organization administrator.
1. Hover your cursor over the **Configuration** (gear) icon in the side menu and click **Users**. 1. Navigate to **Administration > Users**.
1. Click **Pending Invites**. 1. Click **Pending Invites**.
The **Pending Invites** button appears only when there are unaccepted invitations. The **Pending Invites** button appears only when there are unaccepted invitations.
@ -128,7 +128,7 @@ This action does not remove the user account from the Grafana server.
**To remove a user from an organization**: **To remove a user from an organization**:
1. Sign in to Grafana as an organization administrator. 1. Sign in to Grafana as an organization administrator.
1. Hover your cursor over the **Configuration** (gear) icon in the side menu and click **Users**. 1. Navigate to **Administration > Users**.
1. Find the user account that you want to remove from the organization. 1. Find the user account that you want to remove from the organization.
Use the search field to filter the list, if necessary. Use the search field to filter the list, if necessary.

@ -27,8 +27,7 @@ You can change your Grafana password at any time.
**To change your password**: **To change your password**:
1. Sign in to Grafana. 1. Sign in to Grafana.
1. Hover your mouse over the user icon in the lower-left corner of the page. 1. Click the user icon in the top right corner of the page and select **Change Password**.
1. Click **Change Password**. Grafana opens the **Change Password** tab.
1. Enter your old password and a new password. 1. Enter your old password and a new password.
1. Confirm your new password. 1. Confirm your new password.
1. Click **Change Password**. 1. Click **Change Password**.
@ -40,8 +39,8 @@ Your profile includes your name, user name, and email address, which you can upd
**To edit your profile**: **To edit your profile**:
1. Sign in to Grafana. 1. Sign in to Grafana.
1. Hover your cursor over the user icon in the lower-left corner of the page and click **Preferences**. 1. Click the user icon in the top right corner of the page and select **Profile**.
1. In the **Edit Profile** section, update your profile and click **Save**. 1. In the **Profile** section, update your details and click **Save**.
## Edit your preferences ## Edit your preferences
@ -56,9 +55,9 @@ You can choose the way you would like data to appear in Grafana, including the U
**To edit your preferences**: **To edit your preferences**:
1. Sign in to Grafana. 1. Sign in to Grafana.
1. Hover your cursor over the user icon in the lower-left corner of the page, and click **Preferences**. 1. Click the user icon in the top right corner of the page and select **Profile**.
1. Update any of the values in the **Preferences** section. 1. Update any of the values in the Preferences section.
1. Click **Save** at the bottom of the Preferences section. 1. Click **Save** at the bottom of the section.
## Switch organizations ## Switch organizations
@ -67,7 +66,7 @@ When you sign in to Grafana, the system signs you in to a default organization.
**To switch organizations**: **To switch organizations**:
1. Sign in to Grafana. 1. Sign in to Grafana.
1. Hover your cursor over the user icon in the lower-left corner of the page and click **Switch organization**. 1. Click the user icon in the top right corner of the page and select **Switch organization**.
1. Next to the organization that you want to sign in to, click **Switch to**. 1. Next to the organization that you want to sign in to, click **Switch to**.
## View your assigned organizations ## View your assigned organizations
@ -77,8 +76,8 @@ Every user is a member of at least one organization. You can have different role
**To view your assigned organizations**: **To view your assigned organizations**:
1. Sign in to Grafana. 1. Sign in to Grafana.
1. Hover your cursor over the user icon in the lower-left corner of the page and click **Preferences**. 1. Click the user icon in the top right corner of the page and select **Profile**.
1. Scroll down to the **Organizations** section and review the following information: 1. Scroll down to the Organizations section and review the following information:
- **Name**: The name of the organizations of which you are a member. - **Name**: The name of the organizations of which you are a member.
- **Role**: The role to which you are assigned in the organization. For more information about roles and permissions, refer to [Organization users and permissions]({{< relref "../../roles-and-permissions/#organization-users-and-permissions" >}}). - **Role**: The role to which you are assigned in the organization. For more information about roles and permissions, refer to [Organization users and permissions]({{< relref "../../roles-and-permissions/#organization-users-and-permissions" >}}).
- **Current**: Grafana indicates the organization that you are currently signed into as _Current_. If you are a member of multiple organizations, you can click **Select** to switch to that organization. - **Current**: Grafana indicates the organization that you are currently signed into as _Current_. If you are a member of multiple organizations, you can click **Select** to switch to that organization.
@ -90,7 +89,7 @@ Grafana logs your sessions in each Grafana instance. You can review this section
**To view your Grafana sessions**: **To view your Grafana sessions**:
1. Sign in to Grafana. 1. Sign in to Grafana.
1. Hover your cursor over the user icon in the lower-left corner of the page, and click **Preferences**. 1. Click the user icon in the top right corner of the page and select **Profile**.
1. Scroll down to the **Sessions** section. 1. Scroll down to the **Sessions** section.
## Sign out a user session ## Sign out a user session
@ -100,6 +99,6 @@ You can sign out other sessions using your account in order to prevent other peo
**To sign out one of your Grafana sessions**: **To sign out one of your Grafana sessions**:
1. Sign in to Grafana. 1. Sign in to Grafana.
1. Hover your cursor over the user icon in the lower-left corner of the page, and click **Preferences**. 1. Click the user icon in the top right corner of the page and select **Profile**.
1. Scroll down to the **Sessions** section. 1. Scroll down to the **Sessions** section.
1. Click the red "sign out" icon next to the session you would like to sign out. 1. Click the red "sign out" icon next to the session you would like to sign out.

Loading…
Cancel
Save