opensource/grafana
1
0
Fork 0
mirror of https://github.com/grafana/grafana.git synced 2025-08-03 04:22:13 +08:00
Code Issues Packages Projects Releases Wiki Activity

Docs: update license restrictions (#49334)

Browse Source 
* Docs: update license restrictions

* apply review feedback

* remove initial description of two license types

Clean up tiered licensing copy and keep it all in one deprecated section, refer to old docs if user wants to learn more.

* fix linting issues

* update title

* fix config url

Co-authored-by: Mitch Seaman <mjseaman@users.noreply.github.com>
This commit is contained in:
Agnès Toulet
2022-06-07 11:39:01 +02:00
committed by GitHub
parent 2e1827127d
commit 3df7ee81f3
1 changed files with 14 additions and 117 deletions
Download Patch File Download Diff File Expand all files Collapse all files

131
docs/sources/enterprise/license/license-restrictions.md
View File

@ -11,68 +11,22 @@ title: License restrictions
weight: 300
---
# Understanding Grafana Enterprise licensing
# Grafana Enterprise license restrictions
When you become a Grafana Enterprise customer, you receive a license that governs your use of Grafana Enterprise.
You either have:
## Active users limit
- tiered licensing, or
- combined licensing
To understand which license type you have, refer to [Determine the number of active users for each licensed role](#determine-the-number-of-active-users-for-each-licensed-role).
## Tiered licensing
Tiered licensing defines dashboard viewers, and dashboard editors and administrators, as two distinct user types that each have their own user limit.
For example, your license might include 300 viewers and 50 editors or administrators. Although editors and administrators have separate permissions and can do different things, Grafana counts them together as a single licensed role.
### Active users limit
Your Grafana license includes a maximum number of _Viewer_ and _Editor/Admin_ active users. For example, your license can include a maximum of 500 viewers and 100 editor/admins.
Your Grafana license includes a maximum number of active users.
- An _active user_ is a user who has signed in to Grafana within the last 30 days. This is a rolling window that is updated daily.
- When you reach the number of maximum active viewers or editor/admins, only currently active users can sign in; new users and non-active users cannot sign in when you reach the limit.
- Grafana applies sign-in restrictions separately for viewers and editor/admins. If your Grafana license reaches its limit of active viewers but not its limit of active editor/admins, new editors and admins can still sign in.
- The number of dashboards that a user can view or edit, and the number of organizations that they can access does not affect the active user count. A user with editor permissions for many dashboards across many different organizations counts as one editor.
- When you reach the maximum number of active users, only currently active users (users who have signed in over the past 30 days) can sign in. When a new user or a previously-inactive user tries to sign in, the user will see an error message indicating that Grafana has reached its license limit.
- The user's role, number of dashboards that a user can view or edit, and the number of organizations that they can access does not affect the active user count.
- A license limit banner appears to administrators when Grafana reaches its active user limit; editors and viewers do not see the banner.
To change user roles to make better use of your licenses, refer to [Optimize your tiered license](#optimize-your-tiered-license).
### Permission domains
### Determine the number of active users
You can assign role permissions _globally_ and restrict access to a specific dashboard or set of dashboards.
**Organization permissions**: When you create a user, you select a role on the user details page. Your selection applies to all Grafana dashboards within the Organization. For example, a user with the viewer role can see all dashboards, but cannot create or edit dashboards. For more information about user roles and permissions, refer to [About users and permissions]({{< relref "../../administration/manage-users-and-permissions/about-users-and-permissions/" >}}).
**Dashboard permissions**: You can also assign permissions to dashboards or groups (folders) of dashboards. For example, you might want a viewer to also have editor permissions for a specific dashboard. While that user can see _all_ dashboards, they can only update one of them. For more information about dashboard permissions, refer to
[Dashboard permissions]({{< relref "../../administration/manage-users-and-permissions/about-users-and-permissions/#dashboard-permissions" >}}).
When you grant editor/admin dashboard permissions to a viewer, the editor/admin active-user count increases by one as shown on the **Utilization** panel of the **Statistics and licensing** page, and the user’s licensed role changes to editor/admin.
> The editor/admin count increases because the user can edit and save a dashboard.
### Grant dashboard edit without save permissions
You can grant viewers the ability to edit but not save a dashboard. This setting is useful when you have users that want to explore dashboards, but only need the generated view temporarily and do not require an editor/admin license.
> This setting does not affect viewers’ license role billing.
To grant dashboard edit without save permissions:
1. Open the `grafana.ini` file that contains default configurations.
The name and location of the file depends on your installation. For information about locating
the default configurations file, refer to [Configuration]({{< relref "../../setup-grafana/configure-grafana/" >}}).
1. Change the `viewers-can-edit` setting to `true`.
1. Restart Grafana Enterprise.
### Determine the number of active users for each licensed role
Because you can assign a user global permissions while also enhancing (or limiting) their access to specific dashboards, it might be helpful for you to periodically check license counts.
To determine the number of active users for each licensed role:
To determine the number of active users:
1. Sign in to Grafana Enterprise as a System Administrator.
@ -80,74 +34,17 @@ To determine the number of active users for each licensed role:
1. Click **Statistics and licensing**.
1. Review the role utilization count on the **Utilization** panel.
1. Review the utilization count on the **Utilization** panel.
> Utilization data updates when the user signs back in to Grafana after you change their permissions.
## Tiered licensing (deprecated)
### Optimize your tiered license
A tiered license defines dashboard viewers, and dashboard editors and administrators, as two distinct user types that each have their own user limit.
Grafana counts viewer users separately from editor/admin users. If you reach the limit imposed by your license for either of these user types, use the following techniques to make optimum use of the licenses you purchased.
As of Grafana Enterprise version 9.0, Grafana only counts and enforces the _total_ number of active users in your Grafana instance. For example, if you purchase 150 active users, you can have 20 admins, 70 editors, and 60 viewers, or you can have 150 admins. Grafana will enforce the total number of active users even if you use a license that grants a specific number of admins or editors and a certain number of viewers. This is a more permissive policy than before, which gives you the flexibility to change users' roles.
- **Review and update organization permissions.** You can modify organization permissions to reduce the count of one type of user. For example, if you reach the limit of editor/admin users, assign viewer permissions to one (or more) editor/admin users who agree to read-only access to dashboards. The license count updates when a user signs back in to Grafana.
- **Review and update dashboard permissions.** Because viewers can also count toward editor/admin usage, if they are granted access to edit specific dashboards, review your dashboard permissions and adjust accordingly. Remove editor or admin permissions where necessary.
- **Delete users.** Review the number of users you have for each type of permission and remove inactive users. Removing users immediately frees up space for new users.
If you are running a pre-9.0 version of Grafana Enterprise, please refer to the documentation for that version to learn more about license enforcement in your current version.
> When you delete a user you also delete their preferences, dashboard and folder permissions, and references to that user from the dashboard versions they have updated.
Users who are synced via SAML, Oauth, or LDAP will also lose these attributes.
### Update user permissions for dashboards
You can change the access a user has to specific dashboards. For billing purposes, Grafana charges for the highest level permission assigned to the user. For example, if you assign editor/admin dashboard permissions to a viewer user, Grafana counts that user as an editor/admin.
To change user permissions for dashboards:
1. Sign in to Grafana as a system administrator.
1. Hover your mouse over **Server Admin** (the shield icon) and click **Statistics and licensing**.
1. In the **Dashboard and Folder Permissions** area, click the dashboard in the \*\*Resource title (URL) column.
The **Permission** page opens.
1. Use the dropdown list to select a role.
The next time the user signs in, the **Utilization** panel on the **Statistics and licensing** page displays updated data.
## Combined licensing
As of Grafana Enterprise Version 8.3, you can purchase (or transition to) combined licensing. With combined licensing, you purchase a specific number of users, and you are free to distribute those users across all roles, in any combination.
For example, if you purchase 150 licenses, you can have 20 admins, 70 editors, and 60 viewers, or you can have 10 admins, 100 editors, and 40 viewers. This change reduces license complexity.
### Transition to combined license model
To transition from the tiered licensing model to the combined license model, contact your Grafana account team and request to switch to combined user pricing. Once you update your contract with the account team, they will issue you a new license token.
For instructions about how to update your license, refer to [Activate an Enterprise license]({{< relref "activate-license/" >}}).
After you apply the token, Grafana Enterprise resets your license and updates the user counts on the **Utilization** panel.
> If you are running Grafana Enterprise 8.2 or earlier, the license grants you the total number of licensed users _for each user type_.
For example, if your current license includes 60 viewers and 40 editor/admins, the new license includes 100 viewers and 100 editor/admins. Grafana Enterprise 8.3 removes the distinction between viewers and editor/admins as shown on the **Utilization** panel.
Before you upgrade to Grafana 8.3, ensure that the total number of active users in Grafana does not exceed the number of users in your combined license. If it does, then new users cannot sign in to Grafana 8.3 until the active user count returns below the licensed limit.
## Determining your current license type
You can identify your license type in Grafana 8.3 and higher. If you are running Grafana 8.2 or older, refer to your contract to determine your license type.
To determine if you have tiered pricing or combined pricing, complete the following steps in Grafana v8.3 or higher:
1. Sign in to Grafana as a system administrator.
1. Hover your mouse over **Server Admin** (the shield icon), and click **Statistics and licensing**.
1. In the **Utilization** panel, review the license count data.
- If you see **Admins & Editors** and **Viewers**, then you have a tiered license.
- If you only see **Users**, then you have a combined license.
## License restrictions common to both license types
## Additional license restrictions
Your license is controlled by the following rules:
@ -157,7 +54,7 @@ As the license expiration date approaches, you will see a banner in Grafana that
**Grafana License URL:** Your license does not work with an instance of Grafana with a different root URL.
The License URL is the root URL of your Grafana instance.
The License URL is the complete URL of your Grafana instance, for example `https://grafana.your-company.com/`. It is defined in the [root_url]({{< relref "../../setup-grafana/configure-grafana/#root_url">}}) configuration setting.
**Concurrent sessions limit**: As of Grafana Enterprise 7.5, users can initiate up to three concurrent sessions of Grafana.