Navigation: Updates to the docs for admin subsections (#77500)

updates to the docs for admin subsections
This commit is contained in:
Ashley Harrison 2023-11-02 14:23:19 +00:00 committed by GitHub
parent d5f749482a
commit 9a905b6312
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
16 changed files with 53 additions and 45 deletions

View File

@ -48,7 +48,7 @@ To follow these instructions, you need at least one of the following:
To create an API, complete the following steps:
1. Sign in to Grafana.
1. Click **Administration** in the left-side menu and select **API Keys**.
1. Click **Administration** in the left-side menu, **Users and access**, and select **API Keys**.
1. Click **Add API key**.
1. Enter a unique name for the key.
1. In the **Role** field, select one of the following access levels you want to assign to the key.
@ -101,7 +101,7 @@ For more information about permissions, refer to [Roles and permissions]({{< rel
To migrate all API keys to service accounts, complete the following steps:
1. Sign in to Grafana, point to **Configuration** (the gear icon), and click **API Keys**.
1. Sign in to Grafana, point to **Administration**, **Users and access**, and click **API Keys**.
1. In the top of the page, find the section which says **Switch from API keys to service accounts**
1. Click **Migrate to service accounts now**.
1. A confirmation window will appear, asking to confirm the migration. Click **Yes, migrate now** if you are willing to continue.
@ -110,7 +110,7 @@ To migrate all API keys to service accounts, complete the following steps:
To migrate a single API key to a service account, complete the following steps:
1. Sign in to Grafana.
1. Click **Administration** in the left-side menu and select **API Keys**.
1. Click **Administration** in the left-side menu, **Users and access**, and select **API Keys**.
1. Find the API Key you want to migrate.
1. Click **Migrate to service account**.

View File

@ -52,7 +52,7 @@ There is more than one way to add the license to a Grafana instance:
This is the preferred option for single instance installations of Grafana Enterprise.
1. Sign in as a Grafana server administrator.
1. Click **Administration > Stats and license** in the side navigation menu.
1. Click **Administration > General > Stats and license** in the side navigation menu.
1. Click **Upload a new token**.
1. Select your license file, and upload it.
@ -207,6 +207,8 @@ To determine the number of active users:
1. Click **Administration** in the side navigation menu.
1. Click **General**.
1. Click **Stats and license**.
1. Review the utilization count on the **Utilization** panel.

View File

@ -112,6 +112,6 @@ In this task you configure Grafana Enterprise to validate the license with AWS i
### Task 4: Start or restart Grafana
1. To restart Grafana and activate your license, update the service running Grafana to use the latest revision of the task definition that you created.
1. After you update the service, navigate to your Grafana instance, sign in with Grafana Admin credentials, and navigate to **Administration > Stats and license** to validate that your license is active.
1. After you update the service, navigate to your Grafana instance, sign in with Grafana Admin credentials, and navigate to **Administration > General > Stats and license** to validate that your license is active.
For more information about validating that your license is active, refer to [Grafana Enterprise license restrictions]({{< relref "../../#grafana-enterprise-license-restrictions" >}}).

View File

@ -123,7 +123,7 @@ To restart Grafana on a Kubernetes cluster,
1. Run the command `kubectl rollout restart deployment my-release`.
1. After you update the service, navigate to your Grafana instance, sign in with Grafana Admin credentials, and navigate to **Administration > Stats and license** to validate that your license is active.
1. After you update the service, navigate to your Grafana instance, sign in with Grafana Admin credentials, and navigate to **Administration > General > Stats and license** to validate that your license is active.
For more information about restarting Grafana, refer to [Restart Grafana]({{< relref "../../../../setup-grafana/start-restart-grafana/" >}}).

View File

@ -36,7 +36,7 @@ You can use AWS Marketplace to make the following modifications to your Grafana
1. Sign in to Grafana as a Server Administrator.
1. Click **Administration** in the side navigation menu, and then **Stats and license**.
1. Click **Administration** in the side navigation menu, **General**, and then **Stats and license**.
1. In the **Token** section under **Enterprise License**, click **Renew token**.

View File

@ -59,7 +59,7 @@ Complete this task when you want to view a list of existing organizations.
**To view a list of organizations:**
1. Sign in to Grafana as a server administrator.
1. Click **Administration** in the left-side menu, and then **Organizations**.
1. Click **Administration** in the left-side menu, **General**, and then **Organizations**.
## Create an organization
@ -72,7 +72,7 @@ Create an organization when you want to isolate dashboards and other resources f
**To create an organization:**
1. Sign in to Grafana as a server administrator.
1. Click **Administration** in the left-side menu, and then **Organizations**.
1. Click **Administration** in the left-side menu, **General**, and then **Organizations**.
1. Click **+ New org**.
1. Enter the name of the new organization and click **Create**.
@ -100,7 +100,7 @@ Deleting the organization also deletes all teams and dashboards associated the o
**To delete an organization:**
1. Sign in to Grafana as a server administrator.
1. Click **Administration** in the left-side menu, and then **Organizations**.
1. Click **Administration** in the left-side menu, **General**, and then **Organizations**.
1. Click the red **X** next to the organization that you want to delete.
1. Click **Delete**.
@ -115,6 +115,6 @@ Edit an organization when you want to change its name.
**To edit an organization:**
1. Sign in to Grafana as a server administrator.
1. Click **Administration** in the left-side menu, and then **Organizations**.
1. Click **Administration** in the left-side menu, **General**, and then **Organizations**.
1. Click the organization you want to edit.
1. Update the organization name and click **Update**.

View File

@ -44,6 +44,7 @@ Grafana server administrators and organization administrators can change organiz
Follow these instructions if you are a Grafana Server Admin.
1. Click **Administration** in the left-side menu.
1. Click **General**.
1. Click **Organizations**.
1. In the organization list, click the name of the organization that you want to change.
1. In **Name**, enter the new organization name.
@ -54,6 +55,7 @@ Follow these instructions if you are a Grafana Server Admin.
If you are an Organization Admin, follow these steps:
1. Click **Administration** in the left-side menu.
1. Click **General**.
1. Click **Default preferences**.
1. In **Organization name**, enter the new name.
1. Click **Update organization name**.
@ -63,7 +65,7 @@ If you are an Organization Admin, follow these steps:
Organization administrators and team administrators can change team names and email addresses.
To change the team name or email, follow these steps:
1. Click **Administration** in the left-side menu and select **Team**.
1. Click **Administration** in the left-side menu, **Users and access**, and select **Team**.
1. In the team list, click the name of the team that you want to change.
1. Click the **Settings** tab.
1. In the Team details section, you can edit the following:
@ -112,6 +114,7 @@ To see what the current settings are, refer to [View server settings]({{< relref
Organization administrators can change the UI theme for all users in an organization.
1. Click **Administration** in the left-side menu.
1. Click **General**.
1. Click **Default preferences**.
1. In the Preferences section, select the UI theme.
1. Click **Save**.
@ -120,7 +123,7 @@ Organization administrators can change the UI theme for all users in an organiza
Organization and team administrators can change the UI theme for all users on a team.
1. Click **Administration** in the left-side menu and select **Teams**.
1. Click **Administration** in the left-side menu, **Users and access**, and select **Teams**.
1. Click the team for which you want to change the UI theme.
1. Click the **Settings** tab.
1. In the Preferences section, select the UI theme.
@ -149,6 +152,7 @@ Grafana server administrators can choose a default timezone for all users on the
Organization administrators can choose a default timezone for their organization.
1. Click **Administration** in the left-side menu.
1. Click **General**.
1. Click **Default preferences**.
1. Click to select an option in the **Timezone** list. **Default** is either the browser local timezone or the timezone selected at a higher level.
1. Click **Save**.
@ -157,7 +161,7 @@ Organization administrators can choose a default timezone for their organization
Organization administrators and team administrators can choose a default timezone for all users on a team.
1. Click **Administration** in the left-side menu and select **Teams**.
1. Click **Administration** in the left-side menu, **Users and access**, and select **Teams**.
1. Click the team for which you want to change the timezone.
1. Click the **Settings** tab.
1. Click to select an option in the **Timezone** list. **Default** is either the browser local timezone or the timezone selected at a higher level.
@ -209,6 +213,7 @@ Organization administrators can choose a default home dashboard for their organi
1. Navigate to the dashboard you want to set as the home dashboard.
1. Click the star next to the dashboard title to mark the dashboard as a favorite if it is not already.
1. Click **Administration** in the left-side menu.
1. Click **General**.
1. Click **Default preferences**.
1. In the **Home Dashboard** field, select the dashboard that you want to use for your home dashboard. Options include all starred dashboards.
1. Click **Save**.
@ -219,7 +224,7 @@ Organization administrators and Team Admins can set a default home dashboard for
1. Navigate to the dashboard you want to set as the home dashboard.
1. Click the star next to the dashboard title to mark the dashboard as a favorite if it is not already.
1. Click **Administration** in the left-side menu and select **Teams**.
1. Click **Administration** in the left-side menu, **Users and access**, and select **Teams**.
1. Click the team for which you want to change the home dashboard.
1. Click the **Settings** tab.
1. In the **Home Dashboard** field, select the dashboard that you want to use for your home dashboard. Options include all starred dashboards.
@ -246,6 +251,7 @@ Grafana server administrators can change the default Grafana UI language for all
Organization administrators can change the language for all users in an organization.
1. Click **Administration** in the left-side menu.
1. Click **General**.
1. Click **Default preferences**.
1. In the Preferences section, select an option in the **Language** dropdown.
1. Click **Save**.
@ -254,7 +260,7 @@ Organization administrators can change the language for all users in an organiza
Organization and team administrators can set a default language for all users on a team.
1. Click **Administration** in the left-side menu and select **Teams**.
1. Click **Administration** in the left-side menu, **Users and access**, and select **Teams**.
1. Click the team for which you want to change the language.
1. Click the **Settings** tab.
1. In the Preferences section, select an option in the **Language** dropdown.

View File

@ -85,13 +85,13 @@ Before following the steps below, make sure you are logged in as a Grafana admin
<a id="#plugin-catalog-entry"></a>
Administrators can find the Plugin catalog at **Administration > Plugins**.
Administrators can find the Plugin catalog at **Administration > Plugins and data > Plugins**.
### Browse plugins
To browse for available plugins:
1. In Grafana, click **Administration > Plugins** in the side navigation menu to view installed plugins.
1. In Grafana, click **Administration > Plugins and data > Plugins** in the side navigation menu to view installed plugins.
1. Click the **All** filter to browse all available plugins.
1. Click the **Data sources**, **Panels**, or **Applications** buttons to filter by plugin type.
@ -99,7 +99,7 @@ To browse for available plugins:
To install a plugin:
1. In Grafana, click **Administration > Plugins** in the side navigation menu to view installed plugins.
1. In Grafana, click **Administration > Plugins and data > Plugins** in the side navigation menu to view installed plugins.
1. Click the **All** filter to browse all available plugins.
1. Browse and find a plugin.
1. Click on the plugin logo.
@ -111,7 +111,7 @@ When the update is complete, you see a confirmation message that the installatio
To update a plugin:
1. In Grafana, click **Administration > Plugins** in the side navigation menu to view installed plugins.
1. In Grafana, click **Administration > Plugins and data > Plugins** in the side navigation menu to view installed plugins.
1. Click on the plugin logo.
1. Click **Update**.
@ -121,7 +121,7 @@ When the update is complete, you see a confirmation message that the update was
To uninstall a plugin:
1. In Grafana, click **Administration > Plugins** in the side navigation menu to view installed plugins.
1. In Grafana, click **Administration > Plugins and data > Plugins** in the side navigation menu to view installed plugins.
1. Click on the plugin logo.
1. Click **Uninstall**.

View File

@ -54,14 +54,14 @@ 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" >}}).
3. In the left-side menu, click **Administration** and then **Users**, **Teams**, or **Service accounts**.
3. In the left-side menu, click **Administration**, **Users and access**, 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.
5. Click **Update**.
**To assign a fixed role as a server administrator:**
1. Sign in to Grafana as a server administrator.
1. Click **Administration** in the left-side menu, and then **Users**.
1. Click **Administration** in the left-side menu, **Users and access**, and then **Users**.
1. Click a user.
1. In the Organizations section, click **Change role**.
1. Select a role within an organization that you want to assign to the user.

View File

@ -34,7 +34,7 @@ If you are a Grafana server administrator, use the Settings tab to view the sett
### View server settings
1. Log in to your Grafana server with an account that has the Grafana Admin flag set.
1. Click **Administration** in the left-side menu, and then **Settings**.
1. Click **Administration** in the left-side menu, **General**, and then **Settings**.
### Available settings
@ -51,7 +51,7 @@ If you are a Grafana server admin, then you can view useful statistics about you
### View server stats
1. Log in to your Grafana server with an account that has the Grafana Admin flag set.
1. Click **Administration** in the left-side menu, and then **Stats and license**.
1. Click **Administration** in the left-side menu, **General**, and then **Stats and license**.
### Available stats

View File

@ -45,7 +45,7 @@ A user can belong to multiple teams.
To create a team:
1. Sign in to Grafana as an organization administrator or team administrator.
1. Click **Administration** in the left-side menu and select **Teams**.
1. Click **Administration** in the left-side menu, **Users and access**, and select **Teams**.
1. Click **New Team**.
1. Complete the fields and click **Create**.
1. Click **Add member**.
@ -59,7 +59,7 @@ Add a team member to an existing team whenever you want to provide access to tea
To add a team member:
1. Sign in to Grafana as an organization administrator.
1. Click **Administration** in the left-side menu and select **Teams**.
1. Click **Administration** in the left-side menu, **Users and access**, and select **Teams**.
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. Choose if you want to add the user as a team Member or an Admin.
@ -72,7 +72,7 @@ Complete this task when you want to add or modify team member permissions.
To grant team member permissions:
1. Sign in to Grafana as an organization administrator or a team administrator.
1. Click **Administration** in the left-side menu and select **Teams**.
1. Click **Administration** in the left-side menu, **Users and access**, and select **Teams**.
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 Permission column, select the new user permission level.
@ -84,7 +84,7 @@ You can remove a team member when you no longer want to apply team permissions t
To remove a team member:
1. Sign in to Grafana as an organization administrator or team administrator.
1. Click **Administration** in the left-side menu and select **Teams**.
1. Click **Administration** in the left-side menu, **Users and access**, and select **Teams**.
1. Click a team from which you want to remove a user.
1. Click the **X** next to the name of the user.
@ -95,7 +95,7 @@ Delete a team when you no longer need it. This action permanently deletes the te
To delete a team:
1. Sign in to Grafana as an organization administrator.
1. Click **Administration** in the left-side menu and select **Teams**.
1. Click **Administration** in the left-side menu, **Users and access**, and select **Teams**.
1. Click the **X** next to the name of the team.
1. Click **Delete**.
@ -106,7 +106,7 @@ See the complete list of teams in your Grafana organization.
To view a list of teams:
1. Sign in to Grafana as an organization administrator or a team administrator.
1. Click **Administration** in the left-side menu and select **Teams**.
1. Click **Administration** in the left-side menu, **Users and access**, and select **Teams**.
The role you use to sign in to Grafana determines how you see team lists.

View File

@ -38,7 +38,7 @@ You can see a list of users with accounts in your Grafana organization. If neces
**To view a list of organization users**:
1. Sign in to Grafana as an organization administrator.
1. Navigate to **Administration > Users**.
1. Navigate to **Administration > Users and access > Users**.
{{% admonition type="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.
@ -59,7 +59,7 @@ Organization roles sync from the authentication provider on user sign-in. To pre
**To change the organization role of a user**:
1. Sign in to Grafana as an organization administrator.
1. Navigate to **Administration > Users**.
1. Navigate to **Administration > Users and access > Users**.
1. Find the user account for which you want to change the role.
If necessary, use the search field to filter the list.
@ -96,7 +96,7 @@ If you have [server administrator]({{< relref "../../roles-and-permissions/#graf
> **Note**: It might be that you are currently in the proper organization and don't need to switch organizations.
1. Navigate to **Administration > Users**.
1. Navigate to **Administration > Users and access > Users**.
1. Click **Organization users**.
1. Click **Invite**.
1. Enter the following information:
@ -127,7 +127,7 @@ The **Pending Invites** button is only visible if there are unanswered invitatio
**To manage a pending invitation**:
1. Sign in to Grafana as an organization administrator.
1. Navigate to **Administration > Users**.
1. Navigate to **Administration > Users and access > Users**.
1. Click **Pending Invites**.
The **Pending Invites** button appears only when there are unaccepted invitations.
@ -149,7 +149,7 @@ This action does not remove the user account from the Grafana server.
**To remove a user from an organization**:
1. Sign in to Grafana as an organization administrator.
1. Navigate to **Administration > Users**.
1. Navigate to **Administration > Users and access > Users**.
1. Find the user account that you want to remove from the organization.
Use the search field to filter the list, if necessary.

View File

@ -39,7 +39,7 @@ You can see a list of users with accounts on your Grafana server. This action mi
**To view a list of users**:
1. Sign in to Grafana as a server administrator.
1. Click **Administration** in the left-side menu, and then **Users**.
1. Click **Administration** in the left-side menu, **Users and access**, and then **Users**.
{{% admonition type="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-org-users/#view-a-list-of-organization-users" >}}).
@ -56,7 +56,7 @@ View user details when you want to see login, and organizations and permissions
**To view user details**:
1. Sign in to Grafana as a server administrator.
1. Click **Administration** in the left-side menu, and then **Users**.
1. Click **Administration** in the left-side menu, **Users and access**, and then **Users**.
1. Click a user.
A user account contains the following sections.
@ -88,7 +88,7 @@ Edit a user account when you want to modify user login credentials, or delete, d
**To edit a user account**:
1. Sign in to Grafana as a server administrator.
1. Click **Administration** in the left-side menu, and then **Users**.
1. Click **Administration** in the left-side menu, **Users and access**, and then **Users**.
1. Click a user.
1. Complete any of the following actions, as necessary.
@ -115,7 +115,7 @@ When you configure advanced authentication using Oauth, SAML, LDAP, or the Auth
**To add a user**:
1. Sign in to Grafana as a server administrator.
1. Click **Administration** in the left-side menu, and then **Users**.
1. Click **Administration** in the left-side menu, **Users and access**, and then **Users**.
1. Click **New user**.
1. Complete the fields and click **Create user**.
@ -136,7 +136,7 @@ The force logout action can apply to one device that is logged in to Grafana, or
- Ensure you have Grafana server administrator privileges
1. Sign in to Grafana as a server administrator.
1. Click **Administration** in the left-side menu, and then **Users**.
1. Click **Administration** in the left-side menu, **Users and access**, and then **Users**.
1. Click a user.
1. Scroll down to the Sessions section.
1. Perform one of the following actions:

View File

@ -31,7 +31,7 @@ You are required to specify an Admin role for each organization. The first user
**To add a user to an organization**:
1. Sign in to Grafana as a server administrator.
1. Click **Administration** in the left-side menu, and then **Users**.
1. Click **Administration** in the left-side menu, **Users and access**, and then **Users**.
1. Click a user.
1. In the Organizations section, click **Add user to organization**.
1. Select an organization and a role.
@ -57,7 +57,7 @@ Remove a user from an organization when they no longer require access to the das
**To remove a user from an organization**:
1. Sign in to Grafana as a server administrator.
1. Click **Administration** in the left-side menu, and then **Users**.
1. Click **Administration** in the left-side menu, **Users and access**, and then **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**.

View File

@ -27,7 +27,7 @@ Server administrators are "super-admins" with full permissions to create, read,
**To assign or remove Grafana administrator privileges**:
1. Sign in to Grafana as a server administrator.
1. Click **Administration** in the left-side menu, and then **Users**.
1. Click **Administration** in the left-side menu, **Users and access**, and then **Users**.
1. Click a user.
1. In the Permissions section, next to Grafana Admin, click **Change**.
1. Click **Yes** or **No**, depending on whether or not you want this user to have the Grafana server administrator role.

View File

@ -21,7 +21,7 @@ Update organization permissions when you want to enhance or restrict a user's ac
**To change a user's organization permissions**:
1. Sign in to Grafana as a server administrator.
1. Click **Administration** in the left-side menu, and then **Users**.
1. Click **Administration** in the left-side menu, **Users and access**, and then **Users**.
1. Click a user.
1. In the Organizations section, click **Change role** for the role you want to change
1. Select another role.