From 8e8aae06a32c3367a70288ddcf9b78d6614578ff Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Agn=C3=A8s=20Toulet?= <35176601+AgnesToulet@users.noreply.github.com> Date: Wed, 13 May 2020 11:23:01 +0200 Subject: [PATCH] Docs: Enterprise improvements (#24395) * Docs: fix LDAP link * Docs: add License Expiration behavior for usage insights * Docs: update auth overview with a features matrix * Docs: refactor Enterprise overview * Docs: updates team sync supported providers * Docs: add auth feature matrix missing versions * Docs: fix license expiration indent * Docs: small improvements * Docs: apply PR feedbacks * Docs: fix typo * Docs: fix typo Oauth -> OAuth --- docs/sources/auth/azuread.md | 2 +- docs/sources/auth/enhanced_ldap.md | 2 +- docs/sources/auth/okta.md | 2 +- docs/sources/auth/overview.md | 27 ++++++------- docs/sources/enterprise/_index.md | 40 ++++++++----------- docs/sources/enterprise/license-expiration.md | 17 +++++--- docs/sources/enterprise/team-sync.md | 19 ++++----- 7 files changed, 53 insertions(+), 56 deletions(-) diff --git a/docs/sources/auth/azuread.md b/docs/sources/auth/azuread.md index d9cc1426cad..7749f64d213 100644 --- a/docs/sources/auth/azuread.md +++ b/docs/sources/auth/azuread.md @@ -92,7 +92,7 @@ To enable the Azure AD OAuth2 you must register your application with Azure AD. 1. Click on **Users and groups** and add Users/Groups to the Grafana roles by using **Add User**. -## Enable Azure AD Oauth in Grafana +## Enable Azure AD OAuth in Grafana 1. Add the following to the [Grafana configuration file]({{< relref "../installation/configuration.md#config-file-locations" >}}): diff --git a/docs/sources/auth/enhanced_ldap.md b/docs/sources/auth/enhanced_ldap.md index 4faeb2719c1..2d710352780 100755 --- a/docs/sources/auth/enhanced_ldap.md +++ b/docs/sources/auth/enhanced_ldap.md @@ -12,6 +12,6 @@ weight = 3 # Enhanced LDAP integration -The enhanced LDAP integration adds additional functionality on top of the existing {LDAP integration]({{< relref "ldap.md" >}}). +The enhanced LDAP integration adds additional functionality on top of the existing [LDAP integration]({{< relref "ldap.md" >}}). > Enhanced LDAP integration is only available in Grafana Enterprise. For more information, refer to [Enhanced LDAP integration]({{< relref "../enterprise/enhanced_ldap.md" >}}) in [Grafana Enterprise]({{< relref "../enterprise" >}}). diff --git a/docs/sources/auth/okta.md b/docs/sources/auth/okta.md index 1ee1b9691ce..832fcce2e89 100644 --- a/docs/sources/auth/okta.md +++ b/docs/sources/auth/okta.md @@ -36,7 +36,7 @@ Before you can sign a user in, you need to create an Okta application from the O 1. Click **Done** to finish creating the Okta application. -## Enable Okta Oauth in Grafana +## Enable Okta OAuth in Grafana 1. Add the following to the [Grafana configuration file]({{< relref "../installation/configuration.md#config-file-locations" >}}): diff --git a/docs/sources/auth/overview.md b/docs/sources/auth/overview.md index c6a4ab75fc6..afa4dac1ce9 100644 --- a/docs/sources/auth/overview.md +++ b/docs/sources/auth/overview.md @@ -14,21 +14,20 @@ weight = 1 Grafana provides many ways to authenticate users. Some authentication integrations also enable syncing user permissions and org memberships. -## OAuth Integrations +Here is a table showing all supported authentication providers and the features available for them. [Team sync]({{< relref "../enterprise/team-sync.md" >}}) and [active sync]({{< relref "../enterprise/enhanced_ldap.md#active-ldap-synchronization" >}}) are only available in Grafana Enterprise. + +Provider | Support | Role mapping | Team sync
*(Enterprise only)* | Active sync
*(Enterprise only)* +-------- | :-----: | :----------: | :-------: | :---------: +[Auth Proxy]({{< relref "auth-proxy.md" >}}) | v2.1+ | - | v6.3+ | - +[Azure AD OAuth]({{< relref "azuread.md" >}}) | v6.7+ | v6.7+ | v6.7+ | - +[Generic OAuth]({{< relref "generic-oauth.md" >}}) | v4.0+ | v6.5+ | - | - +[GitHub OAuth]({{< relref "github.md" >}}) | v2.0+ | - | v6.3+ | - +[GitLab OAuth]({{< relref "gitlab.md" >}}) | v5.3+ | - | v6.4+ | - +[Google OAuth]({{< relref "google.md" >}}) | v2.0+ | - | - | - +[LDAP]({{< relref "ldap.md" >}}) | v2.1+ | v2.1+ | v5.3+ | v6.3+ +[Okta OAuth]({{< relref "okta.md" >}}) | v7.0+ | v7.0+ | v7.0+ | - +[SAML]({{< relref "../enterprise/saml.md" >}}) (Enterprise only) | v6.3+ | v7.0+ | v7.0+ | - -- [Google OAuth]({{< relref "google.md" >}}) -- [GitHub OAuth]({{< relref "github.md" >}}) -- [Gitlab OAuth]({{< relref "gitlab.md" >}}) -- [Generic OAuth]({{< relref "generic-oauth.md" >}}) (Okta2, BitBucket, Azure, OneLogin, Auth0) - -## LDAP integrations - -- [LDAP Authentication]({{< relref "ldap.md" >}}) (OpenLDAP, ActiveDirectory, etc) - -## Auth proxy - -- [Auth Proxy]({{< relref "auth-proxy.md" >}}) If you want to handle authentication outside Grafana using a reverse - proxy. ## Grafana Auth diff --git a/docs/sources/enterprise/_index.md b/docs/sources/enterprise/_index.md index 253717193a5..4d78dece7cb 100755 --- a/docs/sources/enterprise/_index.md +++ b/docs/sources/enterprise/_index.md @@ -19,21 +19,9 @@ Grafana Enterprise includes all of the features found in the open source edition [Learn more about Grafana Enterprise.](https://grafana.com/enterprise) -## Enhanced security features +## Authentication -Grafana Enterprise includes integrations with more ways to authenticate your users and enhanced authorization capabilities. - -### Data source permissions - -[Data source permissions]({{< relref "datasource_permissions.md" >}}) allow you to restrict query access to only specific teams and users. - -### Enhanced LDAP integration - -With Grafana Enterprise [enhanced LDAP]({{< relref "enhanced_ldap.md" >}}), you can set up synchronization between LDAP groups and Grafana teams. - -### SAML authentication - -[SAML authentication]({{< relref "saml.md" >}}) enables your Grafana Enterprise users to authenticate with SAML. +Grafana Enterprise includes integrations with more ways to authenticate your users and enhanced authentication capabilities. ### Team sync @@ -42,26 +30,30 @@ With Grafana Enterprise [enhanced LDAP]({{< relref "enhanced_ldap.md" >}}), you Supported auth providers: * [Auth Proxy]({{< relref "../auth/auth-proxy.md#team-sync-enterprise-only">}}) +* [Azure AD OAuth]({{< relref "../auth/azuread.md#team-sync-enterprise-only" >}}) * [GitHub OAuth]({{< relref "../auth/github.md#team-sync-enterprise-only" >}}) * [GitLab OAuth]({{< relref "../auth/gitlab.md#team-sync-enterprise-only" >}}) * [LDAP]({{< relref "enhanced_ldap.md#ldap-group-synchronization-for-teams" >}}) +* [Okta]({{< relref "../auth/okta.md#team-sync-enterprise-only" >}}) * [SAML]({{< relref "saml.md#configure-team-sync" >}}) -## Reporting - -[Reporting]({{< relref "reporting.md" >}}) allows you to take any dashboard, generate a PDF report, and set up a schedule to have it emailed to whoever you choose. +### Enhanced LDAP integration -## Export dashboard as PDF +With Grafana Enterprise [enhanced LDAP]({{< relref "enhanced_ldap.md" >}}), you can set up active LDAP synchronization. -[Export dashboard as PDF]({{< relref "export-pdf.md" >}}) allows you to export a dashboard as a PDF document. +### SAML authentication -## White labeling +[SAML authentication]({{< relref "saml.md" >}}) enables your Grafana Enterprise users to authenticate with SAML. -[White labeling]({{< relref "white-labeling.md" >}}) allows you to replace the Grafana brand and logo with your own corporate brand and logo. You can also change footer links to point to your custom resources. +## Enterprise features -## Usage insights +With Grafana Enterprise, you get access to new features, including: -[Usage insights]({{< relref "usage-insights.md" >}}) allow you to understand how your Grafana instance is used. You can see who is looking at a dashboard, how often a dashboard is seen, and which dashboards are prone to errors. You'll also be able to discover what are the least and the most used dashboards. +* [Data source permissions]({{< relref "datasource_permissions.md" >}}) to restrict query access to specific teams and users. +* [Reporting]({{< relref "reporting.md" >}}) to generate a PDF report from any dashboard and set up a schedule to have it emailed to whoever you choose. +* [Export dashboard as PDF]({{< relref "export-pdf.md" >}}) +* [White labeling]({{< relref "white-labeling.md" >}}) to customize Grafana from the brand and logo to the footer links. +* [Usage insights]({{< relref "usage-insights.md" >}}) to understand how your Grafana instance is used. ## Enterprise plugins @@ -80,7 +72,7 @@ With a Grafana Enterprise license, you get access to premium plugins, including: To purchase or obtain a trial license contact the Grafana Labs [Sales Team](https://grafana.com/contact?about=support&topic=Grafana%20Enterprise). -## License file management +### License file management To download your Grafana Enterprise license log in to your [Grafana.com](https://grafana.com) account and go to your **Org Profile**. In the side menu there is a section for Grafana Enterprise licenses. At the bottom of the license details page there is **Download Token** link that will download the *license.jwt* file containing your license. diff --git a/docs/sources/enterprise/license-expiration.md b/docs/sources/enterprise/license-expiration.md index 13eea1b315f..d8f26b6f8a0 100644 --- a/docs/sources/enterprise/license-expiration.md +++ b/docs/sources/enterprise/license-expiration.md @@ -16,12 +16,13 @@ If your license has expired most of Grafana keeps working as normal. Some enterp ## Update your license -1. Locate your current `license.jwt` file. In a standard installation it is stored inside Grafana's data directory, which on a typical Linux installation is in `/var/lib/grafana/data`. This location might be overridden in the ini file [Configuration](https://grafana.com/docs/grafana/latest/installation/configuration/) -``` -[enterprise] -license_path = /path/to/your/license.jwt -``` -The configuration file's location may also be overridden by the `GF_ENTERPRISE_LICENSE_PATH` environment variable. +1. Locate your current `license.jwt` file. In a standard installation it is stored inside Grafana's data directory, which on a typical Linux installation is in `/var/lib/grafana/data`. This location might be overridden in the ini file [Configuration](https://grafana.com/docs/grafana/latest/installation/configuration/). + ```ini + [enterprise] + license_path = /path/to/your/license.jwt + ``` + The configuration file's location may also be overridden by the `GF_ENTERPRISE_LICENSE_PATH` environment variable. + 2. Log in to your [Grafana.com](https://grafana.com/login) user and make sure you're in the correct organization in the dropdown at the top of the page. 3. Under the **Grafana Enterprise** section in the menu bar to the left, choose licenses and download the currently valid license with which you want to run Grafana. If you cannot see a valid license on Grafana.com, please contact your account manager at Grafana Labs to renew your subscription. 4. Replace the current `license.jwt`-file with the one you've just downloaded. @@ -52,3 +53,7 @@ Enterprise plugins might stop working. ## White labeling The white labeling feature is turned off, meaning that any white labeling options will not have any effect. + +## Usage insights + +All the usage insights features are turned off, meaning that you won't be able to look at dashboard usage, presence indicator or to use improved search. Grafana still collects usage data and you will have access to it as soon as you update your license. diff --git a/docs/sources/enterprise/team-sync.md b/docs/sources/enterprise/team-sync.md index a6c2e645a36..4e6d13923fd 100644 --- a/docs/sources/enterprise/team-sync.md +++ b/docs/sources/enterprise/team-sync.md @@ -25,6 +25,16 @@ This mechanism allows Grafana to remove an existing synchronized user from a tea
+## Supported providers + +* [Auth Proxy]({{< relref "../auth/auth-proxy.md#team-sync-enterprise-only">}}) +* [Azure AD]({{< relref "../auth/azuread.md#team-sync-enterprise-only" >}}) +* [GitHub OAuth]({{< relref "../auth/github.md#team-sync-enterprise-only" >}}) +* [GitLab OAuth]({{< relref "../auth/gitlab.md#team-sync-enterprise-only" >}}) +* [LDAP]({{< relref "enhanced_ldap.md#ldap-group-synchronization-for-teams" >}}) +* [Okta]({{< relref "../auth/okta.md#team-sync-enterprise-only" >}}) +* [SAML]({{< relref "saml.md#configure-team-sync" >}}) + ## Synchronize a Grafana team with an external group If you have already grouped some users into a team, then you can synchronize that team with an external group. @@ -41,12 +51,3 @@ If you have already grouped some users into a team, then you can synchronize tha - For Auth Proxy, this is the value we receive as part of the custom `Groups` header. 1. Click `Add group` to save. - -## Supported providers - -* [Auth Proxy]({{< relref "../auth/auth-proxy.md#team-sync-enterprise-only">}}) -* [Azure AD]({{< relref "../auth/azuread.md#team-sync-enterprise-only" >}}) -* [GitHub OAuth]({{< relref "../auth/github.md#team-sync-enterprise-only" >}}) -* [GitLab OAuth]({{< relref "../auth/gitlab.md#team-sync-enterprise-only" >}}) -* [LDAP]({{< relref "enhanced_ldap.md#ldap-group-synchronization-for-teams" >}}) -* [SAML]({{< relref "saml.md#configure-team-sync" >}})