Docs: Refactor administration docs (#50592)

* Move data source management to administration * Move RBAC to administration * Move team management up a docs org level * Combine and rename admin preferences docs * Move plugin management to administration * Combine plugin management docs * Combine API key docs * Combine service account docs * Combine server user management docs * Move datasource management to administration * Move enterprise licenses to administration * Move CLI out of admin, update links to admin * Merge org user management docs * Restructure to Torkel's plan * Fix typo * Weigh admin topics for navigation * Weigh administration topics and align to Torkel's plan * Move server user management from server admin to admin/user management * Move configure docker image to setup guide * Move the remaining server admin docs to the root admin directory * Reweight docker config
2022-06-16 21:09:16 +02:00
parent c043a8818a
commit 845cebdee2
105 changed files with 1602 additions and 1710 deletions
@@ -0,0 +1,147 @@
+---
+aliases:
+  - /docs/grafana/latest/administration/manage-users-and-permissions/manage-server-users/
+  - /docs/grafana/latest/manage-users/server-admin/
+  - /docs/grafana/latest/manage-users/server-admin/server-admin-manage-users/
+  - /docs/grafana/latest/administration/manage-users-and-permissions/manage-server-users/view-list-users/
+  - /docs/grafana/latest/administration/manage-users-and-permissions/manage-server-users/view-edit-user-account/
+  - /docs/grafana/latest/administration/manage-users-and-permissions/manage-server-users/view-user-account-details/
+  - /docs/grafana/latest/administration/manage-users-and-permissions/manage-server-users/add-user/
+  - /docs/grafana/latest/administration/manage-users-and-permissions/manage-server-users/force-user-logout/
+title: Server user management
+weight: 100
+---
+
+# Server user management
+
+A _user_ is defined as any individual who can log in to Grafana. Each user is associated with a _role_ that includes _permissions_. Permissions determine the tasks a user can perform in the system.
+
+If you have [server administrator]({{< relref "../../roles-and-permissions/#grafana-server-administrators" >}}) permissions in Grafana, you can manage all users for a Grafana instance in the Server Admin section:
+
+{{< section >}}
+
+If you have [organization administrator]({{< relref "../../roles-and-permissions/#organization-roles" >}}) permissions and _not_ [server administrator]({{< relref "../../roles-and-permissions/#grafana-server-administrators" >}}) permissions, refer to [Manage users in a organization]({{< relref "../manage-org-users/" >}}).
+
+For more information about users and permissions, refer to [About users and permissions]({{< relref "../../roles-and-permissions/" >}}). For more information about managing users in general, see [User management]({{< relref "../" >}}).
+
+## View a list of users
+
+You can see a list of users with accounts on your Grafana server. This action might be useful when you want to know which role you assigned to each user.
+
+### Before you begin
+
+- Ensure you have Grafana server administrator privileges
+
+**To view a list of users**:
+
+1. Sign in to Grafana as a server administrator.
+1. Hover your cursor over the **Server Admin** (shield) icon until a menu appears, and click **Users**.
+
+![Server Admin user list](/static/img/docs/manage-users/server-user-list-7-3.png)
+
+> **Note:** If you have [organization administrator]({{< relref "../../roles-and-permissions/#organization-roles" >}}) permissions and _not_ [server administrator]({{< relref "../../roles-and-permissions/#grafana-server-administrators" >}}) permissions, you can still [view of list of users in a given organization]({{< relref "../../manage-users-and-permissions/manage-org-users/view-list-org-users/" >}}).
+
+## View user details
+
+View user details when you want to see login, and organizations and permissions settings associated with a user.
+
+### Before you begin:
+
+- Ensure you have Grafana server administrator privileges
+
+**To view user details**:
+
+1. Sign in to Grafana as a server administrator.
+1. Hover your cursor over the **Server Admin** (shield) icon until a menu appears, and click **Users**.
+1. Click a user.
+
+A user account contains the following sections.
+
+#### User information
+
+This section contains basic user information, which users can update.
+
+![Server Admin user information section](/static/img/docs/manage-users/server-admin-user-information-7-3.png)
+
+#### Permissions
+
+This indicates whether the user account has the Grafana administrator flag applied. If the flag is set to **Yes**, then the user is a Grafana server administrator.
+
+![Server Admin Permissions section](/static/img/docs/manage-users/server-admin-permissions-7-3.png)
+
+#### Organisations
+
+This section lists the organizations the user belongs to and their assigned role.
+
+![Server Admin Organizations section](/static/img/docs/manage-users/server-admin-organisations-7-3.png)
+
+#### Sessions
+
+This section includes recent user sessions and information about the time the user logged in and they system they used. You can force logouts, if necessary.
+
+![Server Admin Sessions section](/static/img/docs/manage-users/server-admin-sessions-7-3.png)
+
+## Edit a user account
+
+Edit a user account when you want to modify user login credentials, or delete, disable, or enable a user.
+
+### Before you begin
+
+- Ensure you have Grafana server administrator privileges
+
+**To edit a user account**:
+
+1. Sign in to Grafana as a server administrator.
+1. Hover your cursor over the **Server Admin** (shield) icon until a menu appears, and click **Users**.
+1. Click a user.
+1. Complete any of the following actions, as necessary.
+
+| Action                          | Description                                                                                                                                                     |
+| ------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| Update name, email, or username | **Is the user notified of these changes?**. Click **Save** after you make a change.                                                                             |
+| Change the user's password      | The new password must be at least four characters long. Click **Save** after you make a change.                                                                 |
+| Delete a user                   | This action permanently removes the user from the Grafana server. The user can no longer sign in after you make this change.                                    |
+| Disable user account            | This action prevents a user from signing in with this account, but does not delete the account. You might disable an account if a colleague goes on sabbatical. |
+| Enable a user account           | This action enables a user account.                                                                                                                             |
+
+## Add a user
+
+Add users when you want to manually provide individuals with access to Grafana.
+
+When you create a user using this method, you must create their password. The user does not receive a notification by email. To invite a user to Grafana and allow them to create their own password, [invite a user to join an organization]({{< relref "../../manage-users-and-permissions/manage-org-users/invite-user-join-org/" >}}).
+
+When you configure advanced authentication using Oauth, SAML, LDAP, or the Auth proxy, users are created automatically.
+
+### Before you begin
+
+- Ensure that you have Grafana server administrator privileges
+
+**To add a user**:
+
+1. Sign in to Grafana as a server administrator.
+1. Hover your cursor over the **Server Admin** (shield) icon until a menu appears, and click **Users**.
+1. Click **New user**.
+1. Complete the fields and click **Create user**.
+
+When you create a user, the system assigns the user viewer permissions in a default organization, which you can change. You can now [add a user to a second organization]({{< relref "add-remove-user-to-org/" >}}).
+
+> **Note:** If you have [organization administrator]({{< relref "../../roles-and-permissions/#organization-roles" >}}) permissions and _not_ [server administrator]({{< relref "../../roles-and-permissions/#grafana-server-administrators" >}}) permissions, you can still add users by [inviting a user to join an organization]({{< relref "../../manage-users-and-permissions/manage-org-users/invite-user-join-org/" >}}).
+
+## Force a user to log out of Grafana
+
+If you suspect a user account is compromised or is no longer authorized to access the Grafana server, then you can force the user to log out of Grafana.
+
+The force logout action can apply to one device that is logged in to Grafana, or all devices logged in to Grafana.
+
+### Before you begin
+
+- Ensure you have Grafana server administrator privileges
+
+1. Sign in to Grafana as a server administrator.
+1. Hover your cursor over the **Server Admin** (shield) icon until a menu appears, and click **Users**.
+1. Click a user.
+1. Scroll down to the **Sessions** section.
+1. Perform one of the following actions:
+   - Click **Force logout** next to the session entry that you want logged out of Grafana.
+   - Click **Force logout from all devices**.
+1. Confirm the logout.
@@ -0,0 +1,53 @@
+---
+aliases:
+  - /docs/grafana/latest/administration/manage-users-and-permissions/manage-server-users/add-remove-user-to-org/
+  - /docs/grafana/latest/administration/manage-users-and-permissions/manage-server-users/add-user-to-org/
+title: Add or remove a user from an organization
+weight: 30
+---
+
+# Add a user to an organization
+
+Add a user to an organization when you want the user to have access to organization resources such as dashboards, data sources, and playlists. A user must belong to at least one organization.
+
+You are required to specify an Admin role for each organization. The first user you add to an organization becomes the Admin by default. After you assign the Admin role to a user, you can add other users to an organization as either Admins, Editors, or Viewers.
+
+## Before you begin
+
+- [Create an organization]({{< relref "../../../manage-users-and-permissions/manage-organizations/" >}})
+- [Add a user]({{< relref "../../../manage-users-and-permissions/manage-server-users/add-remove-user-to-org/add-user/" >}}) to Grafana
+- Ensure you have Grafana server administrator privileges
+
+**To add a user to an organization**:
+
+1. Sign in to Grafana as a server administrator.
+1. Hover your cursor over the **Server Admin** (shield) icon until a menu appears, and click **Users**.
+1. Click a user.
+1. In the **Organizations** section, click **Add user to organization**.
+1. Select an organization and a role.
+
+   For more information about user permissions, refer to [Organization roles]({{< relref "../../../manage-users-and-permissions/manage-server-users/about-users-and-permissions/#organization-roles" >}}).
+
+1. Click **Add to organization**.
+
+The next time the user signs in, they will be able to navigate to their new organization using the Switch Organizations option in the user profile menu.
+
+> **Note:** If you have [organization administrator]({{< relref "../../../manage-users-and-permissions/manage-server-users/about-users-and-permissions/#organization-roles" >}}) permissions and _not_ [server administrator]({{< relref "../../../manage-users-and-permissions/manage-server-users/about-users-and-permissions/#grafana-server-administrators" >}}) permissions, you can still [invite a user to join an organization]({{< relref "../../../manage-users-and-permissions/manage-server-users/manage-org-users/invite-user-join-org/" >}}).
+
+# Remove a user from an organization
+
+Remove a user from an organization when they no longer require access to the dashboards, data sources, or alerts in that organization.
+
+## Before you begin
+
+- Ensure you have Grafana server administrator privileges
+
+**To remove a user from an organization**:
+
+1. Sign in to Grafana as a server administrator.
+1. Hover your cursor over the **Server Admin** (shield) icon until a menu appears, and click **Users**.
+1. Click a user.
+1. In the **Organization** section, click **Remove from organization** next to the organization from which you want to remove the user.
+1. Click **Confirm removal**.
+
+> **Note:** If you have [organization administrator]({{< relref "../../../manage-users-and-permissions/manage-server-users/about-users-and-permissions/#organization-roles" >}}) permissions and _not_ [server administrator]({{< relref "../../../manage-users-and-permissions/manage-server-users/about-users-and-permissions/#grafana-server-administrators" >}}) permissions, you can still [remove a user from an organization]({{< relref "../../../manage-users-and-permissions/manage-server-users/manage-org-users/remove-user-from-org/" >}}) in the Users section of organization configuration.
@@ -0,0 +1,28 @@
+---
+aliases:
+  - /docs/grafana/latest/administration/manage-users-and-permissions/manage-server-users/assign-remove-server-admin-privileges/
+title: Assign or remove Grafana server administrator privileges
+weight: 20
+---
+
+# Assign or remove Grafana server administrator privileges
+
+Grafana server administrators are responsible for creating users, organizations, and managing permissions. For more information about the server administration role, refer to [Grafana server administrators]({{< relref "../../../manage-users-and-permissions/manage-server-users/about-users-and-permissions/#grafana-server-administrators" >}}).
+
+> **Note:** Server administrators are "super-admins" with full permissions to create, read, update, and delete all resources and users in all organizations, as well as update global settings such as licenses. Only grant this permission to trusted users.
+
+## Before you begin
+
+- [Add a user]({{< relref "../../../manage-users-and-permissions/manage-server-users/assign-remove-server-admin-privileges/add-user/" >}})
+- Ensure you have Grafana server administrator privileges
+
+**To assign or remove Grafana administrator privileges**:
+
+1. Sign in to Grafana as a server administrator.
+1. Hover your cursor over the **Server Admin** (shield) icon until a menu appears, and click **Users**.
+1. Click a user.
+1. In the **Grafana Admin** section, click **Change**.
+1. Click **Yes** or **No**, depending on whether or not you want this user to have the Grafana server administrator role.
+1. Click **Change**.
+
+The system updates the user's permission the next time they load a page in Grafana.
@@ -0,0 +1,23 @@
+---
+aliases:
+  - /docs/grafana/latest/administration/manage-users-and-permissions/manage-server-users/change-user-org-permissions/
+title: Change a user's organization permissions
+weight: 50
+---
+
+# Change a user's organization permissions
+
+Update organization permissions when you want to enhance or restrict a user's access to organization resources. For more information about organization permissions, refer to [Organization roles]({{< relref "../../../manage-users-and-permissions/manage-server-users/about-users-and-permissions/#organization-roles" >}}).
+
+## Before you begin
+
+- [Add a user to an organization]({{< relref "../../../manage-users-and-permissions/manage-server-users/change-user-org-permissions/add-remove-user-to-org/" >}})
+- Ensure you have Grafana server administrator privileges
+
+**To change a user's organization permissions**:
+
+1. Sign in to Grafana as a server administrator.
+1. Hover your cursor over the **Server Admin** (shield) icon until a menu appears, and click **Users**.
+1. Click a user.
+1. In the **Organizations** section, click the role you want to change, and then select another role.
+1. Click **Update**.
@@ -0,0 +1,25 @@
+---
+aliases:
+  - /docs/grafana/latest/administration/manage-users-and-permissions/manage-server-users/force-user-logout/
+title: Force a user to logout from Grafana
+weight: 90
+---
+
+# Force a user to log out of Grafana
+
+If you suspect a user account is compromised or is no longer authorized to access the Grafana server, then you can force the user to log out of Grafana.
+
+The force logout action can apply to one device that is logged in to Grafana, or all devices logged in to Grafana.
+
+## Before you begin
+
+- Ensure you have Grafana server administrator privileges
+
+1. Sign in to Grafana as a server administrator.
+1. Hover your cursor over the **Server Admin** (shield) icon until a menu appears, and click **Users**.
+1. Click a user.
+1. Scroll down to the **Sessions** section.
+1. Perform one of the following actions:
+   - Click **Force logout** next to the session entry that you want logged out of Grafana.
+   - Click **Force logout from all devices**.
+1. Confirm the logout.
@@ -0,0 +1,33 @@
+---
+aliases:
+  - /docs/grafana/latest/administration/manage-users-and-permissions/manage-server-users/grant-editor-admin-permissions/
+title: Grant editors administrator permissions
+weight: 60
+---
+
+# Grant editors administrator permissions
+
+By default, the editor organization role does not allow editors to manage dashboard folders, dashboards, and teams, which you can change by modifying a configuration parameter. You can allow them to do so using the `editors_can_admin` configuration option.
+
+This setting can be used to enable self-organizing teams to administer their own dashboards.
+
+When `editors_can_admin` is enabled:
+
+- Users with the Editor role in an organization are Administrators for new dashboards and folders they create, meaning they can edit dashboard permissions. To learn more about dashboard permissions, refer to [Manage dashboard permissions]({{< relref "../../../manage-users-and-permissions/manage-server-users/manage-dashboard-permissions/" >}}).
+- Users with the Editor role in an organization can create teams, and they are Administrators of the teams they create. To learn more about team permissions, refer to [Manage teams]({{< relref "../../../manage-users-and-permissions/manage-server-users/manage-teams/" >}})
+
+> **Note**: If you use Grafana Enterprise and customize users' permissions using RBAC, the RBAC permissions override the functionality enabled by the `editors_can_admin` flag.
+
+## Before you begin
+
+- Ensure that you have access to the Grafana server
+
+**To enable editors with administrator permissions**:
+
+1. Log in to the Grafana server and open the Grafana configuration file.
+
+   For more information about the Grafana configuration file and its location, refer to [Configuration]({{< relref "../../../setup-grafana/configure-grafana/" >}}).
+
+1. Locate the `editors_can_admin` parameter.
+1. Set the `editors_can_admin` value to `true`.
+1. Save your changes and restart the Grafana server.