docs: nav updates for administration & licensing (#65400)

* navigation related updates text only

* fixed styling
pull/65403/head
Isabel 2 years ago committed by GitHub
parent c0b5d2dfaa
commit c94760e844
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
  1. 4
      docs/sources/administration/enterprise-licensing/_index.md
  2. 2
      docs/sources/administration/enterprise-licensing/activate-aws-marketplace-license/activate-license-on-ecs/index.md
  3. 2
      docs/sources/administration/enterprise-licensing/activate-aws-marketplace-license/activate-license-on-eks/index.md
  4. 2
      docs/sources/administration/enterprise-licensing/activate-aws-marketplace-license/manage-license-in-aws-marketplace/index.md
  5. 14
      docs/sources/administration/organization-management/index.md
  6. 4
      docs/sources/administration/organization-preferences/index.md
  7. 8
      docs/sources/administration/roles-and-permissions/access-control/assign-rbac-roles/index.md
  8. 4
      docs/sources/administration/stats-and-license/index.md
  9. 12
      docs/sources/administration/user-management/server-user-management/_index.md
  10. 8
      docs/sources/administration/user-management/server-user-management/add-remove-user-to-org/index.md
  11. 4
      docs/sources/administration/user-management/server-user-management/assign-remove-server-admin-privileges/index.md
  12. 7
      docs/sources/administration/user-management/server-user-management/change-user-org-permissions/index.md

@ -205,9 +205,9 @@ To determine the number of active users:
1. Sign in to Grafana Enterprise as a System Administrator. 1. Sign in to Grafana Enterprise as a System Administrator.
1. Click **Server Admin** (the shield icon). 1. Click **Administration** in the left-side menu.
1. Click **Statistics and licensing**. 1. Click **Stats and license**.
1. Review the utilization count on the **Utilization** panel. 1. Review the utilization count on the **Utilization** panel.

@ -108,6 +108,6 @@ In this task you configure Grafana Enterprise to validate the license with AWS i
### Task 4: Start or restart Grafana ### 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. 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 the **Statistics and Licensing** page 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 > 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" >}}). For more information about validating that your license is active, refer to [Grafana Enterprise license restrictions]({{< relref "../../#grafana-enterprise-license-restrictions" >}}).

@ -119,7 +119,7 @@ To restart Grafana on a Kubernetes cluster,
1. Run the command `kubectl rollout restart deployment my-release`. 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 the Statistics and Licensing page 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 > 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/" >}}). For more information about restarting Grafana, refer to [Restart Grafana]({{< relref "../../../../setup-grafana/start-restart-grafana/" >}}).

@ -32,7 +32,7 @@ You can use AWS Marketplace to make the following modifications to your Grafana
1. Sign in to Grafana as a Server Administrator. 1. Sign in to Grafana as a Server Administrator.
1. Hover over **Server Admin** in the navigation bar and click **Statistics and Licensing**. 1. Click **Administration** in the left-side menu, and then **Stats and license**.
1. In the **Token** section under **Enterprise License**, click **Renew License**. 1. In the **Token** section under **Enterprise License**, click **Renew License**.

@ -59,9 +59,7 @@ Complete this task when you want to view a list of existing organizations.
**To view a list of organizations:** **To view a list of organizations:**
1. Sign in to Grafana as a server administrator. 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 **Orgs**. 1. Click **Administration** in the left-side menu, and then **Organizations**.
A list of organizations appears.
## Create an organization ## Create an organization
@ -74,13 +72,13 @@ Create an organization when you want to isolate dashboards and other resources f
**To create an organization:** **To create an organization:**
1. Sign in to Grafana as a server administrator. 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 **Orgs**. 1. Click **Administration** in the left-side menu, and then **Organizations**.
1. Click **+ New org**. 1. Click **+ New org**.
1. Enter the name of the new organization and click **Create**. 1. Enter the name of the new organization and click **Create**.
Grafana creates the organization and adds you as the organization administrator. Grafana creates the organization, adds you as the organization administrator, and opens the Default preferences page.
1. On the **Preferences** tab, select a home dashboard, time zone, and week start. 1. In the Preferences section, select a home dashboard, time zone, and week start.
For more information about preferences, refer to [Preferences]({{< relref "../organization-preferences/" >}}). For more information about preferences, refer to [Preferences]({{< relref "../organization-preferences/" >}}).
@ -100,7 +98,7 @@ This action permanently removes an organization from your Grafana server.
**To delete an organization:** **To delete an organization:**
1. Sign in to Grafana as a server administrator. 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 **Orgs**. 1. Click **Administration** in the left-side menu, and then **Organizations**.
1. Click the red **X** next to the organization that you want to delete. 1. Click the red **X** next to the organization that you want to delete.
1. Click **Delete**. 1. Click **Delete**.
@ -115,6 +113,6 @@ Edit an organization when you want to change its name.
**To edit an organization:** **To edit an organization:**
1. Sign in to Grafana as a server administrator. 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 **Orgs**. 1. Click **Administration** in the left-side menu, and then **Organizations**.
1. Click the organization you want to edit. 1. Click the organization you want to edit.
1. Update the organization name and click **Update**. 1. Update the organization name and click **Update**.

@ -39,8 +39,8 @@ Grafana server administrators and organization administrators can change organiz
Follow these instructions if you are a Grafana Server Admin. Follow these instructions if you are a Grafana Server Admin.
1. Hover your cursor over the **Server Admin** (shield) icon until a menu appears. 1. Click **Administration** in the left-side menu.
1. Click **Orgs**. 1. Click **Organizations**.
1. In the organization list, click the name of the organization that you want to change. 1. In the organization list, click the name of the organization that you want to change.
1. In **Name**, enter the new organization name. 1. In **Name**, enter the new organization name.
1. Click **Update**. 1. Click **Update**.

@ -54,10 +54,12 @@ In both cases, the assignment applies only to the user, team or service account
**To assign a fixed role as a server administrator:** **To assign a fixed role as a server administrator:**
1. Sign in to Grafana, hover your cursor over **Server Admin** (the shield icon) in the left navigation menu, and click **Users**. 1. Sign in to Grafana as a server administrator.
1. Click **Administration** in the left-side menu, and then **Users**.
1. Click a user. 1. Click a user.
1. In the **Organizations** section, select a role within an organization that you want to assign to the user. 1. In the Organizations section, click **Change role**.
1. Click **Update**. 1. Select a role within an organization that you want to assign to the user.
1. Click **Save**.
## Assign fixed or custom roles to a team using provisioning ## Assign fixed or custom roles to a team using provisioning

@ -34,7 +34,7 @@ If you are a Grafana server administrator, use the Settings tab to view the sett
### View server settings ### View server settings
1. Log in to your Grafana server with an account that has the Grafana Admin flag set. 1. Log in to your Grafana server with an account that has the Grafana Admin flag set.
1. Hover your cursor over the **Server Admin** (shield) icon in the side menu and then click the **Settings** tab. 1. Click **Administration** in the left-side menu, and then **Settings**.
### Available 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 ### View server stats
1. Log in to your Grafana server with an account that has the Grafana Admin flag set. 1. Log in to your Grafana server with an account that has the Grafana Admin flag set.
1. Hover your cursor over the **Server Admin** (shield) icon in the side menu and then click the **Stats & Licensing** tab. 1. Click **Administration** in the left-side menu, and then **Stats and license**.
### Available stats ### Available stats

@ -35,7 +35,7 @@ You can see a list of users with accounts on your Grafana server. This action mi
**To view a list of users**: **To view a list of users**:
1. Sign in to Grafana as a server administrator. 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 **Administration** in the left-side menu, and then **Users**.
> **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" >}}). > **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" >}}).
@ -50,7 +50,7 @@ View user details when you want to see login, and organizations and permissions
**To view user details**: **To view user details**:
1. Sign in to Grafana as a server administrator. 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 **Administration** in the left-side menu, and then **Users**.
1. Click a user. 1. Click a user.
A user account contains the following sections. A user account contains the following sections.
@ -82,7 +82,7 @@ Edit a user account when you want to modify user login credentials, or delete, d
**To edit a user account**: **To edit a user account**:
1. Sign in to Grafana as a server administrator. 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 **Administration** in the left-side menu, and then **Users**.
1. Click a user. 1. Click a user.
1. Complete any of the following actions, as necessary. 1. Complete any of the following actions, as necessary.
@ -109,7 +109,7 @@ When you configure advanced authentication using Oauth, SAML, LDAP, or the Auth
**To add a user**: **To add a user**:
1. Sign in to Grafana as a server administrator. 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 **Administration** in the left-side menu, and then **Users**.
1. Click **New user**. 1. Click **New user**.
1. Complete the fields and click **Create user**. 1. Complete the fields and click **Create user**.
@ -128,9 +128,9 @@ The force logout action can apply to one device that is logged in to Grafana, or
- Ensure you have Grafana server administrator privileges - Ensure you have Grafana server administrator privileges
1. Sign in to Grafana as a server administrator. 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 **Administration** in the left-side menu, and then **Users**.
1. Click a user. 1. Click a user.
1. Scroll down to the **Sessions** section. 1. Scroll down to the Sessions section.
1. Perform one of the following actions: 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** next to the session entry that you want logged out of Grafana.
- Click **Force logout from all devices**. - Click **Force logout from all devices**.

