mirror of
https://github.com/grafana/grafana.git
synced 2025-02-25 18:55:37 -06:00
Docs: Identify which Grafana editions are relevant to each Enterprise doc (#49207)
* Add section to Ent docs index re: Cloud features * Add and update notes identifying Enterprise and Cloud features * Address feedback
This commit is contained in:
committed by
GitHub
parent
1d7d8bbf96
commit
3ecee06630
@@ -10,9 +10,13 @@ weight = 150
|
||||
|
||||
Grafana Enterprise is a commercial edition of Grafana that includes additional features not found in the open source version.
|
||||
|
||||
Building on everything you already know and love about Grafana open source, Grafana Enterprise includes [exclusive datasource plugins]({{< relref "#enterprise-plugins">}}) and [additional features]({{< relref "#enterprise-features">}}). On top of that you get 24x7x365 support and training from the core Grafana team.
|
||||
Building on everything you already know and love about Grafana open source, Grafana Enterprise includes [exclusive datasource plugins]({{< relref "#enterprise-plugins">}}) and [additional features]({{< relref "#enterprise-features">}}). You also get 24x7x365 support and training from the core Grafana team.
|
||||
|
||||
To learn more about Grafana Enterprise, refer to [our product page.](https://grafana.com/enterprise)
|
||||
To learn more about Grafana Enterprise, refer to [our product page](https://grafana.com/enterprise).
|
||||
|
||||
## Enterprise features in Grafana Cloud
|
||||
|
||||
Many Grafana Enterprise features are also available in [Grafana Cloud]({{< relref "/grafana-cloud" >}}) Pro and Advanced accounts. For details, refer to [the Grafana Cloud features table](https://grafana.com/pricing/#featuresTable) and [Enterprise features available to Grafana Cloud Pro and Advanced accounts]({{< relref "/grafana-cloud/reference/enterprise-features" >}}).
|
||||
|
||||
## Authentication
|
||||
|
||||
@@ -34,23 +38,23 @@ Supported auth providers:
|
||||
|
||||
### Enhanced LDAP integration
|
||||
|
||||
With Grafana Enterprise [enhanced LDAP]({{< relref "enhanced_ldap.md" >}}), you can set up active LDAP synchronization.
|
||||
With [enhanced LDAP integration]({{< relref "enhanced_ldap.md" >}}), you can set up active LDAP synchronization.
|
||||
|
||||
### SAML authentication
|
||||
|
||||
[SAML authentication]({{< relref "./saml" >}}) enables your Grafana Enterprise users to authenticate with SAML.
|
||||
[SAML authentication]({{< relref "./saml" >}}) enables users to authenticate with single sign-on services that use Security Assertion Markup Language (SAML).
|
||||
|
||||
## Enterprise features
|
||||
|
||||
With Grafana Enterprise, you get access to the following features:
|
||||
Grafana Enterprise adds the following features:
|
||||
|
||||
- [Role-based access control]({{< relref "./access-control/_index.md" >}}) to control access with role-based permissions.
|
||||
- [Role-based access control]({{< relref "./access-control/" >}}) to control access with role-based permissions.
|
||||
- [Data source permissions]({{< relref "datasource_permissions.md" >}}) to restrict query access to specific teams and users.
|
||||
- [Data source query caching]({{< relref "query-caching.md" >}}) to temporarily store query results in Grafana to reduce data source load and rate limiting.
|
||||
- [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/_index.md" >}}) to understand how your Grafana instance is used.
|
||||
- [Usage insights]({{< relref "./usage-insights/" >}}) to understand how your Grafana instance is used.
|
||||
- [Vault integration]({{< relref "vault.md" >}}) to manage your configuration or provisioning secrets with Vault.
|
||||
- [Auditing]({{< relref "auditing.md" >}}) tracks important changes to your Grafana instance to help you manage and mitigate suspicious activity and meet compliance requirements.
|
||||
- [Request security]({{< relref "request-security.md" >}}) makes it possible to restrict outgoing requests from the Grafana server.
|
||||
@@ -58,7 +62,7 @@ With Grafana Enterprise, you get access to the following features:
|
||||
|
||||
## Enterprise data sources
|
||||
|
||||
With a Grafana Enterprise license, you get access to premium data sources, including:
|
||||
With a Grafana Enterprise license, you also get access to premium data sources, including:
|
||||
|
||||
- [AppDynamics](https://grafana.com/grafana/plugins/dlopes7-appdynamics-datasource)
|
||||
- [Azure Devops](https://grafana.com/grafana/plugins/grafana-azuredevops-datasource)
|
||||
@@ -80,4 +84,4 @@ With a Grafana Enterprise license, you get access to premium data sources, inclu
|
||||
|
||||
## Try Grafana Enterprise
|
||||
|
||||
To purchase or obtain a trial license contact the Grafana Labs [Sales Team](https://grafana.com/contact?about=support&topic=Grafana%20Enterprise).
|
||||
To purchase or obtain a trial license, contact the Grafana Labs [Sales Team](https://grafana.com/contact?about=support&topic=Grafana%20Enterprise).
|
||||
|
||||
@@ -8,10 +8,10 @@ weight = 1100
|
||||
|
||||
# Auditing
|
||||
|
||||
> **Note:** Only available in Grafana Enterprise v7.3+.
|
||||
|
||||
Auditing allows you to track important changes to your Grafana instance. By default, audit logs are logged to file but the auditing feature also supports sending logs directly to Loki.
|
||||
|
||||
> **Note:** Available in [Grafana Enterprise]({{< relref "../enterprise" >}}) version 7.3 and later, and [Grafana Cloud Advanced]({{< relref "/grafana-cloud" >}}).
|
||||
|
||||
## Audit logs
|
||||
|
||||
Audit logs are JSON objects representing user actions like:
|
||||
@@ -331,7 +331,7 @@ max_file_size_mb = 256
|
||||
|
||||
Audit logs are sent to a [Loki](/oss/loki/) service, through HTTP or gRPC.
|
||||
|
||||
> The HTTP option for the Loki exporter is only available in Grafana Enterprise v7.4+.
|
||||
> **Note:** The HTTP option for the Loki exporter is available only in Grafana Enterprise version 7.4 and later.
|
||||
|
||||
```ini
|
||||
[auditing.logs.loki]
|
||||
|
||||
@@ -10,7 +10,7 @@ weight = 500
|
||||
|
||||
Data source permissions allow you to restrict access for users to query a data source. For each data source there is a permission page that allows you to enable permissions and restrict query permissions to specific **Users** and **Teams**.
|
||||
|
||||
> Only available in Grafana Enterprise.
|
||||
> **Note:** Available in [Grafana Enterprise]({{< relref "../enterprise" >}}) and [Grafana Cloud Pro and Advanced]({{< relref "/grafana-cloud" >}}).
|
||||
|
||||
## Enable data source permissions
|
||||
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
+++
|
||||
aliases = ["/docs/grafana/latest/enterprise/enhanced_ldap/"]
|
||||
description = "Grafana Enhanced LDAP Integration Guide "
|
||||
description = "Grafana Enhanced LDAP Integration Guide"
|
||||
keywords = ["grafana", "configuration", "documentation", "ldap", "active directory", "enterprise"]
|
||||
title = "Enhanced LDAP Integration"
|
||||
weight = 600
|
||||
@@ -10,9 +10,9 @@ weight = 600
|
||||
|
||||
The enhanced LDAP integration adds additional functionality on top of the [LDAP integration]({{< relref "../auth/ldap.md" >}}) available in the open source edition of Grafana.
|
||||
|
||||
> Enhanced LDAP integration is only available in [Grafana Cloud Advanced](https://grafana.com/docs/grafana-cloud/) and in [Grafana Enterprise]({{< relref "../enterprise" >}}).
|
||||
> **Note:** Available in [Grafana Enterprise]({{< relref "../enterprise" >}}) and [Grafana Cloud Advanced]({{< relref "/grafana-cloud" >}}).
|
||||
|
||||
> Refer to [Role-based access control]({{< relref "../enterprise/access-control/_index.md" >}}) in Grafana Enterprise to understand how you can control access with role-based permissions.
|
||||
> To control user access with role-based permissions, refer to [role-based access control]({{< relref "./access-control" >}}).
|
||||
|
||||
## LDAP group synchronization for teams
|
||||
|
||||
@@ -33,7 +33,7 @@ a user as member of a team, and it will not be removed when the user signs in. T
|
||||
|
||||
In the open source version of Grafana, user data from LDAP is synchronized only during the login process when authenticating using LDAP.
|
||||
|
||||
With active LDAP synchronization, available in Grafana Enterprise v6.3+, you can configure Grafana to actively sync users with LDAP servers in the background. Only users that have logged into Grafana at least once are synchronized.
|
||||
With active LDAP synchronization, available in Grafana Enterprise version 6.3 and later, you can configure Grafana to actively sync users with LDAP servers in the background. Only users that have logged into Grafana at least once are synchronized.
|
||||
|
||||
Users with updated role and team membership will need to refresh the page to get access to the new features.
|
||||
|
||||
|
||||
@@ -19,7 +19,7 @@ Defaults to `<paths.data>/license.jwt`.
|
||||
|
||||
### license_text
|
||||
|
||||
> **Note:** Available in Grafana Enterprise v7.4+.
|
||||
> **Note:** Available in Grafana Enterprise version 7.4 and later.
|
||||
|
||||
When set to the text representation (i.e. content of the license file)
|
||||
of the license, Grafana will evaluate and apply the given license to
|
||||
@@ -27,7 +27,7 @@ the instance.
|
||||
|
||||
### auto_refresh_license
|
||||
|
||||
> **Note:** Available in Grafana Enterprise v7.4+.
|
||||
> **Note:** Available in Grafana Enterprise version 7.4 and later.
|
||||
|
||||
When enabled, Grafana will send the license and usage statistics to
|
||||
the license issuer. If the license has been updated on the issuer's
|
||||
@@ -37,7 +37,7 @@ automatically. Defaults to `true`.
|
||||
|
||||
### license_validation_type
|
||||
|
||||
> **Note:** Available in Grafana Enterprise v8.3+.
|
||||
> **Note:** Available in Grafana Enterprise version 8.3 and later.
|
||||
|
||||
When set to `aws`, Grafana will validate its license status with Amazon Web Services (AWS) instead of with Grafana Labs. Only use this setting if you purchased an Enterprise license from AWS Marketplace. Defaults to empty, which means that by default Grafana Enterprise will validate using a license issued by Grafana Labs. For details about licenses issued by AWS, refer to [Activate a Grafana Enterprise license purchased through AWS Marketplace]({{< relref "../enterprise/license/activate-aws-marketplace-license/" >}}).
|
||||
|
||||
@@ -322,7 +322,7 @@ New duration for renewed tokens. Vault may be configured to ignore this value an
|
||||
|
||||
## [security.egress]
|
||||
|
||||
> **Note:** Available in Grafana Enterprise v7.4 and later versions.
|
||||
> **Note:** Available in Grafana Enterprise version 7.4 and later.
|
||||
|
||||
Security egress makes it possible to control outgoing traffic from the Grafana server.
|
||||
|
||||
@@ -350,7 +350,7 @@ Encryption algorithm used to encrypt secrets stored in the database and cookies.
|
||||
|
||||
## [caching]
|
||||
|
||||
> **Note:** Available in Grafana Enterprise v7.5 and later versions.
|
||||
> **Note:** Available in Grafana Enterprise version 7.5 and later.
|
||||
|
||||
When query caching is enabled, Grafana can temporarily store the results of data source queries and serve cached responses to similar requests.
|
||||
|
||||
|
||||
@@ -8,11 +8,11 @@ weight = 1400
|
||||
|
||||
# Export dashboard as PDF
|
||||
|
||||
You can generate PDFs from any of your dashboards and save it to file.
|
||||
You can generate and save PDF files from any of your dashboards.
|
||||
|
||||
> Only available in Grafana Enterprise v6.7+.
|
||||
> **Note:** Available in [Grafana Enterprise]({{< relref "../enterprise" >}}).
|
||||
|
||||
1. In the upper right corner of the dashboard that you want to export as PDF, click the **Share dashboard** icon.
|
||||
1. On the PDF tab, select the layout option for exported dashboard: **Portrait** or **Landscape**.
|
||||
1. Click **Save as PDF** to render dashboard as a PDF document.
|
||||
Grafana opens the PDF in a new window or browser tab.
|
||||
1. Click **Save as PDF** to render the dashboard as a PDF file.
|
||||
Grafana opens the PDF file in a new window or browser tab.
|
||||
|
||||
@@ -12,6 +12,8 @@ When query caching is enabled, Grafana temporarily stores the results of data so
|
||||
|
||||
Query caching works for all backend data sources, and queries sent through the data source proxy. You can enable the cache globally and configure the cache duration (also called Time to Live, or TTL).
|
||||
|
||||
> **Note:** Available in [Grafana Enterprise]({{< relref "../enterprise" >}}) and [Grafana Cloud Pro and Advanced]({{< relref "/grafana-cloud" >}}).
|
||||
|
||||
The following cache backends are available: in-memory, Redis, and Memcached.
|
||||
|
||||
> **Note:** Storing cached queries in-memory can increase Grafana's memory footprint. In production environments, a Redis or Memcached backend is highly recommended.
|
||||
@@ -30,7 +32,7 @@ You can make a panel retrieve fresh data more frequently by increasing the **Max
|
||||
|
||||
## Data sources that work with query caching
|
||||
|
||||
Query caching works for all [Enterprise data sources](https://grafana.com/grafana/plugins/?type=datasource&enterprise=1), and it works for the following [built-in data sources]({{< relref "../datasources/_index.md" >}}):
|
||||
Query caching works for all [Enterprise data sources](https://grafana.com/grafana/plugins/?type=datasource&enterprise=1) as well as the following [built-in data sources]({{< relref "../datasources/_index.md" >}}):
|
||||
|
||||
- CloudWatch Metrics
|
||||
- Google Cloud Monitoring
|
||||
|
||||
@@ -12,6 +12,8 @@ Recorded queries allow you to see trends over time by taking a snapshot of a dat
|
||||
|
||||
For our plugins that do not return time series, it might be useful to plot historical data. For example, you might want to query ServiceNow to see a history of request response times but it can only return current point-in-time metrics.
|
||||
|
||||
> **Note:** Available in [Grafana Enterprise]({{< relref "../enterprise" >}}).
|
||||
|
||||
## How recorded queries work
|
||||
|
||||
> **Note:** An administrator must configure a Prometheus data source and associate it with a [Remote write target](#remote-write-target) before recorded queries can be used.
|
||||
|
||||
@@ -10,7 +10,7 @@ weight = 800
|
||||
|
||||
Reporting allows you to automatically generate PDFs from any of your dashboards and have Grafana email them to interested parties on a schedule. This is available in Grafana Cloud Pro and Advanced and in Grafana Enterprise.
|
||||
|
||||
> If you have [Role-based access control]({{< relref "../enterprise/access-control/_index.md" >}}) enabled, for some actions you would need to have relevant permissions.
|
||||
> If you enabled [Role-based access control]({{< relref "../enterprise/access-control/_index.md" >}}), for some actions users would need to have relevant permissions.
|
||||
> Refer to specific guides to understand what permissions are required.
|
||||
|
||||
{{< figure src="/static/img/docs/enterprise/reports_list_8.1.png" max-width="500px" class="docs-image--no-shadow" >}}
|
||||
@@ -51,7 +51,7 @@ Only organization admins can create reports by default. You can customize who ca
|
||||
|
||||
### Choose template variables
|
||||
|
||||
> **Note:** Available in Grafana Enterprise version 7.5+ (behind `reportVariables` feature flag) and Grafana Enterprise version 8+ without a feature flag.
|
||||
> **Note:** Available in [Grafana Enterprise]({{< relref "../enterprise" >}}) version 7.5 and later behind the `reportVariables` feature flag, Grafana Enterprise version 8.0 and later without a feature flag, and [Grafana Cloud Pro and Advanced]({{< relref "/grafana-cloud" >}}).
|
||||
|
||||
You can configure report-specific template variables for the dashboard on the report page. The variables that you select will override the variables from the dashboard, and they are used when rendering a PDF file of the report. For detailed information about using template variables, refer to the [Templates and variables]({{< relref "../variables/_index.md" >}}) section.
|
||||
|
||||
@@ -59,7 +59,7 @@ You can configure report-specific template variables for the dashboard on the re
|
||||
|
||||
### Render a report with panels or rows set to repeat by a variable
|
||||
|
||||
> **Note:** Available in Grafana Enterprise v8+.
|
||||
> **Note:** Available in [Grafana Enterprise]({{< relref "../enterprise" >}}) version 8.0 and later, and [Grafana Cloud Pro and Advanced]({{< relref "/grafana-cloud" >}}).
|
||||
|
||||
You can include dynamic dashboards with panels or rows, set to repeat by a variable, into reports. For detailed information about setting up repeating panels or rows in dashboards, refer to the [Repeat panels or rows]({{< relref "../panels/add-panels-dynamically/" >}}) section.
|
||||
|
||||
@@ -71,7 +71,7 @@ You can include dynamic dashboards with panels or rows, set to repeat by a varia
|
||||
|
||||
### Report time range
|
||||
|
||||
> Setting custom report time range is available in Grafana Enterprise v7.2+.
|
||||
> **Note:** You can set custom report time ranges in [Grafana Enterprise]({{< relref "../enterprise" >}}) 7.2+ and [Grafana Cloud Pro and Advanced]({{< relref "/grafana-cloud" >}}).
|
||||
|
||||
By default, reports use the saved time range of the dashboard. Changing the time range of the report can be done by:
|
||||
|
||||
@@ -84,7 +84,7 @@ If the time zone is set differently between your Grafana server and its remote i
|
||||
|
||||
### Layout and orientation
|
||||
|
||||
> We're actively working on developing new report layout options. [Contact us](https://grafana.com/contact?about=grafana-enterprise&topic=design-process&value=reporting) if you would like to get involved in the design process.
|
||||
> We're actively developing new report layout options. [Contact us](https://grafana.com/contact?about=grafana-enterprise&topic=design-process&value=reporting) to get involved in the design process.
|
||||
|
||||
| Layout | Orientation | Support | Description | Preview |
|
||||
| ------ | ----------- | ------- | --------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
@@ -95,7 +95,7 @@ If the time zone is set differently between your Grafana server and its remote i
|
||||
|
||||
### CSV export
|
||||
|
||||
> **Note:** Only available in Grafana Enterprise v8.0+, with the [Grafana image renderer plugin](https://grafana.com/grafana/plugins/grafana-image-renderer) v3.0+.
|
||||
> **Note:** Available in [Grafana Enterprise]({{< relref "../enterprise" >}}) 8+ with the [Grafana image renderer plugin](https://grafana.com/grafana/plugins/grafana-image-renderer) v3.0+, and [Grafana Cloud Pro and Advanced]({{< relref "/grafana-cloud" >}}).
|
||||
|
||||
You can attach a CSV file to the report email for each table panel on the selected dashboard, along with the PDF report. By default, CSVs larger than 10Mb won't be sent to avoid email servers to reject the email. You can increase or decrease this limit in the [reporting configuration]({{< relref "#rendering-configuration" >}}).
|
||||
|
||||
@@ -107,9 +107,10 @@ A background job runs every 10 minutes and removes temporary CSV files. You can
|
||||
|
||||
### Scheduling
|
||||
|
||||
> Note: Scheduler has been significantly changed in Grafana Enterprise v8.1.
|
||||
> **Note:** Available in [Grafana Enterprise]({{< relref "../enterprise" >}}) version 8.0 and later, and [Grafana Cloud Pro and Advanced]({{< relref "/grafana-cloud" >}}).
|
||||
> The scheduler was significantly changed in Grafana Enterprise version 8.1.
|
||||
|
||||
Scheduled reports can be sent once or repeatedly on an hourly, daily, weekly, or monthly basis, or at custom intervals. You can also disable scheduling by selecting **Never**: for example, if you want to send the report via the API.
|
||||
Scheduled reports can be sent once, or repeated on an hourly, daily, weekly, or monthly basis, or sent at custom intervals. You can also disable scheduling by selecting **Never**, for example to send the report via the API.
|
||||
|
||||
{{< figure src="/static/img/docs/enterprise/reports_scheduler_8.1.png" max-width="500px" class="docs-image--no-shadow" >}}
|
||||
|
||||
@@ -129,7 +130,7 @@ When you schedule a report with a monthly frequency, and set the start date betw
|
||||
|
||||
### Send test email
|
||||
|
||||
> Only available in Grafana Enterprise v7.0+.
|
||||
> **Note:** Available in [Grafana Enterprise]({{< relref "../enterprise" >}}) version 7.0 and later, and [Grafana Cloud Pro and Advanced]({{< relref "/grafana-cloud" >}}).
|
||||
|
||||
1. In the report, click **Send test email**.
|
||||
1. In the Email field, enter the email address or addresses that you want to test, separated by semicolon.
|
||||
@@ -142,7 +143,7 @@ The last saved version of the report will be sent to selected emails. You can us
|
||||
|
||||
## Pause report
|
||||
|
||||
> **Note:** Available in Grafana Enterprise v8+.
|
||||
> **Note:** Available in [Grafana Enterprise]({{< relref "../enterprise" >}}) version 8.0 and later, and [Grafana Cloud Pro and Advanced]({{< relref "/grafana-cloud" >}}).
|
||||
|
||||
You can pause sending of reports from the report list view by clicking the pause icon. The report will not be sent according to its schedule until it is resumed by clicking the resume button on the report row.
|
||||
|
||||
@@ -183,14 +184,15 @@ font_italic = DejaVuSansCondensed-Oblique.ttf
|
||||
|
||||
## Reports settings
|
||||
|
||||
> **Note:** Available in Grafana Enterprise v7.2+.
|
||||
> **Note:** Available in [Grafana Enterprise]({{< relref "../enterprise" >}}) version 7.2 and later, and [Grafana Cloud Pro and Advanced]({{< relref "/grafana-cloud" >}}).
|
||||
|
||||
You can configure organization-wide report settings in the **Settings** tab on the **Reporting** page. Settings are applied to all the reports for current organization.
|
||||
|
||||
You can customize the branding options.
|
||||
|
||||
Report branding:
|
||||
**Company logo URL** - Company logo displayed in the report PDF. Defaults to the Grafana logo.
|
||||
|
||||
- **Company logo URL** - Company logo displayed in the report PDF. Defaults to the Grafana logo.
|
||||
|
||||
Email branding:
|
||||
|
||||
|
||||
@@ -8,17 +8,12 @@ weight = 400
|
||||
|
||||
# Request security
|
||||
|
||||
> **Note:** Available in Grafana Enterprise v7.4 and later versions.
|
||||
|
||||
Request security makes it possible to limit requests from the Grafana server, and it targets requests that are generated by users.
|
||||
|
||||
For example:
|
||||
|
||||
- Data source metric queries
|
||||
- Alert notifications
|
||||
Request security allows you to limit requests from the Grafana server by targeting requests generated by users, such as data source metric queries and alert notifications.
|
||||
|
||||
This can be used to limit access to internal systems that the server Grafana runs on can access but that users of Grafana should not be able to access. This feature does not affect traffic from the Grafana users browser.
|
||||
|
||||
> **Note:** Available in [Grafana Enterprise]({{< relref "../enterprise" >}}) version 7.4 and later, and [Grafana Cloud Pro and Advanced]({{< relref "/grafana-cloud" >}}).
|
||||
|
||||
> **Note:** Although request security works with backend plugins, you can create a backend plugin that bypasses this security.
|
||||
|
||||
## IP and hostname blocking
|
||||
|
||||
@@ -17,6 +17,6 @@ weight: 10
|
||||
|
||||
SAML authentication integration enables your Grafana users to log in by using an external SAML 2.0 Identity Provider (IdP). To enable this, Grafana becomes a Service Provider (SP) in the authentication flow, interacting with the IdP to exchange user information.
|
||||
|
||||
> Only available in Grafana Enterprise v6.3+. If you experience any issues with our implementation, contact our [Technical Support team](https://grafana.com/contact?plcmt=top-nav&cta=contactus)
|
||||
> **Note:** Available in [Grafana Enterprise]({{< relref "../enterprise" >}}) and [Grafana Cloud Pro and Advanced]({{< relref "/grafana-cloud" >}}).
|
||||
|
||||
{{< section >}}
|
||||
|
||||
@@ -20,7 +20,7 @@ SAML authentication integration allows your Grafana users to log in by using an
|
||||
|
||||
The SAML single sign-on (SSO) standard is varied and flexible. Our implementation contains a subset of features needed to provide a smooth authentication experience into Grafana.
|
||||
|
||||
> Only available in Grafana Enterprise v6.3+. If you encounter any problems with our implementation, please don't hesitate to contact us.
|
||||
> **Note:** Available in [Grafana Enterprise]({{< relref "../enterprise" >}}) and [Grafana Cloud Pro and Advanced]({{< relref "/grafana-cloud" >}}).
|
||||
|
||||
## Supported SAML
|
||||
|
||||
|
||||
@@ -46,7 +46,7 @@ The table below describes all SAML configuration options. Continue reading below
|
||||
|
||||
### Signature algorithm
|
||||
|
||||
> Only available in Grafana v7.3+
|
||||
> **Note:** Available in Grafana version 7.3 and later.
|
||||
|
||||
The SAML standard recommends using a digital signature for some types of messages, like authentication or logout requests. If the `signature_algorithm` option is configured, Grafana will put a digital signature into SAML requests. Supported signature types are `rsa-sha1`, `rsa-sha256`, `rsa-sha512`. This option should match your IdP configuration, otherwise, signature validation will fail. Grafana uses key and certificate configured with `private_key` and `certificate` options for signing SAML requests.
|
||||
|
||||
@@ -83,7 +83,7 @@ The integration provides two key endpoints as part of Grafana:
|
||||
|
||||
### IdP-initiated Single Sign-On (SSO)
|
||||
|
||||
> Only available in Grafana v7.3+
|
||||
> **Note:** Available in Grafana version 7.3 and later.
|
||||
|
||||
By default, Grafana allows only service provider (SP) initiated logins (when the user logs in with SAML via Grafana’s login page). If you want users to log in into Grafana directly from your identity provider (IdP), set the `allow_idp_initiated` configuration option to `true` and configure `relay_state` with the same value specified in the IdP configuration.
|
||||
|
||||
@@ -91,7 +91,7 @@ IdP-initiated SSO has some security risks, so make sure you understand the risks
|
||||
|
||||
### Single logout
|
||||
|
||||
> Only available in Grafana v7.3+
|
||||
> **Note:** Available in Grafana version 7.3 and later.
|
||||
|
||||
SAML's single logout feature allows users to log out from all applications associated with the current IdP session established via SAML SSO. If the `single_logout` option is set to `true` and a user logs out, Grafana requests IdP to end the user session which in turn triggers logout from all other applications the user is logged into using the same IdP session (applications should support single logout). Conversely, if another application connected to the same IdP logs out using single logout, Grafana receives a logout request from IdP and ends the user session.
|
||||
|
||||
@@ -125,7 +125,7 @@ By default, new Grafana users using SAML authentication will have an account cre
|
||||
|
||||
### Configure team sync
|
||||
|
||||
> Team sync support for SAML only available in Grafana v7.0+
|
||||
> **Note:** Team sync support for SAML is available in Grafana version 7.0 and later.
|
||||
|
||||
To use SAML Team sync, set [`assertion_attribute_groups`]({{< relref ".././enterprise-configuration.md#assertion-attribute-groups" >}}) to the attribute name where you store user groups. Then Grafana will use attribute values extracted from SAML assertion to add user into the groups with the same name configured on the External group sync tab.
|
||||
|
||||
@@ -133,7 +133,7 @@ To use SAML Team sync, set [`assertion_attribute_groups`]({{< relref ".././enter
|
||||
|
||||
### Configure role sync
|
||||
|
||||
> Only available in Grafana v7.0+
|
||||
> **Note:** Available in Grafana version 7.0 and later.
|
||||
|
||||
Role sync allows you to map user roles from an identity provider to Grafana. To enable role sync, configure role attribute and possible values for the Editor, Admin, and Grafana Admin roles. For more information about user roles, refer to [About users and permissions]({{< relref "../../administration/manage-users-and-permissions/about-users-and-permissions.md" >}}).
|
||||
|
||||
@@ -160,7 +160,7 @@ role_values_grafana_admin = superadmin
|
||||
|
||||
### Configure organization mapping
|
||||
|
||||
> Only available in Grafana v7.0+
|
||||
> **Note:** Available in Grafana version 7.0 and later.
|
||||
|
||||
Organization mapping allows you to assign users to particular organization in Grafana depending on attribute value obtained from identity provider.
|
||||
|
||||
@@ -186,7 +186,7 @@ You can use `*` as an Organization if you want all your users to be in some orga
|
||||
|
||||
### Configure allowed organizations
|
||||
|
||||
> Only available in Grafana v7.0+
|
||||
> **Note:** Available in Grafana version 7.0 and later.
|
||||
|
||||
With the [`allowed_organizations`]({{< relref ".././enterprise-configuration.md#allowed-organizations" >}}) option you can specify a list of organizations where the user must be a member of at least one of them to be able to log in to Grafana.
|
||||
|
||||
|
||||
@@ -8,9 +8,9 @@ weight = 500
|
||||
|
||||
# Settings updates at runtime
|
||||
|
||||
> **Note:** Available in Grafana Enterprise v8.0+.
|
||||
> **Note:** Available in Grafana Enterprise version 8.0 and later.
|
||||
|
||||
Settings updates at runtime allows you to update Grafana settings with no need to restart the Grafana server.
|
||||
By updating settings at runtime, you can update Grafana settings without needing to restart the Grafana server.
|
||||
|
||||
Updates that happen at runtime are stored in the database and override
|
||||
[settings from the other sources](https://grafana.com/docs/grafana/latest/administration/configuration/)
|
||||
@@ -88,5 +88,5 @@ HTTP API, then the other instances are synchronized through the database and the
|
||||
|
||||
## Control access with role-based access control
|
||||
|
||||
If you have [Role-based access control]({{< relref "../enterprise/access-control/_index.md" >}}) enabled, you can control who can read or update settings.
|
||||
If you have [role-based access control]({{< relref "../enterprise/access-control/_index.md" >}}) enabled, you can control who can read or update settings.
|
||||
Refer to the [Admin API]({{< relref "../developers/http_api/admin.md#update-settings" >}}) for more information.
|
||||
|
||||
@@ -12,7 +12,7 @@ weight = 1000
|
||||
|
||||
Team sync lets you set up synchronization between your auth providers teams and teams in Grafana. This enables LDAP, OAuth, or SAML users who are members of certain teams or groups to automatically be added or removed as members of certain teams in Grafana.
|
||||
|
||||
> Available in Grafana Cloud Pro and Advanced and in Grafana Enterprise.
|
||||
> **Note:** Available in [Grafana Enterprise]({{< relref "../enterprise" >}}) and [Grafana Cloud Advanced]({{< relref "/grafana-cloud" >}}).
|
||||
|
||||
Grafana keeps track of all synchronized users in teams, and you can see which users have been synchronized in the team members list, see `LDAP` label in screenshot.
|
||||
This mechanism allows Grafana to remove an existing synchronized user from a team when its group membership changes. This mechanism also enables you to manually add a user as member of a team, and it will not be removed when the user signs in. This gives you flexibility to combine LDAP group memberships and Grafana team memberships.
|
||||
|
||||
@@ -10,6 +10,8 @@ weight = 200
|
||||
|
||||
Usage insights allow you to have a better understanding of how your Grafana instance is used.
|
||||
|
||||
> **Note:** Available in [Grafana Enterprise]({{< relref "../enterprise" >}}) and [Grafana Cloud Pro and Advanced]({{< relref "/grafana-cloud" >}}).
|
||||
|
||||
The usage insights feature collects a number of aggregated data and stores them in the database:
|
||||
|
||||
- Dashboard views (aggregated and per user)
|
||||
|
||||
@@ -12,7 +12,7 @@ For every dashboard and data source, you can access usage information.
|
||||
|
||||
## Dashboard insights
|
||||
|
||||
> **Note:** Available in Grafana Enterprise v7.0+.
|
||||
> **Note:** Available in [Grafana Enterprise]({{< relref "../enterprise" >}}) version 7.0 and later, and [Grafana Cloud Pro and Advanced]({{< relref "/grafana-cloud" >}}).
|
||||
|
||||
To see dashboard usage information, go to the top bar and click **Dashboard insights**.
|
||||
|
||||
@@ -27,7 +27,7 @@ Dashboard insights show the following information:
|
||||
|
||||
## Data source insights
|
||||
|
||||
> **Note:** Available in Grafana Enterprise v7.3+.
|
||||
> **Note:** Available in [Grafana Enterprise]({{< relref "../enterprise" >}}) version 7.3 and later, and [Grafana Cloud Pro and Advanced]({{< relref "/grafana-cloud" >}}).
|
||||
|
||||
Data source insights give you information about how a data source has been used in the past 30 days, such as:
|
||||
|
||||
|
||||
@@ -8,7 +8,7 @@ weight = 500
|
||||
|
||||
# Export logs of usage insights
|
||||
|
||||
> **Note:** Available in Grafana Enterprise v7.4+.
|
||||
> **Note:** Available in [Grafana Enterprise]({{< relref "../enterprise" >}}) version 7.4 and later, and [Grafana Cloud Pro and Advanced]({{< relref "/grafana-cloud" >}}).
|
||||
|
||||
By exporting usage logs to Loki, you can directly query them and create dashboards of the information that matters to you most, such as dashboard errors, most active organizations, or your top-10 most-used queries.
|
||||
|
||||
|
||||
@@ -8,7 +8,7 @@ weight = 400
|
||||
|
||||
# Sort dashboards by using insights data
|
||||
|
||||
> **Note:** Available in Grafana Enterprise v7.0+.
|
||||
> **Note:** Available in [Grafana Enterprise]({{< relref "../enterprise" >}}) version 7.0 and later, and [Grafana Cloud Pro and Advanced]({{< relref "/grafana-cloud" >}}).
|
||||
|
||||
In the search view, you can sort dashboards by using insights data. Doing so helps you find unused or broken dashboards or discover those that are most viewed.
|
||||
|
||||
|
||||
@@ -8,7 +8,7 @@ weight = 300
|
||||
|
||||
# Presence indicator
|
||||
|
||||
> **Note:** Available in Grafana Enterprise v7.0+.
|
||||
> **Note:** Available in [Grafana Enterprise]({{< relref "../enterprise" >}}) version 7.0 and later, and [Grafana Cloud Pro and Advanced]({{< relref "/grafana-cloud" >}}).
|
||||
|
||||
When you are signed in and looking at any given dashboard, you can know who is looking at the same dashboard as you are via a presence indicator, which displays avatars of users who have interacted with the dashboard recently. The default time frame is within the past 10 minutes. To see the user's name, hover over the user's avatar. The avatars come from [Gravatar](https://gravatar.com) based on the user's email.
|
||||
|
||||
|
||||
@@ -8,10 +8,9 @@ weight = 1200
|
||||
|
||||
# Vault integration
|
||||
|
||||
> Only available in Grafana Enterprise v7.1+.
|
||||
If you manage your secrets with [Hashicorp Vault](https://www.hashicorp.com/products/vault), you can use them for [Configuration]({{< relref "../administration/configuration.md" >}}) and [Provisioning]({{< relref "../administration/provisioning.md" >}}).
|
||||
|
||||
If you manage your secrets with [Hashicorp Vault](https://www.hashicorp.com/products/vault), you can use them for [Configuration]({{< relref "../administration/configuration.md" >}})
|
||||
and [Provisioning]({{< relref "../administration/provisioning.md" >}}).
|
||||
> **Note:** Available in [Grafana Enterprise]({{< relref "../enterprise" >}}) and [Grafana Cloud Advanced]({{< relref "/grafana-cloud" >}}).
|
||||
|
||||
> **Note:** If you have Grafana [set up for high availability]({{< relref "../administration/set-up-for-high-availability.md" >}}), then we advise not to use dynamic secrets for provisioning files.
|
||||
> Each Grafana instance is responsible for renewing its own leases. Your data source leases might expire when one of your Grafana servers shuts down.
|
||||
|
||||
@@ -10,7 +10,7 @@ weight = 1300
|
||||
|
||||
White labeling allows you to replace the Grafana brand and logo with your own corporate brand and logo.
|
||||
|
||||
> Only available in Grafana Enterprise v6.6+.
|
||||
> **Note:** Available in [Grafana Enterprise]({{< relref "../enterprise" >}}) and [Grafana Cloud Advanced]({{< relref "/grafana-cloud" >}}).
|
||||
|
||||
Grafana Enterprise has white labeling options in the `grafana.ini` file. As with all configuration options, you can also set them with environment variables.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user