@ -27,9 +27,9 @@ You are required to specify an Admin role for each organization. The first user
**To add a user to an organization**: **To add a user to an organization**:
1. Sign in to Grafana as a server administrator. 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 **Administration** in the left-side menu, and then **Users**.
1. Click a user. 1. Click a user.
1. In the **Organizations** section, click **Add user to organization**. 1. In the Organizations section, click **Add user to organization**.
1. Select an organization and a role. 1. Select an organization and a role.
For more information about user permissions, refer to [Organization roles]({{< relref "../../../roles-and-permissions#organization-roles" >}}). For more information about user permissions, refer to [Organization roles]({{< relref "../../../roles-and-permissions#organization-roles" >}}).
@ -51,9 +51,9 @@ Remove a user from an organization when they no longer require access to the das
**To remove a user from an organization**: **To remove a user from an organization**:
1. Sign in to Grafana as a server administrator. 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 **Administration** in the left-side menu, and then **Users**.
1. Click a user. 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. In the Organization section, click **Remove from organization** next to the organization from which you want to remove the user.
1. Click **Confirm removal**. 1. Click **Confirm removal**.
> **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 [remove a user from an organization]({{< relref "../../manage-org-users#remove-a-user-from-an-organization" >}}) in the Users section of organization configuration. > **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 [remove a user from an organization]({{< relref "../../manage-org-users#remove-a-user-from-an-organization" >}}) in the Users section of organization configuration.

@ -21,9 +21,9 @@ Grafana server administrators are responsible for creating users, organizations,
**To assign or remove Grafana administrator privileges**: **To assign or remove Grafana administrator privileges**:
1. Sign in to Grafana as a server administrator. 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 **Administration** in the left-side menu, and then **Users**.
1. Click a user. 1. Click a user.
1. In the **Grafana Admin** section, click **Change**. 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. 1. Click **Yes** or **No**, depending on whether or not you want this user to have the Grafana server administrator role.
1. Click **Change**. 1. Click **Change**.

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

Loading…
Cancel
Save