diff --git a/docs/README.md b/docs/README.md index 4bea7d788e7..0bf4e8446b5 100644 --- a/docs/README.md +++ b/docs/README.md @@ -48,18 +48,6 @@ Only use [reference style links](https://grafana.com/docs/writers-toolkit/write/ ### [Contributing](/contribute/documentation/README.md) -### Using `relref` for internal links - -Use the Hugo shortcode [relref](https://gohugo.io/content-management/cross-references/#use-ref-and-relref) any time you are linking to other internal docs pages. - -Syntax is: - -``` -{{< relref "example.md" >}} -``` - -You might need to add more context for the link (containing folders and so on, `folder/example.md`) if Hugo says the relref is ambiguous. - ### Managing redirects When moving content around or removing pages it's important that users following old links are properly redirected to the new location. We do this using the [aliases](https://gohugo.io/content-management/urls/#aliases) feature in Hugo. diff --git a/docs/sources/administration/correlations/_index.md b/docs/sources/administration/correlations/_index.md index 3a61b1800b5..36e0badf5f5 100644 --- a/docs/sources/administration/correlations/_index.md +++ b/docs/sources/administration/correlations/_index.md @@ -14,23 +14,23 @@ weight: 900 You can create interactive links for Explore visualizations by setting up Correlations. These links can either run queries or generate external URLs related to presented data. -A correlation defines how data in one [data source]({{< relref "../../datasources" >}}) is used to query data in another data source or to generate an external URL. +A correlation defines how data in one [data source](../../datasources/) is used to query data in another data source or to generate an external URL. Some examples: - an application name returned in a logs data source can be used to query metrics related to that application in a metrics data source, or - a user name returned by an SQL data source can be used to query logs related to that particular user in a logs data source - a customer ID in a logs data source can link to a different platform that has a profile on that customer. -[Explore]({{< relref "../../explore" >}}) takes user-defined correlations to display links inside the visualizations. -If a correlation links to a query, you can click on that link to run the related query and see results in [Explore Split View]({{< relref "../../explore#split-and-compare" >}}). +[Explore](../../explore/) takes user-defined correlations to display links inside the visualizations. +If a correlation links to a query, you can click on that link to run the related query and see results in [Explore Split View](../../explore/#split-and-compare). If a correlation links to an external URL, you can click on the link to open the URL in a new tab in your browser. Explore visualizations that currently support showing links based on correlations: -- [Logs Panel]({{< relref "./use-correlations-in-visualizations#correlations-in-logs-panel">}}) -- [Table]({{< relref "./use-correlations-in-visualizations#correlations-in-table">}}) +- [Logs Panel](use-correlations-in-visualizations/#correlations-in-logs-panel) +- [Table](use-correlations-in-visualizations/#correlations-in-table) -You can configure correlations using [provisioning]({{< relref "../provisioning" >}}), the **Administration > Plugins and data > Correlations** page in Grafana or directly in [Explore]({{< relref "../../explore/correlations-editor-in-explore" >}}). +You can configure correlations using [provisioning](../provisioning/), the **Administration > Plugins and data > Correlations** page in Grafana or directly in [Explore](../../explore/correlations-editor-in-explore/). ## Example of how links work in Explore once set up diff --git a/docs/sources/administration/correlations/add-permissions-to-create-new-correlations/index.md b/docs/sources/administration/correlations/add-permissions-to-create-new-correlations/index.md index 8dbca454cac..f232f26189c 100644 --- a/docs/sources/administration/correlations/add-permissions-to-create-new-correlations/index.md +++ b/docs/sources/administration/correlations/add-permissions-to-create-new-correlations/index.md @@ -12,7 +12,7 @@ weight: 30 ## Before you begin -Adding access to create correlations for [Viewers and Editors]({{< relref "../../../administration/roles-and-permissions" >}}) is available with [Role-based access control]({{< relref "../../../administration/roles-and-permissions/access-control" >}}). +Adding access to create correlations for [Viewers and Editors](../../roles-and-permissions/) is available with [Role-based access control](../../roles-and-permissions/access-control/). ## Add permissions to create correlations diff --git a/docs/sources/administration/correlations/correlation-configuration/index.md b/docs/sources/administration/correlations/correlation-configuration/index.md index 56c21d89bc0..f01ef51d670 100644 --- a/docs/sources/administration/correlations/correlation-configuration/index.md +++ b/docs/sources/administration/correlations/correlation-configuration/index.md @@ -29,13 +29,13 @@ Each correlation is configured with the following options: **Transformations** : Optional manipulations to the source data included passed to the target query -Learn how to create correlations using the [Administration page]({{< relref "./create-a-new-correlation#create-a-correlation-in-administration-page" >}}) or with [provisioning]({{< relref "./create-a-new-correlation#create-a-correlation-with-provisioning" >}}). +Learn how to create correlations using the [Administration page](../create-a-new-correlation/#create-a-correlation-in-administration-page) or with [provisioning](../create-a-new-correlation/#create-a-correlation-with-provisioning). ## Source data source and result field Links are shown in Explore visualizations for the results from the correlation’s source data source. A link is assigned to one of the fields from the result provided in the correlation configuration (the results field). -Each visualization displays fields with links in a different way ([Correlations in Logs Panel]({{< relref "./use-correlations-in-visualizations#correlations-in-logs-panel">}}) and see [Correlations in Table]({{< relref "./use-correlations-in-visualizations#correlations-in-table">}})). +Each visualization displays fields with links in a different way ([Correlations in Logs Panel](../use-correlations-in-visualizations/#correlations-in-logs-panel) and see [Correlations in Table](../use-correlations-in-visualizations/#correlations-in-table)). ## Target query @@ -44,10 +44,10 @@ The target query is run when a link is clicked in the visualization. You can use ### Correlation Variables You can use variables inside the target query to access the source data related to the query. -Correlations use [Grafana variable syntax]({{< relref "../../../dashboards/variables/variable-syntax" >}}). +Correlations use [Grafana variable syntax](../../../dashboards/variables/variable-syntax/). Variables are filled with values from the source results when the link is clicked. There are two types of variables you can use: -- [field variables]({{< relref "../../../panels-visualizations/configure-data-links#field-variables" >}}) (allows to access field values and labels) +- [field variables](../../../panels-visualizations/configure-data-links/#field-variables) (allows to access field values and labels) - correlation variables (allows to access field values and transformations) Example: If source results contain a field called “employee”, the value of the field can be accessed with: @@ -57,9 +57,9 @@ Example: If source results contain a field called “employee”, the value of t In addition to mapping field values to shorter variable names, more correlation variables can be created by applying transformations to existing fields -For more details, please see the example in [Use variables and transformations in a correlation]({{< relref "./use-variables-and-transformations" >}}). +For more details, please see the example in [Use variables and transformations in a correlation](../use-variables-and-transformations/). -Correlation creates a data link only if all variables have values in the selected data row. [Global variables]({{< relref "/docs/grafana/latest/dashboards/variables/add-template-variables#global-variables" >}}) are exception to this rule and are not required to be filled in from the returned data. These variables are interpolated automatically by data sources. +Correlation creates a data link only if all variables have values in the selected data row. [Global variables](/docs/grafana/latest/dashboards/variables/add-template-variables/#global-variables) are exception to this rule and are not required to be filled in from the returned data. These variables are interpolated automatically by data sources. ### Correlation Transformations @@ -69,7 +69,7 @@ There are two types of transformations: logfmt and regular expression. Each transformation uses a selected field value as the input. The output of a transformation is a set of new variables based on the type and options of the transformation. -For more details, please see the example in [Use variables and transformations in a correlation]({{< relref "./use-variables-and-transformations" >}}) for more details. +For more details, please see the example in [Use variables and transformations in a correlation](../use-variables-and-transformations/) for more details. ### Logfmt transformation diff --git a/docs/sources/administration/correlations/correlation-permissions/index.md b/docs/sources/administration/correlations/correlation-permissions/index.md index ee228d844fa..30984472c20 100644 --- a/docs/sources/administration/correlations/correlation-permissions/index.md +++ b/docs/sources/administration/correlations/correlation-permissions/index.md @@ -9,11 +9,11 @@ weight: 20 # Permissions -Users with [Viewer base role]({{< relref "../../../administration/roles-and-permissions" >}}) or with [datasources:query RBAC role]({{< relref "../../../administration/roles-and-permissions/access-control" >}}) can: +Users with [Viewer base role](../../roles-and-permissions/) or with [datasources:query RBAC role](../../roles-and-permissions/access-control/) can: - Use correlations in Explore’s visualizations. - List all available correlations in read-only mode. -Users with [Admin base role]({{< relref "../../../administration/roles-and-permissions" >}}) or with [datasources:write RBAC role]({{< relref "../../../administration/roles-and-permissions/access-control" >}}) can: +Users with [Admin base role](../../roles-and-permissions/) or with [datasources:write RBAC role](../../roles-and-permissions/access-control/) can: - Add, edit and delete correlations. diff --git a/docs/sources/administration/correlations/create-a-new-correlation/index.md b/docs/sources/administration/correlations/create-a-new-correlation/index.md index 225d6ca8e1c..2ea3bb0b447 100644 --- a/docs/sources/administration/correlations/create-a-new-correlation/index.md +++ b/docs/sources/administration/correlations/create-a-new-correlation/index.md @@ -15,7 +15,7 @@ Make sure you have permission to add new correlations. Only users with write per ## Create a correlation in Explore's correlations editor -To learn more, refer to Explore's [documentation]({{< relref "../../../explore/correlations-editor-in-explore" >}}) about building correlations in Explore. +To learn more, refer to Explore's [documentation](../../../explore/correlations-editor-in-explore/) about building correlations in Explore. ## Create a correlation in Administration page diff --git a/docs/sources/administration/correlations/use-correlations-in-visualizations/index.md b/docs/sources/administration/correlations/use-correlations-in-visualizations/index.md index 4c98948ee3a..07070f27741 100644 --- a/docs/sources/administration/correlations/use-correlations-in-visualizations/index.md +++ b/docs/sources/administration/correlations/use-correlations-in-visualizations/index.md @@ -27,7 +27,7 @@ weight: 70 1. Open Explore. 1. Select a data source that you chose as the source data source of the correlation. 1. Run a query that results in data containing fields required to build variables in the target query. -1. Links are added to cell rows in the column representing the field with the assigned link ([the results field]({{< relref "../correlation-configuration#source-data-source-and-result-field" >}}). +1. Links are added to cell rows in the column representing the field with the assigned link ([the results field](../correlation-configuration/#source-data-source-and-result-field). 1. Cells containing multiple links accessible with a context menu. {{< figure src="/static/img/docs/correlations/correlations-in-table-10-0.png" max-width="600px" caption="Correlations links in table" >}} diff --git a/docs/sources/administration/correlations/use-variables-and-transformations/index.md b/docs/sources/administration/correlations/use-variables-and-transformations/index.md index 6bc3668f9d8..6251d537352 100644 --- a/docs/sources/administration/correlations/use-variables-and-transformations/index.md +++ b/docs/sources/administration/correlations/use-variables-and-transformations/index.md @@ -73,7 +73,7 @@ Instructions below show how to set up a link that can run metrics query for the - Required correlation type (query) - Target query matching test data source model - “App metrics” correlation contains the following configuration: - - Alias is set to ${application} variable (note that in provisioning files $ is used to access environment variables so it has to be [escaped]({{< relref "../../../administration/provisioning#using-environment-variables" >}})). + - Alias is set to ${application} variable (note that in provisioning files $ is used to access environment variables so it has to be [escaped](../../provisioning/#using-environment-variables)). - Regular expression transformation is created to extract values from “msg” field - Regular expression transformation is used to capture the application name from the full name of the service stored in the log line. - The output of the transformation is mapped to a variable called “application”. diff --git a/docs/sources/administration/data-source-management/_index.md b/docs/sources/administration/data-source-management/_index.md index ce91fc46eae..9eab6986e11 100644 --- a/docs/sources/administration/data-source-management/_index.md +++ b/docs/sources/administration/data-source-management/_index.md @@ -18,10 +18,10 @@ weight: 100 # Data source management Grafana supports many different storage backends for your time series data (data source). -Refer to [data sources]({{< relref "../../datasources" >}}) for more information about using data sources in Grafana. +Refer to [data sources](../../datasources/) for more information about using data sources in Grafana. Only users with the organization admin role can add data sources. -For links to data source-specific documentation, see [Data sources]({{< relref "../../datasources" >}}). +For links to data source-specific documentation, see [Data sources](../../datasources/). ## Data source permissions @@ -32,7 +32,7 @@ You can configure data source permissions to allow or deny certain users the abi - The `admin` permission allows users to query and edit the data source, change permissions on the data source and enable or disable query caching for the data source. {{% admonition type="note" %}} -Available in [Grafana Enterprise]({{< relref "../../introduction/grafana-enterprise/" >}}) and [Grafana Cloud](/docs/grafana-cloud). +Available in [Grafana Enterprise](../../introduction/grafana-enterprise/) and [Grafana Cloud](/docs/grafana-cloud). {{% /admonition %}} By default, data sources in an organization can be queried by any user in that organization. For example, a user with the `Viewer` role can issue any possible query to a data source, not just queries that exist on dashboards to which they have access. Additionally, by default, data sources can be edited by the user who created the data source, as well as users with the `Admin` role. @@ -80,10 +80,10 @@ When you enable query and resource caching, Grafana temporarily stores the resul When using Grafana, a query pertains to a request for data frames to be modified or displayed. A resource relates to any HTTP requests made by a plugin, such as the Amazon Timestream plugin requesting a list of available databases from AWS. For more information on data source queries and resources, please see the developers page on [backend plugins](https://grafana.com/developers/plugin-tools/key-concepts/backend-plugins/). -The caching feature works for **all** backend data sources. You can enable the cache globally in Grafana's [configuration]({{< relref "../../setup-grafana/configure-grafana/enterprise-configuration/#caching" >}}), and configure a cache duration (also called Time to Live, or TTL) for each data source individually. +The caching feature works for **all** backend data sources. You can enable the cache globally in Grafana's [configuration](../../setup-grafana/configure-grafana/enterprise-configuration/#caching), and configure a cache duration (also called Time to Live, or TTL) for each data source individually. {{% admonition type="note" %}} -Available in [Grafana Enterprise]({{< relref "../../introduction/grafana-enterprise/" >}}) and [Grafana Cloud](/docs/grafana-cloud/). +Available in [Grafana Enterprise](../../introduction/grafana-enterprise/) and [Grafana Cloud](/docs/grafana-cloud/). {{% /admonition %}} The following cache backend options are available: in-memory, Redis, and Memcached. @@ -94,9 +94,9 @@ Storing cached queries in-memory can increase Grafana's memory footprint. In pro When a panel queries a data source with cached data, it will either fetch fresh data or use cached data depending on the panel's **interval.** The interval is used to round the query time range to a nearby cached time range, increasing the likelihood of cache hits. Therefore, wider panels and dashboards with shorter time ranges fetch new data more often than narrower panels and dashboards with longer time ranges. -A panel's interval is visible in the [query options]({{< relref "../../panels-visualizations/query-transform-data/" >}}). It is calculated as follows: `time range / max data points`. Max data points are calculated based on the width of the panel. For example, a wide panel with `1000 data points` on a dashboard with a time range of `last 7 days` will retrieve fresh data every 10 minutes: `7d / 1000 = 10m`. In this example, cached data for this panel will be served for up to 10 minutes before Grafana needs to query the data source again for new data. +A panel's interval is visible in the [query options](../../panels-visualizations/query-transform-data/). It is calculated as follows: `time range / max data points`. Max data points are calculated based on the width of the panel. For example, a wide panel with `1000 data points` on a dashboard with a time range of `last 7 days` will retrieve fresh data every 10 minutes: `7d / 1000 = 10m`. In this example, cached data for this panel will be served for up to 10 minutes before Grafana needs to query the data source again for new data. -You can configure a panel to retrieve data more often by increasing the **Max data points** setting in the panel's [query options]({{< relref "../../panels-visualizations/query-transform-data/" >}}). +You can configure a panel to retrieve data more often by increasing the **Max data points** setting in the panel's [query options](../../panels-visualizations/query-transform-data/). ### Caching benefits @@ -108,7 +108,7 @@ By reducing the number of queries and requests sent to data sources, caching can ### Data sources that work with query caching -Query caching works for Grafana's [built-in data sources]({{< relref "../../datasources/#built-in-core-data-sources" >}}), and [backend data source plugins](https://grafana.com/grafana/plugins/?type=datasource) that extend the `DataSourceWithBackend` class in the plugins SDK. +Query caching works for Grafana's [built-in data sources](../../datasources/#built-in-core-data-sources), and [backend data source plugins](https://grafana.com/grafana/plugins/?type=datasource) that extend the `DataSourceWithBackend` class in the plugins SDK. {{% admonition type="note" %}} Logs Insights for the CloudWatch data source does not support query caching due to the way logs are requested from AWS. @@ -122,7 +122,7 @@ Some data sources, such as Elasticsearch, Prometheus, and Loki, cache queries th ### Enable and configure query caching -You must be an Org admin or Grafana admin to enable query caching for a data source. For more information on Grafana roles and permissions, refer to [About users and permissions]({{< relref "../roles-and-permissions/" >}}). +You must be an Org admin or Grafana admin to enable query caching for a data source. For more information on Grafana roles and permissions, refer to [About users and permissions](../roles-and-permissions/). By default, data source queries are not cached. To enable query caching for a single data source: @@ -141,7 +141,7 @@ You can optionally override a data source's configured TTL for individual dashbo If query caching is enabled and the Cache tab is not visible in a data source's settings, then query caching is not available for that data source. {{% /admonition %}} -To configure global settings for query caching, refer to the `caching` section of [Configure Grafana Enterprise]({{< relref "../../setup-grafana/configure-grafana/enterprise-configuration/#caching" >}}). +To configure global settings for query caching, refer to the `caching` section of [Configure Grafana Enterprise](../../setup-grafana/configure-grafana/enterprise-configuration/#caching). ### Disable query caching @@ -152,7 +152,7 @@ To disable query caching for a single data source: 1. In the data source list, click the data source that you want to turn off caching for. 1. On the Cache tab, click **Disable**. -To disable query caching for an entire Grafana instance, set the `enabled` flag to `false` in the `caching` section of [Configure Grafana Enterprise]({{< relref "../../setup-grafana/configure-grafana/enterprise-configuration/#caching" >}}). You will no longer see the Cache tab on any data sources, and no data source queries will be cached. +To disable query caching for an entire Grafana instance, set the `enabled` flag to `false` in the `caching` section of [Configure Grafana Enterprise](../../setup-grafana/configure-grafana/enterprise-configuration/#caching). You will no longer see the Cache tab on any data sources, and no data source queries will be cached. ### Clear cache diff --git a/docs/sources/administration/data-source-management/teamlbac/_index.md b/docs/sources/administration/data-source-management/teamlbac/_index.md index e254a81cfca..4bf449af022 100644 --- a/docs/sources/administration/data-source-management/teamlbac/_index.md +++ b/docs/sources/administration/data-source-management/teamlbac/_index.md @@ -24,10 +24,10 @@ Label-Based Access Control (LBAC) allows fine-grained access control to data sou LBAC for data sources is currently generally available for `Loki` and in **experimental** for `Prometheus`. Support for additional data sources may be added in future updates. -| Data source | [Grafana Cloud](/docs/grafana-cloud) | [Grafana Enterprise]({{< relref "../../introduction/grafana-enterprise/" >}}) | -| ----------- | ------------------------------------ | ----------------------------------------------------------------------------- | -| Loki | GA | GA | -| Prometheus | PrivatePreview | PrivatePreview | +| Data source | [Grafana Cloud](/docs/grafana-cloud) | [Grafana Enterprise](../../../introduction/grafana-enterprise/) | +| ----------- | ------------------------------------ | --------------------------------------------------------------- | +| Loki | GA | GA | +| Prometheus | PrivatePreview | PrivatePreview | {{% admonition type="note" %}} For enterprise this feature requires Grafana Enterprise Metrics (GEM) or Grafana Enterprise Logs (GEL) to function. diff --git a/docs/sources/administration/data-source-management/teamlbac/configure-teamlbac-for-prometheus/index.md b/docs/sources/administration/data-source-management/teamlbac/configure-teamlbac-for-prometheus/index.md index 29f8467ad6d..fa08b2f47cc 100644 --- a/docs/sources/administration/data-source-management/teamlbac/configure-teamlbac-for-prometheus/index.md +++ b/docs/sources/administration/data-source-management/teamlbac/configure-teamlbac-for-prometheus/index.md @@ -31,7 +31,7 @@ To be able to use LBAC for Prometheus data sources, you need to enable the featu LBAC for data sources is available in private preview on Grafana Cloud for Prometheus created with basic authentication. Prometheus data sources for LBAC for data sources can only be created, provisioning is currently not available. -You cannot configure LBAC rules for Grafana-provisioned data sources from the UI. We recommend that you replicate the setting of the provisioned data source in a new data source as described in [LBAC Configuration for New Prometheus Data Source](https://grafana.com/docs/grafana/latest/administration/data-source-management/teamlbac/configure-teamlbac-for-Prometheus/#task-1-lbac-configuration-for-new-Prometheus-data-source) and then add the LBAC configuration to the new data source. +You cannot configure LBAC rules for Grafana-provisioned data sources from the UI. We recommend that you replicate the setting of the provisioned data source in a new data source as described in [LBAC Configuration for New Prometheus Data Source](#task-1-lbac-configuration-for-new-prometheus-data-source) and then add the LBAC configuration to the new data source. ### Permissions diff --git a/docs/sources/administration/enterprise-licensing/_index.md b/docs/sources/administration/enterprise-licensing/_index.md index 16d7e9899f1..31fbf6027a3 100644 --- a/docs/sources/administration/enterprise-licensing/_index.md +++ b/docs/sources/administration/enterprise-licensing/_index.md @@ -23,11 +23,11 @@ weight: 500 # Grafana Enterprise license -When you become a Grafana Enterprise customer, you gain access to Grafana's premium observability features, including enterprise data source plugins, reporting, and role-based access control. In order to use these [enhanced features of Grafana Enterprise]({{< relref "../../introduction/grafana-enterprise" >}}), you must purchase and activate a Grafana Enterprise license. +When you become a Grafana Enterprise customer, you gain access to Grafana's premium observability features, including enterprise data source plugins, reporting, and role-based access control. In order to use these [enhanced features of Grafana Enterprise](../../introduction/grafana-enterprise/), you must purchase and activate a Grafana Enterprise license. -To purchase a license directly from Grafana Labs, [Contact a Grafana Labs representative](/contact?about=grafana-enterprise). To activate an Enterprise license purchased from Grafana Labs, refer to [Activate an Enterprise license]({{< relref "#activate-an-enterprise-license" >}}). +To purchase a license directly from Grafana Labs, [Contact a Grafana Labs representative](/contact?about=grafana-enterprise). To activate an Enterprise license purchased from Grafana Labs, refer to [Activate an Enterprise license](#activate-an-enterprise-license). -You can also purchase a Grafana Enterprise license through the AWS Marketplace. To learn more about activating a license purchased through AWS, refer to [Activate a Grafana Enterprise license purchased through AWS Marketplace]({{< relref "./activate-aws-marketplace-license/" >}}). +You can also purchase a Grafana Enterprise license through the AWS Marketplace. To learn more about activating a license purchased through AWS, refer to [Activate a Grafana Enterprise license purchased through AWS Marketplace](activate-aws-marketplace-license/). {{< section >}} @@ -94,9 +94,9 @@ environment variable. ### Step 3. Ensure that the license file's root URL matches the root_url configuration option -Update the [`root_url`]({{< relref "../../setup-grafana/configure-grafana/#root_url" >}}) in your configuration. It should be the URL that users type in their browsers to access the frontend, not the node hostname(s). +Update the [`root_url`](../../setup-grafana/configure-grafana/#root_url) in your configuration. It should be the URL that users type in their browsers to access the frontend, not the node hostname(s). -This is important, because as part of the validation checks at startup, Grafana compares the license URL to the [`root_url`]({{< relref "../../setup-grafana/configure-grafana/#root_url" >}}) in your configuration. +This is important, because as part of the validation checks at startup, Grafana compares the license URL to the [`root_url`](../../setup-grafana/configure-grafana/#root_url) in your configuration. In your configuration file: @@ -113,7 +113,7 @@ GF_SERVER_ROOT_URL=https://grafana.example.com/ ### Step 4. Restart Grafana -To finalize the installation of Grafana Enterprise, restart Grafana to enable all Grafana Enterprise features. Refer to [restart Grafana]({{< relref "../../setup-grafana/start-restart-grafana/" >}}) for more information. +To finalize the installation of Grafana Enterprise, restart Grafana to enable all Grafana Enterprise features. Refer to [restart Grafana](../../setup-grafana/start-restart-grafana/) for more information. ## License expiration @@ -123,7 +123,7 @@ If your license has expired, most of Grafana keeps working as normal. Some enter ### Update your license -1. Locate your current `license.jwt` file. In a standard installation it is stored inside the Grafana data directory, which on a typical Linux installation is in `/var/lib/grafana/data`. This location might be overridden in the ini file [Configuration]({{< relref "../../setup-grafana/configure-grafana/" >}}). +1. Locate your current `license.jwt` file. In a standard installation it is stored inside the Grafana data directory, which on a typical Linux installation is in `/var/lib/grafana/data`. This location might be overridden in the ini file [Configuration](../../setup-grafana/configure-grafana/). ```ini [enterprise] @@ -135,7 +135,7 @@ If your license has expired, most of Grafana keeps working as normal. Some enter 2. Log in to your [Grafana Cloud Account](/login) 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. -5. [Restart Grafana]({{< relref "../../setup-grafana/start-restart-grafana/" >}}). +5. [Restart Grafana](../../setup-grafana/start-restart-grafana/). ### If your license expires @@ -244,7 +244,7 @@ Your license is controlled by the following rules: **License expiration date:** The license includes an expiration date, which is the date when a license becomes inactive. -As the license expiration date approaches, you will see a banner in Grafana that encourages you to renew. To learn about how to renew your license and what happens in Grafana when a license expires, refer to [License expiration]({{< relref "#license-expiration" >}}). +As the license expiration date approaches, you will see a banner in Grafana that encourages you to renew. To learn about how to renew your license and what happens in Grafana when a license expires, refer to [License expiration](#license-expiration). **License token expiration:** Grafana Enterprise requires a valid token, which is automatically renewed. @@ -256,7 +256,7 @@ License token renewal requires internet access, and requires that the `auto_refr **Grafana License URL:** Your license does not work with an instance of Grafana with a different root URL. -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. +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](../../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. @@ -268,7 +268,7 @@ When a user reaches the session limit, the fourth connection succeeds and the lo To increase the number of licensed users within Grafana, extend a license, or change your licensed URL, contact [Grafana support](/profile/org#support) or your Grafana Labs account team. They will update your license, which you can activate from within Grafana. -For instructions about how to activate your license after it is updated, refer to [Activate an Enterprise license]({{< relref "#activate-an-enterprise-license" >}}). +For instructions about how to activate your license after it is updated, refer to [Activate an Enterprise license](#activate-an-enterprise-license). ## Usage billing @@ -276,7 +276,7 @@ Standard Grafana Enterprise licenses include a certain number of seats that can For those use-cases we support usage-based billing, where your license includes a certain number of included users and you are billed on a monthly basis for any excess active users during the month. -Usage billing involves a contractual agreement between you and Grafana Labs and an update to your license, and it is only available if Grafana Enterprise version 10.0.0 or higher is configured to [automatically refresh its license token]({{< relref "../../setup-grafana/configure-grafana/enterprise-configuration/#auto_refresh_license" >}}). +Usage billing involves a contractual agreement between you and Grafana Labs and an update to your license, and it is only available if Grafana Enterprise version 10.0.0 or higher is configured to [automatically refresh its license token](../../setup-grafana/configure-grafana/enterprise-configuration/#auto_refresh_license). ### User deduplication diff --git a/docs/sources/administration/enterprise-licensing/activate-aws-marketplace-license/_index.md b/docs/sources/administration/enterprise-licensing/activate-aws-marketplace-license/_index.md index 2ecc592a76d..4ac9e4814be 100644 --- a/docs/sources/administration/enterprise-licensing/activate-aws-marketplace-license/_index.md +++ b/docs/sources/administration/enterprise-licensing/activate-aws-marketplace-license/_index.md @@ -30,7 +30,7 @@ You can deploy Grafana Enterprise in the following ways: - Using AWS services like ECS, EKS or EC2. - In an instance outside AWS. -In each case, you must activate the Grafana Enterprise license purchased in AWS Marketplace to take advantage of Grafana Enterprise observability features. Grafana Enterprise licenses purchased through AWS Marketplace are subject to the same [restrictions]({{< relref "../#license-restrictions" >}}) as Grafana Enterprise licensed purchased directly from Grafana Labs. +In each case, you must activate the Grafana Enterprise license purchased in AWS Marketplace to take advantage of Grafana Enterprise observability features. Grafana Enterprise licenses purchased through AWS Marketplace are subject to the same [restrictions](../#license-restrictions) as Grafana Enterprise licensed purchased directly from Grafana Labs. > To purchase a license directly from Grafana Labs or learn more about other Grafana offerings, [Contact a Grafana Labs representative](/contact?about=grafana-enterprise). diff --git a/docs/sources/administration/enterprise-licensing/activate-aws-marketplace-license/activate-license-on-ecs/index.md b/docs/sources/administration/enterprise-licensing/activate-aws-marketplace-license/activate-license-on-ecs/index.md index 5d3858c25cc..c9192e585e6 100644 --- a/docs/sources/administration/enterprise-licensing/activate-aws-marketplace-license/activate-license-on-ecs/index.md +++ b/docs/sources/administration/enterprise-licensing/activate-aws-marketplace-license/activate-license-on-ecs/index.md @@ -48,7 +48,7 @@ Grafana requires that you configure a database to hold dashboards, users, and ot ### Before you begin - Ensure that you have a supported Grafana database available. - - For a list of supported databases, refer to [Supported databases]({{< relref "../../../../setup-grafana/installation/#supported-databases" >}}). + - For a list of supported databases, refer to [Supported databases](../../../../setup-grafana/installation/#supported-databases). - For information about creating a database, refer to [Creating an Amazon RDS DB instance](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_CreateDBInstance.html). - Review the information required to connect to the RDS DB instance. For more information, refer to [Connecting to an Amazon RDS DB instance](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_CommonTasks.Connect.html). @@ -56,7 +56,7 @@ To configure Grafana for high availability: 1. In AWS ECS, use environment variables to update the `database` parameters. - For a list of database parameters, refer to [Configuration]({{< relref "../../../../setup-grafana/configure-grafana/#database" >}}). + For a list of database parameters, refer to [Configuration](../../../../setup-grafana/configure-grafana/#database). 1. Create a revision of the task definition for the ECS Task that runs Grafana Enterprise. @@ -114,4 +114,4 @@ In this task you configure Grafana Enterprise to validate the license with AWS i 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 > 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" >}}). +For more information about validating that your license is active, refer to [Grafana Enterprise license restrictions](../../#grafana-enterprise-license-restrictions). diff --git a/docs/sources/administration/enterprise-licensing/activate-aws-marketplace-license/activate-license-on-eks/index.md b/docs/sources/administration/enterprise-licensing/activate-aws-marketplace-license/activate-license-on-eks/index.md index a5698448447..5199690faa3 100644 --- a/docs/sources/administration/enterprise-licensing/activate-aws-marketplace-license/activate-license-on-eks/index.md +++ b/docs/sources/administration/enterprise-licensing/activate-aws-marketplace-license/activate-license-on-eks/index.md @@ -50,7 +50,7 @@ Grafana requires that you configure a database to hold dashboards, users, and ot ### Before you begin - Ensure that you have a supported Grafana database available. - - For a list of supported databases, refer to [Supported databases]({{< relref "../../../../setup-grafana/installation/#supported-databases" >}}). + - For a list of supported databases, refer to [Supported databases](../../../../setup-grafana/installation/#supported-databases). - For information about creating a database, refer to [Creating an Amazon RDS DB instance](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_CreateDBInstance.html). - Review the information required to connect to the RDS DB instance. For more information, refer to [Connecting to an Amazon RDS DB instance](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_CommonTasks.Connect.html). @@ -82,7 +82,7 @@ To configure Grafana for high availability, choose **one** of the following opti value: [database password] ``` -For more information on Grafana High Availability setup, refer to [Set up Grafana for high availability]({{< relref "../../../../setup-grafana/set-up-for-high-availability/" >}}). +For more information on Grafana High Availability setup, refer to [Set up Grafana for high availability](../../../../setup-grafana/set-up-for-high-availability/). ## Task 3: Configure Grafana Enterprise to validate its license with AWS @@ -99,7 +99,7 @@ In this task, you configure Grafana Enterprise to validate the license with AWS For more information about AWS license permissions, refer to [Actions, resources, and condition keys for AWS License Manager](https://docs.aws.amazon.com/service-authorization/latest/reference/list_awslicensemanager.html). -1. Choose **one** of the following options to update the [license_validation_type]({{< relref "../../../../setup-grafana/configure-grafana/enterprise-configuration/#license_validation_type" >}}) configuration to `aws`: +1. Choose **one** of the following options to update the [license_validation_type](../../../../setup-grafana/configure-grafana/enterprise-configuration/#license_validation_type) configuration to `aws`: - **Option 1:** Use `kubectl edit configmap grafana` to edit `grafana.ini` add the following section to the configuration: @@ -125,6 +125,6 @@ To restart Grafana on a Kubernetes cluster, 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/" >}}). +For more information about restarting Grafana, refer to [Restart Grafana](../../../../setup-grafana/start-restart-grafana/). > If you experience issues when you update the EKS cluster, refer to [Amazon EKS troubleshooting](https://docs.aws.amazon.com/eks/latest/userguide/troubleshooting.html). diff --git a/docs/sources/administration/enterprise-licensing/activate-aws-marketplace-license/activate-license-on-instance-outside-aws/index.md b/docs/sources/administration/enterprise-licensing/activate-aws-marketplace-license/activate-license-on-instance-outside-aws/index.md index a205673c676..9d1741d94a4 100644 --- a/docs/sources/administration/enterprise-licensing/activate-aws-marketplace-license/activate-license-on-instance-outside-aws/index.md +++ b/docs/sources/administration/enterprise-licensing/activate-aws-marketplace-license/activate-license-on-instance-outside-aws/index.md @@ -35,9 +35,9 @@ To activate a Grafana Enterprise license from AWS on a Grafana Enterprise instan To install Grafana, refer to the documentation specific to your implementation. -- [Install Grafana]({{< relref "../../../../setup-grafana/installation/" >}}). -- [Run Grafana Docker image]({{< relref "../../../../setup-grafana/installation/docker/" >}}). -- [Deploy Grafana on Kubernetes]({{< relref "../../../../setup-grafana/installation/kubernetes/#deploy-grafana-enterprise-on-kubernetes" >}}). +- [Install Grafana](../../../../setup-grafana/installation/). +- [Run Grafana Docker image](../../../../setup-grafana/installation/docker/). +- [Deploy Grafana on Kubernetes](../../../../setup-grafana/installation/kubernetes/#deploy-grafana-enterprise-on-kubernetes). ## Task 2: Create an AWS IAM user with access to your Grafana Enterprise license @@ -110,7 +110,7 @@ To retrieve your license, Grafana Enterprise requires access to your AWS account In this task you configure Grafana Enterprise to validate the license with AWS instead of Grafana Labs. -Choose one of the following options to update the [license_validation_type]({{< relref "../../../../setup-grafana/configure-grafana/enterprise-configuration/#license_validation_type" >}}) configuration to `aws`: +Choose one of the following options to update the [license_validation_type](../../../../setup-grafana/configure-grafana/enterprise-configuration/#license_validation_type) configuration to `aws`: - **Option 1:** In the `[enterprise]` section of the grafana.ini configuration file, add `license_validation_type=aws`. @@ -131,4 +131,4 @@ Choose one of the following options to update the [license_validation_type]({{< To activate Grafana Enterprise features, start (or restart) Grafana. -For information about restarting Grafana, refer to [Restart Grafana]({{< relref "../../../../setup-grafana/start-restart-grafana/" >}}). +For information about restarting Grafana, refer to [Restart Grafana](../../../../setup-grafana/start-restart-grafana/). diff --git a/docs/sources/administration/enterprise-licensing/activate-aws-marketplace-license/manage-license-in-aws-marketplace/index.md b/docs/sources/administration/enterprise-licensing/activate-aws-marketplace-license/manage-license-in-aws-marketplace/index.md index 56ba176742d..47988bf8a14 100644 --- a/docs/sources/administration/enterprise-licensing/activate-aws-marketplace-license/manage-license-in-aws-marketplace/index.md +++ b/docs/sources/administration/enterprise-licensing/activate-aws-marketplace-license/manage-license-in-aws-marketplace/index.md @@ -42,4 +42,4 @@ You can use AWS Marketplace to make the following modifications to your Grafana This action retrieves updated license information from AWS. -> To learn more about licensing and active users, refer to [Activate a Grafana Enterprise license purchased through AWS Marketplace]({{< relref "../" >}}). +> To learn more about licensing and active users, refer to [Activate a Grafana Enterprise license purchased through AWS Marketplace](../). diff --git a/docs/sources/administration/feature-toggles/index.md b/docs/sources/administration/feature-toggles/index.md index 90d08353bec..b79d62fbede 100644 --- a/docs/sources/administration/feature-toggles/index.md +++ b/docs/sources/administration/feature-toggles/index.md @@ -19,7 +19,7 @@ For detailed information about particular features and how they operate, refer t ## Manage feature toggles In the **Administration** page, the **Feature Management** section enables authorized users to view and edit the various features that are active in their Grafana environment. -Authorized users include administrators, and users with the [fixed roles]({{< relref "../roles-and-permissions/access-control#fixed-roles" >}}) `featuremgmt.read` and `featuremgmt.write`. +Authorized users include administrators, and users with the [fixed roles](../roles-and-permissions/access-control/#fixed-roles) `featuremgmt.read` and `featuremgmt.write`. There are different options for visibility and customization depending on the development stage of the feature. diff --git a/docs/sources/administration/migration-guide/manually-migrate-to-grafana-cloud.md b/docs/sources/administration/migration-guide/manually-migrate-to-grafana-cloud.md index 6049846c108..d0bffd7b8f2 100644 --- a/docs/sources/administration/migration-guide/manually-migrate-to-grafana-cloud.md +++ b/docs/sources/administration/migration-guide/manually-migrate-to-grafana-cloud.md @@ -219,7 +219,7 @@ Some data sources, like Prometheus or SQL databases, live on private networks or To access these data sources from Grafana Cloud, follow our guide to [configure PDC in your network](https://grafana.com/docs/grafana-cloud/connect-externally-hosted/private-data-source-connect/configure-pdc/), and then configure the applicable Grafana data sources to [connect using PDC](https://grafana.com/docs/grafana-cloud/connect-externally-hosted/private-data-source-connect/configure-pdc/#configure-a-data-source-to-use-private-data-source-connect-pdc). Note that PDC is only needed for your network-secured data sources, not for data sources like Splunk or CloudWatch that are accessible over the public internet. -For more information on how PDC works, see our [overview document]({{< relref "../connect-externally-hosted/private-data-source-connect" >}}). +For more information on how PDC works, see our [overview document](/docs/grafana-cloud/connect-externally-hosted/private-data-source-connect/). ### Migrate reports and playlists using Grafana’s HTTP API diff --git a/docs/sources/administration/organization-management/index.md b/docs/sources/administration/organization-management/index.md index a332c8110db..6c4d52941f3 100644 --- a/docs/sources/administration/organization-management/index.md +++ b/docs/sources/administration/organization-management/index.md @@ -46,7 +46,7 @@ The following table summarizes the resources you can share and/or isolate using The member of one organization cannot view dashboards assigned to another organization. However, a user can belong to multiple organizations. -Grafana Server Administrators are responsible for creating organizations. For more information about the Grafana Server Administrator role, refer to [Grafana server administrators]({{< relref "../roles-and-permissions/#grafana-server-administrators" >}}). +Grafana Server Administrators are responsible for creating organizations. For more information about the Grafana Server Administrator role, refer to [Grafana server administrators](../roles-and-permissions/#grafana-server-administrators). ## View a list of organizations @@ -80,9 +80,9 @@ Create an organization when you want to isolate dashboards and other resources f 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](../organization-preferences/). -For more information about adding users to an organization, refer to [Add a user to an organization]({{< relref "../user-management/server-user-management/add-remove-user-to-org/" >}}). +For more information about adding users to an organization, refer to [Add a user to an organization](../user-management/server-user-management/add-remove-user-to-org/). ## Delete an organization diff --git a/docs/sources/administration/organization-preferences/index.md b/docs/sources/administration/organization-preferences/index.md index 590370bf27f..6ff4cf25dc0 100644 --- a/docs/sources/administration/organization-preferences/index.md +++ b/docs/sources/administration/organization-preferences/index.md @@ -20,9 +20,9 @@ Grafana preferences are basic settings. They control the Grafana UI theme, home Preferences are sometimes confusing because they can be set at four different levels, listed from highest level to lowest: -- **Server -** Affects all users on the Grafana server. Set by a [Grafana server admin]({{< relref "../roles-and-permissions/#grafana-server-administrators" >}}). -- **Organization -** Affects all users in an organization. Set by an [Organization admin]({{< relref "../roles-and-permissions/#organization-roles" >}}). -- **Team -** Affects all users assigned to a team. Set by an Organization Admin or Team Admin. To learn more about these roles, refer to [Teams and permissions]({{< relref "../roles-and-permissions/#teams-and-permissions" >}}). +- **Server -** Affects all users on the Grafana server. Set by a [Grafana server admin](../roles-and-permissions/#grafana-server-administrators). +- **Organization -** Affects all users in an organization. Set by an [Organization admin](../roles-and-permissions/#organization-roles). +- **Team -** Affects all users assigned to a team. Set by an Organization Admin or Team Admin. To learn more about these roles, refer to [Teams and permissions](../roles-and-permissions/#teams-and-permissions). - **User account -** Affects the individual user. Set by the user on their own account. The lowest level always takes precedence. For example, if a user sets their theme to **Light**, then their visualization of Grafana displays the light theme. Nothing at any higher level can override that. @@ -33,7 +33,7 @@ If the user is aware of the change and intended it, then that's great! But if th In Grafana, you can change your names and emails associated with groups or accounts in the Settings or Preferences. This topic provides instructions for each task. -Some tasks require certain permissions. For more information about roles, refer to [Roles and permissions]({{< relref "../roles-and-permissions/" >}}). +Some tasks require certain permissions. For more information about roles, refer to [Roles and permissions](../roles-and-permissions/). ### Change organization name @@ -75,13 +75,13 @@ To change the team name or email, follow these steps: ### Change user name or email -To learn how to edit your user information, refer to [Edit your profile]({{< relref "../user-management/user-preferences/#edit-your-profile" >}}). +To learn how to edit your user information, refer to [Edit your profile](../user-management/user-preferences/#edit-your-profile). ## Change Grafana UI theme In Grafana, you can modify the UI theme configured in the Settings or Preferences. Set the UI theme for the server, an organization, a team, or your personal user account using the instructions in this topic. -Some tasks require certain permissions. For more information about roles, refer to [Roles and permissions]({{< relref "../roles-and-permissions/" >}}). +Some tasks require certain permissions. For more information about roles, refer to [Roles and permissions](../roles-and-permissions/). ### Theme options @@ -105,9 +105,9 @@ Here is an example of the light theme. ### Change server UI theme -As a Grafana server administrator, you can change the default Grafana UI theme for all users who are on the server by setting the [default_theme]({{< relref "../../setup-grafana/configure-grafana/#default_theme" >}}) option in the Grafana configuration file. +As a Grafana server administrator, you can change the default Grafana UI theme for all users who are on the server by setting the [default_theme](../../setup-grafana/configure-grafana/#default_theme) option in the Grafana configuration file. -To see what the current settings are, refer to [View server settings]({{< relref "../stats-and-license#view-server-settings" >}}). +To see what the current settings are, refer to [View server settings](../stats-and-license/#view-server-settings). ### Change organization UI theme @@ -141,11 +141,11 @@ You can change the UI theme for your user account. This setting overrides UI the By default, Grafana uses the timezone in your web browser. However, you can override this setting at the server, organization, team, or individual user level. This topic provides instructions for each task. -Some tasks require certain permissions. For more information about roles, refer to [Roles and permissions]({{< relref "../roles-and-permissions/" >}}). +Some tasks require certain permissions. For more information about roles, refer to [Roles and permissions](../roles-and-permissions/). ### Set server timezone -Grafana server administrators can choose a default timezone for all users on the server by setting the [default_timezone]({{< relref "../../setup-grafana/configure-grafana/#default_timezone" >}}) option in the Grafana configuration file. +Grafana server administrators can choose a default timezone for all users on the server by setting the [default_timezone](../../setup-grafana/configure-grafana/#default_timezone) option in the Grafana configuration file. ### Set organization timezone @@ -179,7 +179,7 @@ You can change the timezone for your user account. This setting overrides timezo The home dashboard you set is the one all users will see by default when they log in. Click the Grafana icon or **Home** in the breadcrumb to return to it. You can set the home dashboard for the server, an organization, a team, or your personal user account. This topic provides instructions for each task. -Some tasks require certain permissions. For more information about roles, refer to [Roles and permissions]({{< relref "../roles-and-permissions/" >}}). +Some tasks require certain permissions. For more information about roles, refer to [Roles and permissions](../roles-and-permissions/). ### Set the home dashboard for the server @@ -194,7 +194,7 @@ Users with the Grafana Server Admin flag on their account or access to the confi #### Use a JSON file as the home dashboard 1. Save your JSON file somewhere that Grafana can access it. For example, in the Grafana `data` folder of Grafana. -1. Update your configuration file to set the path to the JSON file. Refer to [default_home_dashboard_path]({{< relref "../../setup-grafana/configure-grafana/#default_home_dashboard_path" >}}) for more information about modifying the Grafana configuration files. +1. Update your configuration file to set the path to the JSON file. Refer to [default_home_dashboard_path](../../setup-grafana/configure-grafana/#default_home_dashboard_path) for more information about modifying the Grafana configuration files. ```ini [dashboards] @@ -244,7 +244,7 @@ You can choose your own personal home dashboard. This setting overrides all home ### Change server language -Grafana server administrators can change the default Grafana UI language for all users on the server by setting the [default_language]({{< relref "../../setup-grafana/configure-grafana/#default_language" >}}) option in the Grafana configuration file. +Grafana server administrators can change the default Grafana UI language for all users on the server by setting the [default_language](../../setup-grafana/configure-grafana/#default_language) option in the Grafana configuration file. ### Change organization language diff --git a/docs/sources/administration/plugin-management/index.md b/docs/sources/administration/plugin-management/index.md index 21e048ed9ea..5d89d1204c5 100644 --- a/docs/sources/administration/plugin-management/index.md +++ b/docs/sources/administration/plugin-management/index.md @@ -56,17 +56,17 @@ Use app plugins when you want an out-of-the-box monitoring experience. ### Managing access for app plugins -Customize access to app plugins with [RBAC]({{< relref "../roles-and-permissions/access-control/rbac-for-app-plugins" >}}). +Customize access to app plugins with [RBAC](../roles-and-permissions/access-control/rbac-for-app-plugins/). By default, the Viewer, Editor and Admin roles have access to all app plugins that their Organization role allows them to access. Access is granted by the `fixed:plugins.app:reader` role. {{% admonition type="note" %}} -To prevent users from seeing an app plugin, refer to [these permissions scenarios]({{< relref "../roles-and-permissions/access-control/plan-rbac-rollout-strategy#prevent-viewers-from-accessing-an-app-plugin" >}}). +To prevent users from seeing an app plugin, refer to [these permissions scenarios](../roles-and-permissions/access-control/plan-rbac-rollout-strategy/#prevent-viewers-from-accessing-an-app-plugin). {{% /admonition %}} ## Plugin catalog -The Grafana plugin catalog allows you to browse and manage plugins from within Grafana. Only Grafana server administrators and Organization administrators can access and use the plugin catalog. For more information about Grafana roles and permissions, refer to [Roles and permissions]({{< relref "../roles-and-permissions" >}}). +The Grafana plugin catalog allows you to browse and manage plugins from within Grafana. Only Grafana server administrators and Organization administrators can access and use the plugin catalog. For more information about Grafana roles and permissions, refer to [Roles and permissions](../roles-and-permissions/). The following access rules apply depending on the user role: @@ -88,7 +88,7 @@ The Grafana plugin catalog is designed to work with a single Grafana server inst _Video shows the Plugin catalog in a previous version of Grafana._ {{% admonition type="note" %}} -If required, the Grafana plugin catalog can be disabled using the `plugin_admin_enabled` flag in the [configuration]({{< relref "../../setup-grafana/configure-grafana/#plugin_admin_enabled" >}}) file. +If required, the Grafana plugin catalog can be disabled using the `plugin_admin_enabled` flag in the [configuration](../../setup-grafana/configure-grafana/#plugin_admin_enabled) file. {{% /admonition %}} @@ -114,7 +114,7 @@ There are also additional ways to install plugins depending on your setup. #### Install a plugin using Grafana CLI -Grafana CLI allows you to install, upgrade, and manage your Grafana plugins using a command line. For more information about Grafana CLI plugin commands, refer to [Plugin commands]({{< relref "../../cli/#plugins-commands" >}}). +Grafana CLI allows you to install, upgrade, and manage your Grafana plugins using a command line. For more information about Grafana CLI plugin commands, refer to [Plugin commands](../../cli/#plugins-commands). #### Install a plugin from a ZIP file @@ -126,7 +126,7 @@ Download the archive containing the plugin assets, and install it by extracting unzip my-plugin-0.2.0.zip -d YOUR_PLUGIN_DIR/my-plugin ``` -The path to the plugin directory is defined in the configuration file. For more information, refer to [Configuration]({{< relref "../../setup-grafana/configure-grafana/#plugins" >}}). +The path to the plugin directory is defined in the configuration file. For more information, refer to [Configuration](../../setup-grafana/configure-grafana/#plugins). #### Install a plugin using Grafana configuration @@ -134,7 +134,7 @@ The path to the plugin directory is defined in the configuration file. For more This feature requires Grafana 11.5.0 or later. {{% /admonition %}} -You can install plugins by adding the plugin ID to the `plugins.preinstall` section in the Grafana configuration file. This prevents the plugin from being accidentally uninstalled and can be auto-updated. For more information, refer to [Configuration]({{< relref "../../setup-grafana/configure-grafana/#plugins" >}}). +You can install plugins by adding the plugin ID to the `plugins.preinstall` section in the Grafana configuration file. This prevents the plugin from being accidentally uninstalled and can be auto-updated. For more information, refer to [Configuration](../../setup-grafana/configure-grafana/#plugins). #### Install a plugin in air-gapped environment @@ -224,7 +224,7 @@ All plugins are signed under a _signature level_. The signature level determines Unsigned plugins are not supported in Grafana Cloud. {{% /admonition %}} -We strongly recommend that you don't run unsigned plugins in your Grafana instance. However, if you're aware of the risks and you still want to load an unsigned plugin, refer to [Configuration]({{< relref "../../setup-grafana/configure-grafana/#allow_loading_unsigned_plugins" >}}). +We strongly recommend that you don't run unsigned plugins in your Grafana instance. However, if you're aware of the risks and you still want to load an unsigned plugin, refer to [Configuration](../../setup-grafana/configure-grafana/#allow_loading_unsigned_plugins). If you've allowed loading of an unsigned plugin, then Grafana writes a warning message to the server log: @@ -282,7 +282,7 @@ Plugins running inside the Frontend Sandbox should continue to work normally wit The Frontend Sandbox feature is currently behind the `pluginsFrontendSandbox` feature flag. To enable it, you'll need to: -1. Enable the feature flag in your Grafana configuration. For more information about enabling feature flags, refer to [Configure feature toggles](/setup-grafana/configure-grafana/feature-toggles/). +1. Enable the feature flag in your Grafana configuration. For more information about enabling feature flags, refer to [Configure feature toggles](/docs/grafana//setup-grafana/configure-grafana/feature-toggles/). 2. For self-hosted Grafana installations, add the plugin IDs you want to sandbox in the `security` section using the `enable_frontend_sandbox_for_plugins` configuration option. diff --git a/docs/sources/administration/provisioning/index.md b/docs/sources/administration/provisioning/index.md index b06979b4880..bbbbec185cd 100644 --- a/docs/sources/administration/provisioning/index.md +++ b/docs/sources/administration/provisioning/index.md @@ -20,7 +20,7 @@ This makes GitOps more natural since data sources and dashboards can be defined ## Configuration file -Refer to [Configuration]({{< relref "../../setup-grafana/configure-grafana/" >}}) for more information on what you can configure in `grafana.ini`. +Refer to [Configuration](../../setup-grafana/configure-grafana/) for more information on what you can configure in `grafana.ini`. ### Configuration file locations @@ -73,7 +73,7 @@ Therefore, we heavily rely on the expertise of the community. ## Data sources -You can manage data sources in Grafana by adding YAML configuration files in the [`provisioning/datasources`]({{< relref "../../setup-grafana/configure-grafana#provisioning" >}}) directory. +You can manage data sources in Grafana by adding YAML configuration files in the [`provisioning/datasources`](../../setup-grafana/configure-grafana/#provisioning) directory. Each configuration file can contain a list of `datasources` to add or update during startup. If the data source already exists, Grafana reconfigures it to match the provisioned configuration file. @@ -92,7 +92,7 @@ This prevents old configurations from overwriting newer ones if you have differe ### Example data source configuration file -This example provisions a [Graphite data source]({{< relref "../../datasources/graphite" >}}): +This example provisions a [Graphite data source](../../datasources/graphite/): ```yaml # Configuration file version @@ -172,14 +172,14 @@ datasources: editable: false ``` -For provisioning examples of specific data sources, refer to that [data source's documentation]({{< relref "../../datasources" >}}). +For provisioning examples of specific data sources, refer to that [data source's documentation](../../datasources/). #### JSON data Not all data sources have the same configuration settings. Only the most common fields are included in examples. To provision the rest of a data source's settings, include them as a JSON blob in the `jsonData` field. -Common settings in the [built-in core data sources]({{< relref "../../datasources#built-in-core-data-sources" >}}) include: +Common settings in the [built-in core data sources](../../datasources/#built-in-core-data-sources) include: {{< admonition type="note" >}} Data sources tagged with _HTTP\*_ communicate using the HTTP protocol, which includes all core data source plugins except MySQL, PostgreSQL, and MSSQL. @@ -240,11 +240,11 @@ Data sources tagged with _HTTP\*_ communicate using the HTTP protocol, which inc | implementation | string | AlertManager | The implementation of the AlertManager data source, such as `prometheus`, `cortex` or `mimir` | | handleGrafanaManagedAlerts | boolean | AlertManager | When enabled, Grafana-managed alerts are sent to this Alertmanager | -For examples of specific data sources' JSON data, refer to that [data source's documentation]({{< relref "../../datasources" >}}). +For examples of specific data sources' JSON data, refer to that [data source's documentation](../../datasources/). #### Secure JSON Data -Secure JSON data is a map of settings that are encrypted with a [secret key]({{< relref "../../setup-grafana/configure-grafana#secret_key" >}}) from the Grafana configuration. +Secure JSON data is a map of settings that are encrypted with a [secret key](../../setup-grafana/configure-grafana/#secret_key) from the Grafana configuration. The encryption hides content from the users of the application. This should be used for storing the TLS Cert and password that Grafana appends to the request on the server side. All of these settings are optional. @@ -285,7 +285,7 @@ datasources: ## Plugins -You can manage plugin applications in Grafana by adding one or more YAML configuration files in the [`provisioning/plugins`]({{< relref "../../setup-grafana/configure-grafana#provisioning" >}}) directory. +You can manage plugin applications in Grafana by adding one or more YAML configuration files in the [`provisioning/plugins`](../../setup-grafana/configure-grafana/#provisioning) directory. Each configuration file can contain a list of `apps` that update during start up. Grafana updates each app to match the configuration file. @@ -320,7 +320,7 @@ apps: ## Dashboards -You can manage dashboards in Grafana by adding one or more YAML configuration files in the [`provisioning/dashboards`]({{< relref "../../setup-grafana/configure-grafana#dashboards" >}}) directory. +You can manage dashboards in Grafana by adding one or more YAML configuration files in the [`provisioning/dashboards`](../../setup-grafana/configure-grafana/#dashboards) directory. Each configuration file can contain a list of `dashboards providers` that load dashboards into Grafana from the local filesystem. The dashboard provider configuration file looks somewhat like this: @@ -380,7 +380,7 @@ The JSON definition in the input field when using `Copy JSON to Clipboard` or `S ### Reusable dashboard URLs -If the dashboard in the JSON file contains an [UID]({{< relref "../../dashboards/build-dashboards/view-dashboard-json-model" >}}), Grafana forces insert/update on that UID. +If the dashboard in the JSON file contains an [UID](../../dashboards/build-dashboards/view-dashboard-json-model/), Grafana forces insert/update on that UID. This allows you to migrate dashboards between Grafana instances and provisioning Grafana from configuration without breaking the URLs given because the new dashboard URL uses the UID as identifier. When Grafana starts, it updates and inserts all dashboards available in the configured folders. If you modify the file, then the dashboard is also updated. @@ -436,7 +436,7 @@ You can't create nested folders structures, where you have folders within folder ## Alerting -For information on provisioning Grafana Alerting, refer to [Provision Grafana Alerting resources]({{< relref "../../alerting/set-up/provision-alerting-resources/" >}}). +For information on provisioning Grafana Alerting, refer to [Provision Grafana Alerting resources](../../alerting/set-up/provision-alerting-resources/). ### Supported settings @@ -651,5 +651,5 @@ The following sections detail the supported settings and secure settings for eac Grafana Enterprise supports: -- [Provisioning role-based access control with Grafana]({{< relref "../roles-and-permissions/access-control/rbac-grafana-provisioning/" >}}) -- [Provisioning role-based access control with Terraform]({{< relref "../roles-and-permissions/access-control/rbac-terraform-provisioning/" >}}) +- [Provisioning role-based access control with Grafana](../roles-and-permissions/access-control/rbac-grafana-provisioning/) +- [Provisioning role-based access control with Terraform](../roles-and-permissions/access-control/rbac-terraform-provisioning/) diff --git a/docs/sources/administration/recorded-queries/index.md b/docs/sources/administration/recorded-queries/index.md index d61585f0da5..fdeaa7da656 100644 --- a/docs/sources/administration/recorded-queries/index.md +++ b/docs/sources/administration/recorded-queries/index.md @@ -35,7 +35,7 @@ Recorded queries only work with backend data source plugins. Refer to [Backend d - single row and column - A query that returns a single row and column. - row count - A query that returns meaningful rows to be counted. -- expression - Any expression. To learn more about creating and using expressions, see [Write expression queries]({{< relref "../../panels-visualizations/query-transform-data/expression-queries" >}}). +- expression - Any expression. To learn more about creating and using expressions, see [Write expression queries](../../panels-visualizations/query-transform-data/expression-queries/). - dataplane numeric - A query that returns [dataplane numeric kind](/developers/dataplane/numeric) data. After a recorded query is created or enabled, it immediately creates a snapshot and continues to create snapshots at the set interval. The recorded query stops taking snapshots when it is disabled, deleted, or when Grafana is not running. Data points are gathered in the backend by running the recorded query and forwarding each result to a remote-write enabled Prometheus instance. @@ -48,7 +48,7 @@ To use a recorded query, create one and add it to a dashboard. After that, it ca 1. Find/create a query you want to record on a dashboard in an edit panel. The query must only return one row and column. If it returns more, you can still record the number of results returned using the “count” option. - The query's data source must be a backend data source. - - Expressions can be used to aggregate data from a time series query. Refer to [Write expression queries]({{< relref "../../panels-visualizations/query-transform-data/expression-queries" >}}) to learn more about creating and using expressions. + - Expressions can be used to aggregate data from a time series query. Refer to [Write expression queries](../../panels-visualizations/query-transform-data/expression-queries/) to learn more about creating and using expressions. 1. Click the record query button located in the top right of the query editor. 1. Enter recorded query information. All fields are required unless otherwise indicated. - Name - Name of the recorded query. @@ -68,7 +68,7 @@ You can add existing recorded queries to panels in a dashboard. For each recorde 1. If you want to filter recorded queries by data source, select a data source from the filter by data source drop down menu. 1. Click the `Add` button on your recorded query to add it to the panel. -After adding your recorded query to the panel, the panel data source will become `-- Mixed --`. Your recorded query is represented by a `Prometheus` query with a name label matching your recorded query name. Refer to [Prometheus]({{< relref "../../datasources/prometheus/" >}}) to learn more about the `Prometheus` data source. +After adding your recorded query to the panel, the panel data source will become `-- Mixed --`. Your recorded query is represented by a `Prometheus` query with a name label matching your recorded query name. Refer to [Prometheus](../../datasources/prometheus/) to learn more about the `Prometheus` data source. If after adding a recorded query, a query with a `-- Mixed --` data source instead of `Prometheus` data source appears, this could mean that a Prometheus remote write target was not set up for recorded queries. Refer to [Remote write target](#remote-write-target) to set up a remote write point. diff --git a/docs/sources/administration/roles-and-permissions/_index.md b/docs/sources/administration/roles-and-permissions/_index.md index 87457d1d0fa..29c69087072 100644 --- a/docs/sources/administration/roles-and-permissions/_index.md +++ b/docs/sources/administration/roles-and-permissions/_index.md @@ -34,14 +34,14 @@ If you are running Grafana Enterprise, you can also control access to data sourc A Grafana server administrator manages server-wide settings and access to resources such as organizations, users, and licenses. Grafana includes a default server administrator that you can use to manage all of Grafana, or you can divide that responsibility among other server administrators that you create. {{% admonition type="note" %}} -The server administrator role does not mean that the user is also a Grafana [organization administrator]({{< relref "#organization-roles" >}}). +The server administrator role does not mean that the user is also a Grafana [organization administrator](#organization-roles). {{% /admonition %}} A server administrator can perform the following tasks: - Manage users and permissions - Create, edit, and delete organizations -- View server-wide settings defined in the [Configuration]({{< relref "../../setup-grafana/configure-grafana/" >}}) file +- View server-wide settings defined in the [Configuration](../../setup-grafana/configure-grafana/) file - View Grafana server statistics, including total users and active sessions - Upgrade the server to Grafana Enterprise. @@ -49,7 +49,7 @@ A server administrator can perform the following tasks: The server administrator role does not exist in Grafana Cloud. {{% /admonition %}} -To assign or remove server administrator privileges, see [Server user management]({{< relref "../user-management/server-user-management/assign-remove-server-admin-privileges/" >}}). +To assign or remove server administrator privileges, see [Server user management](../user-management/server-user-management/assign-remove-server-admin-privileges/). ## Organization users and permissions @@ -69,11 +69,11 @@ Permissions assigned to a user within an organization control the extent to whic - library panels - API keys -For more information about managing organization users, see [User management]({{< relref "../user-management/manage-org-users/" >}}). +For more information about managing organization users, see [User management](../user-management/manage-org-users/). ### Organization roles -Organization role-based permissions are global, which means that each permission level applies to all Grafana resources within an given organization. For example, an editor can see and update _all_ dashboards in an organization, unless those dashboards have been specifically restricted using [dashboard permissions]({{< relref "../user-management/manage-dashboard-permissions/" >}}). +Organization role-based permissions are global, which means that each permission level applies to all Grafana resources within an given organization. For example, an editor can see and update _all_ dashboards in an organization, unless those dashboards have been specifically restricted using [dashboard permissions](../user-management/manage-dashboard-permissions/). Grafana uses the following roles to control user access: @@ -117,9 +117,9 @@ You can specify the following permissions to dashboards and folders. > Important: When a user creates a dashboard or a folder they are automatically granted **Admin** permissions for it. -For more information about assigning dashboard folder permissions, refer to [Grant dashboard folder permissions]({{< relref "../user-management/manage-dashboard-permissions/#grant-dashboard-folder-permissions" >}}). +For more information about assigning dashboard folder permissions, refer to [Grant dashboard folder permissions](../user-management/manage-dashboard-permissions/#grant-dashboard-folder-permissions). -For more information about assigning dashboard permissions, refer to [Grant dashboard permissions]({{< relref "../user-management/manage-dashboard-permissions/#grant-dashboard-permissions" >}}). +For more information about assigning dashboard permissions, refer to [Grant dashboard permissions](../user-management/manage-dashboard-permissions/#grant-dashboard-permissions). ## Teams and permissions @@ -132,13 +132,13 @@ You can assign a team member one of the following permissions: Because teams exist inside an organization, the organization administrator can manage all teams. -For details on managing teams, see [Team management]({{< relref "../team-management/" >}}). +For details on managing teams, see [Team management](../team-management/). ## Grafana Enterprise user permissions features While Grafana OSS includes a robust set of permissions and settings that you can use to manage user access to server and organization resources, you might find that you require additional capabilities. -[Grafana Enterprise]({{< relref "../../introduction/grafana-enterprise">}}) provides the following permissions-related features: +[Grafana Enterprise](../../introduction/grafana-enterprise/) provides the following permissions-related features: - Data source permissions - Role-based access control (RBAC) @@ -147,13 +147,13 @@ While Grafana OSS includes a robust set of permissions and settings that you can By default, a user can query any data source in an organization, even if the data source is not linked to the user's dashboards. -Data source permissions enable you to restrict data source query permissions to specific **Users**, **Service Accounts**, and **Teams**. For more information about assigning data source permissions, refer to [Data source permissions]({{< relref "../data-source-management/#data-source-permissions/" >}}). +Data source permissions enable you to restrict data source query permissions to specific **Users**, **Service Accounts**, and **Teams**. For more information about assigning data source permissions, refer to [Data source permissions](../data-source-management/#data-source-permissions/). ### Role-based access control RBAC provides you a way of granting, changing, and revoking user read and write access to Grafana resources, such as users, reports, and authentication. -For more information about RBAC, refer to [Role-based access control]({{< relref "../roles-and-permissions/access-control/" >}}). +For more information about RBAC, refer to [Role-based access control](access-control/). ### Learn more diff --git a/docs/sources/administration/stats-and-license/index.md b/docs/sources/administration/stats-and-license/index.md index 1643fd505cf..ec926f73c2f 100644 --- a/docs/sources/administration/stats-and-license/index.md +++ b/docs/sources/administration/stats-and-license/index.md @@ -25,11 +25,11 @@ This setting contains information about tools that Grafana Server Admins can use ## View Grafana server settings -> Refer to [Role-based access control]({{< relref "../roles-and-permissions/access-control" >}}) in Grafana Enterprise to understand how you can control access with RBAC permissions. +> Refer to [Role-based access control](../roles-and-permissions/access-control/) in Grafana Enterprise to understand how you can control access with RBAC permissions. -If you are a Grafana server administrator, use the Settings tab to view the settings that are applied to your Grafana server via the [Configuration]({{< relref "../../setup-grafana/configure-grafana#configuration-file-location" >}}) file and any environmental variables. +If you are a Grafana server administrator, use the Settings tab to view the settings that are applied to your Grafana server via the [Configuration](../../setup-grafana/configure-grafana/#configuration-file-location) file and any environmental variables. -> **Note:** Only Grafana server administrators can access the **Server Admin** menu. For more information about about administrative permissions, refer to [Roles and permissions]({{< relref "../roles-and-permissions#grafana-server-administrators" >}}). +> **Note:** Only Grafana server administrators can access the **Server Admin** menu. For more information about about administrative permissions, refer to [Roles and permissions](../roles-and-permissions/#grafana-server-administrators). ### View server settings @@ -38,15 +38,15 @@ If you are a Grafana server administrator, use the Settings tab to view the sett ### Available settings -For a full list of server settings, refer to [Configuration]({{< relref "../../setup-grafana/configure-grafana#server" >}}). +For a full list of server settings, refer to [Configuration](../../setup-grafana/configure-grafana/#server). ## View Grafana server stats -> Refer to [Role-based access control]({{< relref "../roles-and-permissions/access-control" >}}) in Grafana Enterprise to understand how you can control access with RBAC permissions. +> Refer to [Role-based access control](../roles-and-permissions/access-control/) in Grafana Enterprise to understand how you can control access with RBAC permissions. If you are a Grafana server admin, then you can view useful statistics about your Grafana server in the Stats & Licensing tab. -> **Note:** Only Grafana server administrators can access the **Server Admin** menu. For more information about about administrative permissions, refer to [Roles and permissions]({{< relref "../roles-and-permissions#grafana-server-administrators" >}}). +> **Note:** Only Grafana server administrators can access the **Server Admin** menu. For more information about about administrative permissions, refer to [Roles and permissions](../roles-and-permissions/#grafana-server-administrators). ### View server stats diff --git a/docs/sources/administration/user-management/manage-dashboard-permissions/index.md b/docs/sources/administration/user-management/manage-dashboard-permissions/index.md index b75f675cc5e..88087df89c2 100644 --- a/docs/sources/administration/user-management/manage-dashboard-permissions/index.md +++ b/docs/sources/administration/user-management/manage-dashboard-permissions/index.md @@ -14,7 +14,7 @@ weight: 500 Dashboard and folder permissions enable you to grant a viewer the ability to edit and save dashboard changes, or limit an editor's permission to modify a dashboard. -For more information about dashboard permissions, refer to [Dashboard permissions]({{< relref "../../roles-and-permissions/#dashboard-permissions" >}}). +For more information about dashboard permissions, refer to [Dashboard permissions](../../roles-and-permissions/#dashboard-permissions). ## Grant folder permissions @@ -23,7 +23,7 @@ When you grant user permissions for folders, that setting applies to all dashboa ### Before you begin - Ensure you have organization administrator privileges -- Identify the dashboard folder permissions you want to modify and the users, service accounts or teams to which you want to grant access. For more information about dashboard permissions, refer to [Dashboard permissions]({{< relref "../../roles-and-permissions/#dashboard-permissions" >}}). +- Identify the dashboard folder permissions you want to modify and the users, service accounts or teams to which you want to grant access. For more information about dashboard permissions, refer to [Dashboard permissions](../../roles-and-permissions/#dashboard-permissions). **To grant dashboard folder permissions**: @@ -65,7 +65,7 @@ Grant dashboard permissions when you want to restrict or enhance dashboard acces # Edit dashboard permissions -Edit dashboard permissions when you are want to enhance or restrict a user's access to a dashboard. For more information about dashboard permissions, refer to [Dashboard permissions]({{< relref "../../roles-and-permissions/#dashboard-permissions" >}}). +Edit dashboard permissions when you are want to enhance or restrict a user's access to a dashboard. For more information about dashboard permissions, refer to [Dashboard permissions](../../roles-and-permissions/#dashboard-permissions). ### Before you begin @@ -135,4 +135,4 @@ Folder permissions settings: Result: User1 has editor permissions for the folder because user1 has permissions on a folder that contains this folder. -> Refer to [Role-based access Control]({{< relref "../../roles-and-permissions/access-control/" >}}) in Grafana Enterprise to understand how to use RBAC permissions to restrict access to dashboards, folders, administrative functions, and other resources. +> Refer to [Role-based access Control](../../roles-and-permissions/access-control/) in Grafana Enterprise to understand how to use RBAC permissions to restrict access to dashboards, folders, administrative functions, and other resources. diff --git a/docs/sources/administration/user-management/manage-org-users/index.md b/docs/sources/administration/user-management/manage-org-users/index.md index 85c8a8bb882..1364e55882f 100644 --- a/docs/sources/administration/user-management/manage-org-users/index.md +++ b/docs/sources/administration/user-management/manage-org-users/index.md @@ -19,7 +19,7 @@ weight: 400 Organization administrators can invite users to join their organization. Organization users have access to organization resources based on their role, which is **Admin**, **Editor**, or **Viewer**. Permissions associated with each role determine the tasks a user can perform in the system. -For more information about organization user permissions, refer to [Organization users and permissions]({{< relref "../../roles-and-permissions/#organization-users-and-permissions" >}}). +For more information about organization user permissions, refer to [Organization users and permissions](../../roles-and-permissions/#organization-users-and-permissions). {{% admonition type="note" %}} Users added at the organization level will have access to all stacks and services by default, without the ability to be filtered by stack unless Single Sign-On (SSO) or Role-Based Access Control (RBAC) is implemented. @@ -41,15 +41,15 @@ You can see a list of users with accounts in your Grafana organization. If neces 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. +If you have [server administrator](../../roles-and-permissions/#grafana-server-administrators) permissions, you can also [view a global list of users](../server-user-management/#view-a-list-of-users) in the Server Admin section of Grafana. {{% /admonition %}} ## Change a user's organization permissions -Update user permissions when you want to enhance or restrict a user's access to organization resources. For more information about organization permissions, refer to [Organization roles]({{< relref "../../roles-and-permissions/#organization-roles" >}}). +Update user permissions when you want to enhance or restrict a user's access to organization resources. For more information about organization permissions, refer to [Organization roles](../../roles-and-permissions/#organization-roles). {{% admonition type="note" %}} -Organization roles sync from the authentication provider on user sign-in. To prevent synchronization of organization roles from the authentication provider regardless of their role in the authentication provider, then refer to the `skip_org_role_sync` setting in your Grafana configuration. Refer to [skip org role sync]({{< relref "../../../setup-grafana/configure-grafana/#authgrafana_com-skip_org_role_sync" >}}) for more information. +Organization roles sync from the authentication provider on user sign-in. To prevent synchronization of organization roles from the authentication provider regardless of their role in the authentication provider, then refer to the `skip_org_role_sync` setting in your Grafana configuration. Refer to [skip org role sync](../../../setup-grafana/configure-grafana/#authgrafana_com-skip_org_role_sync) for more information. {{% /admonition %}} ### Before you begin @@ -69,7 +69,7 @@ Organization roles sync from the authentication provider on user sign-in. To pre 1. Click **Update**. {{% admonition type="note" %}} -If you have [server administrator]({{< relref "../../roles-and-permissions/#grafana-server-administrators" >}}) permissions, you can also [change a user's organization permissions]({{< relref "../server-user-management/change-user-org-permissions/" >}}) in the Server Admin section. +If you have [server administrator](../../roles-and-permissions/#grafana-server-administrators) permissions, you can also [change a user's organization permissions](../server-user-management/change-user-org-permissions/) in the Server Admin section. {{% /admonition %}} ## Invite a user to join an organization @@ -80,14 +80,14 @@ When you invite users to join an organization, you assign the **Admin**, **Edito - If the user is new to Grafana, then use their email address to issue an invitation. The system automatically creates the user account on first sign in. {{% admonition type="note" %}} -If you have [server administrator]({{< relref "../../roles-and-permissions/#grafana-server-administrators" >}}) permissions, you can also manually [add a user to an organization]({{< relref "../server-user-management/add-remove-user-to-org/" >}}). +If you have [server administrator](../../roles-and-permissions/#grafana-server-administrators) permissions, you can also manually [add a user to an organization](../server-user-management/add-remove-user-to-org/). {{% /admonition %}} ### Before you begin - Ensure you have organization administrator privileges. - If the user already has access to Grafana, obtain their user name. -- Determine the permissions you want to assign to the user. For more information about organization permissions, refer to [Organization roles]({{< relref "../../roles-and-permissions/#organization-roles" >}}). +- Determine the permissions you want to assign to the user. For more information about organization permissions, refer to [Organization roles](../../roles-and-permissions/#organization-roles). **To invite or add an existing user account to your organization**: @@ -105,7 +105,7 @@ If you have [server administrator]({{< relref "../../roles-and-permissions/#graf | ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | Email or username | Either the email or username that the user will use to sign in to Grafana. | | Name | The user's name. | - | Role | Click the organization role to assign this user. For more information about organization roles, refer to [Organization roles]({{< relref "../../roles-and-permissions/#organization-roles" >}}).. | + | Role | Click the organization role to assign this user. For more information about organization roles, refer to [Organization roles](../../roles-and-permissions/#organization-roles).. | | Send invite email | Switch to on if your organization has configured. The system sends an email to the user inviting them to sign in to Grafana and join the organization. Switch to off if you are not using email. The user can sign in to Grafana with the email or username you entered. | 1. Click **Submit**. @@ -156,4 +156,4 @@ This action does not remove the user account from the Grafana server. 1. Click the red **X** to remove the user from the organization. -> **Note:** If you have [server administrator]({{< relref "../../roles-and-permissions/#grafana-server-administrators" >}}) permissions, you can also [remove a user from an organization]({{< relref "../server-user-management/add-remove-user-to-org/#remove-a-user-from-an-organization" >}}) on the Users page of the Server Admin section. +> **Note:** If you have [server administrator](../../roles-and-permissions/#grafana-server-administrators) permissions, you can also [remove a user from an organization](../server-user-management/add-remove-user-to-org/#remove-a-user-from-an-organization) on the Users page of the Server Admin section. diff --git a/docs/sources/administration/user-management/server-user-management/_index.md b/docs/sources/administration/user-management/server-user-management/_index.md index f5d14efcd25..cd3640c8224 100644 --- a/docs/sources/administration/user-management/server-user-management/_index.md +++ b/docs/sources/administration/user-management/server-user-management/_index.md @@ -20,13 +20,13 @@ weight: 100 A _user_ is defined as any individual who can log in to Grafana. Each user is associated with a _role_ that includes _permissions_. Permissions determine the tasks a user can perform in the system. -If you have [server administrator]({{< relref "../../roles-and-permissions/#grafana-server-administrators" >}}) permissions in Grafana, you can manage all users for a Grafana instance in the Server Admin section: +If you have [server administrator](../../roles-and-permissions/#grafana-server-administrators) permissions in Grafana, you can manage all users for a Grafana instance in the Server Admin section: {{< section >}} -If you have [organization administrator]({{< relref "../../roles-and-permissions/#organization-roles" >}}) permissions and _not_ [server administrator]({{< relref "../../roles-and-permissions/#grafana-server-administrators" >}}) permissions, refer to [Manage users in a organization]({{< relref "../manage-org-users/" >}}). +If you have [organization administrator](../../roles-and-permissions/#organization-roles) permissions and _not_ [server administrator](../../roles-and-permissions/#grafana-server-administrators) permissions, refer to [Manage users in a organization](../manage-org-users/). -For more information about user roles and permissions, refer to [Roles and permissions]({{< relref "../../roles-and-permissions/" >}}). For more information about managing users in general, see [User management]({{< relref "../" >}}). +For more information about user roles and permissions, refer to [Roles and permissions](../../roles-and-permissions/). For more information about managing users in general, see [User management](../). ## View a list of users @@ -42,7 +42,7 @@ You can see a list of users with accounts on your Grafana server. This action mi 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" >}}). +If you have [organization administrator](../../roles-and-permissions/#organization-roles) permissions and _not_ [server administrator](../../roles-and-permissions/#grafana-server-administrators) permissions, you can still [view of list of users in a given organization](../manage-org-users/#view-a-list-of-organization-users). {{% /admonition %}} ## View user details @@ -104,7 +104,7 @@ Edit a user account when you want to modify user login credentials, or delete, d Add users when you want to manually provide individuals with access to Grafana. -When you create a user using this method, you must create their password. The user does not receive a notification by email. To invite a user to Grafana and allow them to create their own password, [invite a user to join an organization]({{< relref "../manage-org-users#invite-a-user-to-join-an-organization" >}}). +When you create a user using this method, you must create their password. The user does not receive a notification by email. To invite a user to Grafana and allow them to create their own password, [invite a user to join an organization](../manage-org-users/#invite-a-user-to-join-an-organization). When you configure advanced authentication using Oauth, SAML, LDAP, or the Auth proxy, users are created automatically. @@ -119,10 +119,10 @@ When you configure advanced authentication using Oauth, SAML, LDAP, or the Auth 1. Click **New user**. 1. Complete the fields and click **Create user**. -When you create a user, the system assigns the user viewer permissions in a default organization, which you can change. You can now [add a user to a second organization]({{< relref "add-remove-user-to-org/" >}}). +When you create a user, the system assigns the user viewer permissions in a default organization, which you can change. You can now [add a user to a second organization](add-remove-user-to-org/). {{% 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 add users by [inviting a user to join an organization]({{< relref "../manage-org-users#invite-a-user-to-join-an-organization" >}}). +If you have [organization administrator](../../roles-and-permissions/#organization-roles) permissions and _not_ [server administrator](../../roles-and-permissions/#grafana-server-administrators) permissions, you can still add users by [inviting a user to join an organization](../manage-org-users/#invite-a-user-to-join-an-organization). {{% /admonition %}} ## Force a user to log out of Grafana diff --git a/docs/sources/administration/user-management/server-user-management/add-remove-user-to-org/index.md b/docs/sources/administration/user-management/server-user-management/add-remove-user-to-org/index.md index 04ddd0dc490..f67983d8e68 100644 --- a/docs/sources/administration/user-management/server-user-management/add-remove-user-to-org/index.md +++ b/docs/sources/administration/user-management/server-user-management/add-remove-user-to-org/index.md @@ -14,7 +14,7 @@ weight: 30 # Add or remove a user in an organization -Server administrators can add and remove users in organizations. To do this as an organization administrator, see [Manage users in an organization]({{< relref "../../manage-org-users/" >}}). +Server administrators can add and remove users in organizations. To do this as an organization administrator, see [Manage users in an organization](../../manage-org-users/). ## Add a user to an organization @@ -24,9 +24,9 @@ You are required to specify an Admin role for each organization. The first user ### Before you begin -- [Create an organization]({{< relref "../../../organization-management/#create-an-organization" >}}) -- [Add a user]({{< relref "./#add-a-user" >}}) to Grafana -- Ensure you have [Grafana server administrator privileges]({{< relref "./assign-remove-server-admin-privileges" >}}) +- [Create an organization](../../../organization-management/#create-an-organization) +- [Add a user](./#add-a-user) to Grafana +- Ensure you have [Grafana server administrator privileges](../assign-remove-server-admin-privileges/) **To add a user to an organization**: @@ -36,14 +36,14 @@ You are required to specify an Admin role for each organization. The first user 1. In the Organizations section, click **Add user to organization**. 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](../../../roles-and-permissions/#organization-roles). 1. Click **Add to organization**. The next time the user signs in, they will be able to navigate to their new organization using the Switch Organizations option in the user profile menu. {{% 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 [invite a user to join an organization]({{< relref "../../manage-org-users#invite-a-user-to-join-an-organization" >}}). +If you have [organization administrator](../../../roles-and-permissions/#organization-roles) permissions and _not_ [server administrator](../../../roles-and-permissions/#grafana-server-administrators) permissions, you can still [invite a user to join an organization](../../manage-org-users/#invite-a-user-to-join-an-organization). {{% /admonition %}} ## Remove a user from an organization @@ -62,4 +62,4 @@ Remove a user from an organization when they no longer require access to the das 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**. -> **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](../../../roles-and-permissions/#organization-roles) permissions and _not_ [server administrator](../../../roles-and-permissions/#grafana-server-administrators) permissions, you can still [remove a user from an organization](../../manage-org-users/#remove-a-user-from-an-organization) in the Users section of organization configuration. diff --git a/docs/sources/administration/user-management/server-user-management/assign-remove-server-admin-privileges/index.md b/docs/sources/administration/user-management/server-user-management/assign-remove-server-admin-privileges/index.md index c017f104bdd..31523789db9 100644 --- a/docs/sources/administration/user-management/server-user-management/assign-remove-server-admin-privileges/index.md +++ b/docs/sources/administration/user-management/server-user-management/assign-remove-server-admin-privileges/index.md @@ -13,7 +13,7 @@ weight: 20 # Assign or remove Grafana server administrator privileges -Grafana server administrators are responsible for creating users, organizations, and managing permissions. For more information about the server administration role, refer to [Grafana server administrators]({{< relref "../../../roles-and-permissions#grafana-server-administrators" >}}). +Grafana server administrators are responsible for creating users, organizations, and managing permissions. For more information about the server administration role, refer to [Grafana server administrators](../../../roles-and-permissions/#grafana-server-administrators). {{% admonition type="note" %}} Server administrators are "super-admins" with full permissions to create, read, update, and delete all resources and users in all organizations, as well as update global settings such as licenses. Only grant this permission to trusted users. @@ -21,7 +21,7 @@ Server administrators are "super-admins" with full permissions to create, read, ## Before you begin -- [Add a user]({{< relref "../#add-a-user" >}}) +- [Add a user](../#add-a-user) - Ensure you have Grafana server administrator privileges **To assign or remove Grafana administrator privileges**: diff --git a/docs/sources/administration/user-management/server-user-management/change-user-org-permissions/index.md b/docs/sources/administration/user-management/server-user-management/change-user-org-permissions/index.md index 4569a5ac8f2..4bf9eac2862 100644 --- a/docs/sources/administration/user-management/server-user-management/change-user-org-permissions/index.md +++ b/docs/sources/administration/user-management/server-user-management/change-user-org-permissions/index.md @@ -11,11 +11,11 @@ weight: 50 # Change a user's organization permissions -Update organization permissions when you want to enhance or restrict a user's access to organization resources. For more information about organization permissions, refer to [Organization roles]({{< relref "../../../roles-and-permissions/#organization-roles" >}}). +Update organization permissions when you want to enhance or restrict a user's access to organization resources. For more information about organization permissions, refer to [Organization roles](../../../roles-and-permissions/#organization-roles). ## Before you begin -- [Add a user to an organization]({{< relref "./add-remove-user-to-org/" >}}) +- [Add a user to an organization](../add-remove-user-to-org/) - Ensure you have Grafana server administrator privileges **To change a user's organization permissions**: diff --git a/docs/sources/administration/user-management/user-preferences/index.md b/docs/sources/administration/user-management/user-preferences/index.md index 41166419d52..eb1bae56a7f 100644 --- a/docs/sources/administration/user-management/user-preferences/index.md +++ b/docs/sources/administration/user-management/user-preferences/index.md @@ -50,7 +50,7 @@ Your profile includes your name, user name, and email address, which you can upd ## Edit your preferences -You can choose the way you would like data to appear in Grafana, including the UI theme, home dashboard, timezone, and first day of the week. You can set these preferences for your own account, for a team, for an organization, or Grafana-wide using configuration settings. Your user preferences take precedence over team, organization, and Grafana default preferences. For more information, see [Grafana preferences]({{< relref "../../organization-preferences/" >}}). +You can choose the way you would like data to appear in Grafana, including the UI theme, home dashboard, timezone, and first day of the week. You can set these preferences for your own account, for a team, for an organization, or Grafana-wide using configuration settings. Your user preferences take precedence over team, organization, and Grafana default preferences. For more information, see [Grafana preferences](../../organization-preferences/). - **UI theme** determines whether Grafana appears in light mode or dark mode. By default, UI theme is set to dark mode. - **Home dashboard** refers to the dashboard you see when you sign in to Grafana. By default, this is set to the Home dashboard. @@ -85,7 +85,7 @@ Every user is a member of at least one organization. You can have different role 1. Click the user icon in the top right corner of the page and select **Profile**. 1. Scroll down to the Organizations section and review the following information: - **Name**: The name of the organizations of which you are a member. - - **Role**: The role to which you are assigned in the organization. For more information about roles and permissions, refer to [Organization users and permissions]({{< relref "../../roles-and-permissions/#organization-users-and-permissions" >}}). + - **Role**: The role to which you are assigned in the organization. For more information about roles and permissions, refer to [Organization users and permissions](../../roles-and-permissions/#organization-users-and-permissions). - **Current**: Grafana indicates the organization that you are currently signed into as _Current_. If you are a member of multiple organizations, you can click **Select** to switch to that organization. ## View your Grafana sessions diff --git a/docs/sources/alerting/set-up/meta-monitoring.md b/docs/sources/alerting/set-up/meta-monitoring.md index 4c29f6ac4a9..46d8c517f8c 100644 --- a/docs/sources/alerting/set-up/meta-monitoring.md +++ b/docs/sources/alerting/set-up/meta-monitoring.md @@ -2,6 +2,7 @@ aliases: - ../meta-monitoring/ # /docs/grafana//alerting/meta-monitoring/ - ../monitoring/ # /docs/grafana//alerting/monitoring/ + - ../monitor/ # /docs/grafana//alerting/monitor/ canonical: https://grafana.com/docs/grafana/latest/alerting/set-up/meta-monitoring description: Monitor your alerting metrics to ensure you identify potential issues before they become critical. keywords: diff --git a/docs/sources/breaking-changes/_index.md b/docs/sources/breaking-changes/_index.md index af76c612b89..fa0628a51d9 100644 --- a/docs/sources/breaking-changes/_index.md +++ b/docs/sources/breaking-changes/_index.md @@ -25,7 +25,7 @@ For our purposes, a breaking change is any change that requires users or operato {{% admonition type="note" %}} -To learn what's available in a Grafana release, refer to the [What's new ]({{< relref "../whatsnew/" >}}) page for each version. For the steps we recommend when you upgrade, check out the [Upgrade guide]({{< relref "../upgrade-guide/" >}}) for each version. +To learn what's available in a Grafana release, refer to the [What's new ](../whatsnew/) page for each version. For the steps we recommend when you upgrade, check out the [Upgrade guide](../upgrade-guide/) for each version. {{% /admonition %}} diff --git a/docs/sources/breaking-changes/breaking-changes-v10-0.md b/docs/sources/breaking-changes/breaking-changes-v10-0.md index 946ba52c93c..8250dba93d2 100644 --- a/docs/sources/breaking-changes/breaking-changes-v10-0.md +++ b/docs/sources/breaking-changes/breaking-changes-v10-0.md @@ -34,7 +34,7 @@ For each change, the provided information: - Guides you in how to mitigate for the change or migrate - Provides more learning resources -For release highlights and deprecations, refer to our [v10.0 What’s new]({{< relref "../whatsnew/whats-new-in-v10-0/" >}}). For the specific steps we recommend when you upgrade to v10.0, check out our [Upgrade guide]({{< relref "../upgrade-guide/upgrade-v10.0/index.md" >}}). +For release highlights and deprecations, refer to our [v10.0 What’s new](../../whatsnew/whats-new-in-v10-0/). For the specific steps we recommend when you upgrade to v10.0, check out our [Upgrade guide](../../upgrade-guide/upgrade-v10.0/). | Action | Scope | @@ -123,7 +123,7 @@ The format for `time` and `timeEnd` should be epoch numbers in millisecond resol **Required permissions** -See note in the [introduction]({{< ref "#annotations-api" >}}) for an explanation. +See note in the [introduction](#annotations-api) for an explanation. | Action | Scope | @@ -178,7 +178,7 @@ format (string with multiple tags being separated by a space). **Required permissions** -See note in the [introduction]({{< ref "#annotations-api" >}}) for an explanation. +See note in the [introduction](#annotations-api) for an explanation. | Action | Scope | | -------------------- | ------------------------------- | @@ -219,7 +219,7 @@ Updates all properties of an annotation that matches the specified id. To only u **Required permissions** -See note in the [introduction]({{< ref "#annotations-api" >}}) for an explanation. +See note in the [introduction](#annotations-api) for an explanation. | Action | Scope | @@ -265,7 +265,7 @@ This operation currently supports updating of the `text`, `tags`, `time` and `ti **Required permissions** -See note in the [introduction]({{< ref "#annotations-api" >}}) for an explanation. +See note in the [introduction](#annotations-api) for an explanation. | Action | Scope | @@ -307,7 +307,7 @@ Deletes the annotation that matches the specified id. **Required permissions** -See note in the [introduction]({{< ref "#annotations-api" >}}) for an explanation. +See note in the [introduction](#annotations-api) for an explanation. | Action | Scope | @@ -344,7 +344,7 @@ Find all the event tags created in the annotations. **Required permissions** -See note in the [introduction]({{< ref "#annotations-api" >}}) for an explanation. +See note in the [introduction](#annotations-api) for an explanation. | Action | Scope | | ------------------ | ----- | diff --git a/docs/sources/developers/http_api/auth.md b/docs/sources/developers/http_api/auth.md index be88ae5ccd0..898def0691b 100644 --- a/docs/sources/developers/http_api/auth.md +++ b/docs/sources/developers/http_api/auth.md @@ -22,10 +22,10 @@ title: 'Authentication HTTP API ' The Authentication HTTP API is used to manage API keys. {{% admonition type="note" %}} -Grafana recommends using service accounts instead of API keys. For more information, refer to [Grafana service account API reference]({{< relref "./serviceaccount/" >}}). +Grafana recommends using service accounts instead of API keys. For more information, refer to [Grafana service account API reference](../serviceaccount/). {{% /admonition %}} -> If you are running Grafana Enterprise, for some endpoints you would need to have relevant permissions. Refer to [Role-based access control permissions]({{< relref "../../administration/roles-and-permissions/access-control/custom-role-actions-scopes/" >}}) for more information. +> If you are running Grafana Enterprise, for some endpoints you would need to have relevant permissions. Refer to [Role-based access control permissions](../../../administration/roles-and-permissions/access-control/custom-role-actions-scopes/) for more information. ## List API keys @@ -38,7 +38,7 @@ This endpoint is deprecated. **Required permissions** -See note in the [introduction]({{< ref "#authentication-api" >}}) for an explanation. +See note in the [introduction](#authentication-api) for an explanation. | Action | Scope | | -------------- | ----------- | @@ -85,7 +85,7 @@ This endpoint has been made obsolete in Grafana 11.3.0. {{% /admonition %}} -Endpoint is obsolete and has been moved to [Grafana service account API]({{< relref "./serviceaccount/" >}}). For more information, refer to [Migrate to Grafana service account API](/docs/grafana//administration/service-accounts/migrate-api-keys/). +Endpoint is obsolete and has been moved to [Grafana service account API](../serviceaccount/). For more information, refer to [Migrate to Grafana service account API](/docs/grafana//administration/service-accounts/migrate-api-keys/). `POST /api/auth/keys` @@ -110,7 +110,7 @@ Content-Type: application/json **Required permissions** -See note in the [introduction]({{< ref "#authentication-api" >}}) for an explanation. +See note in the [introduction](#authentication-api) for an explanation. | Action | Scope | | ---------------- | ---------- | diff --git a/docs/sources/developers/http_api/dashboard.md b/docs/sources/developers/http_api/dashboard.md index 54bfaf63156..75d1f8a50d3 100644 --- a/docs/sources/developers/http_api/dashboard.md +++ b/docs/sources/developers/http_api/dashboard.md @@ -18,7 +18,7 @@ title: Dashboard HTTP API # Dashboard API -> If you are running Grafana Enterprise, for some endpoints you'll need to have specific permissions. Refer to [Role-based access control permissions]({{< relref "/docs/grafana/latest/administration/roles-and-permissions/access-control/custom-role-actions-scopes" >}}) for more information. +> If you are running Grafana Enterprise, for some endpoints you'll need to have specific permissions. Refer to [Role-based access control permissions](/docs/grafana/latest/administration/roles-and-permissions/access-control/custom-role-actions-scopes/) for more information. ## Identifier (id) vs unique identifier (uid) @@ -26,7 +26,7 @@ The identifier (id) of a dashboard is an auto-incrementing numeric value and is The unique identifier (uid) of a dashboard can be used for uniquely identify a dashboard between multiple Grafana installs. It's automatically generated if not provided when creating a dashboard. The uid allows having consistent URLs for accessing -dashboards and when syncing dashboards between multiple Grafana installs, see [dashboard provisioning]({{< relref "/docs/grafana/latest/administration/provisioning#dashboards" >}}) +dashboards and when syncing dashboards between multiple Grafana installs, see [dashboard provisioning](/docs/grafana/latest/administration/provisioning/#dashboards) for more information. This means that changing the title of a dashboard will not break any bookmarked links to that dashboard. The uid can have a maximum length of 40 characters. @@ -41,7 +41,7 @@ Creates a new dashboard or updates an existing dashboard. When updating existing **Required permissions** -See note in the [introduction]({{< ref "#dashboard-api" >}}) for an explanation. +See note in the [introduction](#dashboard-api) for an explanation. | Action | Scope | @@ -80,7 +80,7 @@ JSON Body schema: - **dashboard** – The complete dashboard model. - **dashboard.id** – id = null to create a new dashboard. - **dashboard.uid** – Optional unique identifier when creating a dashboard. uid = null will generate a new uid. -- **dashboard.refresh** - Set the dashboard refresh interval. If this is lower than [the minimum refresh interval]({{< relref "/docs/grafana/latest/setup-grafana/configure-grafana#min_refresh_interval" >}}), then Grafana will ignore it and will enforce the minimum refresh interval. +- **dashboard.refresh** - Set the dashboard refresh interval. If this is lower than [the minimum refresh interval](/docs/grafana/latest/setup-grafana/configure-grafana/#min_refresh_interval), then Grafana will ignore it and will enforce the minimum refresh interval. - **folderId** – The id of the folder to save the dashboard in. - **folderUid** – The UID of the folder to save the dashboard in. Overrides the `folderId`. - **overwrite** – Set to true if you want to overwrite an existing dashboard with a given dashboard UID. @@ -163,7 +163,7 @@ Will return the dashboard given the dashboard unique identifier (uid). Informati **Required permissions** -See note in the [introduction]({{< ref "#dashboard-api" >}}) for an explanation. +See note in the [introduction](#dashboard-api) for an explanation. | Action | Scope | @@ -222,7 +222,7 @@ Will delete the dashboard given the specified unique identifier (uid). **Required permissions** -See note in the [introduction]({{< ref "#dashboard-api" >}}) for an explanation. +See note in the [introduction](#dashboard-api) for an explanation. | Action | Scope | @@ -272,7 +272,7 @@ Will delete permanently the dashboard given the specified unique identifier (uid **Required permissions** -See note in the [introduction]({{< ref "#dashboard-api" >}}) for an explanation. +See note in the [introduction](#dashboard-api) for an explanation. | Action | Scope | @@ -322,7 +322,7 @@ Will restore a deleted dashboard given the specified unique identifier (uid). **Required permissions** -See note in the [introduction]({{< ref "#dashboard-api" >}}) for an explanation. +See note in the [introduction](#dashboard-api) for an explanation. | Action | Scope | @@ -450,4 +450,4 @@ Content-Type: application/json ## Dashboard Search -See [Folder/Dashboard Search API]({{< relref "folder_dashboard_search/" >}}). +See [Folder/Dashboard Search API](../folder_dashboard_search/). diff --git a/docs/sources/developers/http_api/dashboard_permissions.md b/docs/sources/developers/http_api/dashboard_permissions.md index 07242307875..3a12656faf5 100644 --- a/docs/sources/developers/http_api/dashboard_permissions.md +++ b/docs/sources/developers/http_api/dashboard_permissions.md @@ -32,7 +32,7 @@ The permission levels for the permission field: - 2 = Edit - 4 = Admin -> If you are running Grafana Enterprise, for some endpoints you'll need to have specific permissions. Refer to [Role-based access control permissions]({{< relref "/docs/grafana/latest/administration/roles-and-permissions/access-control/custom-role-actions-scopes" >}}) for more information. +> If you are running Grafana Enterprise, for some endpoints you'll need to have specific permissions. Refer to [Role-based access control permissions](/docs/grafana/latest/administration/roles-and-permissions/access-control/custom-role-actions-scopes/) for more information. ## Get permissions for a dashboard @@ -42,7 +42,7 @@ Gets all existing permissions for the dashboard with the given `uid`. **Required permissions** -See note in the [introduction]({{< ref "#dashboard-permission-api" >}}) for an explanation. +See note in the [introduction](#dashboard-permission-api) for an explanation. | Action | Scope | @@ -124,7 +124,7 @@ Updates permissions for a dashboard. This operation will remove existing permiss **Required permissions** -See note in the [introduction]({{< ref "#dashboard-permission-api" >}}) for an explanation. +See note in the [introduction](#dashboard-permission-api) for an explanation. | Action | Scope | diff --git a/docs/sources/developers/http_api/data_source.md b/docs/sources/developers/http_api/data_source.md index e9d8a8b35ab..ddda447bcfc 100644 --- a/docs/sources/developers/http_api/data_source.md +++ b/docs/sources/developers/http_api/data_source.md @@ -19,7 +19,7 @@ title: Data source HTTP API # Data source API -> If you are running Grafana Enterprise, for some endpoints you'll need to have specific permissions. Refer to [Role-based access control permissions]({{< relref "/docs/grafana/latest/administration/roles-and-permissions/access-control/custom-role-actions-scopes" >}}) for more information. +> If you are running Grafana Enterprise, for some endpoints you'll need to have specific permissions. Refer to [Role-based access control permissions](/docs/grafana/latest/administration/roles-and-permissions/access-control/custom-role-actions-scopes/) for more information. ## Get all data sources @@ -31,7 +31,7 @@ This API currently doesn't handle pagination. The default maximum number of data **Required permissions** -See note in the [introduction]({{< ref "#data-source-api" >}}) for an explanation. +See note in the [introduction](#data-source-api) for an explanation. | Action | Scope | | ---------------- | -------------- | @@ -90,7 +90,7 @@ This API is deprecated since Grafana v9.0.0 and will be removed in a future rele **Required permissions** -See note in the [introduction]({{< ref "#data-source-api" >}}) for an explanation. +See note in the [introduction](#data-source-api) for an explanation. | Action | Scope | | ---------------- | ---------------------------------------------------------------------------- | @@ -146,7 +146,7 @@ Content-Type: application/json **Required permissions** -See note in the [introduction]({{< ref "#data-source-api" >}}) for an explanation. +See note in the [introduction](#data-source-api) for an explanation. | Action | Scope | | ---------------- | -------------------------------------------------------------------------------------- | @@ -202,7 +202,7 @@ Content-Type: application/json **Required permissions** -See note in the [introduction]({{< ref "#data-source-api" >}}) for an explanation. +See note in the [introduction](#data-source-api) for an explanation. | Action | Scope | | ---------------- | ---------------------------------------------------------------------------------------------- | @@ -258,7 +258,7 @@ Content-Type: application/json **Required permissions** -See note in the [introduction]({{< ref "#data-source-api" >}}) for an explanation. +See note in the [introduction](#data-source-api) for an explanation. | Action | Scope | | ------------------- | ---------------------------------------------------------------------------------------------- | @@ -292,7 +292,7 @@ Content-Type: application/json **Required permissions** -See note in the [introduction]({{< ref "#data-source-api" >}}) for an explanation. +See note in the [introduction](#data-source-api) for an explanation. | Action | Scope | | ------------------ | ----- | @@ -446,7 +446,7 @@ This API is deprecated since Grafana v9.0.0 and will be removed in a future rele **Required permissions** -See note in the [introduction]({{< ref "#data-source-api" >}}) for an explanation. +See note in the [introduction](#data-source-api) for an explanation. | Action | Scope | | ----------------- | ---------------------------------------------------------------------------- | @@ -529,7 +529,7 @@ Similar to [creating a data source](#create-a-data-source), `password` and `basi **Required permissions** -See note in the [introduction]({{< ref "#data-source-api" >}}) for an explanation. +See note in the [introduction](#data-source-api) for an explanation. | Action | Scope | | ----------------- | -------------------------------------------------------------------------------------- | @@ -617,7 +617,7 @@ This API is deprecated since Grafana v9.0.0 and will be removed in a future rele **Required permissions** -See note in the [introduction]({{< ref "#data-source-api" >}}) for an explanation. +See note in the [introduction](#data-source-api) for an explanation. | Action | Scope | | ------------------ | ---------------------------------------------------------------------------- | @@ -649,7 +649,7 @@ Content-Type: application/json **Required permissions** -See note in the [introduction]({{< ref "#data-source-api" >}}) for an explanation. +See note in the [introduction](#data-source-api) for an explanation. | Action | Scope | | ------------------ | -------------------------------------------------------------------------------------- | @@ -684,7 +684,7 @@ Content-Type: application/json **Required permissions** -See note in the [introduction]({{< ref "#data-source-api" >}}) for an explanation. +See note in the [introduction](#data-source-api) for an explanation. | Action | Scope | | ------------------ | ---------------------------------------------------------------------------------------------- | diff --git a/docs/sources/developers/http_api/datasource_permissions.md b/docs/sources/developers/http_api/datasource_permissions.md index 9c0a0fc3ee8..b65464d0dba 100644 --- a/docs/sources/developers/http_api/datasource_permissions.md +++ b/docs/sources/developers/http_api/datasource_permissions.md @@ -23,9 +23,9 @@ title: Datasource Permissions HTTP API # Data Source Permissions API -> The Data Source Permissions is only available in Grafana Enterprise. Read more about [Grafana Enterprise]({{< relref "/docs/grafana/latest/introduction/grafana-enterprise" >}}). +> The Data Source Permissions is only available in Grafana Enterprise. Read more about [Grafana Enterprise](/docs/grafana/latest/introduction/grafana-enterprise/). -> If you are running Grafana Enterprise, for some endpoints you'll need to have specific permissions. Refer to [Role-based access control permissions]({{< relref "/docs/grafana/latest/administration/roles-and-permissions/access-control/custom-role-actions-scopes" >}}) for more information. +> If you are running Grafana Enterprise, for some endpoints you'll need to have specific permissions. Refer to [Role-based access control permissions](/docs/grafana/latest/administration/roles-and-permissions/access-control/custom-role-actions-scopes/) for more information. This API can be used to list, add and remove permissions for a data source. @@ -39,7 +39,7 @@ Gets all existing permissions for the data source with the given `uid`. **Required permissions** -See note in the [introduction]({{< ref "#data-source-permissions-api" >}}) for an explanation. +See note in the [introduction](#data-source-permissions-api) for an explanation. | Action | Scope | | ---------------------------- | ------------------------------------------------------------------------------------------ | @@ -134,7 +134,7 @@ To remove a permission, set the `permission` field to an empty string. **Required permissions** -See note in the [introduction]({{< ref "#data-source-permissions-api" >}}) for an explanation. +See note in the [introduction](#data-source-permissions-api) for an explanation. | Action | Scope | | ----------------------------- | ------------------------------------------------------------------------------------------ | @@ -206,7 +206,7 @@ To remove a permission, set the `permission` field to an empty string. **Required permissions** -See note in the [introduction]({{< ref "#data-source-permissions-api" >}}) for an explanation. +See note in the [introduction](#data-source-permissions-api) for an explanation. | Action | Scope | | ----------------------------- | ------------------------------------------------------------------------------------------ | @@ -280,7 +280,7 @@ To remove a permission, set the `permission` field to an empty string. **Required permissions** -See note in the [introduction]({{< ref "#data-source-permissions-api" >}}) for an explanation. +See note in the [introduction](#data-source-permissions-api) for an explanation. | Action | Scope | | ----------------------------- | ------------------------------------------------------------------------------------------ | diff --git a/docs/sources/developers/http_api/examples/create-api-tokens-for-org.md b/docs/sources/developers/http_api/examples/create-api-tokens-for-org.md index d5b2ded16a4..caa6bc90243 100644 --- a/docs/sources/developers/http_api/examples/create-api-tokens-for-org.md +++ b/docs/sources/developers/http_api/examples/create-api-tokens-for-org.md @@ -32,7 +32,7 @@ There are two authentication methods to access the API: The task is to create a new organization and then add a Token that can be used by other users. In the examples below which use basic auth, the user is `admin` and the password is `admin`. -1. [Create the org](http://docs.grafana.org/http_api/org/#create-organization). Here is an example using curl: +1. [Create the org](/docs/grafana//http_api/org/#create-organization). Here is an example using curl: ```bash curl -X POST -H "Content-Type: application/json" -d '{"name":"apiorg"}' http://admin:admin@localhost:3000/api/orgs @@ -40,25 +40,25 @@ The task is to create a new organization and then add a Token that can be used b This should return a response: `{"message":"Organization created","orgId":6}`. Use the orgId for the next steps. -1. Optional step. If the org was created previously and/or step 3 fails then first [add your Admin user to the org](http://docs.grafana.org/http_api/org/#add-user-in-organization): +1. Optional step. If the org was created previously and/or step 3 fails then first [add your Admin user to the org](/docs/grafana//http_api/org/#add-user-in-organization): ```bash curl -X POST -H "Content-Type: application/json" -d '{"loginOrEmail":"admin", "role": "Admin"}' http://admin:admin@localhost:3000/api/orgs//users ``` -1. [Switch the org context for the Admin user to the new org](http://docs.grafana.org/http_api/user/#switch-user-context-for-signed-in-user): +1. [Switch the org context for the Admin user to the new org](/docs/grafana//http_api/user/#switch-user-context-for-signed-in-user): ```bash curl -X POST http://admin:admin@localhost:3000/api/user/using/ ``` -1. [Create a Service Account]({{< relref "./serviceaccount/#create-service-account" >}}): +1. [Create a Service Account](../../serviceaccount/#create-service-account): ```bash curl -X POST -H "Content-Type: application/json" -d '{"name":"test", "role": "Admin"}' http://admin:admin@localhost:3000/api/serviceaccounts ``` -1. [Create a Service Account token]({{< relref "./serviceaccount/#create-service-account-tokens" >}}) for the service account created in the previous step: +1. [Create a Service Account token](../../serviceaccount/#create-service-account-tokens) for the service account created in the previous step: ```bash curl -X POST -H "Content-Type: application/json" -d '{"name":"test-token"}' http://admin:admin@localhost:3000/api/serviceaccounts//tokens @@ -83,7 +83,7 @@ The task is to create a new organization and then add a Token that can be used b Using the Token that was created in the previous step, you can create a dashboard or carry out other actions without having to switch organizations. -1. [Add a dashboard](http://docs.grafana.org/http_api/dashboard/#create-update-dashboard) using the key (or bearer token as it is also called): +1. [Add a dashboard](/docs/grafana//http_api/dashboard/#create-update-dashboard) using the key (or bearer token as it is also called): ```bash curl -X POST --insecure -H "Authorization: Bearer eyJrIjoiR0ZXZmt1UFc0OEpIOGN5RWdUalBJTllUTk83VlhtVGwiLCJuIjoiYXBpa2V5Y3VybCIsImlkIjo2fQ==" -H "Content-Type: application/json" -d '{ diff --git a/docs/sources/developers/http_api/examples/curl-examples.md b/docs/sources/developers/http_api/examples/curl-examples.md index a7f3c1ca2e8..b00e59feb4a 100644 --- a/docs/sources/developers/http_api/examples/curl-examples.md +++ b/docs/sources/developers/http_api/examples/curl-examples.md @@ -27,16 +27,16 @@ The most basic example for a dashboard for which there is no authentication. You curl http://localhost:3000/api/search ``` -Here's a cURL command that works for getting the home dashboard when you are running Grafana locally with [basic authentication]({{< relref "/docs/grafana/latest/setup-grafana/configure-security/configure-authentication#basic-auth" >}}) enabled using the default admin credentials: +Here's a cURL command that works for getting the home dashboard when you are running Grafana locally with [basic authentication](/docs/grafana/latest/setup-grafana/configure-security/configure-authentication/#basic-auth) enabled using the default admin credentials: ``` curl http://admin:admin@localhost:3000/api/search ``` -To pass a username and password with [HTTP basic authorization]({{< relref "/docs/grafana/latest/administration/roles-and-permissions/access-control/manage-rbac-roles" >}}), encode them as base64. +To pass a username and password with [HTTP basic authorization](/docs/grafana/latest/administration/roles-and-permissions/access-control/manage-rbac-roles/), encode them as base64. You can't use authorization tokens in the request. -For example, to [list permissions associated with roles]({{< relref "/docs/grafana/latest/administration/roles-and-permissions/access-control/manage-rbac-roles" >}}) given a username of `user` and password of `password`, use: +For example, to [list permissions associated with roles](/docs/grafana/latest/administration/roles-and-permissions/access-control/manage-rbac-roles/) given a username of `user` and password of `password`, use: ``` curl --location '/api/access-control/builtin-roles' --user 'user:password' diff --git a/docs/sources/developers/http_api/folder.md b/docs/sources/developers/http_api/folder.md index dce1ff7eea7..73a9c54ba39 100644 --- a/docs/sources/developers/http_api/folder.md +++ b/docs/sources/developers/http_api/folder.md @@ -18,7 +18,7 @@ title: Folder HTTP API # Folder API -> If you are running Grafana Enterprise, for some endpoints you'll need to have specific permissions. Refer to [Role-based access control permissions]({{< relref "/docs/grafana/latest/administration/roles-and-permissions/access-control/custom-role-actions-scopes" >}}) for more information. +> If you are running Grafana Enterprise, for some endpoints you'll need to have specific permissions. Refer to [Role-based access control permissions](/docs/grafana/latest/administration/roles-and-permissions/access-control/custom-role-actions-scopes/) for more information. ## Identifier (id) vs unique identifier (uid) @@ -40,7 +40,7 @@ that the authenticated user has permission to view. **Required permissions** -See note in the [introduction]({{< ref "#folder-api" >}}) for an explanation. +See note in the [introduction](#folder-api) for an explanation. | Action | Scope | | -------------- | ----------- | @@ -83,7 +83,7 @@ Will return the folder given the folder uid. **Required permissions** -See note in the [introduction]({{< ref "#folder-api" >}}) for an explanation. +See note in the [introduction](#folder-api) for an explanation. | Action | Scope | | -------------- | ----------- | @@ -141,7 +141,7 @@ Creates a new folder. **Required permissions** -See note in the [introduction]({{< ref "#folder-api" >}}) for an explanation. +See note in the [introduction](#folder-api) for an explanation. `folders:create` allows creating folders and subfolders. If granted with scope `folders:uid:general`, allows creating root level folders. Otherwise, allows creating subfolders under the specified folders. @@ -167,7 +167,7 @@ Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk JSON Body schema: -- **uid** – Optional [unique identifier]({{< ref "#identifier-id-vs-unique-identifier-uid" >}}). +- **uid** – Optional [unique identifier](#identifier-id-vs-unique-identifier-uid). - **title** – The title of the folder. - **parentUid** - Optional field, the unique identifier of the parent folder under which the folder should be created. Requires nested folders to be enabled. @@ -215,7 +215,7 @@ Updates an existing folder identified by uid. **Required permissions** -See note in the [introduction]({{< ref "#folder-api" >}}) for an explanation. +See note in the [introduction](#folder-api) for an explanation. | Action | Scope | | --------------- | ----------- | @@ -302,11 +302,11 @@ Content-Length: 97 Deletes an existing folder identified by UID along with all dashboards (and their alerts) stored in the folder. This operation cannot be reverted. -If [Grafana Alerting]({{< relref "/docs/grafana/latest/alerting" >}}) is enabled, you can set an optional query parameter `forceDeleteRules=false` so that requests will fail with 400 (Bad Request) error if the folder contains any Grafana alerts. However, if this parameter is set to `true` then it will delete any Grafana alerts under this folder. +If [Grafana Alerting](/docs/grafana/latest/alerting/) is enabled, you can set an optional query parameter `forceDeleteRules=false` so that requests will fail with 400 (Bad Request) error if the folder contains any Grafana alerts. However, if this parameter is set to `true` then it will delete any Grafana alerts under this folder. **Required permissions** -See note in the [introduction]({{< ref "#folder-api" >}}) for an explanation. +See note in the [introduction](#folder-api) for an explanation. | Action | Scope | | ---------------- | ----------- | @@ -352,7 +352,7 @@ This is relevant only if nested folders are enabled. **Required permissions** -See note in the [introduction]({{< ref "#folder-api" >}}) for an explanation. +See note in the [introduction](#folder-api) for an explanation. If moving the folder under another folder: @@ -367,7 +367,7 @@ If moving the folder under root: JSON body schema: -- **parentUid** – Optional [unique identifier]({{< relref "#identifier-id-vs-unique-identifier-uid" >}}) of the new parent folder. If this is empty, then the folder is moved under the root. +- **parentUid** – Optional [unique identifier](#identifier-id-vs-unique-identifier-uid) of the new parent folder. If this is empty, then the folder is moved under the root. **Example Request**: diff --git a/docs/sources/developers/http_api/folder_dashboard_search.md b/docs/sources/developers/http_api/folder_dashboard_search.md index 5f945a60a03..af741927365 100644 --- a/docs/sources/developers/http_api/folder_dashboard_search.md +++ b/docs/sources/developers/http_api/folder_dashboard_search.md @@ -24,7 +24,7 @@ title: Folder/Dashboard Search HTTP API `GET /api/search/` -> Note: When using [Role-based access control]({{< relref "/docs/grafana/latest/administration/roles-and-permissions/access-control" >}}), search results will contain only dashboards and folders which you have access to. +> Note: When using [Role-based access control](/docs/grafana/latest/administration/roles-and-permissions/access-control/), search results will contain only dashboards and folders which you have access to. Query parameters: diff --git a/docs/sources/developers/http_api/folder_permissions.md b/docs/sources/developers/http_api/folder_permissions.md index 4e7b3ed31ff..74eeffff35a 100644 --- a/docs/sources/developers/http_api/folder_permissions.md +++ b/docs/sources/developers/http_api/folder_permissions.md @@ -32,7 +32,7 @@ The permission levels for the permission field: - 2 = Edit - 4 = Admin -> If you are running Grafana Enterprise, for some endpoints you'll need to have specific permissions. Refer to [Role-based access control permissions]({{< relref "/docs/grafana/latest/administration/roles-and-permissions/access-control/custom-role-actions-scopes" >}}) for more information. +> If you are running Grafana Enterprise, for some endpoints you'll need to have specific permissions. Refer to [Role-based access control permissions](/docs/grafana/latest/administration/roles-and-permissions/access-control/custom-role-actions-scopes/) for more information. ## Get permissions for a folder @@ -42,7 +42,7 @@ Gets all existing permissions for the folder with the given `uid`. **Required permissions** -See note in the [introduction]({{< ref "#folder-permission-api" >}}) for an explanation. +See note in the [introduction](#folder-permission-api) for an explanation. | Action | Scope | | -------------------------- | ----------- | @@ -121,7 +121,7 @@ Updates permissions for a folder. This operation will remove existing permission **Required permissions** -See note in the [introduction]({{< ref "#folder-permission-api" >}}) for an explanation. +See note in the [introduction](#folder-permission-api) for an explanation. | Action | Scope | | --------------------------- | ----------- | diff --git a/docs/sources/developers/http_api/library_element.md b/docs/sources/developers/http_api/library_element.md index c6efb1df45a..19a5577c202 100644 --- a/docs/sources/developers/http_api/library_element.md +++ b/docs/sources/developers/http_api/library_element.md @@ -286,7 +286,7 @@ JSON Body schema: - `name`: Optional, the name of the library element. - `model`: The JSON model for the library element. - `kind`: Kind of element to create, Use `1` for library panels or `2` for library variables. -- `uid`: Optional, the [unique identifier](/http_api/library_element/#identifier-id-vs-unique-identifier-uid). +- `uid`: Optional, the [unique identifier](#identifier-id-vs-unique-identifier-uid). **Example Request**: @@ -366,7 +366,7 @@ JSON Body schema: - `model`: The JSON model for the library element. - `kind`: Kind of element to create. Use `1` for library panels or `2` for library variables. - `version`: Version of the library element you are updating. -- `uid`: Optional, the [unique identifier](/http_api/library_element/#identifier-id-vs-unique-identifier-uid). +- `uid`: Optional, the [unique identifier](#identifier-id-vs-unique-identifier-uid). **Example Request**: diff --git a/docs/sources/developers/http_api/licensing.md b/docs/sources/developers/http_api/licensing.md index 937f25a8468..0d09183750c 100644 --- a/docs/sources/developers/http_api/licensing.md +++ b/docs/sources/developers/http_api/licensing.md @@ -19,7 +19,7 @@ title: Licensing HTTP API # Enterprise License API -Licensing is only available in Grafana Enterprise. Read more about [Grafana Enterprise]({{< relref "/docs/grafana/latest/introduction/grafana-enterprise" >}}). +Licensing is only available in Grafana Enterprise. Read more about [Grafana Enterprise](/docs/grafana/latest/introduction/grafana-enterprise/). {{< admonition type="caution" >}} You can't authenticate to the Licensing HTTP API with service account tokens. @@ -31,7 +31,7 @@ To use these API endpoints you have to use Basic authentication and the Grafana The `admin` user that Grafana is provisioned with by default has permissions to use these API endpoints. {{< /admonition >}} -> If you are running Grafana Enterprise, for some endpoints you'll need to have specific permissions. Refer to [Role-based access control permissions]({{< relref "/docs/grafana/latest/administration/roles-and-permissions/access-control/custom-role-actions-scopes" >}}) for more information. +> If you are running Grafana Enterprise, for some endpoints you'll need to have specific permissions. Refer to [Role-based access control permissions](/docs/grafana/latest/administration/roles-and-permissions/access-control/custom-role-actions-scopes/) for more information. ## Check license availability @@ -43,7 +43,7 @@ Checks if a valid license is available. **Required permissions** -See note in the [introduction]({{< ref "#enterprise-license-api" >}}) for an explanation. +See note in the [introduction](#enterprise-license-api) for an explanation. | Action | Scope | | -------------- | ----- | @@ -85,7 +85,7 @@ Applies a license to a Grafana instance. **Required permissions** -See note in the [introduction]({{< ref "#enterprise-license-api" >}}) for an explanation. +See note in the [introduction](#enterprise-license-api) for an explanation. | Action | Scope | | --------------- | ----- | @@ -147,7 +147,7 @@ Manually ask license issuer for a new token. **Required permissions** -See note in the [introduction]({{< ref "#enterprise-license-api" >}}) for an explanation. +See note in the [introduction](#enterprise-license-api) for an explanation. | Action | Scope | | --------------- | ----- | @@ -208,7 +208,7 @@ Removes the license stored in the Grafana database. **Required permissions** -See note in the [introduction]({{< ref "#enterprise-license-api" >}}) for an explanation. +See note in the [introduction](#enterprise-license-api) for an explanation. | Action | Scope | | ---------------- | ----- | diff --git a/docs/sources/developers/http_api/org.md b/docs/sources/developers/http_api/org.md index d79a60f95ef..d5fb8ab9cb5 100644 --- a/docs/sources/developers/http_api/org.md +++ b/docs/sources/developers/http_api/org.md @@ -23,7 +23,7 @@ The Organization HTTP API is divided in two resources, `/api/org` (current organ and `/api/orgs` (admin organizations). One big difference between these are that the admin of all organizations API only works with basic authentication, see [Admin Organizations API](#admin-organizations-api) for more information. -> If you are running Grafana Enterprise, for some endpoints you'll need to have specific permissions. Refer to [Role-based access control permissions]({{< relref "/docs/grafana/latest/administration/roles-and-permissions/access-control/custom-role-actions-scopes" >}}) for more information. +> If you are running Grafana Enterprise, for some endpoints you'll need to have specific permissions. Refer to [Role-based access control permissions](/docs/grafana/latest/administration/roles-and-permissions/access-control/custom-role-actions-scopes/) for more information. ## Current Organization API @@ -33,7 +33,7 @@ the admin of all organizations API only works with basic authentication, see [Ad **Required permissions** -See note in the [introduction]({{< ref "#organization-api" >}}) for an explanation. +See note in the [introduction](#organization-api) for an explanation. | Action | Scope | | --------- | ----- | @@ -69,7 +69,7 @@ Accessible to users with org admin role. **Required permissions** -See note in the [introduction]({{< ref "#organization-api" >}}) for an explanation. +See note in the [introduction](#organization-api) for an explanation. | Action | Scope | | -------------- | -------- | @@ -115,7 +115,7 @@ when editing folder/dashboard permissions. **Required permissions** -See note in the [introduction]({{< ref "#organization-api" >}}) for an explanation. +See note in the [introduction](#organization-api) for an explanation. | Action | Scope | | -------------- | -------- | @@ -151,7 +151,7 @@ Content-Type: application/json **Required permissions** -See note in the [introduction]({{< ref "#organization-api" >}}) for an explanation. +See note in the [introduction](#organization-api) for an explanation. | Action | Scope | | --------------- | -------- | @@ -185,7 +185,7 @@ Content-Type: application/json **Required permissions** -See note in the [introduction]({{< ref "#organization-api" >}}) for an explanation. +See note in the [introduction](#organization-api) for an explanation. | Action | Scope | | ---------------- | -------- | @@ -215,7 +215,7 @@ Content-Type: application/json **Required permissions** -See note in the [introduction]({{< ref "#organization-api" >}}) for an explanation. +See note in the [introduction](#organization-api) for an explanation. | Action | Scope | | ---------- | ----- | @@ -251,7 +251,7 @@ Adds a global user to the current organization. **Required permissions** -See note in the [introduction]({{< ref "#organization-api" >}}) for an explanation. +See note in the [introduction](#organization-api) for an explanation. | Action | Scope | | ------------- | -------- | @@ -300,7 +300,7 @@ Only works with Basic Authentication (username and password), see [introduction] **Required permissions** -See note in the [introduction]({{< ref "#organization-api" >}}) for an explanation. +See note in the [introduction](#organization-api) for an explanation. | Action | Scope | | --------- | ----- | @@ -342,7 +342,7 @@ Only works with Basic Authentication (username and password), see [introduction] **Required permissions** -See note in the [introduction]({{< ref "#organization-api" >}}) for an explanation. +See note in the [introduction](#organization-api) for an explanation. | Action | Scope | Note | | --------- | ----- | ------------------------------ | @@ -384,7 +384,7 @@ Only works with Basic Authentication (username and password), see [introduction] **Required permissions** -See note in the [introduction]({{< ref "#organization-api" >}}) for an explanation. +See note in the [introduction](#organization-api) for an explanation. | Action | Scope | Note | | ----------- | ----- | ------------------------------ | @@ -427,7 +427,7 @@ Only works with Basic Authentication (username and password), see [introduction] **Required permissions** -See note in the [introduction]({{< ref "#organization-api" >}}) for an explanation. +See note in the [introduction](#organization-api) for an explanation. | Action | Scope | Note | | --------- | ----- | ------------------------------ | @@ -469,7 +469,7 @@ Only works with Basic Authentication (username and password), see [introduction] **Required permissions** -See note in the [introduction]({{< ref "#organization-api" >}}) for an explanation. +See note in the [introduction](#organization-api) for an explanation. | Action | Scope | | ---------- | ----- | @@ -504,7 +504,7 @@ Only works with Basic Authentication (username and password), see [introduction] **Required permissions** -See note in the [introduction]({{< ref "#organization-api" >}}) for an explanation. +See note in the [introduction](#organization-api) for an explanation. | Action | Scope | | ----------- | ----- | @@ -534,7 +534,7 @@ Only works with Basic Authentication (username and password), see [introduction] **Required permissions** -See note in the [introduction]({{< ref "#organization-api" >}}) for an explanation. +See note in the [introduction](#organization-api) for an explanation. | Action | Scope | | -------------- | -------- | @@ -575,7 +575,7 @@ Only works with Basic Authentication (username and password), see [introduction] **Required permissions** -See note in the [introduction]({{< ref "#organization-api" >}}) for an explanation. +See note in the [introduction](#organization-api) for an explanation. | Action | Scope | | ------------- | -------- | @@ -611,7 +611,7 @@ Only works with Basic Authentication (username and password), see [introduction] **Required permissions** -See note in the [introduction]({{< ref "#organization-api" >}}) for an explanation. +See note in the [introduction](#organization-api) for an explanation. | Action | Scope | | --------------- | -------- | @@ -646,7 +646,7 @@ Only works with Basic Authentication (username and password), see [introduction] **Required permissions** -See note in the [introduction]({{< ref "#organization-api" >}}) for an explanation. +See note in the [introduction](#organization-api) for an explanation. | Action | Scope | | ---------------- | -------- | diff --git a/docs/sources/developers/http_api/query_and_resource_caching.md b/docs/sources/developers/http_api/query_and_resource_caching.md index 826292decb6..0b24456e2e2 100644 --- a/docs/sources/developers/http_api/query_and_resource_caching.md +++ b/docs/sources/developers/http_api/query_and_resource_caching.md @@ -24,7 +24,7 @@ title: Query and Resource Caching HTTP API # Query and resource caching API {{% admonition type="note" %}} -If you are running Grafana Enterprise, for some endpoints you'll need to have specific permissions. Refer to [Role-based access control permissions]({{< relref "/docs/grafana/latest/administration/roles-and-permissions/access-control/custom-role-actions-scopes" >}}) for more information. +If you are running Grafana Enterprise, for some endpoints you'll need to have specific permissions. Refer to [Role-based access control permissions](/docs/grafana/latest/administration/roles-and-permissions/access-control/custom-role-actions-scopes/) for more information. {{% /admonition %}} ## Enable caching for a data source @@ -33,7 +33,7 @@ If you are running Grafana Enterprise, for some endpoints you'll need to have sp **Required permissions** -See note in the [introduction]({{< ref "#query-and-resource-caching-api" >}}) for an explanation. +See note in the [introduction](#query-and-resource-caching-api) for an explanation. | Action | Scope | | ------------------------- | -------------- | @@ -83,7 +83,7 @@ Content-Type: application/json **Required permissions** -See note in the [introduction]({{< ref "#query-and-resource-caching-api" >}}) for an explanation. +See note in the [introduction](#query-and-resource-caching-api) for an explanation. | Action | Scope | | ------------------------- | -------------- | @@ -135,7 +135,7 @@ Will clean cached data for _all_ data sources with caching enabled. The `dataSou **Required permissions** -See note in the [introduction]({{< ref "#query-and-resource-caching-api" >}}) for an explanation. +See note in the [introduction](#query-and-resource-caching-api) for an explanation. | Action | Scope | | ------------------------- | -------------- | @@ -185,7 +185,7 @@ Content-Type: application/json **Required permissions** -See note in the [introduction]({{< ref "#query-and-resource-caching-api" >}}) for an explanation. +See note in the [introduction](#query-and-resource-caching-api) for an explanation. | Action | Scope | | ------------------------- | -------------- | @@ -256,7 +256,7 @@ Content-Type: application/json **Required permissions** -See note in the [introduction]({{< ref "#query-and-resource-caching-api" >}}) for an explanation. +See note in the [introduction](#query-and-resource-caching-api) for an explanation. | Action | Scope | | ------------------------ | -------------- | diff --git a/docs/sources/developers/http_api/reporting.md b/docs/sources/developers/http_api/reporting.md index 871775fe15a..8666f253e63 100644 --- a/docs/sources/developers/http_api/reporting.md +++ b/docs/sources/developers/http_api/reporting.md @@ -17,13 +17,13 @@ title: Reporting API # Reporting API -This API allows you to interact programmatically with the [Reporting]({{< relref "/docs/grafana/latest/dashboards/create-reports" >}}) feature. +This API allows you to interact programmatically with the [Reporting](/docs/grafana/latest/dashboards/create-reports/) feature. > The Reporting API is not stabilized yet, it is still in active development and may change without prior notice. -> Reporting is only available in Grafana Enterprise. Read more about [Grafana Enterprise]({{< relref "/docs/grafana/latest/introduction/grafana-enterprise" >}}). +> Reporting is only available in Grafana Enterprise. Read more about [Grafana Enterprise](/docs/grafana/latest/introduction/grafana-enterprise/). -> If you are running Grafana Enterprise, for some endpoints you'll need to have specific permissions. Refer to [Role-based access control permissions]({{< relref "/docs/grafana/latest/administration/roles-and-permissions/access-control/custom-role-actions-scopes" >}}) for more information. +> If you are running Grafana Enterprise, for some endpoints you'll need to have specific permissions. Refer to [Role-based access control permissions](/docs/grafana/latest/administration/roles-and-permissions/access-control/custom-role-actions-scopes/) for more information. ## List all reports @@ -31,7 +31,7 @@ This API allows you to interact programmatically with the [Reporting]({{< relref #### Required permissions -See note in the [introduction]({{< relref "#reporting-api" >}}) for an explanation. +See note in the [introduction](#reporting-api) for an explanation. | Action | Scope | | ------------ | --------------------------- | @@ -103,7 +103,7 @@ Content-Length: 1840 ### Status Codes - **200** – OK -- **401** - Authentication failed, refer to [Authentication API]({{< relref "/docs/grafana/latest/developers/http_api/auth" >}}). +- **401** - Authentication failed, refer to [Authentication API](/docs/grafana/latest/developers/http_api/auth/). - **500** – Unexpected error or server misconfiguration. Refer to server logs for more details. ## Get a report @@ -112,7 +112,7 @@ Content-Length: 1840 #### Required permissions -See note in the [introduction]({{< relref "#reporting-api" >}}) for an explanation. +See note in the [introduction](#reporting-api) for an explanation. | Action | Scope | | ------------ | ---------------------------------------------------------- | @@ -187,7 +187,7 @@ Content-Length: 940 - **200** – OK - **400** – Bad request (invalid report ID). -- **401** - Authentication failed, refer to [Authentication API]({{< relref "/docs/grafana/latest/developers/http_api/auth" >}}). +- **401** - Authentication failed, refer to [Authentication API](/docs/grafana/latest/developers/http_api/auth/). - **403** – Forbidden (access denied to a report or a dashboard used in the report). - **404** – Not found (such report does not exist). - **500** – Unexpected error or server misconfiguration. Refer to server logs for more details. @@ -198,7 +198,7 @@ Content-Length: 940 #### Required permissions -See note in the [introduction]({{< ref "#reporting-api" >}}) for an explanation. +See note in the [introduction](#reporting-api) for an explanation. | Action | Scope | | -------------- | ----- | @@ -308,7 +308,7 @@ Content-Length: 35 #### Required permissions -See note in the [introduction]({{< ref "#reporting-api" >}}) for an explanation. +See note in the [introduction](#reporting-api) for an explanation. | Action | Scope | | ------------- | --------------------------------------------------------- | @@ -316,7 +316,7 @@ See note in the [introduction]({{< ref "#reporting-api" >}}) for an explanation. ### Example request -See [JSON body schema]({{< ref "#config-json-body-schema" >}}) for fields description. +See [JSON body schema](#config-json-body-schema) for fields description. ```http GET /api/reports HTTP/1.1 @@ -381,7 +381,7 @@ Content-Length: 28 - **200** – OK - **400** – Bad request (invalid json, missing or invalid fields values, etc.). -- **401** - Authentication failed, refer to [Authentication API]({{< relref "/docs/grafana/latest/developers/http_api/auth" >}}). +- **401** - Authentication failed, refer to [Authentication API](/docs/grafana/latest/developers/http_api/auth/). - **403** – Forbidden (access denied to a report or a dashboard used in the report). - **404** – Not found (such report does not exist). - **500** – Unexpected error or server misconfiguration. Refer to server logs for more details. @@ -392,7 +392,7 @@ Content-Length: 28 #### Required permissions -See note in the [introduction]({{< ref "#reporting-api" >}}) for an explanation. +See note in the [introduction](#reporting-api) for an explanation. | Action | Scope | | -------------- | --------------------------------------------------------- | @@ -423,7 +423,7 @@ Content-Length: 39 - **200** – OK - **400** – Bad request (invalid report ID). -- **401** - Authentication failed, refer to [Authentication API]({{< relref "/docs/grafana/latest/developers/http_api/auth" >}}). +- **401** - Authentication failed, refer to [Authentication API](/docs/grafana/latest/developers/http_api/auth/). - **404** - Not found (report with this ID does not exist). - **500** - Unexpected error or server misconfiguration. Refer to server logs for more details @@ -435,7 +435,7 @@ Generate and send a report. This API waits for the report to be generated before #### Required permissions -See note in the [introduction]({{< ref "#reporting-api" >}}) for an explanation. +See note in the [introduction](#reporting-api) for an explanation. | Action | Scope | | ------------ | ----- | @@ -477,7 +477,7 @@ Content-Length: 29 - **200** – Report was sent. - **400** – Bad request (invalid json, missing content-type, missing or invalid fields, etc.). -- **401** - Authentication failed, refer to [Authentication API]({{< relref "/docs/grafana/latest/developers/http_api/auth" >}}). +- **401** - Authentication failed, refer to [Authentication API](/docs/grafana/latest/developers/http_api/auth/). - **403** - Forbidden (access denied to a report or a dashboard used in the report). - **404** - Report not found. - **500** - Unexpected error or server misconfiguration. Refer to server logs for more details. @@ -490,7 +490,7 @@ Returns reports branding settings that are global and used across all the report #### Required permissions -See note in the [introduction]({{< ref "#reporting-api" >}}) for an explanation. +See note in the [introduction](#reporting-api) for an explanation. | Action | Scope | | --------------------- | ----- | @@ -529,7 +529,7 @@ Content-Length: 181 ### Status Codes - **200** – OK -- **401** - Authentication failed, refer to [Authentication API]({{< relref "/docs/grafana/latest/developers/http_api/auth" >}}). +- **401** - Authentication failed, refer to [Authentication API](/docs/grafana/latest/developers/http_api/auth/). - **500** - Unexpected error or server misconfiguration. Refer to server logs for more detail ## Save reports branding settings @@ -540,7 +540,7 @@ Creates settings if they don't exist, otherwise updates them. These settings are #### Required permissions -See note in the [introduction]({{< ref "#reporting-api" >}}) for an explanation. +See note in the [introduction](#reporting-api) for an explanation. | Action | Scope | | ---------------------- | ----- | @@ -591,7 +591,7 @@ Content-Length: 35 - **200** – OK - **400** – Bad request (invalid json, missing or invalid fields values, etc.). -- **401** - Authentication failed, refer to [Authentication API]({{< relref "/docs/grafana/latest/developers/http_api/auth" >}}). +- **401** - Authentication failed, refer to [Authentication API](/docs/grafana/latest/developers/http_api/auth/). - **500** - Unexpected error or server misconfiguration. Refer to server logs for more detail ## Send a test email @@ -602,7 +602,7 @@ Sends a test email with a report without persisting it in the database. #### Required permissions -See note in the [introduction]({{< ref "#reporting-api" >}}) for an explanation. +See note in the [introduction](#reporting-api) for an explanation. | Action | Scope | | ------------ | ----- | @@ -610,7 +610,7 @@ See note in the [introduction]({{< ref "#reporting-api" >}}) for an explanation. ### Example request -See [JSON body schema]({{< ref "#config-json-body-schema" >}}) for fields description. +See [JSON body schema](#config-json-body-schema) for fields description. ```http POST /api/reports/test-email HTTP/1.1 @@ -674,6 +674,6 @@ Content-Length: 29 - **200** – OK - **400** – Bad request (invalid json, missing or invalid fields values, etc.). -- **401** - Authentication failed, refer to [Authentication API]({{< relref "/docs/grafana/latest/developers/http_api/auth" >}}). +- **401** - Authentication failed, refer to [Authentication API](/docs/grafana/latest/developers/http_api/auth/). - **403** - Forbidden (access denied to a report or a dashboard used in the report). - **500** - Unexpected error or server misconfiguration. Refer to server logs for more details diff --git a/docs/sources/developers/http_api/serviceaccount.md b/docs/sources/developers/http_api/serviceaccount.md index 680c3472647..559ecc05b3a 100644 --- a/docs/sources/developers/http_api/serviceaccount.md +++ b/docs/sources/developers/http_api/serviceaccount.md @@ -18,7 +18,7 @@ title: Service account HTTP API # Service account API -> If you are running Grafana Enterprise, for some endpoints you'll need to have specific permissions. Refer to [Role-based access control permissions]({{< relref "/docs/grafana/latest/administration/roles-and-permissions/access-control/custom-role-actions-scopes" >}}) for more information. +> If you are running Grafana Enterprise, for some endpoints you'll need to have specific permissions. Refer to [Role-based access control permissions](/docs/grafana/latest/administration/roles-and-permissions/access-control/custom-role-actions-scopes/) for more information. > For Grafana Cloud instances, please use a Bearer token to authenticate. The examples within this section reference Basic authentication which is for On-Prem Grafana instances. ## Search service accounts with Paging @@ -27,7 +27,7 @@ title: Service account HTTP API **Required permissions** -See note in the [introduction]({{< ref "#service-account-api" >}}) for an explanation. +See note in the [introduction](#service-account-api) for an explanation. | Action | Scope | | -------------------- | ----- | @@ -94,7 +94,7 @@ Content-Type: application/json **Required permissions** -See note in the [introduction]({{< ref "#service-account-api" >}}) for an explanation. +See note in the [introduction](#service-account-api) for an explanation. | Action | Scope | | ---------------------- | ----- | @@ -141,7 +141,7 @@ Content-Type: application/json **Required permissions** -See note in the [introduction]({{< ref "#service-account-api" >}}) for an explanation. +See note in the [introduction](#service-account-api) for an explanation. | Action | Scope | | -------------------- | --------------------- | @@ -182,7 +182,7 @@ Content-Type: application/json **Required permissions** -See note in the [introduction]({{< ref "#service-account-api" >}}) for an explanation. +See note in the [introduction](#service-account-api) for an explanation. | Action | Scope | | --------------------- | --------------------- | @@ -228,7 +228,7 @@ Content-Type: application/json **Required permissions** -See note in the [introduction]({{< ref "#service-account-api" >}}) for an explanation. +See note in the [introduction](#service-account-api) for an explanation. | Action | Scope | | ---------------------- | --------------------- | @@ -262,7 +262,7 @@ Content-Type: application/json **Required permissions** -See note in the [introduction]({{< ref "#service-account-api" >}}) for an explanation. +See note in the [introduction](#service-account-api) for an explanation. | Action | Scope | | --------------------- | ------------------ | @@ -294,7 +294,7 @@ Content-Type: application/json **Required permissions** -See note in the [introduction]({{< ref "#service-account-api" >}}) for an explanation. +See note in the [introduction](#service-account-api) for an explanation. | Action | Scope | | --------------------- | ------------------ | @@ -326,7 +326,7 @@ Content-Type: application/json **Required permissions** -See note in the [introduction]({{< ref "#service-account-api" >}}) for an explanation. +See note in the [introduction](#service-account-api) for an explanation. | Action | Scope | | -------------------- | ------------------ | @@ -358,7 +358,7 @@ Content-Type: application/json **Required permissions** -See note in the [introduction]({{< ref "#service-account-api" >}}) for an explanation. +See note in the [introduction](#service-account-api) for an explanation. | Action | Scope | | --------------------- | ------------------ | @@ -390,7 +390,7 @@ Content-Type: application/json **Required permissions** -See note in the [introduction]({{< ref "#service-account-api" >}}) for an explanation. +See note in the [introduction](#service-account-api) for an explanation. | Action | Scope | | -------------------- | --------------------- | @@ -430,7 +430,7 @@ Content-Type: application/json **Required permissions** -See note in the [introduction]({{< ref "#service-account-api" >}}) for an explanation. +See note in the [introduction](#service-account-api) for an explanation. | Action | Scope | | --------------------- | --------------------- | @@ -471,7 +471,7 @@ Content-Type: application/json **Required permissions** -See note in the [introduction]({{< ref "#service-account-api" >}}) for an explanation. +See note in the [introduction](#service-account-api) for an explanation. | Action | Scope | | --------------------- | --------------------- | @@ -505,7 +505,7 @@ This operation will delete the service account and create a legacy API Key for t **Required permissions** -See note in the [introduction]({{< ref "#service-account-api" >}}) for an explanation. +See note in the [introduction](#service-account-api) for an explanation. | Action | Scope | | ---------------------- | --------------------- | diff --git a/docs/sources/developers/http_api/short_url.md b/docs/sources/developers/http_api/short_url.md index 03390a5f655..84c754a42a5 100644 --- a/docs/sources/developers/http_api/short_url.md +++ b/docs/sources/developers/http_api/short_url.md @@ -41,7 +41,7 @@ Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk JSON body schema: -- **path** – The path to shorten, relative to the Grafana [root_url]({{< relref "/docs/grafana/latest/setup-grafana/configure-grafana#root_url" >}}). +- **path** – The path to shorten, relative to the Grafana [root_url](/docs/grafana/latest/setup-grafana/configure-grafana/#root_url). **Example response:** diff --git a/docs/sources/developers/http_api/sso-settings.md b/docs/sources/developers/http_api/sso-settings.md index cb426373485..dfb10ebf71e 100644 --- a/docs/sources/developers/http_api/sso-settings.md +++ b/docs/sources/developers/http_api/sso-settings.md @@ -20,7 +20,7 @@ title: SSO Settings API # SSO Settings API -> If you are running Grafana Enterprise, for some endpoints you'll need to have specific permissions. Refer to [Role-based access control permissions]({{< relref "/docs/grafana/latest/administration/roles-and-permissions/access-control/custom-role-actions-scopes" >}}) for more information. +> If you are running Grafana Enterprise, for some endpoints you'll need to have specific permissions. Refer to [Role-based access control permissions](/docs/grafana/latest/administration/roles-and-permissions/access-control/custom-role-actions-scopes/) for more information. {{% admonition type="note" %}} Available since Grafana 11. SAML support is in public preview behind the `ssoSettingsSAML` feature flag. @@ -29,7 +29,7 @@ Available since Grafana 11. SAML support is in public preview behind the `ssoSet The API can be used to create, update, delete, get, and list SSO Settings for OAuth2 and SAML. The settings managed by this API are stored in the database and override -[settings from other sources]({{< relref "../../setup-grafana/configure-security/configure-authentication" >}}) +[settings from other sources](../../../setup-grafana/configure-security/configure-authentication/) (arguments, environment variables, settings file, etc). Therefore, every time settings for a specific provider are removed or reset to the default settings at runtime, the settings are inherited from the other sources in the reverse order of precedence @@ -45,7 +45,7 @@ The providers or SSO keys that are not managed by this API are retrieved from th **Required permissions** -See note in the [introduction]({{< ref "#sso-settings" >}}) for an explanation. +See note in the [introduction](#sso-settings) for an explanation. | Action | Scope | | --------------- | ---------------------------- | @@ -112,7 +112,7 @@ The SSO keys that are not managed by this API are retrieved from the other sourc **Required permissions** -See note in the [introduction]({{< ref "#sso-settings" >}}) for an explanation. +See note in the [introduction](#sso-settings) for an explanation. | Action | Scope | | --------------- | ---------------------------- | @@ -175,7 +175,7 @@ to wait a few minutes for the configuration to propagate to all Grafana instance **Required permissions** -See note in the [introduction]({{< ref "#sso-settings" >}}) for an explanation. +See note in the [introduction](#sso-settings) for an explanation. | Action | Scope | | ---------------- | ---------------------------- | @@ -222,7 +222,7 @@ Deletes an existing SSO Settings entry for a provider. **Required permissions** -See note in the [introduction]({{< ref "#sso-settings" >}}) for an explanation. +See note in the [introduction](#sso-settings) for an explanation. | Action | Scope | | ---------------- | ---------------------------- | diff --git a/docs/sources/developers/http_api/team.md b/docs/sources/developers/http_api/team.md index e94d80be650..db73f9d11f1 100644 --- a/docs/sources/developers/http_api/team.md +++ b/docs/sources/developers/http_api/team.md @@ -27,7 +27,7 @@ Access to these API endpoints is restricted as follows: - All authenticated users are able to view details of teams they are a member of. - Organization Admins are able to manage all teams and team members. -> If you are running Grafana Enterprise, for some endpoints you'll need to have specific permissions. Refer to [Role-based access control permissions]({{< relref "/docs/grafana/latest/administration/roles-and-permissions/access-control/custom-role-actions-scopes" >}}) for more information. +> If you are running Grafana Enterprise, for some endpoints you'll need to have specific permissions. Refer to [Role-based access control permissions](/docs/grafana/latest/administration/roles-and-permissions/access-control/custom-role-actions-scopes/) for more information. ## Team Search With Paging @@ -39,7 +39,7 @@ or **Required permissions** -See note in the [introduction]({{< ref "#team-api" >}}) for an explanation. +See note in the [introduction](#team-api) for an explanation. | Action | Scope | | ---------- | -------- | @@ -105,7 +105,7 @@ The `name` parameter returns a single team if the parameter matches the `name` f **Required permissions** -See note in the [introduction]({{< ref "#team-api" >}}) for an explanation. +See note in the [introduction](#team-api) for an explanation. | Action | Scope | | ---------- | -------- | @@ -151,7 +151,7 @@ The Team `name` needs to be unique. `name` is required and `email` is optional. **Required permissions** -See note in the [introduction]({{< ref "#team-api" >}}) for an explanation. +See note in the [introduction](#team-api) for an explanation. | Action | Scope | | ------------ | ----- | @@ -195,7 +195,7 @@ There are two fields that can be updated for a team: `name` and `email`. **Required permissions** -See note in the [introduction]({{< ref "#team-api" >}}) for an explanation. +See note in the [introduction](#team-api) for an explanation. | Action | Scope | | ----------- | -------- | @@ -238,7 +238,7 @@ Status Codes: **Required permissions** -See note in the [introduction]({{< ref "#team-api" >}}) for an explanation. +See note in the [introduction](#team-api) for an explanation. | Action | Scope | | ------------ | -------- | @@ -275,7 +275,7 @@ Status Codes: **Required permissions** -See note in the [introduction]({{< ref "#team-api" >}}) for an explanation. +See note in the [introduction](#team-api) for an explanation. | Action | Scope | | ---------------------- | -------- | @@ -328,7 +328,7 @@ Status Codes: **Required permissions** -See note in the [introduction]({{< ref "#team-api" >}}) for an explanation. +See note in the [introduction](#team-api) for an explanation. | Action | Scope | | ----------------------- | -------- | @@ -370,7 +370,7 @@ Status Codes: **Required permissions** -See note in the [introduction]({{< ref "#team-api" >}}) for an explanation. +See note in the [introduction](#team-api) for an explanation. | Action | Scope | | ----------------------- | -------- | @@ -410,7 +410,7 @@ Will override all current members and administrators for the specified team. **Required permissions** -See note in the [introduction]({{< ref "#team-api" >}}) for an explanation. +See note in the [introduction](#team-api) for an explanation. | Action | Scope | | ----------------------- | -------- | @@ -453,7 +453,7 @@ Status Codes: **Required permissions** -See note in the [introduction]({{< ref "#team-api" >}}) for an explanation. +See note in the [introduction](#team-api) for an explanation. | Action | Scope | | ---------- | -------- | @@ -487,7 +487,7 @@ Content-Type: application/json **Required permissions** -See note in the [introduction]({{< ref "#team-api" >}}) for an explanation. +See note in the [introduction](#team-api) for an explanation. | Action | Scope | | ----------- | -------- | diff --git a/docs/sources/developers/http_api/team_sync.md b/docs/sources/developers/http_api/team_sync.md index 84a5b15679f..c4c0e607a2d 100644 --- a/docs/sources/developers/http_api/team_sync.md +++ b/docs/sources/developers/http_api/team_sync.md @@ -23,9 +23,9 @@ title: Team Sync HTTP API # Team Sync API -> Team Sync is only available in Grafana Enterprise. Read more about [Grafana Enterprise]({{< relref "/docs/grafana/latest/introduction/grafana-enterprise" >}}). +> Team Sync is only available in Grafana Enterprise. Read more about [Grafana Enterprise](/docs/grafana/latest/introduction/grafana-enterprise/). -> If you are running Grafana Enterprise, for some endpoints you'll need to have specific permissions. Refer to [Role-based access control permissions]({{< relref "/docs/grafana/latest/administration/roles-and-permissions/access-control/custom-role-actions-scopes" >}}) for more information. +> If you are running Grafana Enterprise, for some endpoints you'll need to have specific permissions. Refer to [Role-based access control permissions](/docs/grafana/latest/administration/roles-and-permissions/access-control/custom-role-actions-scopes/) for more information. ## Get External Groups @@ -33,7 +33,7 @@ title: Team Sync HTTP API **Required permissions** -See note in the [introduction]({{< ref "#external-group-synchronization-api" >}}) for an explanation. +See note in the [introduction](#external-group-synchronization-api) for an explanation. | Action | Scope | | ---------------------- | -------- | @@ -75,7 +75,7 @@ Status Codes: **Required permissions** -See note in the [introduction]({{< ref "#external-group-synchronization-api" >}}) for an explanation. +See note in the [introduction](#external-group-synchronization-api) for an explanation. | Action | Scope | | ----------------------- | -------- | @@ -117,7 +117,7 @@ Status Codes: **Required permissions** -See note in the [introduction]({{< ref "#external-group-synchronization-api" >}}) for an explanation. +See note in the [introduction](#external-group-synchronization-api) for an explanation. | Action | Scope | | ----------------------- | -------- | diff --git a/docs/sources/getting-started/_index.md b/docs/sources/getting-started/_index.md index 6252d05cd40..752757401dd 100644 --- a/docs/sources/getting-started/_index.md +++ b/docs/sources/getting-started/_index.md @@ -14,6 +14,6 @@ weight: 9 Grafana helps you collect, correlate, and visualize data with beautiful dashboards — the open source data visualization and monitoring solution that drives informed decisions, enhances system performance, and streamlines troubleshooting. -This section provides guidance to our open source community about how to build your first dashboard after you have installed Grafana. It also provides step-by-step instructions on how to add a Prometheus, InfluxDB, or an MS SQL Server data source. If you are connecting a different data source, please refer to our complete list of supported [Data sources]({{< relref "../datasources" >}}). If you would like to learn how to get started with Grafana Cloud, our fully managed observability stack, visit the [Grafana Cloud documentation](https://grafana.com/docs/grafana-cloud/quickstart/) for more information. +This section provides guidance to our open source community about how to build your first dashboard after you have installed Grafana. It also provides step-by-step instructions on how to add a Prometheus, InfluxDB, or an MS SQL Server data source. If you are connecting a different data source, please refer to our complete list of supported [Data sources](../datasources/). If you would like to learn how to get started with Grafana Cloud, our fully managed observability stack, visit the [Grafana Cloud documentation](https://grafana.com/docs/grafana-cloud/quickstart/) for more information. {{< section >}} diff --git a/docs/sources/getting-started/get-started-grafana-influxdb.md b/docs/sources/getting-started/get-started-grafana-influxdb.md index d6a163a1219..fed06324346 100644 --- a/docs/sources/getting-started/get-started-grafana-influxdb.md +++ b/docs/sources/getting-started/get-started-grafana-influxdb.md @@ -38,11 +38,11 @@ Windows users might need to make additional adjustments. Look for special instru You can have more than one InfluxDB data source defined in Grafana. -1. Follow the general instructions to [add a data source]({{< relref "../datasources#add-a-data-source" >}}). +1. Follow the general instructions to [add a data source](../../datasources/#add-a-data-source). 1. Decide if you will use InfluxQL or Flux as your query language. - - [Configure the data source]({{< relref "../datasources/influxdb#configure-the-data-source" >}}) for your chosen query language. + - [Configure the data source](../../datasources/influxdb/#configure-the-data-source) for your chosen query language. Each query language has its own unique data source settings. - - For querying features specific to each language, see the data source's [query editor documentation]({{< relref "../datasources/influxdb/query-editor" >}}). + - For querying features specific to each language, see the data source's [query editor documentation](../../datasources/influxdb/query-editor/). ##### InfluxDB guides @@ -75,8 +75,8 @@ Grafana displays a list of possible series. Click one to select it, and Grafana Create a simple Flux query. -1. [Add a panel]({{< relref "../dashboards/build-dashboards/create-dashboard" >}}). -1. In the query editor, select your InfluxDB-Flux data source. For more information, refer to [Queries]({{< relref "../panels-visualizations/query-transform-data" >}}). +1. [Add a panel](../../dashboards/build-dashboards/create-dashboard/). +1. In the query editor, select your InfluxDB-Flux data source. For more information, refer to [Queries](../../panels-visualizations/query-transform-data/). 1. Select the **Table** visualization. 1. In the query editor text field, enter `buckets()` and then click outside of the query editor. @@ -96,12 +96,12 @@ You can also create Flux queries in the InfluxDB Explore view. ![InfluxDB Explore Script Editor](/static/img/docs/influxdb/explore-query-text-7-5.png) -1. In Grafana, [add a panel]({{< relref "../dashboards/build-dashboards/create-dashboard" >}}) and then paste your Flux code into the query editor. +1. In Grafana, [add a panel](../../dashboards/build-dashboards/create-dashboard/) and then paste your Flux code into the query editor. 1. Click **Apply**. Your new panel should be visible with data from your Flux query. #### Check InfluxDB metrics in Grafana Explore -In your Grafana instance, go to the [Explore]({{< relref "../explore" >}}) view and build queries to experiment with the metrics you want to monitor. Here you can also debug issues related to collecting metrics. +In your Grafana instance, go to the [Explore](../../explore/) view and build queries to experiment with the metrics you want to monitor. Here you can also debug issues related to collecting metrics. #### Start building dashboards @@ -109,5 +109,5 @@ There you go! Use Explore and Data Explorer to experiment with your data, and ad Here are some resources to learn more: -- Grafana documentation: [InfluxDB data source]({{< relref "../datasources/influxdb" >}}) +- Grafana documentation: [InfluxDB data source](../../datasources/influxdb/) - InfluxDB documentation: [Comparison of Flux vs InfluxQL](https://docs.influxdata.com/influxdb/v1.8/flux/flux-vs-influxql/) diff --git a/docs/sources/getting-started/get-started-grafana-ms-sql-server.md b/docs/sources/getting-started/get-started-grafana-ms-sql-server.md index 4518d2adfc3..9b714940d4b 100644 --- a/docs/sources/getting-started/get-started-grafana-ms-sql-server.md +++ b/docs/sources/getting-started/get-started-grafana-ms-sql-server.md @@ -99,6 +99,6 @@ Optionally, play around this dashboard and customize it to: Now that you have gained some idea of using the pre-packaged MS SQL data source and some test data, the next step is to setup your own instance of MS SQL Server database and data your development or sandbox area. -To fetch data from your own instance of MS SQL Server, add the data source using instructions in Step 4 of this topic. In Grafana [Explore]({{< relref "../explore" >}}) build queries to experiment with the metrics you want to monitor. +To fetch data from your own instance of MS SQL Server, add the data source using instructions in Step 4 of this topic. In Grafana [Explore](../../explore/) build queries to experiment with the metrics you want to monitor. -Once you have a curated list of queries, create [dashboards]({{< relref "../dashboards" >}}) to render metrics from the SQL Server database. For troubleshooting, user permissions, known issues, and query examples, refer to [Using Microsoft SQL Server in Grafana]({{< relref "../datasources/mssql" >}}). +Once you have a curated list of queries, create [dashboards](../../dashboards/) to render metrics from the SQL Server database. For troubleshooting, user permissions, known issues, and query examples, refer to [Using Microsoft SQL Server in Grafana](../../datasources/mssql/). diff --git a/docs/sources/getting-started/get-started-grafana-prometheus.md b/docs/sources/getting-started/get-started-grafana-prometheus.md index 1ed833b034a..188460d7896 100644 --- a/docs/sources/getting-started/get-started-grafana-prometheus.md +++ b/docs/sources/getting-started/get-started-grafana-prometheus.md @@ -114,11 +114,11 @@ To configure your Prometheus instance to work with Grafana locally instead of Gr #### Check Prometheus metrics in Grafana Explore view -In your Grafana instance, go to the [Explore]({{< relref "../explore" >}}) view and build queries to experiment with the metrics you want to monitor. Here you can also debug issues related to collecting metrics from Prometheus. +In your Grafana instance, go to the [Explore](../../explore/) view and build queries to experiment with the metrics you want to monitor. Here you can also debug issues related to collecting metrics from Prometheus. #### Start building dashboards -Now that you have a curated list of queries, create [dashboards]({{< relref "../dashboards" >}}) to render system metrics monitored by Prometheus. When you install Prometheus and node_exporter or windows_exporter, you will find recommended dashboards for use. +Now that you have a curated list of queries, create [dashboards](../../dashboards/) to render system metrics monitored by Prometheus. When you install Prometheus and node_exporter or windows_exporter, you will find recommended dashboards for use. The following image shows a dashboard with three panels showing some system metrics. @@ -126,5 +126,5 @@ The following image shows a dashboard with three panels showing some system metr To learn more: -- Grafana documentation: [Prometheus data source]({{< relref "../datasources/prometheus" >}}) +- Grafana documentation: [Prometheus data source](../../datasources/prometheus/) - Prometheus documentation: [What is Prometheus?](https://prometheus.io/docs/introduction/overview/) diff --git a/docs/sources/introduction/_index.md b/docs/sources/introduction/_index.md index 0c64bc5f355..9aba0f1cd48 100644 --- a/docs/sources/introduction/_index.md +++ b/docs/sources/introduction/_index.md @@ -16,35 +16,35 @@ weight: 5 [Grafana open source software](/oss/) enables you to query, visualize, alert on, and explore your metrics, logs, and traces wherever they are stored. Grafana OSS provides you with tools to turn your time-series database (TSDB) data into insightful graphs and visualizations. The Grafana OSS plugin framework also enables you to connect other data sources like NoSQL/SQL databases, ticketing tools like Jira or ServiceNow, and CI/CD tooling like GitLab. -After you have [installed Grafana]({{< relref "../setup-grafana/installation" >}}) and set up your first dashboard using instructions in [Getting started with Grafana]({{< relref "../getting-started/build-first-dashboard" >}}), you will have many options to choose from depending on your requirements. For example, if you want to view weather data and statistics about your smart home, then you can create a [playlist]({{< relref "../dashboards/create-manage-playlists" >}}). If you are the administrator for an enterprise and are managing Grafana for multiple teams, then you can set up [provisioning]({{< relref "../administration/provisioning" >}}) and [authentication]({{< relref "../setup-grafana/configure-security/configure-authentication" >}}). +After you have [installed Grafana](../setup-grafana/installation/) and set up your first dashboard using instructions in [Getting started with Grafana](../getting-started/build-first-dashboard/), you will have many options to choose from depending on your requirements. For example, if you want to view weather data and statistics about your smart home, then you can create a [playlist](../dashboards/create-manage-playlists/). If you are the administrator for an enterprise and are managing Grafana for multiple teams, then you can set up [provisioning](../administration/provisioning/) and [authentication](../setup-grafana/configure-security/configure-authentication/). The following sections provide an overview of Grafana features and links to product documentation to help you learn more. For more guidance and ideas, check out our [Grafana Community forums](https://community.grafana.com/). ## Explore metrics, logs, and traces -Explore your data through ad-hoc queries and dynamic drilldown. Split view and compare different time ranges, queries and data sources side by side. Refer to [Explore]({{< relref "../explore" >}}) for more information. +Explore your data through ad-hoc queries and dynamic drilldown. Split view and compare different time ranges, queries and data sources side by side. Refer to [Explore](../explore/) for more information. ## Alerts If you're using Grafana Alerting, then you can have alerts sent through a number of different alert notifiers, including PagerDuty, SMS, email, VictorOps, OpsGenie, or Slack. -Alert hooks allow you to create different notifiers with a bit of code if you prefer some other channels of communication. Visually define [alert rules]({{< relref "../alerting/alerting-rules" >}}) for your most important metrics. +Alert hooks allow you to create different notifiers with a bit of code if you prefer some other channels of communication. Visually define [alert rules](../alerting/alerting-rules/) for your most important metrics. ## Annotations Annotate graphs with rich events from different data sources. Hover over events to see the full event metadata and tags. -This feature, which shows up as a graph marker in Grafana, is useful for correlating data in case something goes wrong. You can create the annotations manually—just control-click on a graph and input some text—or you can fetch data from any data source. Refer to [Annotations]({{< relref "../dashboards/build-dashboards/annotate-visualizations" >}}) for more information. +This feature, which shows up as a graph marker in Grafana, is useful for correlating data in case something goes wrong. You can create the annotations manually—just control-click on a graph and input some text—or you can fetch data from any data source. Refer to [Annotations](../dashboards/build-dashboards/annotate-visualizations/) for more information. ## Dashboard variables -[Template variables]({{< relref "../dashboards/variables" >}}) allow you to create dashboards that can be reused for lots of different use cases. Values aren't hard-coded with these templates, so for instance, if you have a production server and a test server, you can use the same dashboard for both. +[Template variables](../dashboards/variables/) allow you to create dashboards that can be reused for lots of different use cases. Values aren't hard-coded with these templates, so for instance, if you have a production server and a test server, you can use the same dashboard for both. Templating allows you to drill down into your data, say, from all data to North America data, down to Texas data, and beyond. You can also share these dashboards across teams within your organization—or if you create a great dashboard template for a popular data source, you can contribute it to the whole community to customize and use. ## Configure Grafana -If you're a Grafana administrator, then you'll want to thoroughly familiarize yourself with [Grafana configuration options]({{< relref "../setup-grafana/configure-grafana" >}}) and the [Grafana CLI]({{< relref "../cli" >}}). +If you're a Grafana administrator, then you'll want to thoroughly familiarize yourself with [Grafana configuration options](../setup-grafana/configure-grafana/) and the [Grafana CLI](../cli/). Configuration covers both config files and environment variables. You can set up default ports, logging levels, email IP addresses, security, and more. @@ -54,19 +54,19 @@ Discover hundreds of [dashboards](/grafana/dashboards) and [plugins](/grafana/pl ## Authentication -Grafana supports different authentication methods, such as LDAP and OAuth, and allows you to map users to organizations. Refer to the [User authentication overview]({{< relref "../setup-grafana/configure-security/configure-authentication" >}}) for more information. +Grafana supports different authentication methods, such as LDAP and OAuth, and allows you to map users to organizations. Refer to the [User authentication overview](../setup-grafana/configure-security/configure-authentication/) for more information. -In Grafana Enterprise, you can also map users to teams: If your company has its own authentication system, Grafana allows you to map the teams in your internal systems to teams in Grafana. That way, you can automatically give people access to the dashboards designated for their teams. Refer to [Grafana Enterprise]({{< relref "./grafana-enterprise" >}}) for more information. +In Grafana Enterprise, you can also map users to teams: If your company has its own authentication system, Grafana allows you to map the teams in your internal systems to teams in Grafana. That way, you can automatically give people access to the dashboards designated for their teams. Refer to [Grafana Enterprise](grafana-enterprise/) for more information. ## Provisioning While it's easy to click, drag, and drop to create a single dashboard, power users in need of many dashboards will want to automate the setup with a script. You can script anything in Grafana. -For example, if you're spinning up a new Kubernetes cluster, you can also spin up a Grafana automatically with a script that would have the right server, IP address, and data sources preset and locked in so users cannot change them. It's also a way of getting control over a lot of dashboards. Refer to [Provisioning]({{< relref "../administration/provisioning" >}}) for more information. +For example, if you're spinning up a new Kubernetes cluster, you can also spin up a Grafana automatically with a script that would have the right server, IP address, and data sources preset and locked in so users cannot change them. It's also a way of getting control over a lot of dashboards. Refer to [Provisioning](../administration/provisioning/) for more information. ## Permissions -When organizations have one Grafana and multiple teams, they often want the ability to both keep things separate and share dashboards. You can create a team of users and then set permissions on [folders and dashboards]({{< relref "../administration/user-management/manage-dashboard-permissions" >}}), and down to the [data source level]({{< relref "../administration/data-source-management#data-source-permissions" >}}) if you're using [Grafana Enterprise]({{< relref "./grafana-enterprise" >}}). +When organizations have one Grafana and multiple teams, they often want the ability to both keep things separate and share dashboards. You can create a team of users and then set permissions on [folders and dashboards](../administration/user-management/manage-dashboard-permissions/), and down to the [data source level](../administration/data-source-management/#data-source-permissions) if you're using [Grafana Enterprise](grafana-enterprise/). ## Other Grafana Labs OSS Projects diff --git a/docs/sources/release-notes/_index.md b/docs/sources/release-notes/_index.md index bdc839a1df3..8409c58c6a7 100644 --- a/docs/sources/release-notes/_index.md +++ b/docs/sources/release-notes/_index.md @@ -16,127 +16,127 @@ as well as notices about deprecations, breaking changes, and changes related to {{% admonition type="note" %}} As of Grafana v9.2 we no longer publish release notes, which are redundant with other release lists that we publish: -- For details about new features, deprecations, and breaking changes in new Grafana releases, see [What's New in Grafana]({{< relref "../whatsnew/" >}}). +- For details about new features, deprecations, and breaking changes in new Grafana releases, see [What's New in Grafana](../whatsnew/). - For lists of changes to Grafana, with links to pull requests and related issues when available, see the [Changelog](https://github.com/grafana/grafana/blob/main/CHANGELOG.md). {{% /admonition %}} -- [Release notes for 9.1.7]({{< relref "release-notes-9-1-7" >}}) -- [Release notes for 9.1.6]({{< relref "release-notes-9-1-6" >}}) -- [Release notes for 9.1.5]({{< relref "release-notes-9-1-5" >}}) -- [Release notes for 9.1.4]({{< relref "release-notes-9-1-4" >}}) -- [Release notes for 9.1.3]({{< relref "release-notes-9-1-3" >}}) -- [Release notes for 9.1.2]({{< relref "release-notes-9-1-2" >}}) -- [Release notes for 9.1.1]({{< relref "release-notes-9-1-1" >}}) -- [Release notes for 9.1.0]({{< relref "release-notes-9-1-0" >}}) -- [Release notes for 9.1.0-beta1]({{< relref "release-notes-9-1-0-beta1" >}}) -- [Release notes for 9.0.9]({{< relref "release-notes-9-0-9" >}}) -- [Release notes for 9.0.8]({{< relref "release-notes-9-0-8" >}}) -- [Release notes for 9.0.7]({{< relref "release-notes-9-0-7" >}}) -- [Release notes for 9.0.6]({{< relref "release-notes-9-0-6" >}}) -- [Release notes for 9.0.5]({{< relref "release-notes-9-0-5" >}}) -- [Release notes for 9.0.4]({{< relref "release-notes-9-0-4" >}}) -- [Release notes for 9.0.3]({{< relref "release-notes-9-0-3" >}}) -- [Release notes for 9.0.2]({{< relref "release-notes-9-0-2" >}}) -- [Release notes for 9.0.1]({{< relref "release-notes-9-0-1" >}}) -- [Release notes for 9.0.0]({{< relref "release-notes-9-0-0/" >}}) -- [Release notes for 9.0.0-beta3]({{< relref "release-notes-9-0-0-beta3/" >}}) -- [Release notes for 9.0.0-beta2]({{< relref "release-notes-9-0-0-beta2/" >}}) -- [Release notes for 9.0.0-beta1]({{< relref "release-notes-9-0-0-beta1/" >}}) -- [Release notes for 8.5.13]({{< relref "release-notes-8-5-13" >}}) -- [Release notes for 8.5.11]({{< relref "release-notes-8-5-11" >}}) -- [Release notes for 8.5.10]({{< relref "release-notes-8-5-10" >}}) -- [Release notes for 8.5.9]({{< relref "release-notes-8-5-9" >}}) -- [Release notes for 8.5.6]({{< relref "release-notes-8-5-6/" >}}) -- [Release notes for 8.5.5]({{< relref "release-notes-8-5-5/" >}}) -- [Release notes for 8.5.4]({{< relref "release-notes-8-5-4/" >}}) -- [Release notes for 8.5.3]({{< relref "release-notes-8-5-3/" >}}) -- [Release notes for 8.5.2]({{< relref "release-notes-8-5-2/" >}}) -- [Release notes for 8.5.1]({{< relref "release-notes-8-5-1/" >}}) -- [Release notes for 8.5.0]({{< relref "release-notes-8-5-0/" >}}) -- [Release notes for 8.5.0-beta1]({{< relref "release-notes-8-5-0-beta1/" >}}) -- [Release notes for 8.4.11]({{< relref "release-notes-8-4-11" >}}) -- [Release notes for 8.4.10]({{< relref "release-notes-8-4-10" >}}) -- [Release notes for 8.4.7]({{< relref "release-notes-8-4-7/" >}}) -- [Release notes for 8.4.6]({{< relref "release-notes-8-4-6/" >}}) -- [Release notes for 8.4.5]({{< relref "release-notes-8-4-5/" >}}) -- [Release notes for 8.4.4]({{< relref "release-notes-8-4-4/" >}}) -- [Release notes for 8.4.3]({{< relref "release-notes-8-4-3/" >}}) -- [Release notes for 8.4.2]({{< relref "release-notes-8-4-2/" >}}) -- [Release notes for 8.4.1]({{< relref "release-notes-8-4-1/" >}}) -- [Release notes for 8.4.0-beta1]({{< relref "release-notes-8-4-0-beta1/" >}}) -- [Release notes for 8.3.11]({{< relref "release-notes-8-3-11/" >}}) -- [Release notes for 8.3.7]({{< relref "release-notes-8-3-7/" >}}) -- [Release notes for 8.3.6]({{< relref "release-notes-8-3-6/" >}}) -- [Release notes for 8.3.5]({{< relref "release-notes-8-3-5/" >}}) -- [Release notes for 8.3.4]({{< relref "release-notes-8-3-4/" >}}) -- [Release notes for 8.3.3]({{< relref "release-notes-8-3-3/" >}}) -- [Release notes for 8.3.2]({{< relref "release-notes-8-3-2/" >}}) -- [Release notes for 8.3.1]({{< relref "release-notes-8-3-1/" >}}) -- [Release notes for 8.3.0]({{< relref "release-notes-8-3-0/" >}}) -- [Release notes for 8.3.0-beta2]({{< relref "release-notes-8-3-0-beta2/" >}}) -- [Release notes for 8.3.0-beta1]({{< relref "release-notes-8-3-0-beta1/" >}}) -- [Release notes for 8.2.7]({{< relref "release-notes-8-2-7/" >}}) -- [Release notes for 8.2.6]({{< relref "release-notes-8-2-6/" >}}) -- [Release notes for 8.2.5]({{< relref "release-notes-8-2-5/" >}}) -- [Release notes for 8.2.4]({{< relref "release-notes-8-2-4/" >}}) -- [Release notes for 8.2.3]({{< relref "release-notes-8-2-3/" >}}) -- [Release notes for 8.2.2]({{< relref "release-notes-8-2-2/" >}}) -- [Release notes for 8.2.1]({{< relref "release-notes-8-2-1/" >}}) -- [Release notes for 8.2.0]({{< relref "release-notes-8-2-0/" >}}) -- [Release notes for 8.2.0-beta2]({{< relref "release-notes-8-2-0-beta2/" >}}) -- [Release notes for 8.2.0-beta1]({{< relref "release-notes-8-2-0-beta1/" >}}) -- [Release notes for 8.1.8]({{< relref "release-notes-8-1-8/" >}}) -- [Release notes for 8.1.7]({{< relref "release-notes-8-1-7/" >}}) -- [Release notes for 8.1.6]({{< relref "release-notes-8-1-6/" >}}) -- [Release notes for 8.1.5]({{< relref "release-notes-8-1-5/" >}}) -- [Release notes for 8.1.4]({{< relref "release-notes-8-1-4/" >}}) -- [Release notes for 8.1.3]({{< relref "release-notes-8-1-3/" >}}) -- [Release notes for 8.1.2]({{< relref "release-notes-8-1-2/" >}}) -- [Release notes for 8.1.1]({{< relref "release-notes-8-1-1/" >}}) -- [Release notes for 8.1.0]({{< relref "release-notes-8-1-0/" >}}) -- [Release notes for 8.1.0-beta3]({{< relref "release-notes-8-1-0-beta3/" >}}) -- [Release notes for 8.1.0-beta2]({{< relref "release-notes-8-1-0-beta2/" >}}) -- [Release notes for 8.1.0-beta1]({{< relref "release-notes-8-1-0-beta1/" >}}) -- [Release notes for 8.0.7]({{< relref "release-notes-8-0-7/" >}}) -- [Release notes for 8.0.6]({{< relref "release-notes-8-0-6/" >}}) -- [Release notes for 8.0.5]({{< relref "release-notes-8-0-5/" >}}) -- [Release notes for 8.0.4]({{< relref "release-notes-8-0-4/" >}}) -- [Release notes for 8.0.3]({{< relref "release-notes-8-0-3/" >}}) -- [Release notes for 8.0.2]({{< relref "release-notes-8-0-2/" >}}) -- [Release notes for 8.0.1]({{< relref "release-notes-8-0-1/" >}}) -- [Release notes for 8.0.0]({{< relref "release-notes-8-0-0/" >}}) -- [Release notes for 8.0.0-beta3]({{< relref "release-notes-8-0-0-beta3/" >}}) -- [Release notes for 8.0.0-beta2]({{< relref "release-notes-8-0-0-beta2/" >}}) -- [Release notes for 8.0.0-beta1]({{< relref "release-notes-8-0-0-beta1/" >}}) -- [Release notes for 7.5.15]({{< relref "release-notes-7-5-15/" >}}) -- [Release notes for 7.5.13]({{< relref "release-notes-7-5-13/" >}}) -- [Release notes for 7.5.12]({{< relref "release-notes-7-5-12/" >}}) -- [Release notes for 7.5.11]({{< relref "release-notes-7-5-11/" >}}) -- [Release notes for 7.5.10]({{< relref "release-notes-7-5-10/" >}}) -- [Release notes for 7.5.9]({{< relref "release-notes-7-5-9/" >}}) -- [Release notes for 7.5.8]({{< relref "release-notes-7-5-8/" >}}) -- [Release notes for 7.5.7]({{< relref "release-notes-7-5-7/" >}}) -- [Release notes for 7.5.6]({{< relref "release-notes-7-5-6/" >}}) -- [Release notes for 7.5.5]({{< relref "release-notes-7-5-5/" >}}) -- [Release notes for 7.5.4]({{< relref "release-notes-7-5-4/" >}}) -- [Release notes for 7.5.3]({{< relref "release-notes-7-5-3/" >}}) -- [Release notes for 7.5.2]({{< relref "release-notes-7-5-2/" >}}) -- [Release notes for 7.5.1]({{< relref "release-notes-7-5-1/" >}}) -- [Release notes for 7.5.0]({{< relref "release-notes-7-5-0/" >}}) -- [Release notes for 7.5.0-beta2]({{< relref "release-notes-7-5-0-beta2/" >}}) -- [Release notes for 7.5.0-beta1]({{< relref "release-notes-7-5-0-beta1/" >}}) -- [Release notes for 7.4.5]({{< relref "release-notes-7-4-5/" >}}) -- [Release notes for 7.4.3]({{< relref "release-notes-7-4-3/" >}}) -- [Release notes for 7.4.2]({{< relref "release-notes-7-4-2/" >}}) -- [Release notes for 7.4.1]({{< relref "release-notes-7-4-1/" >}}) -- [Release notes for 7.4.0]({{< relref "release-notes-7-4-0/" >}}) -- [Release notes for 7.3.10]({{< relref "release-notes-7-3-10/" >}}) -- [Release notes for 7.3.7]({{< relref "release-notes-7-3-7/" >}}) -- [Release notes for 7.3.6]({{< relref "release-notes-7-3-6/" >}}) -- [Release notes for 7.3.5]({{< relref "release-notes-7-3-5/" >}}) -- [Release notes for 7.3.4]({{< relref "release-notes-7-3-4/" >}}) -- [Release notes for 7.3.3]({{< relref "release-notes-7-3-3/" >}}) -- [Release notes for 7.3.2]({{< relref "release-notes-7-3-2/" >}}) -- [Release notes for 7.3.1]({{< relref "release-notes-7-3-1/" >}}) -- [Release notes for 7.3.0]({{< relref "release-notes-7-3-0/" >}}) +- [Release notes for 9.1.7](release-notes-9-1-7/) +- [Release notes for 9.1.6](release-notes-9-1-6/) +- [Release notes for 9.1.5](release-notes-9-1-5/) +- [Release notes for 9.1.4](release-notes-9-1-4/) +- [Release notes for 9.1.3](release-notes-9-1-3/) +- [Release notes for 9.1.2](release-notes-9-1-2/) +- [Release notes for 9.1.1](release-notes-9-1-1/) +- [Release notes for 9.1.0](release-notes-9-1-0/) +- [Release notes for 9.1.0-beta1](release-notes-9-1-0-beta1/) +- [Release notes for 9.0.9](release-notes-9-0-9/) +- [Release notes for 9.0.8](release-notes-9-0-8/) +- [Release notes for 9.0.7](release-notes-9-0-7/) +- [Release notes for 9.0.6](release-notes-9-0-6/) +- [Release notes for 9.0.5](release-notes-9-0-5/) +- [Release notes for 9.0.4](release-notes-9-0-4/) +- [Release notes for 9.0.3](release-notes-9-0-3/) +- [Release notes for 9.0.2](release-notes-9-0-2/) +- [Release notes for 9.0.1](release-notes-9-0-1/) +- [Release notes for 9.0.0](release-notes-9-0-0/) +- [Release notes for 9.0.0-beta3](release-notes-9-0-0-beta3/) +- [Release notes for 9.0.0-beta2](release-notes-9-0-0-beta2/) +- [Release notes for 9.0.0-beta1](release-notes-9-0-0-beta1/) +- [Release notes for 8.5.13](release-notes-8-5-13/) +- [Release notes for 8.5.11](release-notes-8-5-11/) +- [Release notes for 8.5.10](release-notes-8-5-10/) +- [Release notes for 8.5.9](release-notes-8-5-9/) +- [Release notes for 8.5.6](release-notes-8-5-6/) +- [Release notes for 8.5.5](release-notes-8-5-5/) +- [Release notes for 8.5.4](release-notes-8-5-4/) +- [Release notes for 8.5.3](release-notes-8-5-3/) +- [Release notes for 8.5.2](release-notes-8-5-2/) +- [Release notes for 8.5.1](release-notes-8-5-1/) +- [Release notes for 8.5.0](release-notes-8-5-0/) +- [Release notes for 8.5.0-beta1](release-notes-8-5-0-beta1/) +- [Release notes for 8.4.11](release-notes-8-4-11/) +- [Release notes for 8.4.10](release-notes-8-4-10/) +- [Release notes for 8.4.7](release-notes-8-4-7/) +- [Release notes for 8.4.6](release-notes-8-4-6/) +- [Release notes for 8.4.5](release-notes-8-4-5/) +- [Release notes for 8.4.4](release-notes-8-4-4/) +- [Release notes for 8.4.3](release-notes-8-4-3/) +- [Release notes for 8.4.2](release-notes-8-4-2/) +- [Release notes for 8.4.1](release-notes-8-4-1/) +- [Release notes for 8.4.0-beta1](release-notes-8-4-0-beta1/) +- [Release notes for 8.3.11](release-notes-8-3-11/) +- [Release notes for 8.3.7](release-notes-8-3-7/) +- [Release notes for 8.3.6](release-notes-8-3-6/) +- [Release notes for 8.3.5](release-notes-8-3-5/) +- [Release notes for 8.3.4](release-notes-8-3-4/) +- [Release notes for 8.3.3](release-notes-8-3-3/) +- [Release notes for 8.3.2](release-notes-8-3-2/) +- [Release notes for 8.3.1](release-notes-8-3-1/) +- [Release notes for 8.3.0](release-notes-8-3-0/) +- [Release notes for 8.3.0-beta2](release-notes-8-3-0-beta2/) +- [Release notes for 8.3.0-beta1](release-notes-8-3-0-beta1/) +- [Release notes for 8.2.7](release-notes-8-2-7/) +- [Release notes for 8.2.6](release-notes-8-2-6/) +- [Release notes for 8.2.5](release-notes-8-2-5/) +- [Release notes for 8.2.4](release-notes-8-2-4/) +- [Release notes for 8.2.3](release-notes-8-2-3/) +- [Release notes for 8.2.2](release-notes-8-2-2/) +- [Release notes for 8.2.1](release-notes-8-2-1/) +- [Release notes for 8.2.0](release-notes-8-2-0/) +- [Release notes for 8.2.0-beta2](release-notes-8-2-0-beta2/) +- [Release notes for 8.2.0-beta1](release-notes-8-2-0-beta1/) +- [Release notes for 8.1.8](release-notes-8-1-8/) +- [Release notes for 8.1.7](release-notes-8-1-7/) +- [Release notes for 8.1.6](release-notes-8-1-6/) +- [Release notes for 8.1.5](release-notes-8-1-5/) +- [Release notes for 8.1.4](release-notes-8-1-4/) +- [Release notes for 8.1.3](release-notes-8-1-3/) +- [Release notes for 8.1.2](release-notes-8-1-2/) +- [Release notes for 8.1.1](release-notes-8-1-1/) +- [Release notes for 8.1.0](release-notes-8-1-0/) +- [Release notes for 8.1.0-beta3](release-notes-8-1-0-beta3/) +- [Release notes for 8.1.0-beta2](release-notes-8-1-0-beta2/) +- [Release notes for 8.1.0-beta1](release-notes-8-1-0-beta1/) +- [Release notes for 8.0.7](release-notes-8-0-7/) +- [Release notes for 8.0.6](release-notes-8-0-6/) +- [Release notes for 8.0.5](release-notes-8-0-5/) +- [Release notes for 8.0.4](release-notes-8-0-4/) +- [Release notes for 8.0.3](release-notes-8-0-3/) +- [Release notes for 8.0.2](release-notes-8-0-2/) +- [Release notes for 8.0.1](release-notes-8-0-1/) +- [Release notes for 8.0.0](release-notes-8-0-0/) +- [Release notes for 8.0.0-beta3](release-notes-8-0-0-beta3/) +- [Release notes for 8.0.0-beta2](release-notes-8-0-0-beta2/) +- [Release notes for 8.0.0-beta1](release-notes-8-0-0-beta1/) +- [Release notes for 7.5.15](release-notes-7-5-15/) +- [Release notes for 7.5.13](release-notes-7-5-13/) +- [Release notes for 7.5.12](release-notes-7-5-12/) +- [Release notes for 7.5.11](release-notes-7-5-11/) +- [Release notes for 7.5.10](release-notes-7-5-10/) +- [Release notes for 7.5.9](release-notes-7-5-9/) +- [Release notes for 7.5.8](release-notes-7-5-8/) +- [Release notes for 7.5.7](release-notes-7-5-7/) +- [Release notes for 7.5.6](release-notes-7-5-6/) +- [Release notes for 7.5.5](release-notes-7-5-5/) +- [Release notes for 7.5.4](release-notes-7-5-4/) +- [Release notes for 7.5.3](release-notes-7-5-3/) +- [Release notes for 7.5.2](release-notes-7-5-2/) +- [Release notes for 7.5.1](release-notes-7-5-1/) +- [Release notes for 7.5.0](release-notes-7-5-0/) +- [Release notes for 7.5.0-beta2](release-notes-7-5-0-beta2/) +- [Release notes for 7.5.0-beta1](release-notes-7-5-0-beta1/) +- [Release notes for 7.4.5](release-notes-7-4-5/) +- [Release notes for 7.4.3](release-notes-7-4-3/) +- [Release notes for 7.4.2](release-notes-7-4-2/) +- [Release notes for 7.4.1](release-notes-7-4-1/) +- [Release notes for 7.4.0](release-notes-7-4-0/) +- [Release notes for 7.3.10](release-notes-7-3-10/) +- [Release notes for 7.3.7](release-notes-7-3-7/) +- [Release notes for 7.3.6](release-notes-7-3-6/) +- [Release notes for 7.3.5](release-notes-7-3-5/) +- [Release notes for 7.3.4](release-notes-7-3-4/) +- [Release notes for 7.3.3](release-notes-7-3-3/) +- [Release notes for 7.3.2](release-notes-7-3-2/) +- [Release notes for 7.3.1](release-notes-7-3-1/) +- [Release notes for 7.3.0](release-notes-7-3-0/) diff --git a/docs/sources/setup-grafana/configure-docker.md b/docs/sources/setup-grafana/configure-docker.md index 0ad1aecabbd..f5c706f1845 100644 --- a/docs/sources/setup-grafana/configure-docker.md +++ b/docs/sources/setup-grafana/configure-docker.md @@ -84,9 +84,9 @@ For a list of available tags, refer to [grafana/grafana-oss](https://hub.docker. ## Default paths -Grafana comes with default configuration parameters that remain the same among versions regardless of the operating system or the environment (for example, virtual machine, Docker, Kubernetes, etc.). You can refer to the [Configure Grafana]({{< relref "./configure-grafana" >}}) documentation to view all the default configuration settings. +Grafana comes with default configuration parameters that remain the same among versions regardless of the operating system or the environment (for example, virtual machine, Docker, Kubernetes, etc.). You can refer to the [Configure Grafana](../configure-grafana/) documentation to view all the default configuration settings. -The following configurations are set by default when you start the Grafana Docker container. When running in Docker you cannot change the configurations by editing the `conf/grafana.ini` file. Instead, you can modify the configuration using [environment variables]({{< relref "./configure-grafana#override-configuration-with-environment-variables" >}}). +The following configurations are set by default when you start the Grafana Docker container. When running in Docker you cannot change the configurations by editing the `conf/grafana.ini` file. Instead, you can modify the configuration using [environment variables](../configure-grafana/#override-configuration-with-environment-variables). | Setting | Default value | | --------------------- | ------------------------- | @@ -99,7 +99,7 @@ The following configurations are set by default when you start the Grafana Docke ## Install plugins in the Docker container -You can install publicly available plugins and plugins that are private or used internally in an organization. For plugin installation instructions, refer to [Install plugins in the Docker container]({{< relref "./installation/docker#install-plugins-in-the-docker-container" >}}). +You can install publicly available plugins and plugins that are private or used internally in an organization. For plugin installation instructions, refer to [Install plugins in the Docker container](../installation/docker/#install-plugins-in-the-docker-container). ### Install plugins from other sources @@ -209,7 +209,7 @@ docker run -d -p 3000:3000 --name=grafana grafana-custom ## Logging -By default, Docker container logs are directed to `STDOUT`, a common practice in the Docker community. You can change this by setting a different [log mode]({{< relref "./configure-grafana#mode" >}}) such as `console`, `file`, or `syslog`. You can use one or more modes by separating them with spaces, for example, `console file`. By default, both `console` and `file` modes are enabled. +By default, Docker container logs are directed to `STDOUT`, a common practice in the Docker community. You can change this by setting a different [log mode](../configure-grafana/#mode) such as `console`, `file`, or `syslog`. You can use one or more modes by separating them with spaces, for example, `console file`. By default, both `console` and `file` modes are enabled. Example: @@ -235,7 +235,7 @@ The following example demonstrates how to set the admin password: ### Configure Docker secrets credentials for AWS CloudWatch -Grafana ships with built-in support for the [Amazon CloudWatch datasource]({{< relref "../datasources/aws-cloudwatch" >}}). To configure the data source, you must provide information such as the AWS ID-Key, secret access key, region, and so on. You can use Docker secrets as a way to provide this information. +Grafana ships with built-in support for the [Amazon CloudWatch datasource](../../datasources/aws-cloudwatch/). To configure the data source, you must provide information such as the AWS ID-Key, secret access key, region, and so on. You can use Docker secrets as a way to provide this information. Example: @@ -309,7 +309,7 @@ The following list includes the supported environment variables: By default, the Grafana log level is set to `INFO`, but you can increase the log level to `DEBUG` mode when you want to reproduce a problem. -For more information about logging, refer to [logs]({{< relref "./configure-grafana#log" >}}). +For more information about logging, refer to [logs](../configure-grafana/#log). ### Increase log level using the Docker run (CLI) command diff --git a/docs/sources/setup-grafana/configure-grafana/_index.md b/docs/sources/setup-grafana/configure-grafana/_index.md index babe3619b35..5c7b92515ec 100644 --- a/docs/sources/setup-grafana/configure-grafana/_index.md +++ b/docs/sources/setup-grafana/configure-grafana/_index.md @@ -203,13 +203,13 @@ Override log path using the command line argument `cfg:default.paths.logs`: #### `plugins` -Directory where Grafana automatically scans and looks for plugins. For information about manually or automatically installing plugins, refer to [Install Grafana plugins]({{< relref "../../administration/plugin-management#install-grafana-plugins" >}}). +Directory where Grafana automatically scans and looks for plugins. For information about manually or automatically installing plugins, refer to [Install Grafana plugins](../../administration/plugin-management/#install-grafana-plugins). **macOS:** By default, the Mac plugin location is: `/usr/local/var/lib/grafana/plugins`. #### `provisioning` -Directory that contains [provisioning]({{< relref "../../administration/provisioning" >}}) configuration files that Grafana applies on startup. +Directory that contains [provisioning](../../administration/provisioning/) configuration files that Grafana applies on startup. Dashboards are reloaded when the JSON files change.
@@ -475,7 +475,7 @@ Set to `true` to add metrics and tracing for database queries. The default value ### `[remote_cache]` -Caches authentication details and session information in the configured database, Redis or Memcached. This setting does not configure [Query Caching in Grafana Enterprise]({{< relref "../../administration/data-source-management#query-and-resource-caching" >}}). +Caches authentication details and session information in the configured database, Redis or Memcached. This setting does not configure [Query Caching in Grafana Enterprise](../../administration/data-source-management/#query-and-resource-caching). #### `type` @@ -783,7 +783,7 @@ The following example limits access to the backend of a single plugin: #### `angular_support_enabled` This is set to false by default, meaning that the angular framework and support components aren't be loaded. -This means that all [plugins]({{< relref "../../developers/angular_deprecation/angular-plugins" >}}) and core features that depend on angular support won't work. +This means that all [plugins](../../developers/angular_deprecation/angular-plugins/) and core features that depend on angular support won't work. The core features that depend on angular are: @@ -884,7 +884,7 @@ For SQL data sources (MySql, Postgres, MSSQL) you can override the default maxim Set to `false` to prohibit users from being able to sign up or create user accounts. Default is `false`. A Grafana Admin can still create users. -For more information about creating a user, refer to [Add a user]({{< relref "../../administration/user-management/server-user-management#add-a-user" >}}). +For more information about creating a user, refer to [Add a user](../../administration/user-management/server-user-management/#add-a-user). #### `allow_org_create` @@ -954,7 +954,7 @@ If you manage users externally you can replace the user invite button for organi This option is deprecated - assign your viewers as editors, if you are using RBAC assign the data sources explorer role to your users. {{< /admonition >}} -Viewers can access and use [Explore]({{< relref "../../explore" >}}) and perform temporary edits on panels in dashboards they have access to. They cannot save their changes. Default is `false`. +Viewers can access and use [Explore](../../explore/) and perform temporary edits on panels in dashboards they have access to. They cannot save their changes. Default is `false`. #### `editors_can_admin` @@ -991,7 +991,7 @@ This is a comma-separated list of usernames. Users specified here are hidden in ### `[auth]` -Grafana provides many ways to authenticate users. Refer to the Grafana [Authentication overview]({{< relref "../configure-security/configure-authentication" >}}) and other authentication documentation for detailed instructions on how to set up and configure authentication. +Grafana provides many ways to authenticate users. Refer to the Grafana [Authentication overview](../configure-security/configure-authentication/) and other authentication documentation for detailed instructions on how to set up and configure authentication. #### `login_cookie_name` @@ -1196,25 +1196,25 @@ This means the plugin can only access data and resources within that specific or ### `[auth.anonymous]` -Refer to [Anonymous authentication]({{< relref "../configure-security/configure-authentication/grafana#anonymous-authentication" >}}) for detailed instructions. +Refer to [Anonymous authentication](../configure-security/configure-authentication/grafana/#anonymous-authentication) for detailed instructions.
### `[auth.github]` -Refer to [GitHub OAuth2 authentication]({{< relref "../configure-security/configure-authentication/github" >}}) for detailed instructions. +Refer to [GitHub OAuth2 authentication](../configure-security/configure-authentication/github/) for detailed instructions.
### `[auth.gitlab]` -Refer to [GitLab OAuth 2.0 authentication]({{< relref "../configure-security/configure-authentication/gitlab" >}}) for detailed instructions. +Refer to [GitLab OAuth 2.0 authentication](../configure-security/configure-authentication/gitlab/) for detailed instructions.
### `[auth.google]` -Refer to [Google OAuth2 authentication]({{< relref "../configure-security/configure-authentication/google" >}}) for detailed instructions. +Refer to [Google OAuth2 authentication](../configure-security/configure-authentication/google/) for detailed instructions.
@@ -1232,37 +1232,37 @@ Legacy key names, still in the configuration file so they work in environment va ### `[auth.azuread]` -Refer to [Azure AD OAuth2 authentication]({{< relref "../configure-security/configure-authentication/azuread" >}}) for detailed instructions. +Refer to [Azure AD OAuth2 authentication](../configure-security/configure-authentication/azuread/) for detailed instructions.
### `[auth.okta]` -Refer to [Okta OAuth2 authentication]({{< relref "../configure-security/configure-authentication/okta" >}}) for detailed instructions. +Refer to [Okta OAuth2 authentication](../configure-security/configure-authentication/okta/) for detailed instructions.
### `[auth.generic_oauth]` -Refer to [Generic OAuth authentication]({{< relref "../configure-security/configure-authentication/generic-oauth" >}}) for detailed instructions. +Refer to [Generic OAuth authentication](../configure-security/configure-authentication/generic-oauth/) for detailed instructions.
### `[auth.basic]` -Refer to [Basic authentication]({{< relref "../configure-security/configure-authentication#basic-authentication" >}}) for detailed instructions. +Refer to [Basic authentication](../configure-security/configure-authentication/#basic-authentication) for detailed instructions.
### `[auth.proxy]` -Refer to [Auth proxy authentication]({{< relref "../configure-security/configure-authentication/auth-proxy" >}}) for detailed instructions. +Refer to [Auth proxy authentication](../configure-security/configure-authentication/auth-proxy/) for detailed instructions.
### `[auth.ldap]` -Refer to [LDAP authentication]({{< relref "../configure-security/configure-authentication/ldap" >}}) for detailed instructions. +Refer to [LDAP authentication](../configure-security/configure-authentication/ldap/) for detailed instructions. ### `[aws]` @@ -1421,7 +1421,7 @@ Disabled by default, needs to be explicitly enabled. ### `[auth.jwt]` -Refer to [JWT authentication]({{< relref "../configure-security/configure-authentication/jwt" >}}) for more information. +Refer to [JWT authentication](../configure-security/configure-authentication/jwt/) for more information.
@@ -1726,7 +1726,7 @@ Limit the number of query evaluation results per alert rule. If the condition qu ### `[unified_alerting]` -For more information about the Grafana alerts, refer to [Grafana Alerting]({{< relref "../../alerting" >}}). +For more information about the Grafana alerts, refer to [Grafana Alerting](../../alerting/). #### `enabled` @@ -1858,7 +1858,7 @@ If a rule frequency is lower than this value, then this value is enforced. ### `[unified_alerting.screenshots]` -For more information about screenshots, refer to [Images in notifications]({{< relref "../../alerting/configure-notifications/template-notifications/images-in-notifications" >}}). +For more information about screenshots, refer to [Images in notifications](../../alerting/configure-notifications/template-notifications/images-in-notifications/). #### `capture` @@ -1949,7 +1949,7 @@ Configures max number of API annotations that Grafana keeps. Default value is 0, ### `[explore]` -For more information about this feature, refer to [Explore]({{< relref "../../explore" >}}). +For more information about this feature, refer to [Explore](../../explore/). #### `enabled` @@ -2026,7 +2026,7 @@ Short links without an expiration increase the size of the database and can't be ### `[metrics]` -For detailed instructions, refer to [Internal Grafana metrics]({{< relref "../set-up-grafana-monitoring" >}}). +For detailed instructions, refer to [Internal Grafana metrics](../set-up-grafana-monitoring/). #### `enabled` @@ -2423,7 +2423,7 @@ Set to `true` if you want to test alpha plugins that are not yet ready for gener Enter a comma-separated list of plugin identifiers to identify plugins to load even if they are unsigned. Plugins with modified signatures are never loaded. -We do _not_ recommend using this option. For more information, refer to [Plugin signatures]({{< relref "../../administration/plugin-management#plugin-signatures" >}}). +We do _not_ recommend using this option. For more information, refer to [Plugin signatures](../../administration/plugin-management/#plugin-signatures). #### `plugin_admin_enabled` @@ -2431,7 +2431,7 @@ Available to Grafana administrators only, enables installing, uninstalling, and Set to `true` by default. Setting it to `false` hides the controls. -For more information, refer to [Plugin catalog]({{< relref "../../administration/plugin-management#plugin-catalog" >}}). +For more information, refer to [Plugin catalog](../../administration/plugin-management/#plugin-catalog). #### `plugin_admin_external_manage_enabled` @@ -2493,7 +2493,7 @@ This option disables all preinstalled plugins. The default is `false`. To disabl The `max_connections` option specifies the maximum number of connections to the Grafana Live WebSocket endpoint per Grafana server instance. Default is `100`. -Refer to [Grafana Live configuration documentation]({{< relref "../set-up-grafana-live" >}}) if you specify a number higher than default since this can require some operating system and infrastructure tuning. +Refer to [Grafana Live configuration documentation](../set-up-grafana-live/) if you specify a number higher than default since this can require some operating system and infrastructure tuning. 0 disables Grafana Live, -1 means unlimited connections. @@ -2501,7 +2501,7 @@ Refer to [Grafana Live configuration documentation]({{< relref "../set-up-grafan The `allowed_origins` option is a comma-separated list of additional origins (`Origin` header of HTTP Upgrade request during WebSocket connection establishment) that is accepted by Grafana Live. -If not set (default), then the origin is matched over [root_url]({{< relref "#root_url" >}}) which should be sufficient for most scenarios. +If not set (default), then the origin is matched over [root_url](#root_url) which should be sufficient for most scenarios. Origin patterns support wildcard symbol "\*". @@ -2518,7 +2518,7 @@ allowed_origins = "https://*.example.com" The high availability (HA) engine name for Grafana Live. By default, it's not set. The only possible value is `redis`. -For more information, refer to the [Configure Grafana Live HA setup]({{< relref "../set-up-grafana-live#configure-grafana-live-ha-setup" >}}). +For more information, refer to the [Configure Grafana Live HA setup](../set-up-grafana-live/#configure-grafana-live-ha-setup). #### `ha_engine_address` @@ -2558,7 +2558,7 @@ Experimental. Requires the feature toggle `externalCorePlugins` to be enabled. ### `[plugin.grafana-image-renderer]` -For more information, refer to [Image rendering]({{< relref "../image-rendering" >}}). +For more information, refer to [Image rendering](../image-rendering/). #### `rendering_timezone` @@ -2665,7 +2665,7 @@ Change the listening port of the gRPC server. Default port is `0` and uses a por ### `[enterprise]` -For more information about Grafana Enterprise, refer to [Grafana Enterprise]({{< relref "../../introduction/grafana-enterprise" >}}). +For more information about Grafana Enterprise, refer to [Grafana Enterprise](../../introduction/grafana-enterprise/).
@@ -2685,7 +2685,7 @@ Some feature toggles for stable features are on by default. Use this setting to The options in this section configure the experimental Feature Toggle Admin Page feature, which is enabled using the `featureToggleAdminPage` feature toggle. Grafana Labs offers support on a best-effort basis, and breaking changes might occur prior to the feature being made generally available. -For more information, refer to [Configure feature toggles]({{< relref "./feature-toggles" >}}). +For more information, refer to [Configure feature toggles](feature-toggles/). #### `allow_editing` @@ -2778,7 +2778,7 @@ Set this to `false` to disable loading other custom base maps and hide them in t ### `[rbac]` -Refer to [Role-based access control]({{< relref "../../administration/roles-and-permissions/access-control" >}}) for more information. +Refer to [Role-based access control](../../administration/roles-and-permissions/access-control/) for more information. ### `[navigation.app_sections]` diff --git a/docs/sources/setup-grafana/configure-grafana/configure-custom-branding/index.md b/docs/sources/setup-grafana/configure-grafana/configure-custom-branding/index.md index 8a16c6e293d..a0a33ea3229 100644 --- a/docs/sources/setup-grafana/configure-grafana/configure-custom-branding/index.md +++ b/docs/sources/setup-grafana/configure-grafana/configure-custom-branding/index.md @@ -15,7 +15,7 @@ weight: 300 Custom branding enables you to replace the Grafana Labs brand and logo with your corporate brand and logo. {{% admonition type="note" %}} -Available in [Grafana Enterprise]({{< relref "../../../introduction/grafana-enterprise" >}}) and [Grafana Cloud](/docs/grafana-cloud). For Cloud Advanced and Enterprise customers, please provide custom elements and logos to our Support team. We will help you host your images and update your custom branding. +Available in [Grafana Enterprise](../../../introduction/grafana-enterprise/) and [Grafana Cloud](/docs/grafana-cloud). For Cloud Advanced and Enterprise customers, please provide custom elements and logos to our Support team. We will help you host your images and update your custom branding. This feature is not available for Grafana Free and Pro tiers. For more information on feature availability across plans, refer to our [feature comparison page](/docs/grafana-cloud/cost-management-and-billing/understand-grafana-cloud-features/) @@ -39,7 +39,7 @@ With custom branding, you have the ability to modify the following elements: > You will have to host your logo and other images used by the custom branding feature separately. Make sure Grafana can access the URL where the assets are stored. -The configuration file in Grafana Enterprise contains the following options. For more information about configuring Grafana, refer to [Configure Grafana]({{< relref "../../configure-grafana" >}}). +The configuration file in Grafana Enterprise contains the following options. For more information about configuring Grafana, refer to [Configure Grafana](../). ```ini # Enterprise only diff --git a/docs/sources/setup-grafana/configure-grafana/enterprise-configuration/index.md b/docs/sources/setup-grafana/configure-grafana/enterprise-configuration/index.md index a7ef4fa0733..bf4b6fc65c6 100644 --- a/docs/sources/setup-grafana/configure-grafana/enterprise-configuration/index.md +++ b/docs/sources/setup-grafana/configure-grafana/enterprise-configuration/index.md @@ -12,7 +12,7 @@ weight: 100 # Configure Grafana Enterprise -This page describes Grafana Enterprise-specific configuration options that you can specify in a `.ini` configuration file or using environment variables. Refer to [Configuration]({{< relref "../../configure-grafana" >}}) for more information about available configuration options. +This page describes Grafana Enterprise-specific configuration options that you can specify in a `.ini` configuration file or using environment variables. Refer to [Configuration](../) for more information about available configuration options. ## [enterprise] @@ -41,7 +41,7 @@ The license only automatically updates once per day. To immediately update the t ### license_validation_type -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 "../../../administration/enterprise-licensing/activate-aws-marketplace-license" >}}). +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](../../../administration/enterprise-licensing/activate-aws-marketplace-license/). ## [white_labeling] @@ -84,7 +84,7 @@ List the link IDs to use here. Grafana will look for matching link configuration ## [usage_insights.export] -By [exporting usage logs]({{< relref "../../configure-security/export-logs" >}}), 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. +By [exporting usage logs](../../configure-security/export-logs/), 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. ### enabled @@ -184,7 +184,7 @@ Allowed domains to receive reports. Use an asterisk (`*`) to allow all domains. ## [auditing] -[Auditing]({{< relref "../../configure-security/audit-grafana" >}}) 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. +[Auditing](../../configure-security/audit-grafana/) 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. ### enabled @@ -409,7 +409,7 @@ Setting 'enabled' to `true` allows users to configure query caching for data sou This value is `true` by default. {{% admonition type="note" %}} -This setting enables the caching feature, but it does not turn on query caching for any data source. To turn on query caching for a data source, update the setting on the data source configuration page. For more information, refer to the [query caching docs]({{< relref "../../../administration/data-source-management#enable-and-configure-query-caching" >}}). +This setting enables the caching feature, but it does not turn on query caching for any data source. To turn on query caching for a data source, update the setting on the data source configuration page. For more information, refer to the [query caching docs](../../../administration/data-source-management/#enable-and-configure-query-caching). {{% /admonition %}} ### ttl diff --git a/docs/sources/setup-grafana/configure-grafana/feature-toggles/index.md b/docs/sources/setup-grafana/configure-grafana/feature-toggles/index.md index 6850b23da88..a4a4163bb49 100644 --- a/docs/sources/setup-grafana/configure-grafana/feature-toggles/index.md +++ b/docs/sources/setup-grafana/configure-grafana/feature-toggles/index.md @@ -13,7 +13,7 @@ weight: 150 You use feature toggles, also known as feature flags, to enable or disable features in Grafana. You can turn on feature toggles to try out new functionality in development or test environments. -This page contains a list of available feature toggles. To learn how to turn on feature toggles, refer to our [Configure Grafana documentation]({{< relref "../_index.md#feature_toggles" >}}). Feature toggles are also available to Grafana Cloud Advanced customers. If you use Grafana Cloud Advanced, you can open a support ticket and specify the feature toggles and stack for which you want them enabled. +This page contains a list of available feature toggles. To learn how to turn on feature toggles, refer to our [Configure Grafana documentation](../#feature_toggles). Feature toggles are also available to Grafana Cloud Advanced customers. If you use Grafana Cloud Advanced, you can open a support ticket and specify the feature toggles and stack for which you want them enabled. For more information about feature release stages, refer to [Release life cycle for Grafana Labs](https://grafana.com/docs/release-life-cycle/) and [Manage feature toggles](https://grafana.com/docs/grafana//administration/feature-toggles/#manage-feature-toggles). @@ -231,7 +231,7 @@ Experimental features might be changed or removed without prior notice. ## Development feature toggles -The following toggles require explicitly setting Grafana's [app mode]({{< relref "../_index.md#app_mode" >}}) to 'development' before you can enable this feature toggle. These features tend to be experimental. +The following toggles require explicitly setting Grafana's [app mode](../#app_mode) to 'development' before you can enable this feature toggle. These features tend to be experimental. | Feature toggle name | Description | | -------------------------------------- | ----------------------------------------------------------------------------- | diff --git a/docs/sources/setup-grafana/configure-grafana/proxy/index.md b/docs/sources/setup-grafana/configure-grafana/proxy/index.md index e38f5e5aae0..7f17909ad5d 100644 --- a/docs/sources/setup-grafana/configure-grafana/proxy/index.md +++ b/docs/sources/setup-grafana/configure-grafana/proxy/index.md @@ -44,6 +44,6 @@ To complete this task, you must first deploy a socks proxy server that supports 1. Set up a data source and configure it to send data source connections through the proxy. - To configure your data sources to send connections through the proxy, `enableSecureSocksProxy=true` must be specified in the data source json. You can do this in the [API]({{< relref "../../../developers/http_api/data_source" >}}) or use [file based provisioning]({{< relref "../../../administration/provisioning#data-sources" >}}). + To configure your data sources to send connections through the proxy, `enableSecureSocksProxy=true` must be specified in the data source json. You can do this in the [API](../../../developers/http_api/data_source/) or use [file based provisioning](../../../administration/provisioning/#data-sources). Additionally, you can set the socks5 username and password by adding `secureSocksProxyUsername` in the data source json and `secureSocksProxyPassword` in the secure data source json. diff --git a/docs/sources/setup-grafana/configure-grafana/settings-updates-at-runtime/index.md b/docs/sources/setup-grafana/configure-grafana/settings-updates-at-runtime/index.md index 046c0528c43..f755b6d0246 100644 --- a/docs/sources/setup-grafana/configure-grafana/settings-updates-at-runtime/index.md +++ b/docs/sources/setup-grafana/configure-grafana/settings-updates-at-runtime/index.md @@ -17,13 +17,13 @@ weight: 500 # Settings updates at runtime {{% admonition type="note" %}} -This functionality is deprecated and will be removed in a future release. For configuring SAML authentication, please use the new [SSO settings API]({{< relref "../../../developers/http_api/sso-settings" >}}). +This functionality is deprecated and will be removed in a future release. For configuring SAML authentication, please use the new [SSO settings API](../../../developers/http_api/sso-settings/). {{% /admonition %}} 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 other sources]({{< relref "../../configure-grafana" >}}) +[settings from other sources](../) (arguments, environment variables, settings file, etc). Therefore, every time a specific setting key is removed at runtime, the value used for that key is the inherited one from the other sources in the reverse order of precedence (`arguments > environment variables > settings file`). When no value is provided through any of these options, then the value used will be the application default @@ -32,7 +32,7 @@ Currently, **it only supports updates on the `auth.saml` section.** ## Update settings via the API -You can update settings through the [Admin API]({{< relref "../../../developers/http_api/admin#update-settings" >}}). +You can update settings through the [Admin API](../../../developers/http_api/admin/#update-settings). When you submit a settings update via API, Grafana verifies if the given settings updates are allowed and valid. If they are, then Grafana stores the settings in the database and reloads Grafana services with no need to restart the instance. @@ -99,5 +99,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 "../../../administration/roles-and-permissions/access-control" >}}) enabled, you can control who can read or update settings. -Refer to the [Admin API]({{< relref "../../../developers/http_api/admin#update-settings" >}}) for more information. +If you have [role-based access control](../../../administration/roles-and-permissions/access-control/) enabled, you can control who can read or update settings. +Refer to the [Admin API](../../../developers/http_api/admin/#update-settings) for more information. diff --git a/docs/sources/setup-grafana/configure-security/_index.md b/docs/sources/setup-grafana/configure-security/_index.md index c638203fc8d..af6d0d9307b 100644 --- a/docs/sources/setup-grafana/configure-security/_index.md +++ b/docs/sources/setup-grafana/configure-security/_index.md @@ -19,11 +19,11 @@ To prevent this type of exploitation from happening, we recommend that you apply ## Limit IP addresses/hostnames for data source URL -You can configure Grafana to only allow certain IP addresses or hostnames to be used as data source URLs and proxied through the Grafana data source proxy. Refer to [data_source_proxy_whitelist]({{< relref "../configure-grafana#data_source_proxy_whitelist" >}}) for usage instructions. +You can configure Grafana to only allow certain IP addresses or hostnames to be used as data source URLs and proxied through the Grafana data source proxy. Refer to [data_source_proxy_whitelist](../configure-grafana/#data_source_proxy_whitelist) for usage instructions. ## Request security -The request security configuration option allows users to limit requests from the Grafana server. It targets requests that are generated by users. For more information, refer to [Request security]({{< relref "./configure-request-security" >}}). +The request security configuration option allows users to limit requests from the Grafana server. It targets requests that are generated by users. For more information, refer to [Request security](configure-request-security/). {{% admonition type="note" %}} Request security is available in Grafana Enterprise v7.4 and later versions. @@ -53,7 +53,7 @@ For example, in a Grafana instance with one data source, one dashboard, and one To address this vulnerability, you can restrict data source query access in the following ways: -- Create multiple data sources with some restrictions added in data source configuration that restrict access (like database name or credentials). Then use the [Data Source Permissions]({{< relref "../../administration/data-source-management#data-source-permissions" >}}) Enterprise feature to restrict user access to the data source in Grafana. +- Create multiple data sources with some restrictions added in data source configuration that restrict access (like database name or credentials). Then use the [Data Source Permissions](../../administration/data-source-management/#data-source-permissions) Enterprise feature to restrict user access to the data source in Grafana. - Create a separate Grafana organization, and in that organization, create a separate data source. Make sure the data source has some option/user/credentials setting that limits access to a subset of the data. Not all data sources have an option to limit access. ## Implications of enabling anonymous access to dashboards diff --git a/docs/sources/setup-grafana/configure-security/audit-grafana.md b/docs/sources/setup-grafana/configure-security/audit-grafana.md index 9bafd16630e..7353235d90a 100644 --- a/docs/sources/setup-grafana/configure-security/audit-grafana.md +++ b/docs/sources/setup-grafana/configure-security/audit-grafana.md @@ -26,7 +26,7 @@ To enable sending Grafana Cloud audit logs to your Grafana Cloud Logs instance, Only API requests or UI actions that trigger an API request generate an audit log. {{% admonition type="note" %}} -Available in [Grafana Enterprise]({{< relref "../../introduction/grafana-enterprise" >}}) and [Grafana Cloud](/docs/grafana-cloud). +Available in [Grafana Enterprise](../../../introduction/grafana-enterprise/) and [Grafana Cloud](/docs/grafana-cloud). {{% /admonition %}} ## Audit logs @@ -145,7 +145,7 @@ to the action when the user requests a report's preview to be sent through email \* Where `AUTH-MODULE` is the name of the authentication module: `grafana`, `saml`, `ldap`, etc. \ -\*\* Includes manual log out, token expired/revoked, and [SAML Single Logout]({{< relref "./configure-authentication/saml#single-logout" >}}). +\*\* Includes manual log out, token expired/revoked, and [SAML Single Logout](../configure-authentication/saml/#single-logout). #### Service accounts @@ -359,7 +359,7 @@ The auditing feature is disabled by default. {{% /admonition %}} Audit logs can be saved into files, sent to a Loki instance or sent to the Grafana default logger. By default, only the file exporter is enabled. -You can choose which exporter to use in the [configuration file]({{< relref "../configure-grafana" >}}). +You can choose which exporter to use in the [configuration file](../../configure-grafana/). Options are `file`, `loki`, and `logger`. Use spaces to separate multiple modes, such as `file loki`. @@ -437,4 +437,4 @@ url = user:password@localhost:3000 ### Console exporter -Audit logs are sent to the Grafana default logger. The audit logs use the `auditing.console` logger and are logged on `debug`-level, learn how to enable debug logging in the [log configuration]({{< relref "../configure-grafana#log" >}}) section of the documentation. Accessing the audit logs in this way is not recommended for production use. +Audit logs are sent to the Grafana default logger. The audit logs use the `auditing.console` logger and are logged on `debug`-level, learn how to enable debug logging in the [log configuration](../../configure-grafana/#log) section of the documentation. Accessing the audit logs in this way is not recommended for production use. diff --git a/docs/sources/setup-grafana/configure-security/configure-authentication/_index.md b/docs/sources/setup-grafana/configure-security/configure-authentication/_index.md index 3e20606bb1e..41132550368 100644 --- a/docs/sources/setup-grafana/configure-security/configure-authentication/_index.md +++ b/docs/sources/setup-grafana/configure-security/configure-authentication/_index.md @@ -17,24 +17,24 @@ weight: 200 Grafana provides many ways to authenticate users. Some authentication integrations also enable syncing user permissions and org memberships. -The following table shows all supported authentication methods and the features available for them. [Team sync]({{< relref "../configure-team-sync" >}}) and [active sync]({{< relref "./enhanced-ldap#active-ldap-synchronization" >}}) are only available in Grafana Enterprise. +The following table shows all supported authentication methods and the features available for them. [Team sync](../configure-team-sync/) and [active sync](enhanced-ldap/#active-ldap-synchronization) are only available in Grafana Enterprise. -| Authentication method | Multi Org Mapping | Enforce Sync | Role Mapping | Grafana Admin Mapping | Team Sync | Allowed groups | Active Sync | Skip OrgRole mapping | Auto Login | Single Logout | -| :---------------------------------------------------- | :---------------- | :----------- | :----------- | :-------------------- | :-------- | :------------- | :---------- | :------------------- | :--------- | :------------ | -| [Anonymous access]({{< relref "./anonymous-auth" >}}) | N/A | N/A | N/A | N/A | N/A | N/A | N/A | N/A | N/A | N/A | -| [Auth Proxy]({{< relref "./auth-proxy" >}}) | no | yes | yes | no | yes | no | N/A | no | N/A | N/A | -| [Azure AD OAuth]({{< relref "./azuread" >}}) | yes | yes | yes | yes | yes | yes | N/A | yes | yes | yes | -| [Basic auth]({{< relref "./grafana" >}}) | yes | N/A | yes | yes | N/A | N/A | N/A | N/A | N/A | N/A | -| [Passwordless auth]({{< relref "./passwordless" >}}) | yes | N/A | yes | yes | N/A | N/A | N/A | N/A | N/A | N/A | -| [Generic OAuth]({{< relref "./generic-oauth" >}}) | yes | yes | yes | yes | yes | no | N/A | yes | yes | yes | -| [GitHub OAuth]({{< relref "./github" >}}) | yes | yes | yes | yes | yes | yes | N/A | yes | yes | yes | -| [GitLab OAuth]({{< relref "./gitlab" >}}) | yes | yes | yes | yes | yes | yes | N/A | yes | yes | yes | -| [Google OAuth]({{< relref "./google" >}}) | yes | no | no | no | yes | no | N/A | no | yes | yes | -| [Grafana.com OAuth]({{< relref "./grafana-cloud" >}}) | no | no | yes | no | N/A | N/A | N/A | yes | yes | yes | -| [Okta OAuth]({{< relref "./okta" >}}) | yes | yes | yes | yes | yes | yes | N/A | yes | yes | yes | -| [SAML]({{< relref "./saml" >}}) (Enterprise only) | yes | yes | yes | yes | yes | yes | N/A | yes | yes | yes | -| [LDAP]({{< relref "./ldap" >}}) | yes | yes | yes | yes | yes | yes | yes | no | N/A | N/A | -| [JWT Proxy]({{< relref "./jwt" >}}) | no | yes | yes | yes | no | no | N/A | no | N/A | N/A | +| Authentication method | Multi Org Mapping | Enforce Sync | Role Mapping | Grafana Admin Mapping | Team Sync | Allowed groups | Active Sync | Skip OrgRole mapping | Auto Login | Single Logout | +| :---------------------------------- | :---------------- | :----------- | :----------- | :-------------------- | :-------- | :------------- | :---------- | :------------------- | :--------- | :------------ | +| [Anonymous access](anonymous-auth/) | N/A | N/A | N/A | N/A | N/A | N/A | N/A | N/A | N/A | N/A | +| [Auth Proxy](auth-proxy/) | no | yes | yes | no | yes | no | N/A | no | N/A | N/A | +| [Azure AD OAuth](azuread/) | yes | yes | yes | yes | yes | yes | N/A | yes | yes | yes | +| [Basic auth](grafana/) | yes | N/A | yes | yes | N/A | N/A | N/A | N/A | N/A | N/A | +| [Passwordless auth](passwordless/) | yes | N/A | yes | yes | N/A | N/A | N/A | N/A | N/A | N/A | +| [Generic OAuth](generic-oauth/) | yes | yes | yes | yes | yes | no | N/A | yes | yes | yes | +| [GitHub OAuth](github/) | yes | yes | yes | yes | yes | yes | N/A | yes | yes | yes | +| [GitLab OAuth](gitlab/) | yes | yes | yes | yes | yes | yes | N/A | yes | yes | yes | +| [Google OAuth](google/) | yes | no | no | no | yes | no | N/A | no | yes | yes | +| [Grafana.com OAuth](grafana-cloud/) | no | no | yes | no | N/A | N/A | N/A | yes | yes | yes | +| [Okta OAuth](okta/) | yes | yes | yes | yes | yes | yes | N/A | yes | yes | yes | +| [SAML](saml/) (Enterprise only) | yes | yes | yes | yes | yes | yes | N/A | yes | yes | yes | +| [LDAP](ldap/) | yes | yes | yes | yes | yes | yes | yes | no | N/A | N/A | +| [JWT Proxy](jwt/) | no | yes | yes | yes | no | no | N/A | no | N/A | N/A | Fields explanation: @@ -61,7 +61,7 @@ Fields explanation: ## Configuring multiple identity providers Grafana allows you to configure more than one authentication provider, however it is not possible to configure the same type of authentication provider twice. -For example, you can have [SAML]({{< relref "./saml" >}}) (Enterprise only) and [Generic OAuth]({{< relref "./generic-oauth" >}}) configured, but you can not have two different [Generic OAuth]({{< relref "./generic-oauth" >}}) configurations. +For example, you can have [SAML](saml/) (Enterprise only) and [Generic OAuth](generic-oauth/) configured, but you can not have two different [Generic OAuth](generic-oauth/) configurations. > Note: Grafana does not support multiple identity providers resolving the same user. Ensure there are no user account overlaps between the different providers @@ -69,7 +69,7 @@ In scenarios where you have multiple identity providers of the same type, there - Use different Grafana instances each configured with a given identity provider. - Check if the identity provider supports account federation. In such cases, you can configure it once and let your identity provider federate the accounts from different providers. -- If SAML is supported by the identity provider, you can configure one [Generic OAuth]({{< relref "./generic-oauth" >}}) and one [SAML]({{< relref "./saml" >}}) (Enterprise only). +- If SAML is supported by the identity provider, you can configure one [Generic OAuth](generic-oauth/) and one [SAML](saml/) (Enterprise only). ## Using the same email address to login with different identity providers @@ -142,7 +142,7 @@ oauth_allow_insecure_email_lookup = true You can also enable email lookup using the API: {{% admonition type="note" %}} -Available in [Grafana Enterprise]({{< relref "../../../introduction/grafana-enterprise" >}}) and [Grafana Cloud]({{< relref "../../../introduction/grafana-cloud" >}}) since Grafana v10.4. +Available in [Grafana Enterprise](../../../introduction/grafana-enterprise/) and [Grafana Cloud](../../../introduction/grafana-cloud/) since Grafana v10.4. {{% /admonition %}} ``` @@ -208,7 +208,7 @@ a Grafana admin user, you can also do the same for any user from the Server Admi ### Protected roles {{% admonition type="note" %}} -Available in [Grafana Enterprise]({{< relref "../../../introduction/grafana-enterprise" >}}) and [Grafana Cloud]({{< relref "../../../introduction/grafana-cloud" >}}). +Available in [Grafana Enterprise](../../../introduction/grafana-enterprise/) and [Grafana Cloud](../../../introduction/grafana-cloud/). {{% /admonition %}} By default, after you configure an authorization provider, Grafana will adopt existing users into the new authentication scheme. For example, if you have created a user with basic authentication having the login `jsmith@example.com`, then set up SAML authentication where `jsmith@example.com` is an account, the user's authentication type will be changed to SAML if they perform a SAML sign-in. diff --git a/docs/sources/setup-grafana/configure-security/configure-authentication/auth-proxy/index.md b/docs/sources/setup-grafana/configure-security/configure-authentication/auth-proxy/index.md index 5ed036bb6ed..357cd103714 100644 --- a/docs/sources/setup-grafana/configure-security/configure-authentication/auth-proxy/index.md +++ b/docs/sources/setup-grafana/configure-security/configure-authentication/auth-proxy/index.md @@ -251,7 +251,7 @@ headers = "Groups:X-WEBAUTH-GROUPS" You use the `X-WEBAUTH-GROUPS` header to send the team information for each user. Specifically, the set of Grafana's group IDs that the user belongs to. -First, we need to set up the mapping between your authentication provider and Grafana. Follow [these instructions]({{< relref "../../configure-team-sync#synchronize-a-grafana-team-with-an-external-group" >}}) to add groups to a team within Grafana. +First, we need to set up the mapping between your authentication provider and Grafana. Follow [these instructions](../../configure-team-sync/#synchronize-a-grafana-team-with-an-external-group) to add groups to a team within Grafana. Once that's done. You can verify your mappings by querying the API. @@ -313,7 +313,7 @@ With this, the user `leonard` will be automatically placed into the Loki team as An empty `X-WEBAUTH-GROUPS` or the absence of a groups header will remove the user from all teams. {{% /admonition %}} -[Learn more about Team Sync]({{< relref "../../configure-team-sync" >}}) +[Learn more about Team Sync](../../configure-team-sync/) ## Login token and session cookie diff --git a/docs/sources/setup-grafana/configure-security/configure-authentication/azuread/index.md b/docs/sources/setup-grafana/configure-security/configure-authentication/azuread/index.md index 8ac7d9bd79f..fd1b2773749 100644 --- a/docs/sources/setup-grafana/configure-security/configure-authentication/azuread/index.md +++ b/docs/sources/setup-grafana/configure-security/configure-authentication/azuread/index.md @@ -22,7 +22,7 @@ weight: 800 The Azure AD authentication allows you to use a Microsoft Entra ID (formerly known as Azure Active Directory) tenant as an identity provider for Grafana. You can use Entra ID application roles to assign users and groups to Grafana roles from the Azure Portal. {{% admonition type="note" %}} -If Users use the same email address in Microsoft Entra ID that they use with other authentication providers (such as Grafana.com), you need to do additional configuration to ensure that the users are matched correctly. Please refer to [Using the same email address to login with different identity providers]({{< relref "../../configure-authentication#using-the-same-email-address-to-login-with-different-identity-providers" >}}) for more information. +If Users use the same email address in Microsoft Entra ID that they use with other authentication providers (such as Grafana.com), you need to do additional configuration to ensure that the users are matched correctly. Please refer to [Using the same email address to login with different identity providers](../#using-the-same-email-address-to-login-with-different-identity-providers) for more information. {{% /admonition %}} ## Create the Microsoft Entra ID application @@ -253,11 +253,11 @@ Refer to [Terraform Registry](https://registry.terraform.io/providers/grafana/gr ## Configure Azure AD authentication client using the Grafana configuration file -Ensure that you have access to the [Grafana configuration file]({{< relref "../../../configure-grafana#configuration-file-location" >}}). +Ensure that you have access to the [Grafana configuration file](../../../configure-grafana/#configuration-file-location). ### Enable Azure AD OAuth in Grafana -Add the following to the [Grafana configuration file]({{< relref "../../../configure-grafana#configuration-file-location" >}}): +Add the following to the [Grafana configuration file](../../../configure-grafana/#configuration-file-location): ``` [auth.azuread] @@ -293,7 +293,7 @@ GF_AUTH_AZUREAD_FEDERATED_CREDENTIAL_AUDIENCE ``` {{% admonition type="note" %}} -Verify that the Grafana [root_url]({{< relref "../../../configure-grafana#root_url" >}}) is set in your Azure Application Redirect URLs. +Verify that the Grafana [root_url](../../../configure-grafana/#root_url) is set in your Azure Application Redirect URLs. {{% /admonition %}} ### Configure refresh token @@ -417,7 +417,7 @@ Entra ID does not emit the groups claim in the token and emits a group overage c If Grafana receives a token with a group overage claim instead of a groups claim, Grafana attempts to retrieve the user's group membership by calling the included endpoint. -To ensure this functionality works correctly, you must enable [`force_use_graph_api`]({{< relref "./#force-fetching-groups-from-microsoft-graph-api" >}}) in your configuration. +To ensure this functionality works correctly, you must enable [`force_use_graph_api`](./#force-fetching-groups-from-microsoft-graph-api) in your configuration. {{% admonition type="note" %}} The 'App registration' must include the `GroupMember.Read.All` API permission for group overage claim calls to succeed. @@ -451,7 +451,7 @@ force_use_graph_api = true By default, Azure AD authentication will map users to organization roles based on the most privileged application role assigned to the user in Entra ID. If no application role is found, the user is assigned the role specified by -[the `auto_assign_org_role` option]({{< relref "../../../configure-grafana#auto_assign_org_role" >}}). +[the `auto_assign_org_role` option](../../../configure-grafana/#auto_assign_org_role). You can disable this default role assignment by setting `role_attribute_strict = true`. This setting denies user access if no role or an invalid role is returned and the `org_mapping` expression evaluates to an empty mapping. You can use the `org_mapping` configuration option to assign the user to multiple organizations and specify their role based on their Entra ID group membership. For more information, refer to [Org roles mapping example](#org-roles-mapping-example). If the org role mapping (`org_mapping`) is specified and Entra ID returns a valid role, then the user will get the highest of the two roles. @@ -476,7 +476,7 @@ org_mapping = ["032cb8e0-240f-4347-9120-6f33013e817a:org_foo:Viewer", "bce1c492- ## Skip organization role sync If Azure AD authentication is not intended to sync user roles and organization membership and prevent the sync of org roles from Entra ID, set `skip_org_role_sync` to `true`. This is useful if you want to manage the organization roles for your users from within Grafana or that your organization roles are synced from another provider. -See [Configure Grafana]({{< relref "../../../configure-grafana#authazuread" >}}) for more details. +See [Configure Grafana](../../../configure-grafana/#authazuread) for more details. ```ini [auth.azuread] @@ -487,7 +487,7 @@ skip_org_role_sync = true ## Configuration options -The following table outlines the various Azure AD/Entra ID configuration options. You can apply these options as environment variables, similar to any other configuration within Grafana. For more information, refer to [Override configuration with environment variables]({{< relref "../../../configure-grafana#override-configuration-with-environment-variables" >}}). +The following table outlines the various Azure AD/Entra ID configuration options. You can apply these options as environment variables, similar to any other configuration within Grafana. For more information, refer to [Override configuration with environment variables](../../../configure-grafana/#override-configuration-with-environment-variables). | Setting | Required | Supported on Cloud | Description | Default | | ---------------------------- | -------- | ------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------- | @@ -502,12 +502,12 @@ The following table outlines the various Azure AD/Entra ID configuration options | `scopes` | No | Yes | List of comma- or space-separated OAuth2 scopes. | `openid email profile` | | `allow_sign_up` | No | Yes | Controls Grafana user creation through the Azure AD/Entra ID login. Only existing Grafana users can log in with Azure AD/Entra ID if set to `false`. | `true` | | `auto_login` | No | Yes | Set to `true` to enable users to bypass the login screen and automatically log in. This setting is ignored if you configure multiple auth providers to use auto-login. | `false` | -| `role_attribute_strict` | No | Yes | Set to `true` to deny user login if the Grafana org role cannot be extracted using `role_attribute_path` or `org_mapping`. For more information on user role mapping, refer to [Map roles]({{< relref "#map-roles" >}}). | `false` | +| `role_attribute_strict` | No | Yes | Set to `true` to deny user login if the Grafana org role cannot be extracted using `role_attribute_path` or `org_mapping`. For more information on user role mapping, refer to [Map roles](#map-roles). | `false` | | `org_attribute_path` | No | No | [JMESPath](http://jmespath.org/examples.html) expression to use for Grafana org to role lookup. Grafana will first evaluate the expression using the OAuth2 ID token. If no value is returned, the expression will be evaluated using the user information obtained from the UserInfo endpoint. The result of the evaluation will be mapped to org roles based on `org_mapping`. For more information on org to role mapping, refer to [Org roles mapping example](#org-roles-mapping-example). | | | `org_mapping` | No | No | List of comma- or space-separated `::` mappings. Value can be `*` meaning "All users". Role is optional and can have the following values: `None`, `Viewer`, `Editor` or `Admin`. For more information on external organization to role mapping, refer to [Org roles mapping example](#org-roles-mapping-example). | | -| `allow_assign_grafana_admin` | No | No | Set to `true` to automatically sync the Grafana server administrator role. When enabled, if the Azure AD/Entra ID user's App role is `GrafanaAdmin`, Grafana grants the user server administrator privileges and the organization administrator role. If disabled, the user will only receive the organization administrator role. For more details on user role mapping, refer to [Map roles]({{< relref "#map-roles" >}}). | `false` | +| `allow_assign_grafana_admin` | No | No | Set to `true` to automatically sync the Grafana server administrator role. When enabled, if the Azure AD/Entra ID user's App role is `GrafanaAdmin`, Grafana grants the user server administrator privileges and the organization administrator role. If disabled, the user will only receive the organization administrator role. For more details on user role mapping, refer to [Map roles](#map-roles). | `false` | | `skip_org_role_sync` | No | Yes | Set to `true` to stop automatically syncing user roles. This will allow you to set organization roles for your users from within Grafana manually. | `false` | -| `allowed_groups` | No | Yes | List of comma- or space-separated groups. The user should be a member of at least one group to log in. If you configure `allowed_groups`, you must also configure Azure AD/Entra ID to include the `groups` claim following [Configure group membership claims on the Azure Portal]({{< relref "#configure-group-membership-claims-on-the-azure-portal" >}}). | | +| `allowed_groups` | No | Yes | List of comma- or space-separated groups. The user should be a member of at least one group to log in. If you configure `allowed_groups`, you must also configure Azure AD/Entra ID to include the `groups` claim following [Configure group membership claims on the Azure Portal](#configure-group-membership-claims-on-the-azure-portal). | | | `allowed_organizations` | No | Yes | List of comma- or space-separated Azure tenant identifiers. The user should be a member of at least one tenant to log in. | | | `allowed_domains` | No | Yes | List of comma- or space-separated domains. The user should belong to at least one domain to log in. | | | `tls_skip_verify_insecure` | No | No | If set to `true`, the client accepts any certificate presented by the server and any host name in that certificate. _You should only use this for testing_, because this mode leaves SSL/TLS susceptible to man-in-the-middle attacks. | `false` | diff --git a/docs/sources/setup-grafana/configure-security/configure-authentication/enhanced-ldap/index.md b/docs/sources/setup-grafana/configure-security/configure-authentication/enhanced-ldap/index.md index a8992e015d6..ee6f7c6335f 100644 --- a/docs/sources/setup-grafana/configure-security/configure-authentication/enhanced-ldap/index.md +++ b/docs/sources/setup-grafana/configure-security/configure-authentication/enhanced-ldap/index.md @@ -21,12 +21,12 @@ weight: 400 # Configure enhanced LDAP integration -The enhanced LDAP integration adds additional functionality on top of the [LDAP integration]({{< relref "../ldap" >}}) available in the open source edition of Grafana. +The enhanced LDAP integration adds additional functionality on top of the [LDAP integration](../ldap/) available in the open source edition of Grafana. -> **Note:** Available in [Grafana Enterprise]({{< relref "../../../../introduction/grafana-enterprise" >}}) and [Grafana Cloud](/docs/grafana-cloud). +> **Note:** Available in [Grafana Enterprise](../../../../introduction/grafana-enterprise/) and [Grafana Cloud](/docs/grafana-cloud). > If you are a Grafana Cloud customer, please [open a support ticket in the Cloud Portal](/profile/org#support) to request this feature. -> To control user access with role-based permissions, refer to [role-based access control]({{< relref "../../../../administration/roles-and-permissions/access-control" >}}). +> To control user access with role-based permissions, refer to [role-based access control](../../../../administration/roles-and-permissions/access-control/). ## LDAP group synchronization @@ -70,7 +70,7 @@ sync_cron = "0 1 * * *" # This is default value (At 1 am every day) active_sync_enabled = true # enabled by default ``` -Single bind configuration (as in the [Single bind example]({{< relref "../ldap#single-bind-example" >}})) is not supported with active LDAP synchronization because Grafana needs user information to perform LDAP searches. +Single bind configuration (as in the [Single bind example](../ldap/#single-bind-example)) is not supported with active LDAP synchronization because Grafana needs user information to perform LDAP searches. For the synchronization to work, the `servers.search_filter` and `servers.attributes.username` in the ldap.toml config file must match. By default, the `servers.attributes.username` is `cn`, so if you use another attribute as the search filter, you must also update the username attribute. diff --git a/docs/sources/setup-grafana/configure-security/configure-authentication/generic-oauth/index.md b/docs/sources/setup-grafana/configure-security/configure-authentication/generic-oauth/index.md index 1c9571f712d..99e9abb057a 100644 --- a/docs/sources/setup-grafana/configure-security/configure-authentication/generic-oauth/index.md +++ b/docs/sources/setup-grafana/configure-security/configure-authentication/generic-oauth/index.md @@ -23,17 +23,17 @@ weight: 700 Grafana provides OAuth2 integrations for the following auth providers: -- [Azure AD OAuth]({{< relref "../azuread" >}}) -- [GitHub OAuth]({{< relref "../github" >}}) -- [GitLab OAuth]({{< relref "../gitlab" >}}) -- [Google OAuth]({{< relref "../google" >}}) -- [Grafana Com OAuth]({{< relref "../grafana-cloud" >}}) -- [Keycloak OAuth]({{< relref "../keycloak" >}}) -- [Okta OAuth]({{< relref "../okta" >}}) +- [Azure AD OAuth](../azuread/) +- [GitHub OAuth](../github/) +- [GitLab OAuth](../gitlab/) +- [Google OAuth](../google/) +- [Grafana Com OAuth](../grafana-cloud/) +- [Keycloak OAuth](../keycloak/) +- [Okta OAuth](../okta/) If your OAuth2 provider is not listed, you can use Generic OAuth authentication. -This topic describes how to configure Generic OAuth authentication using different methods and includes [examples of setting up Generic OAuth]({{< relref "#examples-of-setting-up-generic-oauth2" >}}) with specific OAuth2 providers. +This topic describes how to configure Generic OAuth authentication using different methods and includes [examples of setting up Generic OAuth](#examples-of-setting-up-generic-oauth2) with specific OAuth2 providers. ## Before you begin @@ -44,7 +44,7 @@ To follow this guide: - If you are using refresh tokens, ensure you know how to set them up with your OAuth2 provider. Consult the documentation of your OAuth2 provider for more information. {{% admonition type="note" %}} -If Users use the same email address in Azure AD that they use with other authentication providers (such as Grafana.com), you need to do additional configuration to ensure that the users are matched correctly. Please refer to the [Using the same email address to login with different identity providers]({{< relref "../../configure-authentication#using-the-same-email-address-to-login-with-different-identity-providers" >}}) documentation for more information. +If Users use the same email address in Azure AD that they use with other authentication providers (such as Grafana.com), you need to do additional configuration to ensure that the users are matched correctly. Please refer to the [Using the same email address to login with different identity providers](../#using-the-same-email-address-to-login-with-different-identity-providers) documentation for more information. {{% /admonition %}} ## Configure generic OAuth authentication client using the Grafana UI @@ -63,7 +63,7 @@ If you need to reset changes you made in the UI back to the default values, clic If you run Grafana in high availability mode, configuration changes may not get applied to all Grafana instances immediately. You may need to wait a few minutes for the configuration to propagate to all Grafana instances. {{% /admonition %}} -Refer to [configuration options]({{< relref "#configuration-options" >}}) for more information. +Refer to [configuration options](#configuration-options) for more information. ## Configure generic OAuth authentication client using the Terraform provider @@ -94,7 +94,7 @@ Refer to [Terraform Registry](https://registry.terraform.io/providers/grafana/gr ## Configure generic OAuth authentication client using the Grafana configuration file -Ensure that you have access to the [Grafana configuration file]({{< relref "../../../configure-grafana#configuration-file-location" >}}). +Ensure that you have access to the [Grafana configuration file](../../../configure-grafana/#configuration-file-location). ### Steps @@ -116,9 +116,9 @@ To integrate your OAuth2 provider with Grafana using our Generic OAuth authentic | `api_url` | The user information endpoint of your OAuth2 provider. Information returned by this endpoint must be compatible with [OpenID UserInfo](https://connect2id.com/products/server/docs/api/userinfo). | | `enabled` | Enables Generic OAuth authentication. Set this value to `true`. | - Review the list of other Generic OAuth [configuration options]({{< relref "#configuration-options" >}}) and complete them, as necessary. + Review the list of other Generic OAuth [configuration options](#configuration-options) and complete them, as necessary. -1. Optional: [Configure a refresh token]({{< relref "#configure-a-refresh-token" >}}): +1. Optional: [Configure a refresh token](#configure-a-refresh-token): a. Extend the `scopes` field of `[auth.generic_oauth]` section in Grafana configuration file with refresh token scope used by your OAuth2 provider. @@ -126,8 +126,8 @@ To integrate your OAuth2 provider with Grafana using our Generic OAuth authentic c. Enable the refresh token on the provider if required. -1. [Configure role mapping]({{< relref "#configure-role-mapping" >}}). -1. Optional: [Configure group synchronization]({{< relref "#configure-group-synchronization" >}}). +1. [Configure role mapping](#configure-role-mapping). +1. Optional: [Configure group synchronization](#configure-group-synchronization). 1. Restart Grafana. You should now see a Generic OAuth login button on the login page and be able to log in or sign up with your OAuth2 provider. @@ -198,9 +198,9 @@ Unless `skip_org_role_sync` option is enabled, the user's role will be set to th The user's role is retrieved using a [JMESPath](http://jmespath.org/examples.html) expression from the `role_attribute_path` configuration option. To map the server administrator role, use the `allow_assign_grafana_admin` configuration option. -Refer to [configuration options]({{< relref "#configuration-options" >}}) for more information. +Refer to [configuration options](#configuration-options) for more information. -If no valid role is found, the user is assigned the role specified by [the `auto_assign_org_role` option]({{< relref "../../../configure-grafana#auto_assign_org_role" >}}). +If no valid role is found, the user is assigned the role specified by [the `auto_assign_org_role` option](../../../configure-grafana/#auto_assign_org_role). You can disable this default role assignment by setting `role_attribute_strict = true`. This setting denies user access if no role or an invalid role is returned after evaluating the `role_attribute_path` and the `org_mapping` expressions. You can use the `org_attribute_path` and `org_mapping` configuration options to assign the user to organizations and specify their role. For more information, refer to [Org roles mapping example](#org-roles-mapping-example). If both org role mapping (`org_mapping`) and the regular role mapping (`role_attribute_path`) are specified, then the user will get the highest of the two mapped roles. @@ -320,7 +320,7 @@ Grafana supports synchronization of OAuth2 groups with Grafana teams and roles. Teams and roles get synchronized when the user logs in. Generic OAuth groups can be referenced by group ID, such as `8bab1c86-8fba-33e5-2089-1d1c80ec267d` or `myteam`. -For information on configuring OAuth2 groups with Grafana using the `groups_attribute_path` configuration option, refer to [configuration options]({{< relref "#configuration-options" >}}). +For information on configuring OAuth2 groups with Grafana using the `groups_attribute_path` configuration option, refer to [configuration options](#configuration-options). To learn more about group synchronization, refer to [Configure team sync](https://grafana.com/docs/grafana//setup-grafana/configure-security/configure-team-sync) and [Configure group attribute sync](https://grafana.com/docs/grafana//setup-grafana/configure-security/configure-group-attribute-sync). @@ -347,52 +347,52 @@ Payload: ## Configuration options -The following table outlines the various Generic OAuth configuration options. You can apply these options as environment variables, similar to any other configuration within Grafana. For more information, refer to [Override configuration with environment variables]({{< relref "../../../configure-grafana#override-configuration-with-environment-variables" >}}). +The following table outlines the various Generic OAuth configuration options. You can apply these options as environment variables, similar to any other configuration within Grafana. For more information, refer to [Override configuration with environment variables](../../../configure-grafana/#override-configuration-with-environment-variables). {{< admonition type="note" >}} If the configuration option requires a JMESPath expression that includes a colon, enclose the entire expression in quotes to prevent parsing errors. For example `role_attribute_path: "role:view"` {{< /admonition >}} -| Setting | Required | Supported on Cloud | Description | Default | -| ---------------------------- | -------- | ------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------- | -| `enabled` | No | Yes | Enables Generic OAuth authentication. | `false` | -| `name` | No | Yes | Name that refers to the Generic OAuth authentication from the Grafana user interface. | `OAuth` | -| `icon` | No | Yes | Icon used for the Generic OAuth authentication in the Grafana user interface. | `signin` | -| `client_id` | Yes | Yes | Client ID provided by your OAuth2 app. | | -| `client_secret` | Yes | Yes | Client secret provided by your OAuth2 app. | | -| `auth_url` | Yes | Yes | Authorization endpoint of your OAuth2 provider. | | -| `token_url` | Yes | Yes | Endpoint used to obtain the OAuth2 access token. | | -| `api_url` | Yes | Yes | Endpoint used to obtain user information compatible with [OpenID UserInfo](https://connect2id.com/products/server/docs/api/userinfo). | | -| `auth_style` | No | Yes | Name of the [OAuth2 AuthStyle](https://pkg.go.dev/golang.org/x/oauth2#AuthStyle) to be used when ID token is requested from OAuth2 provider. It determines how `client_id` and `client_secret` are sent to Oauth2 provider. Available values are `AutoDetect`, `InParams` and `InHeader`. | `AutoDetect` | -| `scopes` | No | Yes | List of comma- or space-separated OAuth2 scopes. | `user:email` | -| `empty_scopes` | No | Yes | Set to `true` to use an empty scope during authentication. | `false` | -| `allow_sign_up` | No | Yes | Controls Grafana user creation through the Generic OAuth login. Only existing Grafana users can log in with Generic OAuth if set to `false`. | `true` | -| `auto_login` | No | Yes | Set to `true` to enable users to bypass the login screen and automatically log in. This setting is ignored if you configure multiple auth providers to use auto-login. | `false` | -| `id_token_attribute_name` | No | Yes | The name of the key used to extract the ID token from the returned OAuth2 token. | `id_token` | -| `login_attribute_path` | No | Yes | [JMESPath](http://jmespath.org/examples.html) expression to use for user login lookup from the user ID token. For more information on how user login is retrieved, refer to [Configure login]({{< relref "#configure-login" >}}). | | -| `name_attribute_path` | No | Yes | [JMESPath](http://jmespath.org/examples.html) expression to use for user name lookup from the user ID token. This name will be used as the user's display name. For more information on how user display name is retrieved, refer to [Configure display name]({{< relref "#configure-display-name" >}}). | | -| `email_attribute_path` | No | Yes | [JMESPath](http://jmespath.org/examples.html) expression to use for user email lookup from the user information. For more information on how user email is retrieved, refer to [Configure email address]({{< relref "#configure-email-address" >}}). | | -| `email_attribute_name` | No | Yes | Name of the key to use for user email lookup within the `attributes` map of OAuth2 ID token. For more information on how user email is retrieved, refer to [Configure email address]({{< relref "#configure-email-address" >}}). | `email:primary` | -| `role_attribute_path` | No | Yes | [JMESPath](http://jmespath.org/examples.html) expression to use for Grafana role lookup. Grafana will first evaluate the expression using the OAuth2 ID token. If no role is found, the expression will be evaluated using the user information obtained from the UserInfo endpoint. The result of the evaluation should be a valid Grafana role (`None`, `Viewer`, `Editor`, `Admin` or `GrafanaAdmin`). For more information on user role mapping, refer to [Configure role mapping]({{< relref "#configure-role-mapping" >}}). | | -| `role_attribute_strict` | No | Yes | Set to `true` to deny user login if the Grafana org role cannot be extracted using `role_attribute_path` or `org_mapping`. For more information on user role mapping, refer to [Configure role mapping]({{< relref "#configure-role-mapping" >}}). | `false` | -| `skip_org_role_sync` | No | Yes | Set to `true` to stop automatically syncing user roles. This will allow you to set organization roles for your users from within Grafana manually. | `false` | -| `org_attribute_path` | No | No | [JMESPath](http://jmespath.org/examples.html) expression to use for Grafana org to role lookup. Grafana will first evaluate the expression using the OAuth2 ID token. If no value is returned, the expression will be evaluated using the user information obtained from the UserInfo endpoint. The result of the evaluation will be mapped to org roles based on `org_mapping`. For more information on org to role mapping, refer to [Org roles mapping example](#org-roles-mapping-example). | | -| `org_mapping` | No | No | List of comma- or space-separated `::` mappings. Value can be `*` meaning "All users". Role is optional and can have the following values: `None`, `Viewer`, `Editor` or `Admin`. For more information on external organization to role mapping, refer to [Org roles mapping example](#org-roles-mapping-example). | | -| `allow_assign_grafana_admin` | No | No | Set to `true` to enable automatic sync of the Grafana server administrator role. If this option is set to `true` and the result of evaluating `role_attribute_path` for a user is `GrafanaAdmin`, Grafana grants the user the server administrator privileges and organization administrator role. If this option is set to `false` and the result of evaluating `role_attribute_path` for a user is `GrafanaAdmin`, Grafana grants the user only organization administrator role. For more information on user role mapping, refer to [Configure role mapping]({{< relref "#configure-role-mapping" >}}). | `false` | -| `groups_attribute_path` | No | Yes | [JMESPath](http://jmespath.org/examples.html) expression to use for user group lookup. Grafana will first evaluate the expression using the OAuth2 ID token. If no groups are found, the expression will be evaluated using the user information obtained from the UserInfo endpoint. The result of the evaluation should be a string array of groups. | | -| `allowed_groups` | No | Yes | List of comma- or space-separated groups. The user should be a member of at least one group to log in. If you configure `allowed_groups`, you must also configure `groups_attribute_path`. | | -| `allowed_organizations` | No | Yes | List of comma- or space-separated organizations. The user should be a member of at least one organization to log in. | | -| `allowed_domains` | No | Yes | List of comma- or space-separated domains. The user should belong to at least one domain to log in. | | -| `team_ids` | No | Yes | String list of team IDs. If set, the user must be a member of one of the given teams to log in. If you configure `team_ids`, you must also configure `teams_url` and `team_ids_attribute_path`. | | -| `team_ids_attribute_path` | No | Yes | The [JMESPath](http://jmespath.org/examples.html) expression to use for Grafana team ID lookup within the results returned by the `teams_url` endpoint. | | -| `teams_url` | No | Yes | The URL used to query for team IDs. If not set, the default value is `/teams`. If you configure `teams_url`, you must also configure `team_ids_attribute_path`. | | -| `tls_skip_verify_insecure` | No | No | If set to `true`, the client accepts any certificate presented by the server and any host name in that certificate. _You should only use this for testing_, because this mode leaves SSL/TLS susceptible to man-in-the-middle attacks. | `false` | -| `tls_client_cert` | No | No | The path to the certificate. | | -| `tls_client_key` | No | No | The path to the key. | | -| `tls_client_ca` | No | No | The path to the trusted certificate authority list. | | -| `use_pkce` | No | Yes | Set to `true` to use [Proof Key for Code Exchange (PKCE)](https://datatracker.ietf.org/doc/html/rfc7636). Grafana uses the SHA256 based `S256` challenge method and a 128 bytes (base64url encoded) code verifier. | `false` | -| `use_refresh_token` | No | Yes | Set to `true` to use refresh token and check access token expiration. | `false` | -| `signout_redirect_url` | No | Yes | URL to redirect to after the user logs out. | | +| Setting | Required | Supported on Cloud | Description | Default | +| ---------------------------- | -------- | ------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------- | +| `enabled` | No | Yes | Enables Generic OAuth authentication. | `false` | +| `name` | No | Yes | Name that refers to the Generic OAuth authentication from the Grafana user interface. | `OAuth` | +| `icon` | No | Yes | Icon used for the Generic OAuth authentication in the Grafana user interface. | `signin` | +| `client_id` | Yes | Yes | Client ID provided by your OAuth2 app. | | +| `client_secret` | Yes | Yes | Client secret provided by your OAuth2 app. | | +| `auth_url` | Yes | Yes | Authorization endpoint of your OAuth2 provider. | | +| `token_url` | Yes | Yes | Endpoint used to obtain the OAuth2 access token. | | +| `api_url` | Yes | Yes | Endpoint used to obtain user information compatible with [OpenID UserInfo](https://connect2id.com/products/server/docs/api/userinfo). | | +| `auth_style` | No | Yes | Name of the [OAuth2 AuthStyle](https://pkg.go.dev/golang.org/x/oauth2#AuthStyle) to be used when ID token is requested from OAuth2 provider. It determines how `client_id` and `client_secret` are sent to Oauth2 provider. Available values are `AutoDetect`, `InParams` and `InHeader`. | `AutoDetect` | +| `scopes` | No | Yes | List of comma- or space-separated OAuth2 scopes. | `user:email` | +| `empty_scopes` | No | Yes | Set to `true` to use an empty scope during authentication. | `false` | +| `allow_sign_up` | No | Yes | Controls Grafana user creation through the Generic OAuth login. Only existing Grafana users can log in with Generic OAuth if set to `false`. | `true` | +| `auto_login` | No | Yes | Set to `true` to enable users to bypass the login screen and automatically log in. This setting is ignored if you configure multiple auth providers to use auto-login. | `false` | +| `id_token_attribute_name` | No | Yes | The name of the key used to extract the ID token from the returned OAuth2 token. | `id_token` | +| `login_attribute_path` | No | Yes | [JMESPath](http://jmespath.org/examples.html) expression to use for user login lookup from the user ID token. For more information on how user login is retrieved, refer to [Configure login](#configure-login). | | +| `name_attribute_path` | No | Yes | [JMESPath](http://jmespath.org/examples.html) expression to use for user name lookup from the user ID token. This name will be used as the user's display name. For more information on how user display name is retrieved, refer to [Configure display name](#configure-display-name). | | +| `email_attribute_path` | No | Yes | [JMESPath](http://jmespath.org/examples.html) expression to use for user email lookup from the user information. For more information on how user email is retrieved, refer to [Configure email address](#configure-email-address). | | +| `email_attribute_name` | No | Yes | Name of the key to use for user email lookup within the `attributes` map of OAuth2 ID token. For more information on how user email is retrieved, refer to [Configure email address](#configure-email-address). | `email:primary` | +| `role_attribute_path` | No | Yes | [JMESPath](http://jmespath.org/examples.html) expression to use for Grafana role lookup. Grafana will first evaluate the expression using the OAuth2 ID token. If no role is found, the expression will be evaluated using the user information obtained from the UserInfo endpoint. The result of the evaluation should be a valid Grafana role (`None`, `Viewer`, `Editor`, `Admin` or `GrafanaAdmin`). For more information on user role mapping, refer to [Configure role mapping](#configure-role-mapping). | | +| `role_attribute_strict` | No | Yes | Set to `true` to deny user login if the Grafana org role cannot be extracted using `role_attribute_path` or `org_mapping`. For more information on user role mapping, refer to [Configure role mapping](#configure-role-mapping). | `false` | +| `skip_org_role_sync` | No | Yes | Set to `true` to stop automatically syncing user roles. This will allow you to set organization roles for your users from within Grafana manually. | `false` | +| `org_attribute_path` | No | No | [JMESPath](http://jmespath.org/examples.html) expression to use for Grafana org to role lookup. Grafana will first evaluate the expression using the OAuth2 ID token. If no value is returned, the expression will be evaluated using the user information obtained from the UserInfo endpoint. The result of the evaluation will be mapped to org roles based on `org_mapping`. For more information on org to role mapping, refer to [Org roles mapping example](#org-roles-mapping-example). | | +| `org_mapping` | No | No | List of comma- or space-separated `::` mappings. Value can be `*` meaning "All users". Role is optional and can have the following values: `None`, `Viewer`, `Editor` or `Admin`. For more information on external organization to role mapping, refer to [Org roles mapping example](#org-roles-mapping-example). | | +| `allow_assign_grafana_admin` | No | No | Set to `true` to enable automatic sync of the Grafana server administrator role. If this option is set to `true` and the result of evaluating `role_attribute_path` for a user is `GrafanaAdmin`, Grafana grants the user the server administrator privileges and organization administrator role. If this option is set to `false` and the result of evaluating `role_attribute_path` for a user is `GrafanaAdmin`, Grafana grants the user only organization administrator role. For more information on user role mapping, refer to [Configure role mapping](#configure-role-mapping). | `false` | +| `groups_attribute_path` | No | Yes | [JMESPath](http://jmespath.org/examples.html) expression to use for user group lookup. Grafana will first evaluate the expression using the OAuth2 ID token. If no groups are found, the expression will be evaluated using the user information obtained from the UserInfo endpoint. The result of the evaluation should be a string array of groups. | | +| `allowed_groups` | No | Yes | List of comma- or space-separated groups. The user should be a member of at least one group to log in. If you configure `allowed_groups`, you must also configure `groups_attribute_path`. | | +| `allowed_organizations` | No | Yes | List of comma- or space-separated organizations. The user should be a member of at least one organization to log in. | | +| `allowed_domains` | No | Yes | List of comma- or space-separated domains. The user should belong to at least one domain to log in. | | +| `team_ids` | No | Yes | String list of team IDs. If set, the user must be a member of one of the given teams to log in. If you configure `team_ids`, you must also configure `teams_url` and `team_ids_attribute_path`. | | +| `team_ids_attribute_path` | No | Yes | The [JMESPath](http://jmespath.org/examples.html) expression to use for Grafana team ID lookup within the results returned by the `teams_url` endpoint. | | +| `teams_url` | No | Yes | The URL used to query for team IDs. If not set, the default value is `/teams`. If you configure `teams_url`, you must also configure `team_ids_attribute_path`. | | +| `tls_skip_verify_insecure` | No | No | If set to `true`, the client accepts any certificate presented by the server and any host name in that certificate. _You should only use this for testing_, because this mode leaves SSL/TLS susceptible to man-in-the-middle attacks. | `false` | +| `tls_client_cert` | No | No | The path to the certificate. | | +| `tls_client_key` | No | No | The path to the key. | | +| `tls_client_ca` | No | No | The path to the trusted certificate authority list. | | +| `use_pkce` | No | Yes | Set to `true` to use [Proof Key for Code Exchange (PKCE)](https://datatracker.ietf.org/doc/html/rfc7636). Grafana uses the SHA256 based `S256` challenge method and a 128 bytes (base64url encoded) code verifier. | `false` | +| `use_refresh_token` | No | Yes | Set to `true` to use refresh token and check access token expiration. | `false` | +| `signout_redirect_url` | No | Yes | URL to redirect to after the user logs out. | | ## Examples of setting up Generic OAuth @@ -435,7 +435,7 @@ To set up Generic OAuth authentication with Descope, follow these steps: ### Set up OAuth2 with Auth0 {{< admonition type="note" >}} -Support for the Auth0 "audience" feature is not currently available in Grafana. For roles and permissions, the available options are described [here]({{< relref "../../../../administration/roles-and-permissions/" >}}). +Support for the Auth0 "audience" feature is not currently available in Grafana. For roles and permissions, the available options are described [here](../../../../administration/roles-and-permissions/). {{< /admonition >}} To set up Generic OAuth authentication with Auth0, follow these steps: @@ -577,4 +577,4 @@ steps: `` corresponds to the `issuer: ` configuration in Dex (e.g. the Dex domain possibly including a path such as e.g. `/dex`). The `offline_access` scope is - needed when using [refresh tokens]({{< relref "#configure-a-refresh-token" >}}). + needed when using [refresh tokens](#configure-a-refresh-token). diff --git a/docs/sources/setup-grafana/configure-security/configure-authentication/github/index.md b/docs/sources/setup-grafana/configure-security/configure-authentication/github/index.md index 5792c3a4a70..ffde83ab6d1 100644 --- a/docs/sources/setup-grafana/configure-security/configure-authentication/github/index.md +++ b/docs/sources/setup-grafana/configure-security/configure-authentication/github/index.md @@ -24,7 +24,7 @@ weight: 900 This topic describes how to configure GitHub OAuth authentication. {{% admonition type="note" %}} -If Users use the same email address in GitHub that they use with other authentication providers (such as Grafana.com), you need to do additional configuration to ensure that the users are matched correctly. Please refer to the [Using the same email address to login with different identity providers]({{< relref "../../configure-authentication#using-the-same-email-address-to-login-with-different-identity-providers" >}}) documentation for more information. +If Users use the same email address in GitHub that they use with other authentication providers (such as Grafana.com), you need to do additional configuration to ensure that the users are matched correctly. Please refer to the [Using the same email address to login with different identity providers](../#using-the-same-email-address-to-login-with-different-identity-providers) documentation for more information. {{% /admonition %}} ## Before you begin @@ -57,7 +57,7 @@ If you need to reset changes you made in the UI back to the default values, clic If you run Grafana in high availability mode, configuration changes may not get applied to all Grafana instances immediately. You may need to wait a few minutes for the configuration to propagate to all Grafana instances. {{% /admonition %}} -Refer to [configuration options]({{< relref "#configuration-options" >}}) for more information. +Refer to [configuration options](#configuration-options) for more information. ## Configure GitHub authentication client using the Terraform provider @@ -87,7 +87,7 @@ Go to [Terraform Registry](https://registry.terraform.io/providers/grafana/grafa ## Configure GitHub authentication client using the Grafana configuration file -Ensure that you have access to the [Grafana configuration file]({{< relref "../../../configure-grafana#configuration-file-location" >}}). +Ensure that you have access to the [Grafana configuration file](../../../configure-grafana/#configuration-file-location). ### Configure GitHub authentication @@ -107,10 +107,10 @@ To configure GitHub authentication with Grafana, follow these steps: | `client_id`, `client_secret` | These values must match the client ID and client secret from your GitHub OAuth app. | | `enabled` | Enables GitHub authentication. Set this value to `true`. | - Review the list of other GitHub [configuration options]({{< relref "#configuration-options" >}}) and complete them, as necessary. + Review the list of other GitHub [configuration options](#configuration-options) and complete them, as necessary. -1. [Configure role mapping]({{< relref "#configure-role-mapping" >}}). -1. Optional: [Configure group synchronization]({{< relref "#configure-group-synchronization" >}}). +1. [Configure role mapping](#configure-role-mapping). +1. Optional: [Configure group synchronization](#configure-group-synchronization). 1. Restart Grafana. You should now see a GitHub login button on the login page and be able to log in or sign up with your GitHub accounts. @@ -121,9 +121,9 @@ Unless `skip_org_role_sync` option is enabled, the user's role will be set to th The user's role is retrieved using a [JMESPath](http://jmespath.org/examples.html) expression from the `role_attribute_path` configuration option. To map the server administrator role, use the `allow_assign_grafana_admin` configuration option. -Refer to [configuration options]({{< relref "#configuration-options" >}}) for more information. +Refer to [configuration options](#configuration-options) for more information. -If no valid role is found, the user is assigned the role specified by [the `auto_assign_org_role` option]({{< relref "../../../configure-grafana#auto_assign_org_role" >}}). +If no valid role is found, the user is assigned the role specified by [the `auto_assign_org_role` option](../../../configure-grafana/#auto_assign_org_role). You can disable this default role assignment by setting `role_attribute_strict = true`. This setting denies user access if no role or an invalid role is returned after evaluating the `role_attribute_path` and the `org_mapping` expressions. You can use the `org_mapping` configuration options to assign the user to organizations and specify their role based on their GitHub team membership. For more information, refer to [Org roles mapping example](#org-roles-mapping-example). If both org role mapping (`org_mapping`) and the regular role mapping (`role_attribute_path`) are specified, then the user will get the highest of the two mapped roles. @@ -236,7 +236,7 @@ To learn more about group synchronization, refer to [Configure team sync](https: ## Configuration options -The table below describes all GitHub OAuth configuration options. You can apply these options as environment variables, similar to any other configuration within Grafana. For more information, refer to [Override configuration with environment variables]({{< relref "../../../configure-grafana#override-configuration-with-environment-variables" >}}). +The table below describes all GitHub OAuth configuration options. You can apply these options as environment variables, similar to any other configuration within Grafana. For more information, refer to [Override configuration with environment variables](../../../configure-grafana/#override-configuration-with-environment-variables). {{< admonition type="note" >}} If the configuration option requires a JMESPath expression that includes a colon, enclose the entire expression in quotes to prevent parsing errors. For example `role_attribute_path: "role:view"` @@ -259,7 +259,7 @@ If the configuration option requires a JMESPath expression that includes a colon | `role_attribute_strict` | No | Yes | Set to `true` to deny user login if the Grafana org role cannot be extracted using `role_attribute_path` or `org_mapping`. For more information on user role mapping, refer to [Configure role mapping](#org-roles-mapping-example). | `false` | | `org_mapping` | No | No | List of comma- or space-separated `::` mappings. Value can be `*` meaning "All users". Role is optional and can have the following values: `None`, `Viewer`, `Editor` or `Admin`. For more information on external organization to role mapping, refer to [Org roles mapping example](#org-roles-mapping-example). | | | `skip_org_role_sync` | No | Yes | Set to `true` to stop automatically syncing user roles. | `false` | -| `allow_assign_grafana_admin` | No | No | Set to `true` to enable automatic sync of the Grafana server administrator role. If this option is set to `true` and the result of evaluating `role_attribute_path` for a user is `GrafanaAdmin`, Grafana grants the user the server administrator privileges and organization administrator role. If this option is set to `false` and the result of evaluating `role_attribute_path` for a user is `GrafanaAdmin`, Grafana grants the user only organization administrator role. For more information on user role mapping, refer to [Configure role mapping]({{< relref "#configure-role-mapping" >}}). | `false` | +| `allow_assign_grafana_admin` | No | No | Set to `true` to enable automatic sync of the Grafana server administrator role. If this option is set to `true` and the result of evaluating `role_attribute_path` for a user is `GrafanaAdmin`, Grafana grants the user the server administrator privileges and organization administrator role. If this option is set to `false` and the result of evaluating `role_attribute_path` for a user is `GrafanaAdmin`, Grafana grants the user only organization administrator role. For more information on user role mapping, refer to [Configure role mapping](#configure-role-mapping). | `false` | | `allowed_organizations` | No | Yes | List of comma- or space-separated organizations. User must be a member of at least one organization to log in. | | | `allowed_domains` | No | Yes | List of comma- or space-separated domains. User must belong to at least one domain to log in. | | | `team_ids` | No | Yes | Integer list of team IDs. If set, user has to be a member of one of the given teams to log in. | | diff --git a/docs/sources/setup-grafana/configure-security/configure-authentication/gitlab/index.md b/docs/sources/setup-grafana/configure-security/configure-authentication/gitlab/index.md index d1503808910..230eeb1873f 100644 --- a/docs/sources/setup-grafana/configure-security/configure-authentication/gitlab/index.md +++ b/docs/sources/setup-grafana/configure-security/configure-authentication/gitlab/index.md @@ -24,7 +24,7 @@ weight: 1000 This topic describes how to configure GitLab OAuth authentication. {{% admonition type="note" %}} -If Users use the same email address in GitLab that they use with other authentication providers (such as Grafana.com), you need to do additional configuration to ensure that the users are matched correctly. Please refer to the [Using the same email address to login with different identity providers]({{< relref "../../configure-authentication#using-the-same-email-address-to-login-with-different-identity-providers" >}}) documentation for more information. +If Users use the same email address in GitLab that they use with other authentication providers (such as Grafana.com), you need to do additional configuration to ensure that the users are matched correctly. Please refer to the [Using the same email address to login with different identity providers](../#using-the-same-email-address-to-login-with-different-identity-providers) documentation for more information. {{% /admonition %}} ## Before you begin @@ -57,7 +57,7 @@ If you need to reset changes you made in the UI back to the default values, clic If you run Grafana in high availability mode, configuration changes may not get applied to all Grafana instances immediately. You may need to wait a few minutes for the configuration to propagate to all Grafana instances. {{% /admonition %}} -Refer to [configuration options]({{< relref "#configuration-options" >}}) for more information. +Refer to [configuration options](#configuration-options) for more information. ## Configure GitLab authentication client using the Terraform provider @@ -89,7 +89,7 @@ Go to [Terraform Registry](https://registry.terraform.io/providers/grafana/grafa ## Configure GitLab authentication client using the Grafana configuration file -Ensure that you have access to the [Grafana configuration file]({{< relref "../../../configure-grafana#configuration-file-location" >}}). +Ensure that you have access to the [Grafana configuration file](../../../configure-grafana/#configuration-file-location). ### Steps @@ -112,14 +112,14 @@ To configure GitLab authentication with Grafana, follow these steps: | `client_id`, `client_secret` | These values must match the `Application ID` and `Secret` from your GitLab OAuth application. | | `enabled` | Enables GitLab authentication. Set this value to `true`. | - Review the list of other GitLab [configuration options]({{< relref "#configuration-options" >}}) and complete them, as necessary. + Review the list of other GitLab [configuration options](#configuration-options) and complete them, as necessary. -1. Optional: [Configure a refresh token]({{< relref "#configure-a-refresh-token" >}}): +1. Optional: [Configure a refresh token](#configure-a-refresh-token): a. Set `use_refresh_token` to `true` in `[auth.gitlab]` section in Grafana configuration file. -1. [Configure role mapping]({{< relref "#configure-role-mapping" >}}). -1. Optional: [Configure group synchronization]({{< relref "#configure-group-synchronization" >}}). +1. [Configure role mapping](#configure-role-mapping). +1. Optional: [Configure group synchronization](#configure-group-synchronization). 1. Restart Grafana. You should now see a GitLab login button on the login page and be able to log in or sign up with your GitLab accounts. @@ -154,11 +154,11 @@ Unless `skip_org_role_sync` option is enabled, the user's role will be set to th The user's role is retrieved using a [JMESPath](http://jmespath.org/examples.html) expression from the `role_attribute_path` configuration option. To map the server administrator role, use the `allow_assign_grafana_admin` configuration option. -Refer to [configuration options]({{< relref "#configuration-options" >}}) for more information. +Refer to [configuration options](#configuration-options) for more information. You can use the `org_mapping` configuration option to assign the user to multiple organizations and specify their role based on their GitLab group membership. For more information, refer to [Org roles mapping example](#org-roles-mapping-example). If the org role mapping (`org_mapping`) is specified and Entra ID returns a valid role, then the user will get the highest of the two roles. -If no valid role is found, the user is assigned the role specified by [the `auto_assign_org_role` option]({{< relref "../../../configure-grafana#auto_assign_org_role" >}}). +If no valid role is found, the user is assigned the role specified by [the `auto_assign_org_role` option](../../../configure-grafana/#auto_assign_org_role). You can disable this default role assignment by setting `role_attribute_strict = true`. This setting denies user access if no role or an invalid role is returned after evaluating the `role_attribute_path` and the `org_mapping` expressions. To ease configuration of a proper JMESPath expression, go to [JMESPath](http://jmespath.org/) to test and evaluate expressions with custom payloads. @@ -259,36 +259,36 @@ To learn more about group synchronization, refer to [Configure team sync](https: ## Configuration options -The table below describes all GitLab OAuth configuration options. You can apply these options as environment variables, similar to any other configuration within Grafana. For more information, refer to [Override configuration with environment variables]({{< relref "../../../configure-grafana#override-configuration-with-environment-variables" >}}). +The table below describes all GitLab OAuth configuration options. You can apply these options as environment variables, similar to any other configuration within Grafana. For more information, refer to [Override configuration with environment variables](../../../configure-grafana/#override-configuration-with-environment-variables). {{< admonition type="note" >}} If the configuration option requires a JMESPath expression that includes a colon, enclose the entire expression in quotes to prevent parsing errors. For example `role_attribute_path: "role:view"` {{< /admonition >}} -| Setting | Required | Supported on Cloud | Description | Default | -| ---------------------------- | -------- | ------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------ | -| `enabled` | Yes | Yes | Whether GitLab OAuth authentication is allowed. | `false` | -| `client_id` | Yes | Yes | Client ID provided by your GitLab OAuth app. | | -| `client_secret` | Yes | Yes | Client secret provided by your GitLab OAuth app. | | -| `auth_url` | Yes | Yes | Authorization endpoint of your GitLab OAuth provider. If you use your own instance of GitLab instead of gitlab.com, adjust `auth_url` by replacing the `gitlab.com` hostname with your own. | `https://gitlab.com/oauth/authorize` | -| `token_url` | Yes | Yes | Endpoint used to obtain GitLab OAuth access token. If you use your own instance of GitLab instead of gitlab.com, adjust `token_url` by replacing the `gitlab.com` hostname with your own. | `https://gitlab.com/oauth/token` | -| `api_url` | No | Yes | Grafana uses `/user` endpoint to obtain GitLab user information compatible with [OpenID UserInfo](https://connect2id.com/products/server/docs/api/userinfo). | `https://gitlab.com/api/v4` | -| `name` | No | Yes | Name used to refer to the GitLab authentication in the Grafana user interface. | `GitLab` | -| `icon` | No | Yes | Icon used for GitLab authentication in the Grafana user interface. | `gitlab` | -| `scopes` | No | Yes | List of comma or space-separated GitLab OAuth scopes. | `openid email profile` | -| `allow_sign_up` | No | Yes | Whether to allow new Grafana user creation through GitLab login. If set to `false`, then only existing Grafana users can log in with GitLab OAuth. | `true` | -| `auto_login` | No | Yes | Set to `true` to enable users to bypass the login screen and automatically log in. This setting is ignored if you configure multiple auth providers to use auto-login. | `false` | -| `role_attribute_path` | No | Yes | [JMESPath](http://jmespath.org/examples.html) expression to use for Grafana role lookup. Grafana will first evaluate the expression using the GitLab OAuth token. If no role is found, Grafana creates a JSON data with `groups` key that maps to groups obtained from GitLab's `/oauth/userinfo` endpoint, and evaluates the expression using this data. Finally, if a valid role is still not found, the expression is evaluated against the user information retrieved from `api_url/users` endpoint and groups retrieved from `api_url/groups` endpoint. The result of the evaluation should be a valid Grafana role (`None`, `Viewer`, `Editor`, `Admin` or `GrafanaAdmin`). For more information on user role mapping, refer to [Configure role mapping]({{< relref "#configure-role-mapping" >}}). | | -| `role_attribute_strict` | No | Yes | Set to `true` to deny user login if the Grafana role cannot be extracted using `role_attribute_path`. For more information on user role mapping, refer to [Configure role mapping]({{< relref "#configure-role-mapping" >}}). | `false` | -| `org_mapping` | No | No | List of comma- or space-separated `::` mappings. Value can be `*` meaning "All users". Role is optional and can have the following values: `None`, `Viewer`, `Editor` or `Admin`. For more information on external organization to role mapping, refer to [Org roles mapping example](#org-roles-mapping-example). | | -| `skip_org_role_sync` | No | Yes | Set to `true` to stop automatically syncing user roles. | `false` | -| `allow_assign_grafana_admin` | No | No | Set to `true` to enable automatic sync of the Grafana server administrator role. If this option is set to `true` and the result of evaluating `role_attribute_path` for a user is `GrafanaAdmin`, Grafana grants the user the server administrator privileges and organization administrator role. If this option is set to `false` and the result of evaluating `role_attribute_path` for a user is `GrafanaAdmin`, Grafana grants the user only organization administrator role. For more information on user role mapping, refer to [Configure role mapping]({{< relref "#configure-role-mapping" >}}). | `false` | -| `allowed_domains` | No | Yes | List of comma or space-separated domains. User must belong to at least one domain to log in. | | -| `allowed_groups` | No | Yes | List of comma or space-separated groups. The user should be a member of at least one group to log in. | | -| `tls_skip_verify_insecure` | No | No | If set to `true`, the client accepts any certificate presented by the server and any host name in that certificate. _You should only use this for testing_, because this mode leaves SSL/TLS susceptible to man-in-the-middle attacks. | `false` | -| `tls_client_cert` | No | No | The path to the certificate. | | -| `tls_client_key` | No | No | The path to the key. | | -| `tls_client_ca` | No | No | The path to the trusted certificate authority list. | | -| `use_pkce` | No | Yes | Set to `true` to use [Proof Key for Code Exchange (PKCE)](https://datatracker.ietf.org/doc/html/rfc7636). Grafana uses the SHA256 based `S256` challenge method and a 128 bytes (base64url encoded) code verifier. | `true` | -| `use_refresh_token` | No | Yes | Set to `true` to use refresh token and check access token expiration. The `accessTokenExpirationCheck` feature toggle should also be enabled to use refresh token. | `true` | -| `signout_redirect_url` | No | Yes | URL to redirect to after the user logs out. | | +| Setting | Required | Supported on Cloud | Description | Default | +| ---------------------------- | -------- | ------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------ | +| `enabled` | Yes | Yes | Whether GitLab OAuth authentication is allowed. | `false` | +| `client_id` | Yes | Yes | Client ID provided by your GitLab OAuth app. | | +| `client_secret` | Yes | Yes | Client secret provided by your GitLab OAuth app. | | +| `auth_url` | Yes | Yes | Authorization endpoint of your GitLab OAuth provider. If you use your own instance of GitLab instead of gitlab.com, adjust `auth_url` by replacing the `gitlab.com` hostname with your own. | `https://gitlab.com/oauth/authorize` | +| `token_url` | Yes | Yes | Endpoint used to obtain GitLab OAuth access token. If you use your own instance of GitLab instead of gitlab.com, adjust `token_url` by replacing the `gitlab.com` hostname with your own. | `https://gitlab.com/oauth/token` | +| `api_url` | No | Yes | Grafana uses `/user` endpoint to obtain GitLab user information compatible with [OpenID UserInfo](https://connect2id.com/products/server/docs/api/userinfo). | `https://gitlab.com/api/v4` | +| `name` | No | Yes | Name used to refer to the GitLab authentication in the Grafana user interface. | `GitLab` | +| `icon` | No | Yes | Icon used for GitLab authentication in the Grafana user interface. | `gitlab` | +| `scopes` | No | Yes | List of comma or space-separated GitLab OAuth scopes. | `openid email profile` | +| `allow_sign_up` | No | Yes | Whether to allow new Grafana user creation through GitLab login. If set to `false`, then only existing Grafana users can log in with GitLab OAuth. | `true` | +| `auto_login` | No | Yes | Set to `true` to enable users to bypass the login screen and automatically log in. This setting is ignored if you configure multiple auth providers to use auto-login. | `false` | +| `role_attribute_path` | No | Yes | [JMESPath](http://jmespath.org/examples.html) expression to use for Grafana role lookup. Grafana will first evaluate the expression using the GitLab OAuth token. If no role is found, Grafana creates a JSON data with `groups` key that maps to groups obtained from GitLab's `/oauth/userinfo` endpoint, and evaluates the expression using this data. Finally, if a valid role is still not found, the expression is evaluated against the user information retrieved from `api_url/users` endpoint and groups retrieved from `api_url/groups` endpoint. The result of the evaluation should be a valid Grafana role (`None`, `Viewer`, `Editor`, `Admin` or `GrafanaAdmin`). For more information on user role mapping, refer to [Configure role mapping](#configure-role-mapping). | | +| `role_attribute_strict` | No | Yes | Set to `true` to deny user login if the Grafana role cannot be extracted using `role_attribute_path`. For more information on user role mapping, refer to [Configure role mapping](#configure-role-mapping). | `false` | +| `org_mapping` | No | No | List of comma- or space-separated `::` mappings. Value can be `*` meaning "All users". Role is optional and can have the following values: `None`, `Viewer`, `Editor` or `Admin`. For more information on external organization to role mapping, refer to [Org roles mapping example](#org-roles-mapping-example). | | +| `skip_org_role_sync` | No | Yes | Set to `true` to stop automatically syncing user roles. | `false` | +| `allow_assign_grafana_admin` | No | No | Set to `true` to enable automatic sync of the Grafana server administrator role. If this option is set to `true` and the result of evaluating `role_attribute_path` for a user is `GrafanaAdmin`, Grafana grants the user the server administrator privileges and organization administrator role. If this option is set to `false` and the result of evaluating `role_attribute_path` for a user is `GrafanaAdmin`, Grafana grants the user only organization administrator role. For more information on user role mapping, refer to [Configure role mapping](#configure-role-mapping). | `false` | +| `allowed_domains` | No | Yes | List of comma or space-separated domains. User must belong to at least one domain to log in. | | +| `allowed_groups` | No | Yes | List of comma or space-separated groups. The user should be a member of at least one group to log in. | | +| `tls_skip_verify_insecure` | No | No | If set to `true`, the client accepts any certificate presented by the server and any host name in that certificate. _You should only use this for testing_, because this mode leaves SSL/TLS susceptible to man-in-the-middle attacks. | `false` | +| `tls_client_cert` | No | No | The path to the certificate. | | +| `tls_client_key` | No | No | The path to the key. | | +| `tls_client_ca` | No | No | The path to the trusted certificate authority list. | | +| `use_pkce` | No | Yes | Set to `true` to use [Proof Key for Code Exchange (PKCE)](https://datatracker.ietf.org/doc/html/rfc7636). Grafana uses the SHA256 based `S256` challenge method and a 128 bytes (base64url encoded) code verifier. | `true` | +| `use_refresh_token` | No | Yes | Set to `true` to use refresh token and check access token expiration. The `accessTokenExpirationCheck` feature toggle should also be enabled to use refresh token. | `true` | +| `signout_redirect_url` | No | Yes | URL to redirect to after the user logs out. | | diff --git a/docs/sources/setup-grafana/configure-security/configure-authentication/google/index.md b/docs/sources/setup-grafana/configure-security/configure-authentication/google/index.md index 9e4740c6914..ce130da6e0d 100644 --- a/docs/sources/setup-grafana/configure-security/configure-authentication/google/index.md +++ b/docs/sources/setup-grafana/configure-security/configure-authentication/google/index.md @@ -17,7 +17,7 @@ weight: 1100 To enable Google OAuth you must register your application with Google. Google will generate a client ID and secret key for you to use. {{% admonition type="note" %}} -If Users use the same email address in Google that they use with other authentication providers (such as Grafana.com), you need to do additional configuration to ensure that the users are matched correctly. Please refer to the [Using the same email address to login with different identity providers]({{< relref "../../configure-authentication#using-the-same-email-address-to-login-with-different-identity-providers" >}}) documentation for more information. +If Users use the same email address in Google that they use with other authentication providers (such as Grafana.com), you need to do additional configuration to ensure that the users are matched correctly. Please refer to the [Using the same email address to login with different identity providers](../#using-the-same-email-address-to-login-with-different-identity-providers) documentation for more information. {{% /admonition %}} ## Create Google OAuth keys @@ -86,11 +86,11 @@ Go to [Terraform Registry](https://registry.terraform.io/providers/grafana/grafa ## Configure Google authentication client using the Grafana configuration file -Ensure that you have access to the [Grafana configuration file]({{< relref "../../../configure-grafana#configuration-file-location" >}}). +Ensure that you have access to the [Grafana configuration file](../../../configure-grafana/#configuration-file-location). ### Enable Google OAuth in Grafana -Specify the Client ID and Secret in the [Grafana configuration file]({{< relref "../../../configure-grafana#configuration-file-location" >}}). For example: +Specify the Client ID and Secret in the [Grafana configuration file](../../../configure-grafana/#configuration-file-location). For example: ```bash [auth.google] @@ -189,7 +189,7 @@ To set up group sync for Google OAuth: The external group ID for a Google group is the group's email address, such as `dev@grafana.com`. -To learn more about how to configure group synchronization, refer to [Configure team sync]({{< relref "../../configure-team-sync" >}}) and [Configure group attribute sync](https://grafana.com/docs/grafana//setup-grafana/configure-security/configure-group-attribute-sync) documentation. +To learn more about how to configure group synchronization, refer to [Configure team sync](../../configure-team-sync/) and [Configure group attribute sync](https://grafana.com/docs/grafana//setup-grafana/configure-security/configure-group-attribute-sync) documentation. #### Configure allowed groups @@ -209,7 +209,7 @@ Unless `skip_org_role_sync` option is enabled, the user's role will be set to th The user's role is retrieved using a [JMESPath](http://jmespath.org/examples.html) expression from the `role_attribute_path` configuration option. To map the server administrator role, use the `allow_assign_grafana_admin` configuration option. -If no valid role is found, the user is assigned the role specified by [the `auto_assign_org_role` option]({{< relref "../../../configure-grafana#auto_assign_org_role" >}}). +If no valid role is found, the user is assigned the role specified by [the `auto_assign_org_role` option](../../../configure-grafana/#auto_assign_org_role). You can disable this default role assignment by setting `role_attribute_strict = true`. This setting denies user access if no role or an invalid role is returned after evaluating the `role_attribute_path` and the `org_mapping` expressions. To ease configuration of a proper JMESPath expression, go to [JMESPath](http://jmespath.org/) to test and evaluate expressions with custom payloads. @@ -281,7 +281,7 @@ skip_org_role_sync = false ## Configuration options -The following table outlines the various Google OAuth configuration options. You can apply these options as environment variables, similar to any other configuration within Grafana. For more information, refer to [Override configuration with environment variables]({{< relref "../../../configure-grafana#override-configuration-with-environment-variables" >}}). +The following table outlines the various Google OAuth configuration options. You can apply these options as environment variables, similar to any other configuration within Grafana. For more information, refer to [Override configuration with environment variables](../../../configure-grafana/#override-configuration-with-environment-variables). | Setting | Required | Supported on Cloud | Description | Default | | ---------------------------- | -------- | ------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------- | @@ -298,13 +298,13 @@ The following table outlines the various Google OAuth configuration options. You | `allow_sign_up` | No | Yes | Controls Grafana user creation through the Google login. Only existing Grafana users can log in with Google if set to `false`. | `true` | | `auto_login` | No | Yes | Set to `true` to enable users to bypass the login screen and automatically log in. This setting is ignored if you configure multiple auth providers to use auto-login. | `false` | | `hosted_domain` | No | Yes | Specifies the domain to restrict access to users from that domain. This value is appended to the authorization request using the `hd` parameter. | | -| `validate_hd` | No | Yes | Set to `false` to disable the validation of the `hd` parameter from the Google ID token. For more informatiion, refer to [Enable Google OAuth in Grafana]({{< relref "#enable-google-oauth-in-grafana" >}}). | `true` | -| `role_attribute_strict` | No | Yes | Set to `true` to deny user login if the Grafana org role cannot be extracted using `role_attribute_path` or `org_mapping`. For more information on user role mapping, refer to [Configure role mapping]({{< relref "#configure-role-mapping" >}}). | `false` | +| `validate_hd` | No | Yes | Set to `false` to disable the validation of the `hd` parameter from the Google ID token. For more informatiion, refer to [Enable Google OAuth in Grafana](#enable-google-oauth-in-grafana). | `true` | +| `role_attribute_strict` | No | Yes | Set to `true` to deny user login if the Grafana org role cannot be extracted using `role_attribute_path` or `org_mapping`. For more information on user role mapping, refer to [Configure role mapping](#configure-role-mapping). | `false` | | `org_attribute_path` | No | No | [JMESPath](http://jmespath.org/examples.html) expression to use for Grafana org to role lookup. Grafana will first evaluate the expression using the OAuth2 ID token. If no value is returned, the expression will be evaluated using the user information obtained from the UserInfo endpoint. The result of the evaluation will be mapped to org roles based on `org_mapping`. For more information on org to role mapping, refer to [Org roles mapping example](#org-roles-mapping-example). | | | `org_mapping` | No | No | List of comma- or space-separated `::` mappings. Value can be `*` meaning "All users". Role is optional and can have the following values: `None`, `Viewer`, `Editor` or `Admin`. For more information on external organization to role mapping, refer to [Org roles mapping example](#org-roles-mapping-example). | | -| `allow_assign_grafana_admin` | No | No | Set to `true` to automatically sync the Grafana server administrator role. When enabled, if the Google user's App role is `GrafanaAdmin`, Grafana grants the user server administrator privileges and the organization administrator role. If disabled, the user will only receive the organization administrator role. For more details on user role mapping, refer to [Map roles]({{< relref "#map-roles" >}}). | `false` | +| `allow_assign_grafana_admin` | No | No | Set to `true` to automatically sync the Grafana server administrator role. When enabled, if the Google user's App role is `GrafanaAdmin`, Grafana grants the user server administrator privileges and the organization administrator role. If disabled, the user will only receive the organization administrator role. For more details on user role mapping, refer to [Map roles](#map-roles). | `false` | | `skip_org_role_sync` | No | Yes | Set to `true` to stop automatically syncing user roles. This will allow you to set organization roles for your users from within Grafana manually. | `false` | -| `allowed_groups` | No | Yes | List of comma- or space-separated groups. The user should be a member of at least one group to log in. If you configure `allowed_groups`, you must also configure Google to include the `groups` claim following [Configure allowed groups]({{< relref "#configure-allowed-groups" >}}). | | +| `allowed_groups` | No | Yes | List of comma- or space-separated groups. The user should be a member of at least one group to log in. If you configure `allowed_groups`, you must also configure Google to include the `groups` claim following [Configure allowed groups](#configure-allowed-groups). | | | `allowed_organizations` | No | Yes | List of comma- or space-separated Azure tenant identifiers. The user should be a member of at least one tenant to log in. | | | `allowed_domains` | No | Yes | List of comma- or space-separated domains. The user should belong to at least one domain to log in. | | | `tls_skip_verify_insecure` | No | No | If set to `true`, the client accepts any certificate presented by the server and any host name in that certificate. _You should only use this for testing_, because this mode leaves SSL/TLS susceptible to man-in-the-middle attacks. | `false` | diff --git a/docs/sources/setup-grafana/configure-security/configure-authentication/jwt/index.md b/docs/sources/setup-grafana/configure-security/configure-authentication/jwt/index.md index dc73b488a1b..29dfa1f17ae 100644 --- a/docs/sources/setup-grafana/configure-security/configure-authentication/jwt/index.md +++ b/docs/sources/setup-grafana/configure-security/configure-authentication/jwt/index.md @@ -31,7 +31,7 @@ Grafana does not currently support refresh tokens. To use JWT authentication: -1. Enable JWT in the [main config file]({{< relref "../../../configure-grafana" >}}). +1. Enable JWT in the [main config file](../../../configure-grafana/). 1. Specify the header name that contains a token. ```ini @@ -106,7 +106,7 @@ provided in the HTTP header and a reverse proxy should rewrite requests to the Grafana instance to include the JWT in the request's headers. {{% admonition type="note" %}} -For embedding to work, you must enable `allow_embedding` in the [security section]({{< relref "../../../configure-grafana#allow_embedding" >}}). This setting is not available in Grafana Cloud. +For embedding to work, you must enable `allow_embedding` in the [security section](../../../configure-grafana/#allow_embedding). This setting is not available in Grafana Cloud. {{% /admonition %}} In a scenario where it is not possible to rewrite the request headers you @@ -200,7 +200,7 @@ expect_claims = {"iss": "https://your-token-issuer", "your-custom-claim": "foo"} Grafana checks for the presence of a role using the [JMESPath](http://jmespath.org/examples.html) specified via the `role_attribute_path` configuration option. The JMESPath is applied to JWT token claims. The result after evaluation of the `role_attribute_path` JMESPath expression should be a valid Grafana role, for example, `None`, `Viewer`, `Editor` or `Admin`. To assign the role to a specific organization include the `X-Grafana-Org-Id` header along with your JWT when making API requests to Grafana. -To learn more about the header, please refer to the [documentation]({{< relref "../../../../developers/http_api#x-grafana-org-id-header" >}}). +To learn more about the header, please refer to the [documentation](../../../../developers/http_api/#x-grafana-org-id-header). ### JMESPath examples diff --git a/docs/sources/setup-grafana/configure-security/configure-authentication/keycloak/index.md b/docs/sources/setup-grafana/configure-security/configure-authentication/keycloak/index.md index 323e6e1614d..347d5fbc4dc 100644 --- a/docs/sources/setup-grafana/configure-security/configure-authentication/keycloak/index.md +++ b/docs/sources/setup-grafana/configure-security/configure-authentication/keycloak/index.md @@ -22,10 +22,10 @@ weight: 1300 Keycloak OAuth2 authentication allows users to log in to Grafana using their Keycloak credentials. This guide explains how to set up Keycloak as an authentication provider in Grafana. -Refer to [Generic OAuth authentication]({{< relref "../generic-oauth" >}}) for extra configuration options available for this provider. +Refer to [Generic OAuth authentication](../generic-oauth/) for extra configuration options available for this provider. {{% admonition type="note" %}} -If Users use the same email address in Keycloak that they use with other authentication providers (such as Grafana.com), you need to do additional configuration to ensure that the users are matched correctly. Please refer to the [Using the same email address to login with different identity providers]({{< relref "../../configure-authentication#using-the-same-email-address-to-login-with-different-identity-providers" >}}) documentation for more information. +If Users use the same email address in Keycloak that they use with other authentication providers (such as Grafana.com), you need to do additional configuration to ensure that the users are matched correctly. Please refer to the [Using the same email address to login with different identity providers](../#using-the-same-email-address-to-login-with-different-identity-providers) documentation for more information. {{% /admonition %}} You may have to set the `root_url` option of `[server]` for the callback URL to be @@ -143,7 +143,7 @@ If you use nested groups containing special characters such as quotes or colons, groups_attribute_path = reverse("Global:department") ``` -To learn more about how to configure group synchronization, refer to [Configure team sync]({{< relref "../../configure-team-sync" >}}) and [Configure group attribute sync](https://grafana.com/docs/grafana//setup-grafana/configure-security/configure-group-attribute-sync) documentation. +To learn more about how to configure group synchronization, refer to [Configure team sync](../../configure-team-sync/) and [Configure group attribute sync](https://grafana.com/docs/grafana//setup-grafana/configure-security/configure-group-attribute-sync) documentation. ## Enable Single Logout diff --git a/docs/sources/setup-grafana/configure-security/configure-authentication/ldap-ui/_index.md b/docs/sources/setup-grafana/configure-security/configure-authentication/ldap-ui/_index.md index 89ae937a995..0710af26b0e 100644 --- a/docs/sources/setup-grafana/configure-security/configure-authentication/ldap-ui/_index.md +++ b/docs/sources/setup-grafana/configure-security/configure-authentication/ldap-ui/_index.md @@ -14,7 +14,7 @@ weight: 300 # Configure LDAP authentication using the Grafana user interface -This page explains how to configure LDAP authentication in Grafana using the Grafana user interface. For more detailed information about configuring LDAP authentication using the configuration file, refer to [LDAP authentication]({{< relref "../ldap" >}}). +This page explains how to configure LDAP authentication in Grafana using the Grafana user interface. For more detailed information about configuring LDAP authentication using the configuration file, refer to [LDAP authentication](../ldap/). Benefits of using the Grafana user interface to configure LDAP authentication include: diff --git a/docs/sources/setup-grafana/configure-security/configure-authentication/ldap/index.md b/docs/sources/setup-grafana/configure-security/configure-authentication/ldap/index.md index 68e45f10032..bde7f28b541 100644 --- a/docs/sources/setup-grafana/configure-security/configure-authentication/ldap/index.md +++ b/docs/sources/setup-grafana/configure-security/configure-authentication/ldap/index.md @@ -19,10 +19,10 @@ The LDAP integration in Grafana allows your Grafana users to login with their LD group memberships and Grafana Organization user roles. {{% admonition type="note" %}} -[Enhanced LDAP authentication]({{< relref "../enhanced-ldap" >}}) is available in [Grafana Cloud](/docs/grafana-cloud/) and in [Grafana Enterprise]({{< relref "../../../../introduction/grafana-enterprise" >}}). +[Enhanced LDAP authentication](../enhanced-ldap/) is available in [Grafana Cloud](/docs/grafana-cloud/) and in [Grafana Enterprise](../../../../introduction/grafana-enterprise/). {{% /admonition %}} -Refer to [Role-based access control]({{< relref "../../../../administration/roles-and-permissions/access-control" >}}) to understand how you can control access with role-based permissions. +Refer to [Role-based access control](../../../../administration/roles-and-permissions/access-control/) to understand how you can control access with role-based permissions. ## Supported LDAP Servers @@ -32,7 +32,7 @@ This means that you should be able to configure LDAP integration using any compl ## Enable LDAP -In order to use LDAP integration you'll first need to enable LDAP in the [main config file]({{< relref "../../../configure-grafana" >}}) as well as specify the path to the LDAP +In order to use LDAP integration you'll first need to enable LDAP in the [main config file](../../../configure-grafana/) as well as specify the path to the LDAP specific configuration file (default: `/etc/grafana/ldap.toml`). After enabling LDAP, the default behavior is for Grafana users to be created automatically upon successful LDAP authentication. If you prefer for only existing Grafana users to be able to sign in, you can change `allow_sign_up` to `false` in the `[auth.ldap]` section. @@ -160,7 +160,7 @@ Note that this does not work if you are using the single bind configuration outl {{< figure src="/static/img/docs/ldap_debug_mapping_testing.png" class="docs-image--no-shadow" max-width="600px" alt="LDAP mapping displayed" >}} -[Grafana Enterprise]({{< relref "../../../../introduction/grafana-enterprise" >}}) users with [enhanced LDAP integration]({{< relref "../enhanced-ldap" >}}) enabled can also see sync status in the debug view. This requires the `ldap.status:read` permission. +[Grafana Enterprise](../../../../introduction/grafana-enterprise/) users with [enhanced LDAP integration](../enhanced-ldap/) enabled can also see sync status in the debug view. This requires the `ldap.status:read` permission. {{< figure src="/static/img/docs/ldap_sync_debug.png" class="docs-image--no-shadow" max-width="600px" alt="LDAP sync status" >}} @@ -414,7 +414,7 @@ Please inspect your Active Directory configuration and documentation to find the ## Troubleshooting -To troubleshoot and get more log info enable LDAP debug logging in the [main config file]({{< relref "../../../configure-grafana" >}}). +To troubleshoot and get more log info enable LDAP debug logging in the [main config file](../../../configure-grafana/). ```bash [log] diff --git a/docs/sources/setup-grafana/configure-security/configure-authentication/okta/index.md b/docs/sources/setup-grafana/configure-security/configure-authentication/okta/index.md index 39d77ca3f7f..4cc50a36f2a 100644 --- a/docs/sources/setup-grafana/configure-security/configure-authentication/okta/index.md +++ b/docs/sources/setup-grafana/configure-security/configure-authentication/okta/index.md @@ -17,7 +17,7 @@ weight: 1400 {{< docs/shared lookup="auth/intro.md" source="grafana" version="" >}} {{% admonition type="note" %}} -If Users use the same email address in Okta that they use with other authentication providers (such as Grafana.com), you need to do additional configuration to ensure that the users are matched correctly. Please refer to the [Using the same email address to login with different identity providers]({{< relref "../../configure-authentication#using-the-same-email-address-to-login-with-different-identity-providers" >}}) documentation for more information. +If Users use the same email address in Okta that they use with other authentication providers (such as Grafana.com), you need to do additional configuration to ensure that the users are matched correctly. Please refer to the [Using the same email address to login with different identity providers](../#using-the-same-email-address-to-login-with-different-identity-providers) documentation for more information. {{% /admonition %}} ## Before you begin @@ -67,7 +67,7 @@ To follow this guide, ensure you have permissions in your Okta workspace to crea The remaining attributes are optional and can be set as needed. 1. Click **Save**. -1. (Optional) You can add the role attribute to the default User profile. To do this, please follow the steps in the [Optional: Add the role attribute to the User (default) Okta profile]({{< relref "#optional-add-the-role-attribute-to-the-user-default-okta-profile" >}}) section. +1. (Optional) You can add the role attribute to the default User profile. To do this, please follow the steps in the [Optional: Add the role attribute to the User (default) Okta profile](#optional-add-the-role-attribute-to-the-user-default-okta-profile) section. ### Configure Groups claim @@ -115,7 +115,7 @@ If you need to reset changes you made in the UI back to the default values, clic If you run Grafana in high availability mode, configuration changes may not get applied to all Grafana instances immediately. You may need to wait a few minutes for the configuration to propagate to all Grafana instances. {{% /admonition %}} -Refer to [configuration options]({{< relref "#configuration-options" >}}) for more information. +Refer to [configuration options](#configuration-options) for more information. ## Configure Okta authentication client using the Terraform provider @@ -147,13 +147,13 @@ Go to [Terraform Registry](https://registry.terraform.io/providers/grafana/grafa ## Configure Okta authentication client using the Grafana configuration file -Ensure that you have access to the [Grafana configuration file]({{< relref "../../../configure-grafana#configuration-file-location" >}}). +Ensure that you have access to the [Grafana configuration file](../../../configure-grafana/#configuration-file-location). ### Steps To integrate your Okta OIDC provider with Grafana using our Okta OIDC integration, follow these steps: -1. Follow the [Create an Okta app]({{< relref "#create-an-okta-app" >}}) steps to create an OIDC app in Okta. +1. Follow the [Create an Okta app](#create-an-okta-app) steps to create an OIDC app in Okta. 1. Refer to the following table to update field values located in the `[auth.okta]` section of the Grafana configuration file: @@ -165,11 +165,11 @@ To integrate your Okta OIDC provider with Grafana using our Okta OIDC integratio | `api_url` | The user information endpoint of your Okta OIDC provider. `https://.okta.com/oauth2/v1/userinfo` | | `enabled` | Enables Okta OIDC authentication. Set this value to `true`. | -1. Review the list of other Okta OIDC [configuration options]({{< relref "#configuration-options" >}}) and complete them as necessary. +1. Review the list of other Okta OIDC [configuration options](#configuration-options) and complete them as necessary. -1. Optional: [Configure a refresh token]({{< relref "#configure-a-refresh-token" >}}). -1. [Configure role mapping]({{< relref "#configure-role-mapping" >}}). -1. Optional: [Configure group synchronization]({{< relref "#configure-group-synchronization-enterprise-only" >}}). +1. Optional: [Configure a refresh token](#configure-a-refresh-token). +1. [Configure role mapping](#configure-role-mapping). +1. Optional: [Configure group synchronization](#configure-group-synchronization-enterprise-only). 1. Restart Grafana. You should now see a Okta OIDC login button on the login page and be able to log in or sign up with your OIDC provider. @@ -214,17 +214,17 @@ Unless `skip_org_role_sync` option is enabled, the user's role will be set to th The user's role is retrieved using a [JMESPath](http://jmespath.org/examples.html) expression from the `role_attribute_path` configuration option against the `api_url` (`/userinfo` OIDC endpoint) endpoint payload. -If no valid role is found, the user is assigned the role specified by [the `auto_assign_org_role` option]({{< relref "../../../configure-grafana#auto_assign_org_role" >}}). +If no valid role is found, the user is assigned the role specified by [the `auto_assign_org_role` option](../../../configure-grafana/#auto_assign_org_role). You can disable this default role assignment by setting `role_attribute_strict = true`. This setting denies user access if no role or an invalid role is returned after evaluating the `role_attribute_path` and the `org_mapping` expressions. You can use the `org_attribute_path` and `org_mapping` configuration options to assign the user to organizations and specify their role. For more information, refer to [Org roles mapping example](#org-roles-mapping-example). If both org role mapping (`org_mapping`) and the regular role mapping (`role_attribute_path`) are specified, then the user will get the highest of the two mapped roles. To allow mapping Grafana server administrator role, use the `allow_assign_grafana_admin` configuration option. -Refer to [configuration options]({{< relref "../generic-oauth/index.md#configuration-options" >}}) for more information. +Refer to [configuration options](../generic-oauth/#configuration-options) for more information. -In [Create an Okta app]({{< relref "#create-an-okta-app" >}}), you created a custom attribute in Okta to store the role. You can use this attribute to map the role to a Grafana role by setting the `role_attribute_path` configuration option to the custom attribute name: `role_attribute_path = grafana_role`. +In [Create an Okta app](#create-an-okta-app), you created a custom attribute in Okta to store the role. You can use this attribute to map the role to a Grafana role by setting the `role_attribute_path` configuration option to the custom attribute name: `role_attribute_path = grafana_role`. -If you want to map the role based on the user's group, you can use the `groups` attribute from the user info endpoint. An example of this is `role_attribute_path = contains(groups[*], 'Example::DevOps') && 'Admin' || 'None'`. You can find more examples of JMESPath expressions on the Generic OAuth page for [JMESPath examples]({{< relref "../generic-oauth/index.md#role-mapping-examples" >}}). +If you want to map the role based on the user's group, you can use the `groups` attribute from the user info endpoint. An example of this is `role_attribute_path = contains(groups[*], 'Example::DevOps') && 'Admin' || 'None'`. You can find more examples of JMESPath expressions on the Generic OAuth page for [JMESPath examples](../generic-oauth/#role-mapping-examples). To learn about adding custom claims to the user info in Okta, refer to [add custom claims](https://developer.okta.com/docs/guides/customize-tokens-returned-from-okta/main/#add-a-custom-claim-to-a-token). @@ -254,36 +254,36 @@ Teams and roles get synchronized when the user logs in. Okta groups can be referenced by group names, like `Admins` or `Editors`. -To learn more about how to configure group synchronization, refer to [Configure team sync]({{< relref "../../configure-team-sync" >}}) and [Configure group attribute sync](https://grafana.com/docs/grafana//setup-grafana/configure-security/configure-group-attribute-sync) documentation. +To learn more about how to configure group synchronization, refer to [Configure team sync](../../configure-team-sync/) and [Configure group attribute sync](https://grafana.com/docs/grafana//setup-grafana/configure-security/configure-group-attribute-sync) documentation. ## Configuration options -The following table outlines the various Okta OIDC configuration options. You can apply these options as environment variables, similar to any other configuration within Grafana. For more information, refer to [Override configuration with environment variables]({{< relref "../../../configure-grafana#override-configuration-with-environment-variables" >}}). +The following table outlines the various Okta OIDC configuration options. You can apply these options as environment variables, similar to any other configuration within Grafana. For more information, refer to [Override configuration with environment variables](../../../configure-grafana/#override-configuration-with-environment-variables). {{< admonition type="note" >}} If the configuration option requires a JMESPath expression that includes a colon, enclose the entire expression in quotes to prevent parsing errors. For example `role_attribute_path: "role:view"` {{< /admonition >}} -| Setting | Required | Supported on Cloud | Description | Default | -| ----------------------- | -------- | ------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------- | -| `enabled` | No | Yes | Enables Okta OIDC authentication. | `false` | -| `name` | No | Yes | Name that refers to the Okta OIDC authentication from the Grafana user interface. | `Okta` | -| `icon` | No | Yes | Icon used for the Okta OIDC authentication in the Grafana user interface. | `okta` | -| `client_id` | Yes | Yes | Client ID provided by your Okta OIDC app. | | -| `client_secret` | Yes | Yes | Client secret provided by your Okta OIDC app. | | -| `auth_url` | Yes | Yes | Authorization endpoint of your Okta OIDC provider. | | -| `token_url` | Yes | Yes | Endpoint used to obtain the Okta OIDC access token. | | -| `api_url` | Yes | Yes | Endpoint used to obtain user information. | | -| `scopes` | No | Yes | List of comma- or space-separated Okta OIDC scopes. | `openid profile email groups` | -| `allow_sign_up` | No | Yes | Controls Grafana user creation through the Okta OIDC login. Only existing Grafana users can log in with Okta OIDC if set to `false`. | `true` | -| `auto_login` | No | Yes | Set to `true` to enable users to bypass the login screen and automatically log in. This setting is ignored if you configure multiple auth providers to use auto-login. | `false` | -| `role_attribute_path` | No | Yes | [JMESPath](http://jmespath.org/examples.html) expression to use for Grafana role lookup. Grafana will first evaluate the expression using the Okta OIDC ID token. If no role is found, the expression will be evaluated using the user information obtained from the UserInfo endpoint. The result of the evaluation should be a valid Grafana role (`None`, `Viewer`, `Editor`, `Admin` or `GrafanaAdmin`). For more information on user role mapping, refer to [Configure role mapping]({{< relref "#configure-role-mapping" >}}). | | -| `role_attribute_strict` | No | Yes | Set to `true` to deny user login if the Grafana org role cannot be extracted using `role_attribute_path` or `org_mapping`. For more information on user role mapping, refer to [Configure role mapping]({{< relref "#configure-role-mapping" >}}). | `false` | -| `org_attribute_path` | No | No | [JMESPath](http://jmespath.org/examples.html) expression to use for Grafana org to role lookup. The result of the evaluation will be mapped to org roles based on `org_mapping`. For more information on org to role mapping, refer to [Org roles mapping example](#org-roles-mapping-example). | | -| `org_mapping` | No | No | List of comma- or space-separated `::` mappings. Value can be `*` meaning "All users". Role is optional and can have the following values: `None`, `Viewer`, `Editor` or `Admin`. For more information on external organization to role mapping, refer to [Org roles mapping example](#org-roles-mapping-example). | | -| `skip_org_role_sync` | No | Yes | Set to `true` to stop automatically syncing user roles. This will allow you to set organization roles for your users from within Grafana manually. | `false` | -| `allowed_groups` | No | Yes | List of comma- or space-separated groups. The user should be a member of at least one group to log in. | | -| `allowed_domains` | No | Yes | List of comma- or space-separated domains. The user should belong to at least one domain to log in. | | -| `use_pkce` | No | Yes | Set to `true` to use [Proof Key for Code Exchange (PKCE)](https://datatracker.ietf.org/doc/html/rfc7636). Grafana uses the SHA256 based `S256` challenge method and a 128 bytes (base64url encoded) code verifier. | `true` | -| `use_refresh_token` | No | Yes | Set to `true` to use refresh token and check access token expiration. | `false` | -| `signout_redirect_url` | No | Yes | URL to redirect to after the user logs out. | | +| Setting | Required | Supported on Cloud | Description | Default | +| ----------------------- | -------- | ------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------- | +| `enabled` | No | Yes | Enables Okta OIDC authentication. | `false` | +| `name` | No | Yes | Name that refers to the Okta OIDC authentication from the Grafana user interface. | `Okta` | +| `icon` | No | Yes | Icon used for the Okta OIDC authentication in the Grafana user interface. | `okta` | +| `client_id` | Yes | Yes | Client ID provided by your Okta OIDC app. | | +| `client_secret` | Yes | Yes | Client secret provided by your Okta OIDC app. | | +| `auth_url` | Yes | Yes | Authorization endpoint of your Okta OIDC provider. | | +| `token_url` | Yes | Yes | Endpoint used to obtain the Okta OIDC access token. | | +| `api_url` | Yes | Yes | Endpoint used to obtain user information. | | +| `scopes` | No | Yes | List of comma- or space-separated Okta OIDC scopes. | `openid profile email groups` | +| `allow_sign_up` | No | Yes | Controls Grafana user creation through the Okta OIDC login. Only existing Grafana users can log in with Okta OIDC if set to `false`. | `true` | +| `auto_login` | No | Yes | Set to `true` to enable users to bypass the login screen and automatically log in. This setting is ignored if you configure multiple auth providers to use auto-login. | `false` | +| `role_attribute_path` | No | Yes | [JMESPath](http://jmespath.org/examples.html) expression to use for Grafana role lookup. Grafana will first evaluate the expression using the Okta OIDC ID token. If no role is found, the expression will be evaluated using the user information obtained from the UserInfo endpoint. The result of the evaluation should be a valid Grafana role (`None`, `Viewer`, `Editor`, `Admin` or `GrafanaAdmin`). For more information on user role mapping, refer to [Configure role mapping](#configure-role-mapping). | | +| `role_attribute_strict` | No | Yes | Set to `true` to deny user login if the Grafana org role cannot be extracted using `role_attribute_path` or `org_mapping`. For more information on user role mapping, refer to [Configure role mapping](#configure-role-mapping). | `false` | +| `org_attribute_path` | No | No | [JMESPath](http://jmespath.org/examples.html) expression to use for Grafana org to role lookup. The result of the evaluation will be mapped to org roles based on `org_mapping`. For more information on org to role mapping, refer to [Org roles mapping example](#org-roles-mapping-example). | | +| `org_mapping` | No | No | List of comma- or space-separated `::` mappings. Value can be `*` meaning "All users". Role is optional and can have the following values: `None`, `Viewer`, `Editor` or `Admin`. For more information on external organization to role mapping, refer to [Org roles mapping example](#org-roles-mapping-example). | | +| `skip_org_role_sync` | No | Yes | Set to `true` to stop automatically syncing user roles. This will allow you to set organization roles for your users from within Grafana manually. | `false` | +| `allowed_groups` | No | Yes | List of comma- or space-separated groups. The user should be a member of at least one group to log in. | | +| `allowed_domains` | No | Yes | List of comma- or space-separated domains. The user should belong to at least one domain to log in. | | +| `use_pkce` | No | Yes | Set to `true` to use [Proof Key for Code Exchange (PKCE)](https://datatracker.ietf.org/doc/html/rfc7636). Grafana uses the SHA256 based `S256` challenge method and a 128 bytes (base64url encoded) code verifier. | `true` | +| `use_refresh_token` | No | Yes | Set to `true` to use refresh token and check access token expiration. | `false` | +| `signout_redirect_url` | No | Yes | URL to redirect to after the user logs out. | | diff --git a/docs/sources/setup-grafana/configure-security/configure-authentication/saml-ui/index.md b/docs/sources/setup-grafana/configure-security/configure-authentication/saml-ui/index.md index 0a192c80baf..fc71df3b8bc 100644 --- a/docs/sources/setup-grafana/configure-security/configure-authentication/saml-ui/index.md +++ b/docs/sources/setup-grafana/configure-security/configure-authentication/saml-ui/index.md @@ -12,10 +12,10 @@ weight: 600 # Configure SAML authentication using the Grafana user interface {{% admonition type="note" %}} -Available in [Grafana Enterprise]({{< relref "../../../../introduction/grafana-enterprise" >}}) version 10.0 and later, and [Grafana Cloud Pro and Advanced](/docs/grafana-cloud/). +Available in [Grafana Enterprise](../../../../introduction/grafana-enterprise/) version 10.0 and later, and [Grafana Cloud Pro and Advanced](/docs/grafana-cloud/). {{% /admonition %}} -You can configure SAML authentication in Grafana through the user interface (UI) or the Grafana configuration file. For instructions on how to set up SAML using the Grafana configuration file, refer to [Configure SAML authentication using the configuration file]({{< relref "../saml" >}}). +You can configure SAML authentication in Grafana through the user interface (UI) or the Grafana configuration file. For instructions on how to set up SAML using the Grafana configuration file, refer to [Configure SAML authentication using the configuration file](../saml/). The Grafana SAML UI provides the following advantages over configuring SAML in the Grafana configuration file: @@ -25,7 +25,7 @@ The Grafana SAML UI provides the following advantages over configuring SAML in t - Access to the SAML UI only requires access to authentication settings, so it can be used by users with limited access to Grafana's configuration {{% admonition type="note" %}} -Any configuration changes made through the Grafana user interface (UI) will take precedence over settings specified in the Grafana configuration file or through environment variables. This means that if you modify any configuration settings in the UI, they will override any corresponding settings set via environment variables or defined in the configuration file. For more information on how Grafana determines the order of precedence for its settings, please refer to the [Settings update at runtime]({{< relref "../../../configure-grafana/settings-updates-at-runtime" >}}). +Any configuration changes made through the Grafana user interface (UI) will take precedence over settings specified in the Grafana configuration file or through environment variables. This means that if you modify any configuration settings in the UI, they will override any corresponding settings set via environment variables or defined in the configuration file. For more information on how Grafana determines the order of precedence for its settings, please refer to the [Settings update at runtime](../../../configure-grafana/settings-updates-at-runtime/). {{% /admonition %}} {{% admonition type="note" %}} @@ -36,13 +36,13 @@ Disabling the UI does not affect any configuration settings that were previously To follow this guide, you need: -- Knowledge of SAML authentication. Refer to [SAML authentication in Grafana]({{< relref "../saml" >}}) for an overview of Grafana's SAML integration. +- Knowledge of SAML authentication. Refer to [SAML authentication in Grafana](../saml/) for an overview of Grafana's SAML integration. - Permissions `settings:read` and `settings:write` with scope `settings:auth.saml:*` that allow you to read and update SAML authentication settings. These permissions are granted by `fixed:authentication.config:writer` role. By default, this role is granted to Grafana server administrator in self-hosted instances and to Organization admins in Grafana Cloud instances. -- Grafana instance running Grafana version 10.0 or later with [Grafana Enterprise]({{< relref "../../../../introduction/grafana-enterprise" >}}) or [Grafana Cloud Pro or Advanced](/docs/grafana-cloud/) license. +- Grafana instance running Grafana version 10.0 or later with [Grafana Enterprise](../../../../introduction/grafana-enterprise/) or [Grafana Cloud Pro or Advanced](/docs/grafana-cloud/) license. {{% admonition type="note" %}} It is possible to set up Grafana with SAML authentication using Azure AD. However, if an Azure AD user belongs to more than 150 groups, a Graph API endpoint is shared instead. @@ -54,8 +54,8 @@ As of Grafana 11.2, the SAML integration offers a mechanism to retrieve user gro Related links: - [Azure AD SAML limitations](https://learn.microsoft.com/en-us/entra/identity-platform/id-token-claims-reference#groups-overage-claim) -- [Set up SAML with Azure AD]({{< relref "../saml#set-up-saml-with-azure-ad" >}}) -- [Configure a Graph API application in Azure AD]({{< relref "../saml#configure-a-graph-api-application-in-azure-ad" >}}) +- [Set up SAML with Azure AD](../saml/#set-up-saml-with-azure-ad) +- [Configure a Graph API application in Azure AD](../saml/#configure-a-graph-api-application-in-azure-ad) {{% /admonition %}} ## Steps To Configure SAML Authentication @@ -68,12 +68,12 @@ Sign in to Grafana and navigate to **Administration > Authentication > Configure For assistance, consult the following table for additional guidance about certain fields: - | Field | Description | - | ------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | - | **Allow signup** | If enabled, you can create new users through the SAML login. If disabled, then only existing Grafana users can log in with SAML. | - | **Auto login** | If enabled, Grafana will attempt to automatically log in with SAML skipping the login screen. | - | **Single logout** | The SAML single logout feature enables users to log out from all applications associated with the current IdP session established using SAML SSO. For more information, refer to [SAML single logout documentation]]({{< relref "../saml#single-logout" >}}). | - | **Identity provider initiated login** | Enables users to log in to Grafana directly from the SAML IdP. For more information, refer to [IdP initiated login documentation]({{< relref "../saml#idp-initiated-single-sign-on-sso" >}}). | + | Field | Description | + | ------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | + | **Allow signup** | If enabled, you can create new users through the SAML login. If disabled, then only existing Grafana users can log in with SAML. | + | **Auto login** | If enabled, Grafana will attempt to automatically log in with SAML skipping the login screen. | + | **Single logout** | The SAML single logout feature enables users to log out from all applications associated with the current IdP session established using SAML SSO. For more information, refer to [SAML single logout documentation]](../saml/#single-logout). | + | **Identity provider initiated login** | Enables users to log in to Grafana directly from the SAML IdP. For more information, refer to [IdP initiated login documentation](../saml/#idp-initiated-single-sign-on-sso). | 1. Click **Next: Sign requests**. @@ -85,7 +85,7 @@ Sign in to Grafana and navigate to **Administration > Authentication > Configure Use the [PKCS #8](https://en.wikipedia.org/wiki/PKCS_8) format to issue the private key. - For more information, refer to an [example on how to generate SAML credentials]({{< relref "../saml#generate-private-key-for-saml-authentication" >}}). + For more information, refer to an [example on how to generate SAML credentials](../saml/#generate-private-key-for-saml-authentication). Alternatively, you can generate a new private key and certificate pair directly from the UI. Click on the `Generate key and certificate` button to open a form where you enter some information you want to be embedded into the new certificate. @@ -111,7 +111,7 @@ Sign in to Grafana and navigate to **Administration > Authentication > Configure ### 4. User Mapping Section -1. If you wish to [map user information from SAML assertions]({{< relref "../saml#assertion-mapping" >}}), complete the **Assertion attributes mappings** section. +1. If you wish to [map user information from SAML assertions](../saml/#assertion-mapping), complete the **Assertion attributes mappings** section. If Azure is the Identity Provider over SAML there are caveats for the assertion attribute mappings. Due to how Azure interprets these attributes the full URL will need to be entered in the corresponding fields within the UI, which should match the URLs from the metadata XML. There are differences depending on whether it's a Role or Group claim vs other assertions which Microsoft has [documented](https://learn.microsoft.com/en-us/entra/identity-platform/reference-claims-customization#table-2-saml-restricted-claim-set). @@ -132,15 +132,15 @@ http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress ![image](https://github.com/user-attachments/assets/23910ab8-20ec-4dfd-8ef6-7dbaec51ac90) You also need to configure the **Groups attribute** field if you want to use group synchronization. Group sync allows you to automatically map users to Grafana teams or role-based access control roles based on their SAML group membership. -To learn more about how to configure group synchronization, refer to [Configure team sync]({{< relref "../../configure-team-sync" >}}) and [Configure group attribute sync](https://grafana.com/docs/grafana//setup-grafana/configure-security/configure-group-attribute-sync) documentation. +To learn more about how to configure group synchronization, refer to [Configure team sync](../../configure-team-sync/) and [Configure group attribute sync](https://grafana.com/docs/grafana//setup-grafana/configure-security/configure-group-attribute-sync) documentation. 1. If you want to automatically assign users' roles based on their SAML roles, complete the **Role mapping** section. First, you need to configure the **Role attribute** field to specify which SAML attribute should be used to retrieve SAML role information. Then enter the SAML roles that you want to map to Grafana roles in **Role mapping** section. If you want to map multiple SAML roles to a Grafana role, separate them by a comma and a space. For example, `Editor: editor, developer`. - Role mapping will automatically update user's [basic role]({{< relref "../../../../administration/roles-and-permissions/access-control#basic-roles" >}}) based on their SAML roles every time the user logs in to Grafana. - Learn more about [SAML role synchronization]({{< relref "../saml#configure-role-sync" >}}). + Role mapping will automatically update user's [basic role](../../../../administration/roles-and-permissions/access-control/#basic-roles) based on their SAML roles every time the user logs in to Grafana. + Learn more about [SAML role synchronization](../saml/#configure-role-sync). 1. If you're setting up Grafana with Azure AD using the SAML protocol and want to fetch user groups from the Graph API, complete the **Azure AD Service Account Configuration** subsection. 1. Set up a service account in Azure AD and provide the necessary details in the **Azure AD Service Account Configuration** section. @@ -155,7 +155,7 @@ To learn more about how to configure group synchronization, refer to [Configure If you want users to have different roles in different organizations, you can additionally specify a role. For example, `Org mapping: Engineering:2:Editor` will map users who belong to `Engineering` organizations in SAML to Grafana organization with ID 2 and assign them Editor role. Organization mapping will automatically update user's organization memberships (and roles, if they have been configured) based on their SAML organization every time the user logs in to Grafana. - Learn more about [SAML organization mapping]({{< relref "../saml#configure-organization-mapping" >}}). + Learn more about [SAML organization mapping](../saml/#configure-organization-mapping). 1. If you want to limit the access to Grafana based on user's SAML organization membership, fill in the **Allowed organizations** field. 1. Click **Next: Test and enable**. diff --git a/docs/sources/setup-grafana/configure-security/configure-authentication/saml/index.md b/docs/sources/setup-grafana/configure-security/configure-authentication/saml/index.md index 0a438b8c727..28ac28100d3 100644 --- a/docs/sources/setup-grafana/configure-security/configure-authentication/saml/index.md +++ b/docs/sources/setup-grafana/configure-security/configure-authentication/saml/index.md @@ -22,7 +22,7 @@ weight: 500 # Configure SAML authentication using the configuration file {{% admonition type="note" %}} -Available in [Grafana Enterprise]({{< relref "../../../../introduction/grafana-enterprise" >}}) and [Grafana Cloud](/docs/grafana-cloud). +Available in [Grafana Enterprise](../../../../introduction/grafana-enterprise/) and [Grafana Cloud](/docs/grafana-cloud). {{% /admonition %}} SAML authentication integration allows 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. @@ -30,8 +30,8 @@ SAML authentication integration allows your Grafana users to log in by using an You can configure SAML authentication in Grafana through one of the following methods: - the Grafana configuration file -- the API (refer to [SSO Settings API]({{< relref "../../../../developers/http_api/sso-settings" >}})) -- the user interface (refer to [Configure SAML authentication using the Grafana user interface]({{< relref "../saml-ui" >}})) +- the API (refer to [SSO Settings API](../../../../developers/http_api/sso-settings/)) +- the user interface (refer to [Configure SAML authentication using the Grafana user interface](../saml-ui/)) - the Terraform provider (refer to [Terraform docs](https://registry.terraform.io/providers/grafana/grafana/latest/docs/resources/sso_settings)) {{% admonition type="note" %}} @@ -66,7 +66,7 @@ In terms of initiation, Grafana supports: - SP-initiated requests - IdP-initiated requests -By default, SP-initiated requests are enabled. For instructions on how to enable IdP-initiated logins, see [IdP-initiated Single Sign-On (SSO)]({{< relref "#idp-initiated-single-sign-on-sso" >}}). +By default, SP-initiated requests are enabled. For instructions on how to enable IdP-initiated logins, see [IdP-initiated Single Sign-On (SSO)](#idp-initiated-single-sign-on-sso). {{% admonition type="note" %}} It is possible to set up Grafana with SAML authentication using Azure AD. However, if an Azure AD user belongs to more than 150 groups, a Graph API endpoint is shared instead. @@ -78,21 +78,21 @@ As of Grafana 11.2, the SAML integration offers a mechanism to retrieve user gro Related links: - [Azure AD SAML limitations](https://learn.microsoft.com/en-us/entra/identity-platform/id-token-claims-reference#groups-overage-claim) -- [Set up SAML with Azure AD]({{< relref "#set-up-saml-with-azure-ad" >}}) -- [Configure a Graph API application in Azure AD]({{< relref "#configure-a-graph-api-application-in-azure-ad" >}}) +- [Set up SAML with Azure AD](#set-up-saml-with-azure-ad) +- [Configure a Graph API application in Azure AD](#configure-a-graph-api-application-in-azure-ad) {{% /admonition %}} ### Edit SAML options in the Grafana config file -1. In the `[auth.saml]` section in the Grafana configuration file, set [`enabled`]({{< relref "../../../configure-grafana/enterprise-configuration#enabled" >}}) to `true`. -1. Configure the [certificate and private key]({{< relref "#certificate-and-private-key" >}}). +1. In the `[auth.saml]` section in the Grafana configuration file, set [`enabled`](../../../configure-grafana/enterprise-configuration/#enabled) to `true`. +1. Configure the [certificate and private key](#certificate-and-private-key). 1. On the Okta application page where you have been redirected after application created, navigate to the **Sign On** tab and find **Identity Provider metadata** link in the **Settings** section. -1. Set the [`idp_metadata_url`]({{< relref "../../../configure-grafana/enterprise-configuration#idp_metadata_url" >}}) to the URL obtained from the previous step. The URL should look like `https://.okta.com/app//sso/saml/metadata`. +1. Set the [`idp_metadata_url`](../../../configure-grafana/enterprise-configuration/#idp_metadata_url) to the URL obtained from the previous step. The URL should look like `https://.okta.com/app//sso/saml/metadata`. 1. Set the following options to the attribute names configured at the **step 10** of the SAML integration setup. You can find this attributes on the **General** tab of the application page (**ATTRIBUTE STATEMENTS** and **GROUP ATTRIBUTE STATEMENTS** in the **SAML Settings** section). - - [`assertion_attribute_login`]({{< relref "../../../configure-grafana/enterprise-configuration#assertion_attribute_login" >}}) - - [`assertion_attribute_email`]({{< relref "../../../configure-grafana/enterprise-configuration#assertion_attribute_email" >}}) - - [`assertion_attribute_name`]({{< relref "../../../configure-grafana/enterprise-configuration#assertion_attribute_name" >}}) - - [`assertion_attribute_groups`]({{< relref "../../../configure-grafana/enterprise-configuration#assertion_attribute_groups" >}}) + - [`assertion_attribute_login`](../../../configure-grafana/enterprise-configuration/#assertion_attribute_login) + - [`assertion_attribute_email`](../../../configure-grafana/enterprise-configuration/#assertion_attribute_email) + - [`assertion_attribute_name`](../../../configure-grafana/enterprise-configuration/#assertion_attribute_name) + - [`assertion_attribute_groups`](../../../configure-grafana/enterprise-configuration/#assertion_attribute_groups) 1. (Optional) Set the `name` parameter in the `[auth.saml]` section in the Grafana configuration file. This parameter replaces SAML in the Grafana user interface in locations such as the sign-in button. 1. Save the configuration file and then restart the Grafana server. @@ -119,7 +119,7 @@ assertion_attribute_groups = Group To use the SAML integration, in the `auth.saml` section of in the Grafana custom configuration file, set `enabled` to `true`. -Refer to [Configuration]({{< relref "../../../configure-grafana" >}}) for more information about configuring Grafana. +Refer to [Configuration](../../../configure-grafana/) for more information about configuring Grafana. ## Additional configuration for HTTP-Post binding @@ -172,13 +172,13 @@ Grafana supports user authentication through Azure AD, which is useful when you **Before you begin:** - Ensure you have permission to administer SAML authentication. For more information about roles and permissions in Grafana. - - [Roles and permissions]({{< relref "../../../../administration/roles-and-permissions" >}}). + - [Roles and permissions](../../../../administration/roles-and-permissions/). - Learn the limitations of Azure AD SAML integration. - [Azure AD SAML limitations](https://learn.microsoft.com/en-us/entra/identity-platform/id-token-claims-reference#groups-overage-claim) - Configure SAML integration with Azure AD, create an app integration inside the Azure AD organization first. - [Add app integration in Azure AD](https://docs.microsoft.com/en-us/azure/active-directory/manage-apps/add-application-portal-configure) - If you have users that belong to more than 150 groups, you need to configure a registered application to provide an Azure Graph API to retrieve the groups. - - [Setup Azure AD Graph API applications]({{< relref "#set-up-saml-with-azure-ad" >}}) + - [Setup Azure AD Graph API applications](#set-up-saml-with-azure-ad) ### Generate self-signed certificates @@ -277,7 +277,7 @@ Grafana supports user authentication through Okta, which is useful when you want **Before you begin:** - To configure SAML integration with Okta, create an app integration inside the Okta organization first. [Add app integration in Okta](https://help.okta.com/en/prod/Content/Topics/Apps/apps-overview-add-apps.htm) -- Ensure you have permission to administer SAML authentication. For more information about roles and permissions in Grafana, refer to [Roles and permissions]({{< relref "../../../../administration/roles-and-permissions" >}}). +- Ensure you have permission to administer SAML authentication. For more information about roles and permissions in Grafana, refer to [Roles and permissions](../../../../administration/roles-and-permissions/). **To set up SAML with Okta:** @@ -391,7 +391,7 @@ Additionally, Grafana did not support IdP sessions and could not include the `Se Starting from Grafana version 11.5, Grafana uses the `NameID` from the SAML assertion to create the logout request. If the `NameID` is not present in the assertion, Grafana defaults to using the user's `Login` attribute. Additionally, Grafana supports including the `SessionIndex` in the logout request if it is provided in the SAML assertion by the IdP. {{% admonition type="note" %}} -These improvements are available in public preview behind the `improvedExternalSessionHandling` feature toggle, starting from Grafana v11.5. To enable it, refer to the [Configure feature toggles]({{< relref "../../../../setup-grafana/configure-grafana/feature-toggles/" >}}) +These improvements are available in public preview behind the `improvedExternalSessionHandling` feature toggle, starting from Grafana v11.5. To enable it, refer to the [Configure feature toggles](../../../configure-grafana/feature-toggles/) {{% /admonition %}} ### Assertion mapping @@ -435,7 +435,7 @@ auto_login = true Group synchronization allows you to map user groups from an identity provider to Grafana teams and roles. -To use SAML group synchronization, set [`assertion_attribute_groups`]({{< relref "../../../configure-grafana/enterprise-configuration#assertion_attribute_groups" >}}) to the attribute name where you store user groups. +To use SAML group synchronization, set [`assertion_attribute_groups`](../../../configure-grafana/enterprise-configuration/#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 to Grafana teams and grant them roles. {{% admonition type="note" %}} @@ -474,22 +474,22 @@ The following `External Group ID`s would be valid for configuring team sync or r - `admins_group` - `division_1` -To learn more about how to configure group synchronization, refer to [Configure team sync]({{< relref "../../configure-team-sync" >}}) and [Configure group attribute sync](https://grafana.com/docs/grafana//setup-grafana/configure-security/configure-group-attribute-sync) documentation. +To learn more about how to configure group synchronization, refer to [Configure team sync](../../configure-team-sync/) and [Configure group attribute sync](https://grafana.com/docs/grafana//setup-grafana/configure-security/configure-group-attribute-sync) documentation. ### Configure role sync -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 [Roles and permissions]({{< relref "../../../../administration/roles-and-permissions" >}}). +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 [Roles and permissions](../../../../administration/roles-and-permissions/). -1. In the configuration file, set [`assertion_attribute_role`]({{< relref "../../../configure-grafana/enterprise-configuration#assertion_attribute_role" >}}) option to the attribute name where the role information will be extracted from. -1. Set the [`role_values_none`]({{< relref "../../../configure-grafana/enterprise-configuration#role_values_none" >}}) option to the values mapped to the `None` role. -1. Set the [`role_values_viewer`]({{< relref "../../../configure-grafana/enterprise-configuration#role_values_viewer" >}}) option to the values mapped to the `Viewer` role. -1. Set the [`role_values_editor`]({{< relref "../../../configure-grafana/enterprise-configuration#role_values_editor" >}}) option to the values mapped to the `Editor` role. -1. Set the [`role_values_admin`]({{< relref "../../../configure-grafana/enterprise-configuration#role_values_admin" >}}) option to the values mapped to the organization `Admin` role. -1. Set the [`role_values_grafana_admin`]({{< relref "../../../configure-grafana/enterprise-configuration#role_values_grafana_admin" >}}) option to the values mapped to the `Grafana Admin` role. +1. In the configuration file, set [`assertion_attribute_role`](../../../configure-grafana/enterprise-configuration/#assertion_attribute_role) option to the attribute name where the role information will be extracted from. +1. Set the [`role_values_none`](../../../configure-grafana/enterprise-configuration/#role_values_none) option to the values mapped to the `None` role. +1. Set the [`role_values_viewer`](../../../configure-grafana/enterprise-configuration/#role_values_viewer) option to the values mapped to the `Viewer` role. +1. Set the [`role_values_editor`](../../../configure-grafana/enterprise-configuration/#role_values_editor) option to the values mapped to the `Editor` role. +1. Set the [`role_values_admin`](../../../configure-grafana/enterprise-configuration/#role_values_admin) option to the values mapped to the organization `Admin` role. +1. Set the [`role_values_grafana_admin`](../../../configure-grafana/enterprise-configuration/#role_values_grafana_admin) option to the values mapped to the `Grafana Admin` role. If a user role doesn't match any of configured values, then the role specified by the `auto_assign_org_role` config option will be assigned. If the `auto_assign_org_role` field is not set then the user role will default to `Viewer`. -For more information about roles and permissions in Grafana, refer to [Roles and permissions]({{< relref "../../../../administration/roles-and-permissions" >}}). +For more information about roles and permissions in Grafana, refer to [Roles and permissions](../../../../administration/roles-and-permissions/). Example configuration: @@ -518,8 +518,8 @@ skip_org_role_sync = true Organization mapping allows you to assign users to particular organization in Grafana depending on attribute value obtained from identity provider. -1. In configuration file, set [`assertion_attribute_org`]({{< relref "../../../configure-grafana/enterprise-configuration#assertion_attribute_org" >}}) to the attribute name you store organization info in. This attribute can be an array if you want a user to be in multiple organizations. -1. Set [`org_mapping`]({{< relref "../../../configure-grafana/enterprise-configuration#org_mapping" >}}) option to the comma-separated list of `Organization:OrgId` pairs to map organization from IdP to Grafana organization specified by ID. If you want users to have different roles in multiple organizations, you can set this option to a comma-separated list of `Organization:OrgId:Role` mappings. +1. In configuration file, set [`assertion_attribute_org`](../../../configure-grafana/enterprise-configuration/#assertion_attribute_org) to the attribute name you store organization info in. This attribute can be an array if you want a user to be in multiple organizations. +1. Set [`org_mapping`](../../../configure-grafana/enterprise-configuration/#org_mapping) option to the comma-separated list of `Organization:OrgId` pairs to map organization from IdP to Grafana organization specified by ID. If you want users to have different roles in multiple organizations, you can set this option to a comma-separated list of `Organization:OrgId:Role` mappings. For example, use following configuration to assign users from `Engineering` organization to the Grafana organization with ID `2` as Editor and users from `Sales` - to the org with ID `3` as Admin, based on `Org` assertion attribute value: @@ -566,7 +566,7 @@ You can use `*` as the Grafana organization in the mapping if you want all users ### Configure allowed organizations -With the [`allowed_organizations`]({{< relref "../../../configure-grafana/enterprise-configuration#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. +With the [`allowed_organizations`](../../../configure-grafana/enterprise-configuration/#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. To put values containing spaces in the list, use the following JSON syntax: @@ -636,7 +636,7 @@ Go to [Terraform Registry](https://registry.terraform.io/providers/grafana/grafa ## Troubleshoot SAML authentication in Grafana -To troubleshoot and get more log information, enable SAML debug logging in the configuration file. Refer to [Configuration]({{< relref "../../../configure-grafana#filters" >}}) for more information. +To troubleshoot and get more log information, enable SAML debug logging in the configuration file. Refer to [Configuration](../../../configure-grafana/#filters) for more information. ```ini [log] @@ -692,7 +692,7 @@ The keys you provide should look like: When the user logs in using SAML and gets presented with "origin not allowed", the user might be issuing the login from an IdP (identity provider) service or the user is behind a reverse proxy. This potentially happens as Grafana's CSRF checks deem the requests to be invalid. For more information [CSRF](https://owasp.org/www-community/attacks/csrf). -To solve this issue, you can configure either the [`csrf_trusted_origins`]({{< relref "../../../configure-grafana#csrf_trusted_origins" >}}) or [`csrf_additional_headers`]({{< relref "../../../configure-grafana#csrf_additional_headers" >}}) option in the SAML configuration. +To solve this issue, you can configure either the [`csrf_trusted_origins`](../../../configure-grafana/#csrf_trusted_origins) or [`csrf_additional_headers`](../../../configure-grafana/#csrf_additional_headers) option in the SAML configuration. Example of a configuration file: @@ -735,7 +735,7 @@ Ensure cookie_secure is set to true to ensure that cookies are only sent over HT ## Configure SAML authentication in Grafana -The table below describes all SAML configuration options. Continue reading below for details on specific options. Like any other Grafana configuration, you can apply these options as [environment variables]({{< relref "../../../configure-grafana#override-configuration-with-environment-variables" >}}). +The table below describes all SAML configuration options. Continue reading below for details on specific options. Like any other Grafana configuration, you can apply these options as [environment variables](../../../configure-grafana/#override-configuration-with-environment-variables). | Setting | Required | Description | Default | | ---------------------------------------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------- | diff --git a/docs/sources/setup-grafana/configure-security/configure-database-encryption/_index.md b/docs/sources/setup-grafana/configure-security/configure-database-encryption/_index.md index 52a34ebc39b..a6f7f132ca0 100644 --- a/docs/sources/setup-grafana/configure-security/configure-database-encryption/_index.md +++ b/docs/sources/setup-grafana/configure-security/configure-database-encryption/_index.md @@ -16,32 +16,32 @@ weight: 700 Grafana’s database contains secrets, which are used to query data sources, send alert notifications, and perform other functions within Grafana. -Grafana encrypts these secrets before they are written to the database, by using a symmetric-key encryption algorithm called Advanced Encryption Standard (AES). These secrets are signed using a [secret key]({{< relref "../../configure-grafana#secret_key" >}}) that you can change when you configure a new Grafana instance. +Grafana encrypts these secrets before they are written to the database, by using a symmetric-key encryption algorithm called Advanced Encryption Standard (AES). These secrets are signed using a [secret key](../../configure-grafana/#secret_key) that you can change when you configure a new Grafana instance. {{% admonition type="note" %}} Grafana v9.0 and newer use [envelope encryption](#envelope-encryption) by default, which adds a layer of indirection to the encryption process that introduces an [**implicit breaking change**](#implicit-breaking-change) for older versions of Grafana. {{% /admonition %}} -For further details about how to operate a Grafana instance with envelope encryption, see the [Operational work]({{< relref "#operational-work" >}}) section. +For further details about how to operate a Grafana instance with envelope encryption, see the [Operational work](#operational-work) section. {{% admonition type="note" %}} -In Grafana Enterprise, you can also [encrypt secrets in AES-GCM (Galois/Counter Mode)]({{< relref "#changing-your-encryption-mode-to-aes-gcm" >}}) instead of the default AES-CFB (Cipher FeedBack mode). +In Grafana Enterprise, you can also [encrypt secrets in AES-GCM (Galois/Counter Mode)](#changing-your-encryption-mode-to-aes-gcm) instead of the default AES-CFB (Cipher FeedBack mode). {{% /admonition %}} ## Envelope encryption {{% admonition type="note" %}} -Since Grafana v9.0, you can turn envelope encryption off by adding the feature toggle `disableEnvelopeEncryption` to your [Grafana configuration]({{< relref "../../configure-grafana#feature_toggles" >}}). +Since Grafana v9.0, you can turn envelope encryption off by adding the feature toggle `disableEnvelopeEncryption` to your [Grafana configuration](../../configure-grafana/#feature_toggles). {{% /admonition %}} Instead of encrypting all secrets with a single key, Grafana uses a set of keys called data encryption keys (DEKs) to encrypt them. These data encryption keys are themselves encrypted with a single key encryption key (KEK), configured through the `secret_key` attribute in your -[Grafana configuration]({{< relref "../../configure-grafana#secret_key" >}}) or by [Encrypting your database with a key from a key management service (KMS)](#encrypting-your-database-with-a-key-from-a-key-management-service-kms). +[Grafana configuration](../../configure-grafana/#secret_key) or by [Encrypting your database with a key from a key management service (KMS)](#encrypting-your-database-with-a-key-from-a-key-management-service-kms). ### Implicit breaking change Envelope encryption introduces an implicit breaking change to versions of Grafana prior to v9.0, because it changes how secrets stored in the Grafana database are encrypted. Grafana administrators can upgrade to Grafana v9.0 with no action required from the database encryption perspective, but must be extremely careful if they need to roll an upgrade back to Grafana v8.5 or earlier because secrets created or modified after upgrading to Grafana v9.0 can’t be decrypted by previous versions. -Grafana v8.5 implemented envelope encryption behind an optional feature toggle. Grafana administrators who need to downgrade to Grafana v8.5 can enable envelope encryption as a workaround by adding the feature toggle `envelopeEncryption` to the [Grafana configuration]({{< relref "../../configure-grafana#feature_toggles" >}}). +Grafana v8.5 implemented envelope encryption behind an optional feature toggle. Grafana administrators who need to downgrade to Grafana v8.5 can enable envelope encryption as a workaround by adding the feature toggle `envelopeEncryption` to the [Grafana configuration](../../configure-grafana/#feature_toggles). ## Operational work @@ -59,19 +59,19 @@ You can re-encrypt secrets in order to: - Move already existing secrets' encryption forward from legacy to envelope encryption. - Re-encrypt secrets after a [data keys rotation](#rotate-data-keys). -To re-encrypt secrets, use the [Grafana CLI]({{< relref "../../../cli" >}}) by running the `grafana cli admin secrets-migration re-encrypt` command or the `/encryption/reencrypt-secrets` endpoint of the Grafana [Admin API]({{< relref "../../../developers/http_api/admin#roll-back-secrets" >}}). It's safe to run more than once, more recommended under maintenance mode. +To re-encrypt secrets, use the [Grafana CLI](../../../cli/) by running the `grafana cli admin secrets-migration re-encrypt` command or the `/encryption/reencrypt-secrets` endpoint of the Grafana [Admin API](../../../developers/http_api/admin/#roll-back-secrets). It's safe to run more than once, more recommended under maintenance mode. ### Roll back secrets You can roll back secrets encrypted with envelope encryption to legacy encryption. This might be necessary to downgrade to Grafana versions prior to v9.0 after an unsuccessful upgrade. -To roll back secrets, use the [Grafana CLI]({{< relref "../../../cli" >}}) by running the `grafana cli admin secrets-migration rollback` command or the `/encryption/rollback-secrets` endpoint of the Grafana [Admin API]({{< relref "../../../developers/http_api/admin#re-encrypt-secrets" >}}). It's safe to run more than once, more recommended under maintenance mode. +To roll back secrets, use the [Grafana CLI](../../../cli/) by running the `grafana cli admin secrets-migration rollback` command or the `/encryption/rollback-secrets` endpoint of the Grafana [Admin API](../../../developers/http_api/admin/#re-encrypt-secrets). It's safe to run more than once, more recommended under maintenance mode. ### Re-encrypt data keys You can re-encrypt data keys encrypted with a specific key encryption key (KEK). This allows you to either re-encrypt existing data keys with a new KEK version or to re-encrypt them with a completely different KEK. -To re-encrypt data keys, use the [Grafana CLI]({{< relref "../../../cli" >}}) by running the `grafana cli admin secrets-migration re-encrypt-data-keys` command or the `/encryption/reencrypt-data-keys` endpoint of the Grafana [Admin API]({{< relref "../../../developers/http_api/admin#re-encrypt-data-encryption-keys" >}}). It's safe to run more than once, more recommended under maintenance mode. +To re-encrypt data keys, use the [Grafana CLI](../../../cli/) by running the `grafana cli admin secrets-migration re-encrypt-data-keys` command or the `/encryption/reencrypt-data-keys` endpoint of the Grafana [Admin API](../../../developers/http_api/admin/#re-encrypt-data-encryption-keys). It's safe to run more than once, more recommended under maintenance mode. ### Rotate data keys @@ -85,7 +85,7 @@ secrets still encrypted with them. To completely stop using rotated data keys for both encryption and decryption, see [secrets re-encryption](#re-encrypt-secrets). {{% /admonition %}} -To rotate data keys, use the `/encryption/rotate-data-keys` endpoint of the Grafana [Admin API]({{< relref "../../../developers/http_api/admin#rotate-data-encryption-keys" >}}). It's safe to call more than once, more recommended under maintenance mode. +To rotate data keys, use the `/encryption/rotate-data-keys` endpoint of the Grafana [Admin API](../../../developers/http_api/admin/#rotate-data-encryption-keys). It's safe to call more than once, more recommended under maintenance mode. ## Encrypting your database with a key from a key management service (KMS) @@ -95,13 +95,13 @@ You can choose to encrypt secrets stored in the Grafana database using a key fro Grafana integrates with the following key management services: -- [AWS KMS]({{< relref "./encrypt-secrets-using-aws-kms" >}}) -- [Azure Key Vault]({{< relref "./encrypt-secrets-using-azure-key-vault" >}}) -- [Google Cloud KMS]({{< relref "./encrypt-secrets-using-google-cloud-kms" >}}) -- [Hashicorp Key Vault]({{< relref "./encrypt-secrets-using-hashicorp-key-vault" >}}) +- [AWS KMS](encrypt-secrets-using-aws-kms/) +- [Azure Key Vault](encrypt-secrets-using-azure-key-vault/) +- [Google Cloud KMS](encrypt-secrets-using-google-cloud-kms/) +- [Hashicorp Key Vault](encrypt-secrets-using-hashicorp-key-vault/) ## Changing your encryption mode to AES-GCM Grafana encrypts secrets using Advanced Encryption Standard in Cipher FeedBack mode (AES-CFB). You might prefer to use AES in Galois/Counter Mode (AES-GCM) instead, to meet your company’s security requirements or in order to maintain consistency with other services. -To change your encryption mode, update the `algorithm` value in the `[security.encryption]` section of your Grafana configuration file. For further details, refer to [Enterprise configuration]({{< relref "../../configure-grafana/enterprise-configuration#securityencryption" >}}). +To change your encryption mode, update the `algorithm` value in the `[security.encryption]` section of your Grafana configuration file. For further details, refer to [Enterprise configuration](../../configure-grafana/enterprise-configuration/#securityencryption). diff --git a/docs/sources/setup-grafana/configure-security/configure-database-encryption/encrypt-secrets-using-aws-kms/index.md b/docs/sources/setup-grafana/configure-security/configure-database-encryption/encrypt-secrets-using-aws-kms/index.md index f27851f1bd4..d081a085cb6 100644 --- a/docs/sources/setup-grafana/configure-security/configure-database-encryption/encrypt-secrets-using-aws-kms/index.md +++ b/docs/sources/setup-grafana/configure-security/configure-database-encryption/encrypt-secrets-using-aws-kms/index.md @@ -17,7 +17,7 @@ You can use an encryption key from AWS Key Management Service to encrypt secrets **Prerequisites:** - An AWS account with permission to view and create KMS keys and programmatic credentials to access those keys -- Access to the Grafana [configuration]({{< relref "../../../configure-grafana#configuration-file-location" >}}) file +- Access to the Grafana [configuration](../../../configure-grafana/#configuration-file-location) file 1. Create a symmetric API key either from the AWS Management Console or by using the AWS KMS API.

For detailed instructions, refer to [Creating keys](https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html). diff --git a/docs/sources/setup-grafana/configure-security/configure-database-encryption/encrypt-secrets-using-azure-key-vault/index.md b/docs/sources/setup-grafana/configure-security/configure-database-encryption/encrypt-secrets-using-azure-key-vault/index.md index e90f81bc6d0..a13d6f7b41e 100644 --- a/docs/sources/setup-grafana/configure-security/configure-database-encryption/encrypt-secrets-using-azure-key-vault/index.md +++ b/docs/sources/setup-grafana/configure-security/configure-database-encryption/encrypt-secrets-using-azure-key-vault/index.md @@ -17,7 +17,7 @@ You can use an encryption key from Azure Key Vault to encrypt secrets in the Gra **Prerequisites:** - An Azure account with permission to view and create Key Vault keys and programmatic credentials to access those keys -- Access to the Grafana [configuration]({{< relref "../../../configure-grafana#configuration-file-location" >}}) file +- Access to the Grafana [configuration](../../../configure-grafana/#configuration-file-location) file 1. [Create a vault](https://docs.microsoft.com/en-us/azure/key-vault/general/quick-create-portal#create-a-vault). diff --git a/docs/sources/setup-grafana/configure-security/configure-database-encryption/encrypt-secrets-using-google-cloud-kms/index.md b/docs/sources/setup-grafana/configure-security/configure-database-encryption/encrypt-secrets-using-google-cloud-kms/index.md index 240836fa303..3d90697e310 100644 --- a/docs/sources/setup-grafana/configure-security/configure-database-encryption/encrypt-secrets-using-google-cloud-kms/index.md +++ b/docs/sources/setup-grafana/configure-security/configure-database-encryption/encrypt-secrets-using-google-cloud-kms/index.md @@ -17,7 +17,7 @@ You can use an encryption key from Google Cloud Key Management Service to encryp **Prerequisites:** - A Google Cloud account with permission to list and create KMS keys and service accounts to access those keys -- Access to the Grafana [configuration]({{< relref "../../../configure-grafana#configuration-file-location" >}}) file +- Access to the Grafana [configuration](../../../configure-grafana/#configuration-file-location) file 1. [Create a key ring](https://cloud.google.com/kms/docs/creating-keys#kms-create-key-ring-console) in Google Cloud KMS. diff --git a/docs/sources/setup-grafana/configure-security/configure-database-encryption/encrypt-secrets-using-hashicorp-key-vault/index.md b/docs/sources/setup-grafana/configure-security/configure-database-encryption/encrypt-secrets-using-hashicorp-key-vault/index.md index 76bfd46686a..e15a46679b0 100644 --- a/docs/sources/setup-grafana/configure-security/configure-database-encryption/encrypt-secrets-using-hashicorp-key-vault/index.md +++ b/docs/sources/setup-grafana/configure-security/configure-database-encryption/encrypt-secrets-using-hashicorp-key-vault/index.md @@ -17,7 +17,7 @@ You can use an encryption key from Hashicorp Vault to encrypt secrets in the Gra **Prerequisites:** - Permissions to manage Hashicorp Vault to enable secrets engines and issue tokens. -- Access to the Grafana [configuration]({{< relref "../../../configure-grafana#configuration-file-location" >}}) file +- Access to the Grafana [configuration](../../../configure-grafana/#configuration-file-location) file 1. [Enable the transit secrets engine](https://www.vaultproject.io/docs/secrets/transit#setup) in Hashicorp Vault. diff --git a/docs/sources/setup-grafana/configure-security/configure-database-encryption/integrate-with-hashicorp-vault/index.md b/docs/sources/setup-grafana/configure-security/configure-database-encryption/integrate-with-hashicorp-vault/index.md index 12e8707d459..4af6636eaef 100644 --- a/docs/sources/setup-grafana/configure-security/configure-database-encryption/integrate-with-hashicorp-vault/index.md +++ b/docs/sources/setup-grafana/configure-security/configure-database-encryption/integrate-with-hashicorp-vault/index.md @@ -13,14 +13,14 @@ weight: 500 # Integrate Grafana with Hashicorp Vault -If you manage your secrets with [Hashicorp Vault](https://www.hashicorp.com/products/vault), you can use them for [Configuration]({{< relref "../../../configure-grafana" >}}) and [Provisioning]({{< relref "../../../../administration/provisioning" >}}). +If you manage your secrets with [Hashicorp Vault](https://www.hashicorp.com/products/vault), you can use them for [Configuration](../../../configure-grafana/) and [Provisioning](../../../../administration/provisioning/). {{% admonition type="note" %}} -Available in [Grafana Enterprise]({{< relref "../../../../introduction/grafana-enterprise" >}}). +Available in [Grafana Enterprise](../../../../introduction/grafana-enterprise/). {{% /admonition %}} {{% admonition type="note" %}} -If you have Grafana [set up for high availability]({{< relref "../../../set-up-for-high-availability" >}}), then we advise not to use dynamic secrets for provisioning files. +If you have Grafana [set up for high availability](../../../set-up-for-high-availability/), 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. {{% /admonition %}} @@ -63,7 +63,7 @@ token = s.sAZLyI0r7sFLMPq6MWtoOhAN # replace with your key ## Using the Vault expander After you configure Vault, you must set the configuration or provisioning files you wish to -use Vault. Vault configuration is an extension of configuration's [variable expansion]({{< relref "../../../configure-grafana#variable-expansion" >}}) and follows the +use Vault. Vault configuration is an extension of configuration's [variable expansion](../../../configure-grafana/#variable-expansion) and follows the `$__vault{}` syntax. The argument to Vault consists of three parts separated by a colon: @@ -101,12 +101,12 @@ $__vault{database:database/creds/grafana:username} ### Examples -The following examples show you how to set your [configuration]({{< relref "../../../configure-grafana" >}}) or [provisioning]({{< relref "../../../../administration/provisioning" >}}) files to use Vault to retrieve configuration values. +The following examples show you how to set your [configuration](../../../configure-grafana/) or [provisioning](../../../../administration/provisioning/) files to use Vault to retrieve configuration values. #### Configuration The following is a partial example for using Vault to set up a Grafana configuration file's email and database credentials. -Refer to [Configuration]({{< relref "../../../configure-grafana" >}}) for more information. +Refer to [Configuration](../../../configure-grafana/) for more information. ```ini [smtp] @@ -127,7 +127,7 @@ password = $__vault{database:database/creds/grafana:password} The following is a full examples of a provisioning YAML file setting up a MySQL data source using Vault's database secrets engine. -Refer to [Provisioning]({{< relref "../../../../administration/provisioning" >}}) for more information. +Refer to [Provisioning](../../../../administration/provisioning/) for more information. **provisioning/custom.yaml** diff --git a/docs/sources/setup-grafana/configure-security/configure-request-security.md b/docs/sources/setup-grafana/configure-security/configure-request-security.md index 3a5c393a22d..3ef83ccdcb6 100644 --- a/docs/sources/setup-grafana/configure-security/configure-request-security.md +++ b/docs/sources/setup-grafana/configure-security/configure-request-security.md @@ -19,7 +19,7 @@ Request security allows you to limit requests from the Grafana server by targeti 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. {{% admonition type="note" %}} -Available in [Grafana Enterprise]({{< relref "../../introduction/grafana-enterprise" >}}) and [Grafana Cloud Pro and Advanced](/docs/grafana-cloud/). +Available in [Grafana Enterprise](../../../introduction/grafana-enterprise/) and [Grafana Cloud Pro and Advanced](/docs/grafana-cloud/). {{% /admonition %}} {{% admonition type="note" %}} diff --git a/docs/sources/setup-grafana/configure-security/configure-security-hardening/index.md b/docs/sources/setup-grafana/configure-security/configure-security-hardening/index.md index bc0dae58b4a..f5e66394faf 100644 --- a/docs/sources/setup-grafana/configure-security/configure-security-hardening/index.md +++ b/docs/sources/setup-grafana/configure-security/configure-security-hardening/index.md @@ -15,7 +15,7 @@ title: Configure security hardening Security hardening enables you to apply additional security, which can help stop certain vulnerabilities from being exploited by a malicious attacker. {{% admonition type="note" %}} -These settings are available in the [grafana.ini configuration file]({{< relref "../../configure-grafana#configuration-file-location" >}}). To apply changes to the configuration file, restart the Grafana server. +These settings are available in the [grafana.ini configuration file](../../configure-grafana/#configuration-file-location). To apply changes to the configuration file, restart the Grafana server. {{% /admonition %}} ## Additional security for cookies diff --git a/docs/sources/setup-grafana/configure-security/configure-team-sync.md b/docs/sources/setup-grafana/configure-security/configure-team-sync.md index 89665525574..dfe6d4f2c99 100644 --- a/docs/sources/setup-grafana/configure-security/configure-team-sync.md +++ b/docs/sources/setup-grafana/configure-security/configure-team-sync.md @@ -16,7 +16,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. -> **Note:** Available in [Grafana Enterprise]({{< relref "../../introduction/grafana-enterprise" >}}) and [Grafana Cloud Advanced](/docs/grafana-cloud/). +> **Note:** Available in [Grafana Enterprise](../../../introduction/grafana-enterprise/) and [Grafana Cloud Advanced](/docs/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. diff --git a/docs/sources/setup-grafana/configure-security/export-logs.md b/docs/sources/setup-grafana/configure-security/export-logs.md index 56c6dfc9831..d3b1c1e1530 100644 --- a/docs/sources/setup-grafana/configure-security/export-logs.md +++ b/docs/sources/setup-grafana/configure-security/export-logs.md @@ -18,7 +18,7 @@ weight: 900 # Export logs of usage insights {{% admonition type="note" %}} -Available in [Grafana Enterprise]({{< relref "../../introduction/grafana-enterprise" >}}) and [Grafana Cloud Pro and Advanced](/docs/grafana-cloud/). +Available in [Grafana Enterprise](../../../introduction/grafana-enterprise/) and [Grafana Cloud Pro and Advanced](/docs/grafana-cloud/). {{% /admonition %}} 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. This configuration is done for you in Grafana Cloud, with provisioned dashboards. Read about them in the [Grafana Cloud documentation](/docs/grafana-cloud/usage-insights/). @@ -66,7 +66,7 @@ Logs of usage insights contain the following fields, where the fields followed b ## Configuration -To export your logs, enable the usage insights feature and [configure]({{< relref "../../setup-grafana/configure-grafana" >}}) an export location in the configuration file: +To export your logs, enable the usage insights feature and [configure](../../configure-grafana/) an export location in the configuration file: ```ini [usage_insights.export] @@ -96,7 +96,7 @@ tls = true tenant_id = ``` -Using `logger` will print usage insights to your [Grafana server log]({{< relref "../../setup-grafana/configure-grafana#log" >}}). +Using `logger` will print usage insights to your [Grafana server log](../../configure-grafana/#log). There is no option for configuring the `logger` storage type. ## Visualize Loki usage insights in Grafana @@ -110,4 +110,4 @@ If you export logs into Loki, you can build Grafana dashboards to understand you 1. Play with usage insights to understand them: - In Explore, you can use the query `{datasource="gdev-loki",kind="usage_insights"}` to retrieve all logs related to your `gdev-loki` data source. - In a dashboard, you can build a table panel with the query `topk(10, sum by (error) (count_over_time({kind="usage_insights", datasource="gdev-prometheus"} | json | error != "" [$__interval])))` to display the 10 most common errors your users see using the `gdev-prometheus` data source. - - In a dashboard, you can build a graph panel with the queries `sum by(host) (count_over_time({kind="usage_insights"} | json | eventName="data-request" | error != "" [$__interval]))` and `sum by(host) (count_over_time({kind="usage_insights"} | json | eventName="data-request" | error = "" [$__interval]))` to show the evolution of the data request count over time. Using `by (host)` allows you to have more information for each Grafana server you have if you have set up Grafana for [high availability](<{{< relref "../../setup-grafana/set-up-for-high-availability/" >}}>). + - In a dashboard, you can build a graph panel with the queries `sum by(host) (count_over_time({kind="usage_insights"} | json | eventName="data-request" | error != "" [$__interval]))` and `sum by(host) (count_over_time({kind="usage_insights"} | json | eventName="data-request" | error = "" [$__interval]))` to show the evolution of the data request count over time. Using `by (host)` allows you to have more information for each Grafana server you have if you have set up Grafana for [high availability](../../set-up-for-high-availability/). diff --git a/docs/sources/setup-grafana/configure-security/planning-iam-strategy/index.md b/docs/sources/setup-grafana/configure-security/planning-iam-strategy/index.md index 92ac9f1c5f3..d553d33c343 100644 --- a/docs/sources/setup-grafana/configure-security/planning-iam-strategy/index.md +++ b/docs/sources/setup-grafana/configure-security/planning-iam-strategy/index.md @@ -12,7 +12,7 @@ keywords: # Plan your IAM integration strategy -This section describes the decisions you should make when using an Identity and Access Management (IAM) provider to manage access to Grafana. IAM ensures that users have secure access to sensitive data and [other resources]({{< relref "../../../administration/data-source-management" >}}), simplifying user management and authentication. +This section describes the decisions you should make when using an Identity and Access Management (IAM) provider to manage access to Grafana. IAM ensures that users have secure access to sensitive data and [other resources](../../../administration/data-source-management/), simplifying user management and authentication. ## Benefits of integrating with an IAM provider @@ -33,12 +33,12 @@ In order to plan an integration with Grafana, assess your organization's current As a first step, determine how you want to manage users who will access Grafana. Do you already use an identity provider to manage users? If so, Grafana might be able to integrate with your identity provider through one of our IdP integrations. -Refer to [Configure authentication documentation]({{< relref "../../configure-security/configure-authentication" >}}) for the list of supported providers. +Refer to [Configure authentication documentation](../configure-authentication/) for the list of supported providers. If you are not interested in setting up an external identity provider, but still want to limit access to your Grafana instance, consider using Grafana's basic authentication. Finally, if you want your Grafana instance to be accessible to everyone, you can enable anonymous access to Grafana. -For information, refer to the [anonymous authentication documentation]({{< relref "../../configure-security/configure-authentication#anonymous-authentication" >}}). +For information, refer to the [anonymous authentication documentation](../configure-authentication/#anonymous-authentication). ## Ways to organize users @@ -51,7 +51,7 @@ Organize users in subgroups that are sensible to the organization. For example: ### Users in Grafana teams -You can organize users into [teams]({{< relref "../../../administration/team-management" >}}) and assign them roles and permissions reflecting the current organization. For example, instead of assigning five users access to the same dashboard, you can create a team of those users and assign dashboard permissions to the team. +You can organize users into [teams](../../../administration/team-management/) and assign them roles and permissions reflecting the current organization. For example, instead of assigning five users access to the same dashboard, you can create a team of those users and assign dashboard permissions to the team. A user can belong to multiple teams and be a member or an administrator for a given team. Team members inherit permissions from the team but cannot edit the team itself. Team administrators can add members to a team and update its settings, such as the team name, team members, roles assigned, and UI preferences. @@ -59,17 +59,17 @@ Teams are a perfect solution for working with a subset of users. Teams can share ### Users in Grafana organizations -[Grafana organizations]({{< relref "../../../administration/organization-management" >}}) allow complete isolation of resources, such as dashboards and data sources. Users can be members of one or several organizations, and they can only access resources from an organization they belong to. +[Grafana organizations](../../../administration/organization-management/) allow complete isolation of resources, such as dashboards and data sources. Users can be members of one or several organizations, and they can only access resources from an organization they belong to. Having multiple organizations in a single instance of Grafana lets you manage your users in one place while completely separating resources. -Organizations provide a higher measure of isolation within Grafana than teams do and can be helpful in certain scenarios. However, because organizations lack the scalability and flexibility of teams and [folders]({{< relref "../../../dashboards/manage-dashboards#create-a-dashboard-folder" >}}), we do not recommend using them as the default way to group users and resources. +Organizations provide a higher measure of isolation within Grafana than teams do and can be helpful in certain scenarios. However, because organizations lack the scalability and flexibility of teams and [folders](../../../dashboards/manage-dashboards/#create-a-dashboard-folder), we do not recommend using them as the default way to group users and resources. Note that Grafana Cloud does not support having more than 1 organizations per instance. ### Choosing between teams and organizations -[Grafana teams]({{< relref "../../../administration/team-management" >}}) and Grafana organizations serve similar purposes in the Grafana platform. Both are designed to help group users and manage and control access to resources. +[Grafana teams](../../../administration/team-management/) and Grafana organizations serve similar purposes in the Grafana platform. Both are designed to help group users and manage and control access to resources. Teams provide more flexibility, as resources can be accessible by multiple teams, and team creation and management are simple. @@ -106,7 +106,7 @@ A common use case for creating a service account is to perform operations on aut - Set up an external SAML authentication provider - Interact with Grafana without signing in as a user -In [Grafana Enterprise]({{< relref "../../../introduction/grafana-enterprise" >}}), you can also use service accounts in combination with [role-based access control]({{< relref "../../../administration/roles-and-permissions/access-control" >}}) to grant very specific permissions to applications that interact with Grafana. +In [Grafana Enterprise](../../../introduction/grafana-enterprise/), you can also use service accounts in combination with [role-based access control](../../../administration/roles-and-permissions/access-control/) to grant very specific permissions to applications that interact with Grafana. {{% admonition type="note" %}} Service accounts can only act in the organization they are created for. We recommend creating service accounts in each organization if you have the same task needed for multiple organizations. @@ -136,7 +136,7 @@ Service account access tokens inherit permissions from the service account. ### API keys {{% admonition type="note" %}} -Grafana recommends using service accounts instead of API keys. API keys will be deprecated in the near future. For more information, refer to [Grafana service accounts]({{< relref ".#service-accounts" >}}). +Grafana recommends using service accounts instead of API keys. API keys will be deprecated in the near future. For more information, refer to [Grafana service accounts](./#service-accounts). {{% /admonition %}} You can use Grafana API keys to interact with data sources via HTTP APIs. @@ -149,7 +149,7 @@ You can assign roles through the user interface or APIs, establish them through ### What are roles? -Within an organization, Grafana has established three primary [organization roles]({{< relref "../../../administration/roles-and-permissions#organization-roles" >}}) - organization administrator, editor, and viewer - which dictate the user's level of access and permissions, including the ability to edit data sources or create teams. Grafana also has an empty role that you can start with and to which you can gradually add custom permissions. +Within an organization, Grafana has established three primary [organization roles](../../../administration/roles-and-permissions/#organization-roles) - organization administrator, editor, and viewer - which dictate the user's level of access and permissions, including the ability to edit data sources or create teams. Grafana also has an empty role that you can start with and to which you can gradually add custom permissions. To be a member of any organization, every user must be assigned a role. In addition, Grafana provides a server administrator role that grants access to and enables interaction with resources that affect the entire instance, including organizations, users, and server-wide settings. @@ -157,23 +157,23 @@ This particular role can only be accessed by users of self-hosted Grafana instan ### What are permissions? -Each role consists of a set of [permissions]({{< relref "../../../administration/roles-and-permissions#dashboard-permissions" >}}) that determine the tasks a user can perform in the system. +Each role consists of a set of [permissions](../../../administration/roles-and-permissions/#dashboard-permissions) that determine the tasks a user can perform in the system. For example, the **Admin** role includes permissions that let an administrator create and delete users. Grafana allows for precise permission settings on both dashboards and folders, giving you the ability to control which users and teams can view, edit, and administer them. For example, you might want a certain viewer to be able to edit a dashboard. While that user can see all dashboards, you can grant them access to update only one of them. -In [Grafana Enterprise]({{< relref "../../../introduction/grafana-enterprise" >}}), you can also grant granular permissions for data sources to control who can query and edit them. +In [Grafana Enterprise](../../../introduction/grafana-enterprise/), you can also grant granular permissions for data sources to control who can query and edit them. Dashboard, folder, and data source permissions can be set through the UI or APIs or provisioned through Terraform. ### Role-based access control {{% admonition type="note" %}} -Available in [Grafana Enterprise]({{< relref "../../../introduction/grafana-enterprise" >}}) and [Grafana Cloud](/docs/grafana-cloud/). +Available in [Grafana Enterprise](../../../introduction/grafana-enterprise/) and [Grafana Cloud](/docs/grafana-cloud/). {{% /admonition %}} -If you think that the basic organization and server administrator roles are too limiting, it might be beneficial to employ [role-based access control (RBAC)]({{< relref "../../../administration/roles-and-permissions/access-control" >}}). +If you think that the basic organization and server administrator roles are too limiting, it might be beneficial to employ [role-based access control (RBAC)](../../../administration/roles-and-permissions/access-control/). RBAC is a flexible approach to managing user access to Grafana resources, including users, data sources, and reports. It enables easy granting, changing, and revoking of read and write access for users. RBAC comes with pre-defined roles, such as data source writer, which allows updating, reading, or querying all data sources. @@ -190,7 +190,7 @@ When connecting Grafana to an identity provider, it's important to think beyond Team sync is a feature that allows you to synchronize teams or groups from your authentication provider with teams in Grafana. This means that users of specific teams or groups in LDAP, OAuth, or SAML will be automatically added or removed as members of corresponding teams in Grafana. Whenever a user logs in, Grafana will check for any changes in the teams or groups of the authentication provider and update the user's teams in Grafana accordingly. This makes it easy to manage user permissions across multiple systems. {{% admonition type="note" %}} -Available in [Grafana Enterprise]({{< relref "../../../introduction/grafana-enterprise" >}}) and [Grafana Cloud Advanced](/docs/grafana-cloud/). +Available in [Grafana Enterprise](../../../introduction/grafana-enterprise/) and [Grafana Cloud Advanced](/docs/grafana-cloud/). {{% /admonition %}} {{% admonition type="note" %}} diff --git a/docs/sources/setup-grafana/configure-security/secret-scan.md b/docs/sources/setup-grafana/configure-security/secret-scan.md index 031c1c06175..8029c476ded 100644 --- a/docs/sources/setup-grafana/configure-security/secret-scan.md +++ b/docs/sources/setup-grafana/configure-security/secret-scan.md @@ -11,7 +11,7 @@ weight: 1000 # Configure Grafana secret scanning and notifications -With Grafana, you can use the GitHub Secret Scanning service to determine if your [service account tokens]({{< relref "../../administration/service-accounts" >}}) have been leaked on GitHub. +With Grafana, you can use the GitHub Secret Scanning service to determine if your [service account tokens](../../../administration/service-accounts/) have been leaked on GitHub. When GitHub Secret Scanning detects a Grafana secret, its hash is stored in Grafana Labs' secret scanning service. diff --git a/docs/sources/setup-grafana/image-rendering/_index.md b/docs/sources/setup-grafana/image-rendering/_index.md index c3f1fc0425a..6bc566bb3d9 100644 --- a/docs/sources/setup-grafana/image-rendering/_index.md +++ b/docs/sources/setup-grafana/image-rendering/_index.md @@ -18,17 +18,17 @@ weight: 1000 # Set up image rendering -Grafana supports automatic rendering of panels as PNG images. This allows Grafana to automatically generate images of your panels to include in alert notifications, [PDF export]({{< relref "../../dashboards/create-reports#export-dashboard-as-pdf" >}}), and [Reporting]({{< relref "../../dashboards/create-reports" >}}). PDF Export and Reporting are available only in [Grafana Enterprise]({{< relref "../../introduction/grafana-enterprise" >}}) and [Grafana Cloud](/docs/grafana-cloud/). +Grafana supports automatic rendering of panels as PNG images. This allows Grafana to automatically generate images of your panels to include in alert notifications, [PDF export](../../dashboards/create-reports/#export-dashboard-as-pdf), and [Reporting](../../dashboards/create-reports/). PDF Export and Reporting are available only in [Grafana Enterprise](../../introduction/grafana-enterprise/) and [Grafana Cloud](/docs/grafana-cloud/). While an image is being rendered, the PNG image is temporarily written to the file system. When the image is rendered, the PNG image is temporarily written to the `png` folder in the Grafana `data` folder. -A background job runs every 10 minutes and removes temporary images. You can configure how long an image should be stored before being removed by configuring the [temp_data_lifetime]({{< relref "../configure-grafana#temp_data_lifetime" >}}) setting. +A background job runs every 10 minutes and removes temporary images. You can configure how long an image should be stored before being removed by configuring the [temp_data_lifetime](../configure-grafana/#temp_data_lifetime) setting. You can also render a PNG by hovering over the panel to display the actions menu in the top-right corner, and then clicking **Share > Share link**. The **Render image** option is displayed in the link settings. ## Alerting and render limits -Alert notifications can include images, but rendering many images at the same time can overload the server where the renderer is running. For instructions of how to configure this, see [max_concurrent_screenshots]({{< relref "../configure-grafana#max_concurrent_screenshots" >}}). +Alert notifications can include images, but rendering many images at the same time can overload the server where the renderer is running. For instructions of how to configure this, see [max_concurrent_screenshots](../configure-grafana/#max_concurrent_screenshots). ## Install Grafana Image Renderer plugin @@ -48,7 +48,7 @@ Rendering multiple images in parallel requires an even bigger memory footprint. The Grafana Image Renderer plugin has a number of configuration options that are used in plugin or remote rendering modes. -In plugin mode, you can specify them directly in the [Grafana configuration file]({{< relref "../configure-grafana#plugingrafana-image-renderer" >}}). +In plugin mode, you can specify them directly in the [Grafana configuration file](../configure-grafana/#plugingrafana-image-renderer). In remote rendering mode, you can specify them in a `.json` [configuration file](#configuration-file) or, for some of them, you can override the configuration defaults using environment variables. @@ -94,7 +94,7 @@ AUTH_TOKEN=- } ``` -See [Grafana configuration]({{< relref "../configure-grafana#renderer_token" >}}) for how to configure the token in Grafana. +See [Grafana configuration](../configure-grafana/#renderer_token) for how to configure the token in Grafana. ### Rendering mode @@ -164,7 +164,7 @@ RENDERING_MODE=reusable #### Optimize the performance, CPU and memory usage of the image renderer -The performance and resources consumption of the different modes depend a lot on the number of concurrent requests your service is handling. To understand how many concurrent requests your service is handling, [monitor your image renderer service]({{< relref "./monitoring" >}}). +The performance and resources consumption of the different modes depend a lot on the number of concurrent requests your service is handling. To understand how many concurrent requests your service is handling, [monitor your image renderer service](monitoring/). With no concurrent requests, the different modes show very similar performance and CPU / memory usage. @@ -269,7 +269,7 @@ HTTP_MIN_TLS_VERSION=TLSv1.2 #### Enable Prometheus metrics -You can enable [Prometheus](https://prometheus.io/) metrics endpoint `/metrics` using the environment variable `ENABLE_METRICS`. Node.js and render request duration metrics are included, see [Enable Prometheus metrics endpoint]({{< relref "./monitoring#enable-prometheus-metrics-endpoint" >}}) for details. +You can enable [Prometheus](https://prometheus.io/) metrics endpoint `/metrics` using the environment variable `ENABLE_METRICS`. Node.js and render request duration metrics are included, see [Enable Prometheus metrics endpoint](monitoring/#enable-prometheus-metrics-endpoint) for details. Default is `false`. diff --git a/docs/sources/setup-grafana/image-rendering/monitoring/index.md b/docs/sources/setup-grafana/image-rendering/monitoring/index.md index 1d6779133d5..ad4334f52e3 100644 --- a/docs/sources/setup-grafana/image-rendering/monitoring/index.md +++ b/docs/sources/setup-grafana/image-rendering/monitoring/index.md @@ -18,7 +18,7 @@ weight: 100 # Monitor the image renderer -Rendering images requires a lot of memory, mainly because Grafana creates browser instances in the background for the actual rendering. Monitoring your service can help you allocate the right amount of resources to your rendering service and set the right [rendering mode]({{< relref "../../image-rendering#rendering-mode" >}}). +Rendering images requires a lot of memory, mainly because Grafana creates browser instances in the background for the actual rendering. Monitoring your service can help you allocate the right amount of resources to your rendering service and set the right [rendering mode](../#rendering-mode). ## Enable Prometheus metrics endpoint diff --git a/docs/sources/setup-grafana/image-rendering/troubleshooting/index.md b/docs/sources/setup-grafana/image-rendering/troubleshooting/index.md index aa4ce5c8d96..a42ee69df2c 100644 --- a/docs/sources/setup-grafana/image-rendering/troubleshooting/index.md +++ b/docs/sources/setup-grafana/image-rendering/troubleshooting/index.md @@ -32,7 +32,7 @@ You can enable debug log messages for rendering in the Grafana configuration fil filters = rendering:debug ``` -You can also enable more logs in image renderer service itself by enabling [debug logging]({{< relref "#enable-debug-logging" >}}). +You can also enable more logs in image renderer service itself by enabling [debug logging](#enable-debug-logging). ## Missing libraries diff --git a/docs/sources/setup-grafana/installation/_index.md b/docs/sources/setup-grafana/installation/_index.md index 44c69f8ab47..be7a51d7518 100644 --- a/docs/sources/setup-grafana/installation/_index.md +++ b/docs/sources/setup-grafana/installation/_index.md @@ -31,11 +31,11 @@ Grafana relies on other open source software to operate. For a list of open sour Grafana supports the following operating systems: -- [Debian or Ubuntu]({{< relref "./debian" >}}) -- [RHEL or Fedora]({{< relref "./rhel-fedora" >}}) -- [SUSE or openSUSE]({{< relref "./suse-opensuse" >}}) -- [macOS]({{< relref "./mac" >}}) -- [Windows]({{< relref "./windows" >}}) +- [Debian or Ubuntu](debian/) +- [RHEL or Fedora](redhat-rhel-fedora/) +- [SUSE or openSUSE](suse-opensuse/) +- [macOS](mac/) +- [Windows](windows/) {{% admonition type="note" %}} Installation of Grafana on other operating systems is possible, but is not recommended or supported. @@ -51,8 +51,8 @@ Grafana requires the minimum system resources: Some features might require more memory or CPUs, including: - [Server side rendering of images](/grafana/plugins/grafana-image-renderer#requirements) -- [Alerting]({{< relref "../../alerting" >}}) -- [Data source proxy]({{< relref "../../developers/http_api/data_source" >}}) +- [Alerting](../../alerting/) +- [Data source proxy](../../developers/http_api/data_source/) ## Supported databases diff --git a/docs/sources/setup-grafana/installation/debian/index.md b/docs/sources/setup-grafana/installation/debian/index.md index 09965c27678..36fc5451ef5 100644 --- a/docs/sources/setup-grafana/installation/debian/index.md +++ b/docs/sources/setup-grafana/installation/debian/index.md @@ -217,4 +217,4 @@ To uninstall Grafana, run the following commands in a terminal window: ## Next steps -- [Start the Grafana server]({{< relref "../../start-restart-grafana" >}}) +- [Start the Grafana server](../../start-restart-grafana/) diff --git a/docs/sources/setup-grafana/installation/docker/index.md b/docs/sources/setup-grafana/installation/docker/index.md index 91ab60a7764..7a7bd091cb9 100644 --- a/docs/sources/setup-grafana/installation/docker/index.md +++ b/docs/sources/setup-grafana/installation/docker/index.md @@ -24,7 +24,7 @@ Grafana Docker images come in two editions: > **Note:** The recommended and default edition of Grafana is Grafana Enterprise. It is free and includes all the features of the OSS edition. Additionally, you have the option to upgrade to the [full Enterprise feature set](/products/enterprise/?utm_source=grafana-install-page), which includes support for [Enterprise plugins](/grafana/plugins/?enterprise=1&utcm_source=grafana-install-page). -The default images for Grafana are created using the Alpine Linux project and can be found in the Alpine official image. For instructions on configuring a Docker image for Grafana, refer to [Configure a Grafana Docker image]({{< relref "../../configure-docker" >}}). +The default images for Grafana are created using the Alpine Linux project and can be found in the Alpine official image. For instructions on configuring a Docker image for Grafana, refer to [Configure a Grafana Docker image](../../configure-docker/). ## Run Grafana via Docker CLI @@ -114,7 +114,7 @@ docker run -d -p 3000:3000 --name=grafana \ ### Use environment variables to configure Grafana -Grafana supports specifying custom configuration settings using [environment variables]({{< relref "../../../setup-grafana/configure-grafana#override-configuration-with-environment-variables" >}}). +Grafana supports specifying custom configuration settings using [environment variables](../../configure-grafana/#override-configuration-with-environment-variables). ```bash # enable debug logs @@ -128,7 +128,7 @@ docker run -d -p 3000:3000 --name=grafana \ You can install plugins in Grafana from the official and community [plugins page](/grafana/plugins) or by using a custom URL to install a private plugin. These plugins allow you to add new visualization types, data sources, and applications to help you better visualize your data. -Grafana currently supports three types of plugins: panel, data source, and app. For more information on managing plugins, refer to [Plugin Management]({{< relref "../../../administration/plugin-management" >}}). +Grafana currently supports three types of plugins: panel, data source, and app. For more information on managing plugins, refer to [Plugin Management](../../../administration/plugin-management/). To install plugins in the Docker container, complete the following steps: @@ -368,12 +368,12 @@ volumes: ## Next steps -Refer to the [Getting Started]({{< relref "../../../getting-started/build-first-dashboard" >}}) guide for information about logging in, setting up data sources, and so on. +Refer to the [Getting Started](../../../getting-started/build-first-dashboard/) guide for information about logging in, setting up data sources, and so on. ## Configure Docker image -Refer to [Configure a Grafana Docker image]({{< relref "../../configure-docker" >}}) page for details on options for customizing your environment, logging, database, and so on. +Refer to [Configure a Grafana Docker image](../../configure-docker/) page for details on options for customizing your environment, logging, database, and so on. ## Configure Grafana -Refer to the [Configuration]({{< relref "../../configure-grafana" >}}) page for details on options for customizing your environment, logging, database, and so on. +Refer to the [Configuration](../../configure-grafana/) page for details on options for customizing your environment, logging, database, and so on. diff --git a/docs/sources/setup-grafana/installation/mac/index.md b/docs/sources/setup-grafana/installation/mac/index.md index 55d447c17ae..f4c3f5d7342 100644 --- a/docs/sources/setup-grafana/installation/mac/index.md +++ b/docs/sources/setup-grafana/installation/mac/index.md @@ -87,4 +87,4 @@ Alternatively, watch the Grafana for Beginners video below: ## Next steps -- [Start the Grafana server]({{< relref "../../start-restart-grafana" >}}) +- [Start the Grafana server](../../start-restart-grafana/) diff --git a/docs/sources/setup-grafana/installation/redhat-rhel-fedora/index.md b/docs/sources/setup-grafana/installation/redhat-rhel-fedora/index.md index 4a23ffb832c..66e02b66f66 100644 --- a/docs/sources/setup-grafana/installation/redhat-rhel-fedora/index.md +++ b/docs/sources/setup-grafana/installation/redhat-rhel-fedora/index.md @@ -168,7 +168,7 @@ Complete the following steps to install Grafana using the standalone binaries: sudo chown -R grafana:users /usr/local/grafana ``` -1. [Configure the Grafana server to start at boot time using systemd]({{< relref "../../start-restart-grafana#configure-the-grafana-server-to-start-at-boot-using-systemd" >}}). +1. [Configure the Grafana server to start at boot time using systemd](../../start-restart-grafana/#configure-the-grafana-server-to-start-at-boot-using-systemd). ## Uninstall on RHEL or Fedora @@ -206,4 +206,4 @@ To uninstall Grafana, run the following commands in a terminal window: ## Next steps -Refer to [Start the Grafana server]({{< relref "../../start-restart-grafana" >}}). +Refer to [Start the Grafana server](../../start-restart-grafana/). diff --git a/docs/sources/setup-grafana/installation/suse-opensuse/index.md b/docs/sources/setup-grafana/installation/suse-opensuse/index.md index 09f76c8dd5e..1fb76c24104 100644 --- a/docs/sources/setup-grafana/installation/suse-opensuse/index.md +++ b/docs/sources/setup-grafana/installation/suse-opensuse/index.md @@ -194,4 +194,4 @@ To uninstall Grafana, run the following commands in a terminal window: ## Next steps -Refer to [Start the Grafana server]({{< relref "../../start-restart-grafana" >}}). +Refer to [Start the Grafana server](../../start-restart-grafana/). diff --git a/docs/sources/setup-grafana/installation/windows/index.md b/docs/sources/setup-grafana/installation/windows/index.md index 11aca8e3723..e5673ea51cb 100644 --- a/docs/sources/setup-grafana/installation/windows/index.md +++ b/docs/sources/setup-grafana/installation/windows/index.md @@ -44,7 +44,7 @@ You install Grafana using the Windows installer or using the standalone Windows Start Grafana by executing `grafana-server.exe`, located in the `bin` directory, preferably from the command line. If you want to run Grafana as a Windows service, then download [NSSM](https://nssm.cc/). It is very easy to add Grafana as a Windows service using that tool. -1. To run Grafana, open your browser and go to the Grafana port (http://localhost:3000/ is default) and then follow the instructions in [Getting Started]({{< relref "../../../getting-started/build-first-dashboard" >}}). +1. To run Grafana, open your browser and go to the Grafana port (http://localhost:3000/ is default) and then follow the instructions in [Getting Started](../../../getting-started/build-first-dashboard/). > **Note:** The default Grafana port is `3000`. This port might require extra permissions on Windows. If it does not appear in the default port, you can change the port number. @@ -64,4 +64,4 @@ Start Grafana by executing `grafana-server.exe`, located in the `bin` directory, ## Next steps -- [Start the Grafana server]({{< relref "../../start-restart-grafana" >}}) +- [Start the Grafana server](../../start-restart-grafana/) diff --git a/docs/sources/setup-grafana/set-up-for-high-availability.md b/docs/sources/setup-grafana/set-up-for-high-availability.md index b36b64f1dd8..2db5cdba95b 100644 --- a/docs/sources/setup-grafana/set-up-for-high-availability.md +++ b/docs/sources/setup-grafana/set-up-for-high-availability.md @@ -37,13 +37,13 @@ Before you complete the following tasks, configure a MySQL or Postgres database ## Configure multiple Grafana servers to use the same database -Once you have a Postgres or MySQL database available, you can configure your multiple Grafana instances to use a shared backend database. Grafana has default and custom configuration files, and you can update the database settings by updating your custom configuration file as described in the [[database]]({{< relref "./configure-grafana#database" >}}). Once configured to use a shared database, your multiple Grafana instances will persist all long-term data in that database. +Once you have a Postgres or MySQL database available, you can configure your multiple Grafana instances to use a shared backend database. Grafana has default and custom configuration files, and you can update the database settings by updating your custom configuration file as described in the [[database]](../configure-grafana/#database). Once configured to use a shared database, your multiple Grafana instances will persist all long-term data in that database. ## Alerting high availability Grafana Alerting provides a high availability mode. It preserves the semantics of legacy dashboard alerting by executing all alerts on every server and by sending notifications only once per alert. Load distribution between servers is not supported at this time. -For further information and instructions on setting up alerting high availability, refer to [Enable alerting high availability]({{< relref "../alerting/set-up/configure-high-availability" >}}). +For further information and instructions on setting up alerting high availability, refer to [Enable alerting high availability](../../alerting/set-up/configure-high-availability/). **Legacy dashboard alerts** @@ -51,7 +51,7 @@ Legacy Grafana Alerting supports a limited form of high availability. In this mo ## Grafana Live -Grafana Live works with limitations in highly available setup. For details, refer to the [Configure Grafana Live HA setup]({{< relref "./set-up-grafana-live#configure-grafana-live-ha-setup" >}}). +Grafana Live works with limitations in highly available setup. For details, refer to the [Configure Grafana Live HA setup](../set-up-grafana-live/#configure-grafana-live-ha-setup). ## User sessions diff --git a/docs/sources/setup-grafana/set-up-grafana-live.md b/docs/sources/setup-grafana/set-up-grafana-live.md index db747f4652b..b2d1c605384 100644 --- a/docs/sources/setup-grafana/set-up-grafana-live.md +++ b/docs/sources/setup-grafana/set-up-grafana-live.md @@ -29,9 +29,9 @@ By `real-time`, we indicate a soft real-time. Due to network latencies, garbage ## Concepts -Grafana Live sends data to clients over persistent WebSocket connection. Grafana frontend subscribes on channels to receive data which was published into that channel – in other words PUB/SUB mechanics is used. All subscriptions on a page multiplexed inside a single WebSocket connection. There are some rules regarding Live channel names – see [Grafana Live channel]({{< relref "#grafana-live-channel" >}}). +Grafana Live sends data to clients over persistent WebSocket connection. Grafana frontend subscribes on channels to receive data which was published into that channel – in other words PUB/SUB mechanics is used. All subscriptions on a page multiplexed inside a single WebSocket connection. There are some rules regarding Live channel names – see [Grafana Live channel](#grafana-live-channel). -Handling persistent connections like WebSocket in scale may require operating system and infrastructure tuning. That's why by default Grafana Live supports 100 simultaneous connections max. For more details on how to tune this limit, refer to [Live configuration section]({{< relref "#configure-grafana-live" >}}). +Handling persistent connections like WebSocket in scale may require operating system and infrastructure tuning. That's why by default Grafana Live supports 100 simultaneous connections max. For more details on how to tune this limit, refer to [Live configuration section](#configure-grafana-live). ## Features @@ -99,7 +99,7 @@ Grafana Live uses persistent connections (WebSocket at the moment) to deliver re WebSocket is a persistent connection that starts with an HTTP Upgrade request (using the same HTTP port as the rest of Grafana) and then switches to a TCP mode where WebSocket frames can travel in both directions between a client and a server. Each logged-in user opens a WebSocket connection – one per browser tab. -The number of maximum WebSocket connections users can establish with Grafana is limited to 100 by default. See [max_connections]({{< relref "./configure-grafana#max_connections" >}}) option. +The number of maximum WebSocket connections users can establish with Grafana is limited to 100 by default. See [max_connections](../configure-grafana/#max_connections) option. In case you want to increase this limit, ensure that your server and infrastructure allow handling more connections. The following sections discuss several common problems which could happen when managing persistent connections, in particular WebSocket connections. @@ -107,9 +107,9 @@ In case you want to increase this limit, ensure that your server and infrastruct To avoid hijacking of WebSocket connection Grafana Live checks the Origin request header sent by a client in an HTTP Upgrade request. Requests without Origin header pass through without any origin check. -By default, Live accepts connections with Origin header that matches configured [root_url]({{< relref "./configure-grafana#root_url" >}}) (which is a public Grafana URL). +By default, Live accepts connections with Origin header that matches configured [root_url](../configure-grafana/#root_url) (which is a public Grafana URL). -It is possible to provide a list of additional origin patterns to allow WebSocket connections from. This can be achieved using the [allowed_origins]({{< relref "./configure-grafana#allowed_origins" >}}) option of Grafana Live configuration. +It is possible to provide a list of additional origin patterns to allow WebSocket connections from. This can be achieved using the [allowed_origins](../configure-grafana/#allowed_origins) option of Grafana Live configuration. #### Resource usage @@ -215,7 +215,7 @@ ha_engine = redis ha_engine_address = 127.0.0.1:6379 ``` -For additional information, refer to the [ha_engine]({{< relref "./configure-grafana#ha_engine" >}}) and [ha_engine_address]({{< relref "./configure-grafana#ha_engine_address" >}}) options. +For additional information, refer to the [ha_engine](../configure-grafana/#ha_engine) and [ha_engine_address](../configure-grafana/#ha_engine_address) options. After running: diff --git a/docs/sources/setup-grafana/set-up-grafana-monitoring.md b/docs/sources/setup-grafana/set-up-grafana-monitoring.md index 5422e4f7325..1cf7563fd45 100644 --- a/docs/sources/setup-grafana/set-up-grafana-monitoring.md +++ b/docs/sources/setup-grafana/set-up-grafana-monitoring.md @@ -24,13 +24,13 @@ Grafana can emit Jaeger or OpenTelemetry Protocol (OTLP) traces for its HTTP API All HTTP endpoints are logged evenly (annotations, dashboard, tags, and so on). When a trace ID is propagated, it is reported with operation 'HTTP /datasources/proxy/:id/\*'. -Refer to [Configuration's OpenTelemetry section]({{< relref "./configure-grafana#tracingopentelemetry" >}}) for a reference of tracing options available in Grafana. +Refer to [Configuration's OpenTelemetry section](../configure-grafana/#tracingopentelemetry) for a reference of tracing options available in Grafana. ## View Grafana internal metrics Grafana collects some metrics about itself internally. Grafana supports pushing metrics to Graphite or exposing them to be scraped by Prometheus. -For more information about configuration options related to Grafana metrics, refer to [metrics]({{< relref "./configure-grafana#metrics" >}}) and [metrics.graphite]({{< relref "./configure-grafana#metricsgraphite" >}}) in [Configuration]({{< relref "./configure-grafana" >}}). +For more information about configuration options related to Grafana metrics, refer to [metrics](../configure-grafana/#metrics) and [metrics.graphite](../configure-grafana/#metricsgraphite) in [Configuration](../configure-grafana/). ### Available metrics diff --git a/docs/sources/setup-grafana/set-up-https.md b/docs/sources/setup-grafana/set-up-https.md index cb508a87898..a8e564a3baf 100644 --- a/docs/sources/setup-grafana/set-up-https.md +++ b/docs/sources/setup-grafana/set-up-https.md @@ -224,7 +224,7 @@ To adjust permissions, perform the following steps: ## Configure Grafana HTTPS and restart Grafana -In this section you edit the `grafana.ini` file so that it includes the certificate you created. If you need help identifying where to find this file, or what each key means, refer to [Configuration file location]({{< relref "./configure-grafana#configuration-file-location" >}}). +In this section you edit the `grafana.ini` file so that it includes the certificate you created. If you need help identifying where to find this file, or what each key means, refer to [Configuration file location](../configure-grafana/#configuration-file-location). To configure Grafana HTTPS and restart Grafana, complete the following steps. @@ -246,7 +246,7 @@ To configure Grafana HTTPS and restart Grafana, complete the following steps. 1. Optional. From Grafana v11.2, edit the `cert_pass` configuration option with the decryption password if you are using encrypted certificates. -1. [Restart the Grafana server]({{< relref "./start-restart-grafana#linux" >}}) using `systemd`, `init.d`, or the binary as appropriate for your environment. +1. [Restart the Grafana server](../start-restart-grafana/#linux) using `systemd`, `init.d`, or the binary as appropriate for your environment. ## Troubleshooting diff --git a/docs/sources/setup-grafana/sign-in-to-grafana.md b/docs/sources/setup-grafana/sign-in-to-grafana.md index d33ea496821..1d8d240f328 100644 --- a/docs/sources/setup-grafana/sign-in-to-grafana.md +++ b/docs/sources/setup-grafana/sign-in-to-grafana.md @@ -14,13 +14,13 @@ This topic describes how to sign in to Grafana. ## Before you begin -- [Install Grafana]({{< relref "./installation" >}}) +- [Install Grafana](../installation/) ## Steps To sign in to Grafana for the first time, follow these steps: -1. Open your web browser and go to root URL specified in [Grafana configuration file]({{< relref "./configure-grafana" >}}). +1. Open your web browser and go to root URL specified in [Grafana configuration file](../configure-grafana/). Unless you have configured Grafana differently, it is set to use `http://localhost:3000` by default. diff --git a/docs/sources/setup-grafana/start-restart-grafana.md b/docs/sources/setup-grafana/start-restart-grafana.md index 49f99a2cf30..6e1db25203c 100644 --- a/docs/sources/setup-grafana/start-restart-grafana.md +++ b/docs/sources/setup-grafana/start-restart-grafana.md @@ -210,5 +210,5 @@ To restart Grafana: After the Grafana server is up and running, consider taking the next steps: -- Refer to [Get Started]({{< relref "../getting-started" >}}) to learn how to build your first dashboard. -- Refer to [Configuration]({{< relref "./configure-grafana" >}}) to learn about how you can customize your environment. +- Refer to [Get Started](../../getting-started/) to learn how to build your first dashboard. +- Refer to [Configuration](../configure-grafana/) to learn about how you can customize your environment. diff --git a/docs/sources/shared/alerts/first-step.md b/docs/sources/shared/alerts/first-step.md index 8aa44edf357..afd760ef52e 100644 --- a/docs/sources/shared/alerts/first-step.md +++ b/docs/sources/shared/alerts/first-step.md @@ -8,7 +8,7 @@ title: TBD ## TBD -Use the instructions in [Getting started with Grafana]({{< relref "../../getting-started/getting-started/" >}}) to: +Use the instructions in [Getting started with Grafana](/docs/grafana//getting-started/getting-started/) to: - Install Grafana. - Log in to Grafana. diff --git a/docs/sources/shared/alerts/grafana-managed-alerts.md b/docs/sources/shared/alerts/grafana-managed-alerts.md index 3207be93214..77dbbf221cf 100644 --- a/docs/sources/shared/alerts/grafana-managed-alerts.md +++ b/docs/sources/shared/alerts/grafana-managed-alerts.md @@ -22,7 +22,7 @@ Alerting rules can only query backend data sources with alerting enabled: ## Metrics from the alerting engine -The alerting engine publishes some internal metrics about itself. You can read more about how Grafana publishes [internal metrics]({{< relref "../../setup-grafana/set-up-grafana-monitoring/" >}}). See also, [View alert rules and their current state]({{< relref "../../alerting/fundamentals/state-and-health/" >}}). +The alerting engine publishes some internal metrics about itself. You can read more about how Grafana publishes [internal metrics](/docs/grafana//setup-grafana/set-up-grafana-monitoring/). See also, [View alert rules and their current state](/docs/grafana//alerting/fundamentals/state-and-health/). | Metric Name | Type | Description | | --------------------------------------------------- | --------- | ---------------------------------------------------------------------------------------- | diff --git a/docs/sources/shared/auth/intro.md b/docs/sources/shared/auth/intro.md index 92c1e0da425..06f702afc87 100644 --- a/docs/sources/shared/auth/intro.md +++ b/docs/sources/shared/auth/intro.md @@ -10,4 +10,4 @@ There are numerous authentication methods available in Grafana to verify user id You can also configure Grafana to automatically update users' roles and team memberships in Grafana based on the information returned by the auth provider integration. When deciding on an authentication method, it's important to take into account your current identity and access management system as well as the specific authentication and authorization features you require. -For a complete list of the available authentication options and the features they support, refer to [Configure authentication]({{< relref "/docs/grafana/latest/setup-grafana/configure-security/configure-authentication" >}}). +For a complete list of the available authentication options and the features they support, refer to [Configure authentication](/docs/grafana//setup-grafana/configure-security/configure-authentication). diff --git a/docs/sources/shared/developers/authentication.md b/docs/sources/shared/developers/authentication.md index 6e5158dc46f..7c5d400303e 100644 --- a/docs/sources/shared/developers/authentication.md +++ b/docs/sources/shared/developers/authentication.md @@ -21,7 +21,7 @@ curl http://admin:admin@localhost:3000/api/org ### Service account token To create a service account token, click on **Administration** in the left-side menu, click **Users and access**, then **Service Accounts**. -For more information on how to use service account tokens, refer to the [Service Accounts]({{< relref "../../administration/service-accounts/" >}}) documentation. +For more information on how to use service account tokens, refer to the [Service Accounts](/docs/grafana//administration/service-accounts/) documentation. You use the token in all requests in the `Authorization` header, like this: diff --git a/docs/sources/shared/preferences/some-tasks-require-permissions.md b/docs/sources/shared/preferences/some-tasks-require-permissions.md index aee8a2c4072..e805648f8f7 100644 --- a/docs/sources/shared/preferences/some-tasks-require-permissions.md +++ b/docs/sources/shared/preferences/some-tasks-require-permissions.md @@ -6,4 +6,4 @@ labels: title: Some tasks require permissions --- -Some tasks require certain permissions. For more information about roles, refer to [About users and permission]({{< relref "../../administration/manage-users-and-permissions/about-users-and-permissions/" >}}). +Some tasks require certain permissions. For more information about roles, refer to [About users and permission](/docs/grafana//administration/manage-users-and-permissions/about-users-and-permissions/). diff --git a/docs/sources/shared/visualizations/change-axis-link.md b/docs/sources/shared/visualizations/change-axis-link.md index 22023736e4d..00256bc6967 100644 --- a/docs/sources/shared/visualizations/change-axis-link.md +++ b/docs/sources/shared/visualizations/change-axis-link.md @@ -4,4 +4,4 @@ title: Stack series link ## Axis -For full instructions, refer to [Change axis display]({{< relref "../../visualizations/time-series/change-axis-display/" >}}). +For full instructions, refer to [Change axis display](/docs/grafana//visualizations/time-series/change-axis-display/). diff --git a/docs/sources/shared/visualizations/stack-series-link.md b/docs/sources/shared/visualizations/stack-series-link.md index 328f3293109..c8c92e11fe0 100644 --- a/docs/sources/shared/visualizations/stack-series-link.md +++ b/docs/sources/shared/visualizations/stack-series-link.md @@ -4,4 +4,4 @@ title: Stack series link ### Stack series -For full instructions, refer to [Graph stacked time series]({{< relref "../../visualizations/time-series/graph-time-series-stacking/" >}}). +For full instructions, refer to [Graph stacked time series](/docs/grafana//visualizations/time-series/graph-time-series-stacking/). diff --git a/docs/sources/troubleshooting/_index.md b/docs/sources/troubleshooting/_index.md index 77582c18678..0ba9820f64e 100644 --- a/docs/sources/troubleshooting/_index.md +++ b/docs/sources/troubleshooting/_index.md @@ -26,23 +26,23 @@ If you encounter an error or problem, then you can check the Grafana server log. You can enable more logging by changing log level in the Grafana configuration file. -For more information, refer to [Enable debug logging in Grafana CLI]({{< relref "../cli/#enable-debug-logging" >}}) and the [log section in Configuration]({{< relref "../setup-grafana/configure-grafana/#log" >}}). +For more information, refer to [Enable debug logging in Grafana CLI](../cli/#enable-debug-logging) and the [log section in Configuration](../setup-grafana/configure-grafana/#log). ## Troubleshoot with Dashboards Panels -If you have an issue with your Dashboard panel, you can send us debug information. For more information, refer to [Send a panel to Grafana Labs support]({{< relref "./send-panel-to-grafana-support/" >}}). +If you have an issue with your Dashboard panel, you can send us debug information. For more information, refer to [Send a panel to Grafana Labs support](send-panel-to-grafana-support/). ## Troubleshoot with support bundles If you have an issue with your Grafana instance, you can generate an archive containing information concerning the state and the configuration of the instance. -To send us a bundle for advanced support, refer to [Send a support bundle to Grafana Labs support]({{< relref "./support-bundles/" >}}). +To send us a bundle for advanced support, refer to [Send a support bundle to Grafana Labs support](support-bundles/). ## Troubleshoot transformations Order of transformations matters. If the final data output from multiple transformations looks wrong, try changing the transformation order. Each transformation transforms data returned by the previous transformation, not the original raw data. -For more information, refer to [Debug a transformation]({{< relref "../panels-visualizations/query-transform-data/transform-data/#debug-a-transformation" >}}). +For more information, refer to [Debug a transformation](../panels-visualizations/query-transform-data/transform-data/#debug-a-transformation). ## Text missing with server-side image rendering (RPM-based Linux) @@ -58,7 +58,7 @@ sudo yum install urw-fonts ## Troubleshoot backend performance -If you're experiencing backend performance problems, such as high memory or CPU usage, please refer to [Configure profiling and tracing to troubleshoot Grafana]({{< relref "../setup-grafana/configure-grafana/configure-tracing/index.md" >}}). +If you're experiencing backend performance problems, such as high memory or CPU usage, please refer to [Configure profiling and tracing to troubleshoot Grafana](../setup-grafana/configure-grafana/configure-tracing/). ## More help diff --git a/docs/sources/tutorials/iis/index.md b/docs/sources/tutorials/iis/index.md index 20c52aaee37..18a25341c1d 100644 --- a/docs/sources/tutorials/iis/index.md +++ b/docs/sources/tutorials/iis/index.md @@ -47,7 +47,7 @@ You will also need the Application Request Routing (ARR) module for IIS for prox ## Grafana Config -The Grafana config can be set by creating a file named/editing the existing file named `custom.ini` in the `conf` subdirectory of your Grafana installation. See the [installation instructions](http://docs.grafana.org/installation/windows/#configure) for more details. +The Grafana config can be set by creating a file named/editing the existing file named `custom.ini` in the `conf` subdirectory of your Grafana installation. See the [installation instructions](/docs/grafana//installation/windows/#configure) for more details. Using the example from above, if the subpath is `grafana` (you can set this to whatever is required) and the parent site is `yourdomain.com:8080`, then you would add this to the `custom.ini` config file: diff --git a/docs/sources/upgrade-guide/_index.md b/docs/sources/upgrade-guide/_index.md index 874374740f4..28614991494 100644 --- a/docs/sources/upgrade-guide/_index.md +++ b/docs/sources/upgrade-guide/_index.md @@ -22,7 +22,7 @@ We recommend that you upgrade Grafana often to stay current with the latest fixe Because Grafana upgrades are backward compatible, the upgrade process is straightforward, and dashboards and graphs will not change. -To learn what's available in a Grafana release, refer to [What's New]({{< relref "../whatsnew" >}}). +To learn what's available in a Grafana release, refer to [What's New](../whatsnew/). Refer to any of the following upgrade guides: diff --git a/docs/sources/upgrade-guide/upgrade-v8.0/index.md b/docs/sources/upgrade-guide/upgrade-v8.0/index.md index f51f6f4c4ac..720c71960c2 100644 --- a/docs/sources/upgrade-guide/upgrade-v8.0/index.md +++ b/docs/sources/upgrade-guide/upgrade-v8.0/index.md @@ -28,7 +28,7 @@ This section describes technical changes associated with this release of Grafana ### Plugins -Grafana now requires all plugins to be signed. If a plugin is not signed Grafana will not load/start it. This is an additional security measure to make sure plugin files and binaries haven't been tampered with. All Grafana Labs authored plugins, including Enterprise plugins, are now signed. It's possible to allow unsigned plugins using a configuration setting, but is something we strongly advise against doing. For more information about this setting, refer to [allow loading unsigned plugins]({{< relref "../../setup-grafana/configure-grafana#allow_loading_unsigned_plugins" >}}). +Grafana now requires all plugins to be signed. If a plugin is not signed Grafana will not load/start it. This is an additional security measure to make sure plugin files and binaries haven't been tampered with. All Grafana Labs authored plugins, including Enterprise plugins, are now signed. It's possible to allow unsigned plugins using a configuration setting, but is something we strongly advise against doing. For more information about this setting, refer to [allow loading unsigned plugins](../../setup-grafana/configure-grafana/#allow_loading_unsigned_plugins). ### Grafana Live @@ -38,7 +38,7 @@ When WebSocket connection is established, Grafana checks the request Origin head To handle many concurrent WebSocket connections you may need to tune your OS settings or infrastructure. Grafana Live is enabled by default and supports 100 concurrent WebSocket connections max to avoid possible problems with the file descriptor OS limit. As soon as your setup meets the requirements to scale the number of persistent connections this limit can be increased. You also have an option to disable Grafana Live. -Refer to [Grafana Live configuration]({{< relref "../../setup-grafana/set-up-grafana-live" >}}) documentation for more information. +Refer to [Grafana Live configuration](../../setup-grafana/set-up-grafana-live/) documentation for more information. ### Postgres, MySQL, Microsoft SQL Server data sources @@ -65,6 +65,6 @@ ORDER BY time There are two possible workarounds to resolve this problem: 1. In Grafana v8.0.3, use an alias of the string column selected as `metric`. for example, `hostname as metric`. -2. Use the [Standard field definitions' display name]({{< relref "../../panels-visualizations/configure-standard-options#display-name" >}}) to format the alias. For the preceding example query, you would use `${__field.labels.hostname}` option. +2. Use the [Standard field definitions' display name](../../panels-visualizations/configure-standard-options/#display-name) to format the alias. For the preceding example query, you would use `${__field.labels.hostname}` option. -For more information, refer to the our relational databases documentation of [Postgres]({{< relref "../../datasources/postgres#time-series-queries" >}}), [MySQL]({{< relref "../../datasources/mysql#time-series-queries" >}}), [Microsoft SQL Server]({{< relref "../../datasources/mssql/query-editor#time-series-query-examples" >}}). +For more information, refer to the our relational databases documentation of [Postgres](../../datasources/postgres/#time-series-queries), [MySQL](../../datasources/mysql/#time-series-queries), [Microsoft SQL Server](../../datasources/mssql/query-editor/#time-series-query-examples). diff --git a/docs/sources/upgrade-guide/upgrade-v8.1/index.md b/docs/sources/upgrade-guide/upgrade-v8.1/index.md index 7ca4bf2b280..1e96e22f8a0 100644 --- a/docs/sources/upgrade-guide/upgrade-v8.1/index.md +++ b/docs/sources/upgrade-guide/upgrade-v8.1/index.md @@ -34,4 +34,4 @@ As of Grafana v8.1, we no longer support unencrypted storage of passwords and ba Since Grafana v6.2, new or updated data sources store passwords and basic auth passwords encrypted. However, unencrypted passwords and basic auth passwords were also allowed. {{% /admonition %}} -To migrate to encrypted storage, use a `grafana-cli` command to migrate all of your data sources to use encrypted storage of secrets. See [migrate data and encrypt passwords]({{< relref "../../cli#migrate-data-and-encrypt-passwords" >}}) for further instructions. +To migrate to encrypted storage, use a `grafana-cli` command to migrate all of your data sources to use encrypted storage of secrets. See [migrate data and encrypt passwords](../../cli/#migrate-data-and-encrypt-passwords) for further instructions. diff --git a/docs/sources/upgrade-guide/upgrade-v9.0/index.md b/docs/sources/upgrade-guide/upgrade-v9.0/index.md index 70f5a0c7974..9c75c1b4710 100644 --- a/docs/sources/upgrade-guide/upgrade-v9.0/index.md +++ b/docs/sources/upgrade-guide/upgrade-v9.0/index.md @@ -59,7 +59,7 @@ In the Prometheus data source, when grafana receives numeric data from Prometheu +In the InfluxDB data source, browser access mode was deprecated in grafana 8.0.0 and we are removing this feature in 9.0.0. If you are using this mode, you need to [switch to server access mode](../../datasources/influxdb/##influxql-classic-influxdb-query) on the data source configuration page or you can do this via provisioning. --> ### Transformations: Allow more complex regex expressions in rename by regex @@ -90,7 +90,7 @@ The recommendation here is to enable `envelopeEncryption` for older versions, or before upgrading to v9.0. However, the latter is probably going to be removed in one of the next releases, so we hugely encourage to move on with envelope encryption. -Find [here]({{< relref "../../setup-grafana/configure-security/configure-database-encryption" >}}) more details and some +Find [here](../../setup-grafana/configure-security/configure-database-encryption/) more details and some possible workarounds in case you end up in an undesired situation. ### A note on Grafana Enterprise licensing diff --git a/docs/sources/upgrade-guide/upgrade-v9.2/index.md b/docs/sources/upgrade-guide/upgrade-v9.2/index.md index 0215b888fa1..3a5272d3111 100644 --- a/docs/sources/upgrade-guide/upgrade-v9.2/index.md +++ b/docs/sources/upgrade-guide/upgrade-v9.2/index.md @@ -24,4 +24,4 @@ weight: 2100 ## Technical notes -Beginning in v9.2, Grafana has a [supported database versions policy]({{< relref "../../setup-grafana/installation#supported-databases" >}}). As of this release, MySQL versions from 5.7, postgres versions from v10, and SQLite 3 are supported databases. +Beginning in v9.2, Grafana has a [supported database versions policy](../../setup-grafana/installation/#supported-databases). As of this release, MySQL versions from 5.7, postgres versions from v10, and SQLite 3 are supported databases. diff --git a/docs/sources/upgrade-guide/upgrade-v9.5/index.md b/docs/sources/upgrade-guide/upgrade-v9.5/index.md index d177ca70693..26dc25a4f9e 100644 --- a/docs/sources/upgrade-guide/upgrade-v9.5/index.md +++ b/docs/sources/upgrade-guide/upgrade-v9.5/index.md @@ -28,7 +28,7 @@ weight: 1800 Beginning in v9.5, the InfluxDB data source deprecates the `database` field in provisioning files. The `dbName` field under `jsonData` must be used to store the database information. -For more information and examples, please refer to [InfluxDB Provisioning]({{< relref "../../datasources/influxdb#provision-the-data-source" >}}). +For more information and examples, please refer to [InfluxDB Provisioning](../../datasources/influxdb/#provision-the-data-source). ### Dashboard previews deprecation notice @@ -36,4 +36,4 @@ We are deprecating the dashboard previews feature and will remove it in Grafana ### Migrate your API keys to service accounts -We are upgrading Grafana [API keys](/docs/grafana//administration/service-accounts/migrate-api-keys/) to service accounts. Service accounts are a superset of API keys that include token rotation and compatibility with [Role-based access control]({{< relref "../../administration/roles-and-permissions/access-control" >}}). In a future release, we'll automatically migrate all existing API keys to service accounts. All of your existing tokens will continue to work; they will simply be migrated to service accounts. You can preempt this change by migrating your existing API keys to service accounts using Grafana's UI or API. Learn how to do this in the [API keys documentation](/docs/grafana//administration/service-accounts/migrate-api-keys/). +We are upgrading Grafana [API keys](/docs/grafana//administration/service-accounts/migrate-api-keys/) to service accounts. Service accounts are a superset of API keys that include token rotation and compatibility with [Role-based access control](../../administration/roles-and-permissions/access-control/). In a future release, we'll automatically migrate all existing API keys to service accounts. All of your existing tokens will continue to work; they will simply be migrated to service accounts. You can preempt this change by migrating your existing API keys to service accounts using Grafana's UI or API. Learn how to do this in the [API keys documentation](/docs/grafana//administration/service-accounts/migrate-api-keys/). diff --git a/docs/sources/whatsnew/_index.md b/docs/sources/whatsnew/_index.md index db397d8a537..dfe2b307d4d 100644 --- a/docs/sources/whatsnew/_index.md +++ b/docs/sources/whatsnew/_index.md @@ -69,7 +69,7 @@ weight: 1 For release highlights, deprecations, and breaking changes in Grafana releases, refer to these "What's new" pages for each version. {{% admonition type="note" %}} -For Grafana versions prior to v9.2, additional information might also be available in the archive of [release notes]({{< relref "../release-notes/" >}}). +For Grafana versions prior to v9.2, additional information might also be available in the archive of [release notes](../release-notes/). {{% /admonition %}} For a complete list of every change, with links to pull requests and related issues when available, see the [Changelog](https://github.com/grafana/grafana/blob/main/CHANGELOG.md). @@ -88,23 +88,23 @@ For a complete list of every change, with links to pull requests and related iss - [What's new in 10.4](https://grafana.com/docs/grafana//whatsnew/whats-new-in-v10-4/) - [What's new in 10.3](https://grafana.com/docs/grafana//whatsnew/whats-new-in-v10-3/) - [What's new in 10.2](https://grafana.com/docs/grafana//whatsnew/whats-new-in-v10-2/) -- [What's new in 10.1]({{< relref "whats-new-in-v10-1/" >}}) -- [What's new in 10.0]({{< relref "whats-new-in-v10-0/" >}}) +- [What's new in 10.1](whats-new-in-v10-1/) +- [What's new in 10.0](whats-new-in-v10-0/) ## Grafana 9 -- [What's new in 9.5]({{< relref "./whats-new-in-v9-5" >}}) -- [What's new in 9.4]({{< relref "./whats-new-in-v9-4" >}}) -- [What's new in 9.3]({{< relref "./whats-new-in-v9-3" >}}) -- [What's new in 9.2]({{< relref "./whats-new-in-v9-2" >}}) -- [What's new in 9.1]({{< relref "./whats-new-in-v9-1" >}}) -- [What's new in 9.0]({{< relref "./whats-new-in-v9-0" >}}) +- [What's new in 9.5](whats-new-in-v9-5/) +- [What's new in 9.4](whats-new-in-v9-4/) +- [What's new in 9.3](whats-new-in-v9-3/) +- [What's new in 9.2](whats-new-in-v9-2/) +- [What's new in 9.1](whats-new-in-v9-1/) +- [What's new in 9.0](whats-new-in-v9-0/) ## Grafana 8 -- [What's new in 8.5]({{< relref "./whats-new-in-v8-5" >}}) -- [What's new in 8.4]({{< relref "./whats-new-in-v8-4" >}}) -- [What's new in 8.3]({{< relref "./whats-new-in-v8-3" >}}) -- [What's new in 8.2]({{< relref "./whats-new-in-v8-2" >}}) -- [What's new in 8.1]({{< relref "./whats-new-in-v8-1" >}}) -- [What's new in 8.0]({{< relref "./whats-new-in-v8-0" >}}) +- [What's new in 8.5](whats-new-in-v8-5/) +- [What's new in 8.4](whats-new-in-v8-4/) +- [What's new in 8.3](whats-new-in-v8-3/) +- [What's new in 8.2](whats-new-in-v8-2/) +- [What's new in 8.1](whats-new-in-v8-1/) +- [What's new in 8.0](whats-new-in-v8-0/) diff --git a/docs/sources/whatsnew/whats-new-in-v10-0.md b/docs/sources/whatsnew/whats-new-in-v10-0.md index 9d5b08c7c44..6ac989f0346 100644 --- a/docs/sources/whatsnew/whats-new-in-v10-0.md +++ b/docs/sources/whatsnew/whats-new-in-v10-0.md @@ -19,7 +19,7 @@ weight: -37 Welcome to Grafana 10.0! Read on to learn about changes to search and navigation, dashboards and visualizations, and security and authentication. -For even more detail about all the changes in this release, refer to the [changelog](https://github.com/grafana/grafana/blob/main/CHANGELOG.md). For the specific steps we recommend when you upgrade to v10.0, check out our [Upgrade Guide]({{< relref "../upgrade-guide/upgrade-v10.0/index.md" >}}). +For even more detail about all the changes in this release, refer to the [changelog](https://github.com/grafana/grafana/blob/main/CHANGELOG.md). For the specific steps we recommend when you upgrade to v10.0, check out our [Upgrade Guide](../../upgrade-guide/upgrade-v10.0/). -We're promoting the canvas panel out of public preview and into general availability. Over the past several months we've introduced multiple enhancements to the panel such as the ability to draw connections between elements, the ability to set the color and size of connections based on data, and the ability to add data links. We're excited to include Canvas as a first class citizen in Grafana’s core panel library. To learn more about the panel, refer to our [Canvas documentation]({{< relref "../panels-visualizations/visualizations/canvas" >}}). Also, check out our [latest blog post about canvas](https://grafana.com/blog/2023/05/11/use-canvas-panels-to-customize-visualizations-in-grafana/). +We're promoting the canvas panel out of public preview and into general availability. Over the past several months we've introduced multiple enhancements to the panel such as the ability to draw connections between elements, the ability to set the color and size of connections based on data, and the ability to add data links. We're excited to include Canvas as a first class citizen in Grafana’s core panel library. To learn more about the panel, refer to our [Canvas documentation](../../panels-visualizations/visualizations/canvas/). Also, check out our [latest blog post about canvas](https://grafana.com/blog/2023/05/11/use-canvas-panels-to-customize-visualizations-in-grafana/). {{< figure src="/media/docs/grafana/screenshot-grafana-10-0-canvas-service-graph.png" max-width="750px" caption="Canvas service graph" >}} @@ -97,7 +97,7 @@ We're promoting the canvas panel out of public preview and into general availabi _Experimental in all editions of Grafana_ -The Trends panel allows you to display trends where the x-axis is numeric and not time. This experimental panel addresses gaps that were not solved by either the Time series or XY Chart panels. For example, you can plot function graphs, rpm/torque curves, supply/demand relationships, and more. To learn more about the Trend panel, refer to the [Trend documentation]({{< relref "../panels-visualizations/visualizations/trend" >}}). +The Trends panel allows you to display trends where the x-axis is numeric and not time. This experimental panel addresses gaps that were not solved by either the Time series or XY Chart panels. For example, you can plot function graphs, rpm/torque curves, supply/demand relationships, and more. To learn more about the Trend panel, refer to the [Trend documentation](../../panels-visualizations/visualizations/trend/). {{< figure src="/media/docs/grafana/screenshot-grafana-10-0-trend-panel-new-colors.png" max-width="750px" caption="Trend engine power and torque curves" >}} @@ -120,7 +120,7 @@ Currently, the Datagrid Panel supports the following features in Grafana version - Draggable columns and rows - Series selection when pulling data from a data source -To learn more, refer to the [Datagrid documentation]({{< relref "../panels-visualizations/visualizations/datagrid/" >}}). +To learn more, refer to the [Datagrid documentation](../../panels-visualizations/visualizations/datagrid/). In subsequent releases, we’ll continue adding features to the Datagrid panel to further improve the user experience. @@ -163,7 +163,7 @@ _Generally available in all editions of Grafana._ We've implemented support for adding time regions to the Time series panel. Time regions provide a more contextualized experience, enabling you to highlight certain days of the week, such as Monday to Friday to display work weeks, right alongside your data. Time regions are also a useful way to highlight specific parts of a day like night, work hours, or whatever you want to define for each day. They allow you to quickly orient yourself in parts of the day or ignore highlighted parts of the time series. -To learn more, refer to our [time region documentation]({{< relref "../dashboards/build-dashboards/annotate-visualizations/#add-time-regions" >}}). +To learn more, refer to our [time region documentation](../../dashboards/build-dashboards/annotate-visualizations/#add-time-regions). {{< figure src="/media/docs/grafana/screenshot-grafana-10-0-time-regions.png" max-width="750px" caption="Time regions" >}} @@ -175,7 +175,7 @@ _Generally available in all editions of Grafana._ You can now filter dashboard annotations to apply annotations to all panels or selected panels, or use them to exclude selected panels. -To learn more, refer to our [documentation about adding annotation queries]({{< relref "../dashboards/build-dashboards/annotate-visualizations/#add-new-annotation-queries" >}}). +To learn more, refer to our [documentation about adding annotation queries](../../dashboards/build-dashboards/annotate-visualizations/#add-new-annotation-queries). {{< figure src="/media/docs/grafana/screenshot-grafana-10-0-annotation-filtering.png" max-width="750px" caption="Annotation filtering" >}} @@ -266,11 +266,11 @@ To learn more, refer to our [public dashboards documentation](https://grafana.co _Generally available in Grafana Enterprise, Cloud Pro, and Cloud Advanced._ You can now configure SAML using our new user interface, making the process easier and more convenient than ever before. -With the new user interface (UI), you can now configure SAML without needing to restart Grafana and you can control access to the configuration UI by using [role-based access control (RBAC)]({{< relref "../administration/roles-and-permissions/access-control/" >}}), which makes the process much faster and more efficient. +With the new user interface (UI), you can now configure SAML without needing to restart Grafana and you can control access to the configuration UI by using [role-based access control (RBAC)](../../administration/roles-and-permissions/access-control/), which makes the process much faster and more efficient. The SAML UI is available in Grafana Enterprise, Cloud Pro, and Advanced. It's user-friendly, with clear instructions and helpful prompts to guide you through the process. -For more information on how to set up SAML using the Grafana UI, refer to [Configure SAML authentication using the Grafana user interface]({{< relref "../setup-grafana/configure-security/configure-authentication/saml-ui/" >}}). +For more information on how to set up SAML using the Grafana UI, refer to [Configure SAML authentication using the Grafana user interface](../../setup-grafana/configure-security/configure-authentication/saml-ui/). ### Case-insensitive usernames and email addresses diff --git a/docs/sources/whatsnew/whats-new-in-v10-1.md b/docs/sources/whatsnew/whats-new-in-v10-1.md index 5e007c52506..145a5f4d09f 100644 --- a/docs/sources/whatsnew/whats-new-in-v10-1.md +++ b/docs/sources/whatsnew/whats-new-in-v10-1.md @@ -19,7 +19,7 @@ weight: -38 Welcome to Grafana 10.1! Read on to learn about changes to dashboards and visualizations, data sources, security and authentication and more. We're particularly excited about a set of improvements to visualizing logs from [Loki](https://grafana.com/products/cloud/logs/) and other logging data sources in Explore mode, and our Flame graph panel, used to visualize profiling data from [Pyroscope](https://grafana.com/blog/2023/03/15/pyroscope-grafana-phlare-join-for-oss-continuous-profiling/?pg=oss-phlare&plcmt=top-promo-banner) and other continuous profiling data sources. -For even more detail about all the changes in this release, refer to the [changelog](https://github.com/grafana/grafana/blob/main/CHANGELOG.md). For the specific steps we recommend when you upgrade to v10.1, check out our [Upgrade Guide]({{< relref "../upgrade-guide/upgrade-v10.1/index.md" >}}). +For even more detail about all the changes in this release, refer to the [changelog](https://github.com/grafana/grafana/blob/main/CHANGELOG.md). For the specific steps we recommend when you upgrade to v10.1, check out our [Upgrade Guide](../../upgrade-guide/upgrade-v10.1/). -You can now choose whether to set a threshold above which values in the data should be disconnected. This can be useful in cases where you have sensors that report a value at a set interval, but you want to disconnect the values when the sensor does not respond. This feature complements the existing [connect null values functionality]({{< relref "../panels-visualizations/visualizations/time-series/#connect-null-values" >}}). +You can now choose whether to set a threshold above which values in the data should be disconnected. This can be useful in cases where you have sensors that report a value at a set interval, but you want to disconnect the values when the sensor does not respond. This feature complements the existing [connect null values functionality](../../panels-visualizations/visualizations/time-series/#connect-null-values). -To learn more, refer to our [disconnect values documentation]({{< relref "../panels-visualizations/visualizations/time-series/#disconnect-values" >}}). +To learn more, refer to our [disconnect values documentation](../../panels-visualizations/visualizations/time-series/#disconnect-values). {{< figure src="/media/docs/grafana/screenshot-grafana-10-1-disconnect-values-examples.png" max-width="750px" caption="Disconnect values in Time series, Trend, and State timeline visualizations" >}} @@ -114,9 +114,9 @@ _Available in public preview in all editions of Grafana_ -You can now display network data in the Geomap visualization by using the new beta Network layer. This layer supports the same data format as the [Node graph visualization]({{< relref "../panels-visualizations/visualizations/node-graph/#data-api" >}}). +You can now display network data in the Geomap visualization by using the new beta Network layer. This layer supports the same data format as the [Node graph visualization](../../panels-visualizations/visualizations/node-graph/#data-api). -To learn more, refer to our [Geomap network layer documentation]({{< relref "../panels-visualizations/visualizations/geomap/#network-layer-beta" >}}). +To learn more, refer to our [Geomap network layer documentation](../../panels-visualizations/visualizations/geomap/#network-layer-beta). {{< figure src="/media/docs/grafana/screenshot-grafana-10-1-geomap-network-layer-v2.png" max-width="750px" caption="Geomap Network layer" >}} @@ -128,7 +128,7 @@ _Generally available in all editions of Grafana_ You can now add data links to Heatmap visualizations. This allows you to add links to other dashboards, panels, or external URLs that are relevant to the data in your heatmap. We're pleased to highlight that this feature was a community contribution. -To learn more, refer to both our [Heatmap documentation]({{< relref "../panels-visualizations/visualizations/heatmap/" >}}) and our [Configure data links documentation]({{< relref "../panels-visualizations/configure-data-links/" >}}). +To learn more, refer to both our [Heatmap documentation](../../panels-visualizations/visualizations/heatmap/) and our [Configure data links documentation](../../panels-visualizations/configure-data-links/). {{< figure src="/media/docs/grafana/screenshot-grafana-10-1-heatmap-datalinks.png" max-width="750px" caption="Heatmap datalink support" >}} @@ -140,7 +140,7 @@ _Generally available in Grafana Enterprise, Cloud Free, Cloud Pro, and Cloud Adv You can now use the resume and pause report functionality to activate draft reports that have all the required fields filled in. -To learn more, refer to our [Create and manage reports documentation]({{< relref "../dashboards/create-reports" >}}). +To learn more, refer to our [Create and manage reports documentation](../../dashboards/create-reports/). ## Data sources @@ -162,7 +162,7 @@ By default, the `step` parameter is set to the value of the `$__interval` variab _Generally available in all editions of Grafana_ -New functionality for linking of Loki log lines in Explore allows you to quickly navigate to specific log entries for precise analysis. By clicking the **Copy shortlink** button for a log line, you can generate and copy a [short URL]({{< relref "../developers/http_api/short_url/" >}}) that provides direct access to the exact log entry within an absolute time range. When you open the link, Grafana automatically scrolls to the corresponding log line and highlights it, making it easy to identify and focus on the relevant information. +New functionality for linking of Loki log lines in Explore allows you to quickly navigate to specific log entries for precise analysis. By clicking the **Copy shortlink** button for a log line, you can generate and copy a [short URL](../../developers/http_api/short_url/) that provides direct access to the exact log entry within an absolute time range. When you open the link, Grafana automatically scrolls to the corresponding log line and highlights it, making it easy to identify and focus on the relevant information. {{< figure src="/media/docs/grafana/data-sources/loki-shortlink.png" max-width="750px" caption="New Loki log line linking" >}} @@ -211,7 +211,7 @@ Currently, you can add one or more of the following filters: To only show the spans you've matched, you can enable the **Show matches only** toggle. -Learn more about span filtering in our [Tempo data source documentation]({{< relref "../datasources/tempo/#span-filters" >}}). +Learn more about span filtering in our [Tempo data source documentation](../../datasources/tempo/#span-filters). {{< figure src="/media/docs/tempo/screenshot-grafana-tempo-span-filters-v10-1.png" max-width="750px" caption="Traces span filtering" >}} @@ -322,7 +322,7 @@ Data source plugin developers can now use any plugin to visualize data in Explor _All Alerting features are generally available in all editions of Grafana_ -We’ve made a number of improvements to simplify the alert rule creation process as well as improvements to contact points and alert management. For all the details, refer to our [Alerting documentation]({{< relref "../alerting" >}}). +We’ve made a number of improvements to simplify the alert rule creation process as well as improvements to contact points and alert management. For all the details, refer to our [Alerting documentation](../../alerting/). ### Alert rules @@ -426,7 +426,7 @@ We've removed the `onlyExternalOrgRoleSync` feature toggle, and have defaulted t If you prefer to manage your users' organization roles manually, enable the `skip_org_role_sync` option in the Grafana configuration for your authentication provider. -For context on the previous work done leading up to this change, refer to the [Grafana v9.5 What's new]({{< relref "../whatsnew/whats-new-in-v9-5/#auth-lock-organization-roles-synced-from-auth-providers" >}}). +For context on the previous work done leading up to this change, refer to the [Grafana v9.5 What's new](../whats-new-in-v9-5/#auth-lock-organization-roles-synced-from-auth-providers). ### GitLab OIDC support @@ -439,7 +439,7 @@ Grafana now supports GitLab OIDC through the `GitLab` OAuth provider in addition This change also allows Grafana to reduce the access scope to only the required scopes for authentication and authorization, instead of full read API access. -To learn how to migrate your GitLab OAuth2 setup to OIDC, refer to our [GitLab authentication documentation]({{< relref "../setup-grafana/configure-security/configure-authentication/gitlab/" >}}). +To learn how to migrate your GitLab OAuth2 setup to OIDC, refer to our [GitLab authentication documentation](../../setup-grafana/configure-security/configure-authentication/gitlab/). ### Google OIDC and Team Sync support @@ -451,7 +451,7 @@ Grafana now supports Google OIDC through the `Google` OAuth provider in addition This release also adds support for Google OIDC in Team Sync. You can now easily add users to teams by using their Google groups. -To learn how to migrate your Google OAuth2 setup to OIDC and how to set up Team Sync, refer to our [Google authentication documentation]({{< relref "../setup-grafana/configure-security/configure-authentication/google/" >}}). +To learn how to migrate your Google OAuth2 setup to OIDC and how to set up Team Sync, refer to our [Google authentication documentation](../../setup-grafana/configure-security/configure-authentication/google/). ## Plugins @@ -461,7 +461,7 @@ To learn how to migrate your Google OAuth2 setup to OIDC and how to set up Team _Generally available in all editions of Grafana_ -We've made the following updates to increase awareness of the [Angular deprecation]({{< relref "../developers/angular_deprecation/" >}}) and its consequences in future releases of Grafana: +We've made the following updates to increase awareness of the [Angular deprecation](../../developers/angular_deprecation/) and its consequences in future releases of Grafana: #### UI changes @@ -471,9 +471,9 @@ We've made the following updates to increase awareness of the [Angular deprecati #### Other changes -- Angular Plugins will not be loaded if [angular_support_enabled]({{< relref "../setup-grafana/configure-grafana/#angular_support_enabled" >}}) is set to `false`. +- Angular Plugins will not be loaded if [angular_support_enabled](../../setup-grafana/configure-grafana/#angular_support_enabled) is set to `false`. -Learn more in our [Angular support deprecation documentation]({{< relref "../developers/angular_deprecation/" >}}). +Learn more in our [Angular support deprecation documentation](../../developers/angular_deprecation/). ### Deprecated provisioning of data sources with invalid UIDs diff --git a/docs/sources/whatsnew/whats-new-in-v7-0.md b/docs/sources/whatsnew/whats-new-in-v7-0.md index c1b8ce1e957..50d5ddbe753 100644 --- a/docs/sources/whatsnew/whats-new-in-v7-0.md +++ b/docs/sources/whatsnew/whats-new-in-v7-0.md @@ -31,17 +31,17 @@ The Grafana 7.0 stable release is scheduled for the 18th of May. In the meantime The main highlights are: -- [**New Panel Editor** Redesign based on community feedback.]({{< relref "#new-panel-editor-and-unified-data-model" >}}) -- [**Explore** New tracing UI and support for visualizing Jaeger and Zipkin traces.]({{< relref "#new-tracing-ui" >}}) -- [**Enterprise** Usage insights, Presence indicator, and Auth improvements.]({{< relref "#grafana-enterprise" >}}) -- [**Transformations** Transformations and simple Math operations for all data sources.]({{< relref "#transformations" >}}) -- [**Field overrides** Automatically configure panels with data from queries.]({{< relref "#field-options-and-overrides" >}}) -- [**Table** New Table panel.]({{< relref "#table-panel" >}}) -- [**Plugins** New plugins platform.]({{< relref "#plugins-platform" >}}) -- [**Tutorials** New tutorials section.]({{< relref "#new-tutorials" >}}) -- [**Cloudwatch** Support for Cloudwatch Logs in Explore and the Logs panel.]({{< relref "#cloudwatch-logs" >}}) -- [**Breaking change** PhantomJS removed.]({{< relref "#breaking-change---phantomjs-removed" >}}) -- [**Time zones** Time zone support]({{< relref "#time-zone-support" >}}) +- [**New Panel Editor** Redesign based on community feedback.](#new-panel-editor-and-unified-data-model) +- [**Explore** New tracing UI and support for visualizing Jaeger and Zipkin traces.](#new-tracing-ui) +- [**Enterprise** Usage insights, Presence indicator, and Auth improvements.](#grafana-enterprise) +- [**Transformations** Transformations and simple Math operations for all data sources.](#transformations) +- [**Field overrides** Automatically configure panels with data from queries.](#field-options-and-overrides) +- [**Table** New Table panel.](#table-panel) +- [**Plugins** New plugins platform.](#plugins-platform) +- [**Tutorials** New tutorials section.](#new-tutorials) +- [**Cloudwatch** Support for Cloudwatch Logs in Explore and the Logs panel.](#cloudwatch-logs) +- [**Breaking change** PhantomJS removed.](#breaking-change---phantomjs-removed) +- [**Time zones** Time zone support](#time-zone-support) ## New panel editor and unified data model @@ -53,7 +53,7 @@ In previous versions of Grafana, each visualization had slightly different ways We have yet to migrate all core panels to this new architecture so in 7.0 there will be some inconsistencies in the UI between panels. This will be fixed soon in future releases as we update all the core panels and help the community update the community panel plugins. -Learn more about this feature in [Panel editor]({{< relref "../panels-visualizations/panel-editor-overview" >}}). +Learn more about this feature in [Panel editor](../../panels-visualizations/panel-editor-overview/). ## New tracing UI @@ -69,9 +69,9 @@ In the future we will add more workflows and integrations so that correlating be The data you want to visualize can come from many different places and it is usually not in exactly the right form. Users can now transform non-time series data into tables (e.g., JSON files or even simple lookup tables) in seconds without any customization or additional overhead. They can then combine non-time series data with any other data in Grafana; data from an external database or a panel that already exists in one of their current dashboards. -By chaining a simple set of point and click [transformations]({{< relref "../panels-visualizations/query-transform-data/transform-data#transformation-functions" >}}), users will be able join, pivot, filter, re-name and do calculations to get the results they need. Perfect for operations across queries or data sources missing essential data transformations. +By chaining a simple set of point and click [transformations](../../panels-visualizations/query-transform-data/transform-data/#transformation-functions), users will be able join, pivot, filter, re-name and do calculations to get the results they need. Perfect for operations across queries or data sources missing essential data transformations. -[Transformations]({{< relref "../panels-visualizations/query-transform-data/transform-data" >}}) also adds the ability to do math across queries. Lots of data sources do not support this natively, so being able to do it in Grafana is a powerful feature. +[Transformations](../../panels-visualizations/query-transform-data/transform-data/) also adds the ability to do math across queries. Lots of data sources do not support this natively, so being able to do it in Grafana is a powerful feature. For users with large dashboards or with heavy queries, being able to reuse the query result from one panel in another panel can be a huge performance gain for slow queries (e.g log or sql queries). From the data source menu in the query editor, you can choose the `--dashboard--` option and then choose the query result from another panel on the same dashboard. @@ -89,7 +89,7 @@ We are also introducing a new shared data model for both time series and table d - **Outer join:** Joins many time series/tables by a field. This can be used to outer join multiple time series on the _time_ field to show many time series in one table. - **Add field from calculation:** This is a powerful transformation that allows you perform many different types of math operations and add the result as a new field. Can be used to calculate the difference between two series or fields and add the result to a new field. Or multiply one field with another and add the result to a new field. -Learn more about this feature in [Transformations]({{< relref "../panels-visualizations/query-transform-data/transform-data#transformation-functions" >}}). +Learn more about this feature in [Transformations](../../panels-visualizations/query-transform-data/transform-data/#transformation-functions). ## Field options and overrides @@ -99,7 +99,7 @@ Up until now the overrides were available only for Graph and Table panel(via Col This feature enables even more powerful visualizations and fine grained control over how the data is displayed. -Learn more about this feature in [Field overrides]({{< relref "../panels-visualizations/configure-overrides" >}}). +Learn more about this feature in [Field overrides](../../panels-visualizations/configure-overrides/). ## Inspect panels and export data to CSV @@ -107,7 +107,7 @@ Learn more about this feature in [Field overrides]({{< relref "../panels-visuali Another new feature of Grafana 7.0 is the panel inspector. Inspect allows you to view the raw data for any Grafana panel as well as export that data to a CSV file. With Panel inspect you will also be able to perform simple raw data transformations like join, view query stats or detailed execution data. -Learn more about this feature in [Panel Inspector]({{< relref "../panels-visualizations/panel-inspector#inspect-query-request-and-response-data" >}}). +Learn more about this feature in [Panel Inspector](../../panels-visualizations/panel-inspector/#inspect-query-request-and-response-data).
@@ -153,7 +153,7 @@ Plugins can be monitored with the new metrics and health check capabilities. The With this release, we are deprecating the unofficial first version of backend plugins which will be removed in a future release. -To learn more, start with the [overview](https://grafana.com/developers/plugin-tools/key-concepts/backend-plugins/). Next, in this [tutorial](https://grafana.com/developers/plugin-tools/tutorials/build-a-data-source-backend-plugin) you'll learn how to build a backend for a data source plugin and enable it for use with [Grafana Alerting]({{< relref "../alerting" >}}). Make sure to keep an eye out for additional documentation and tutorials that will be published after the Grafana v7.0 release. +To learn more, start with the [overview](https://grafana.com/developers/plugin-tools/key-concepts/backend-plugins/). Next, in this [tutorial](https://grafana.com/developers/plugin-tools/tutorials/build-a-data-source-backend-plugin) you'll learn how to build a backend for a data source plugin and enable it for use with [Grafana Alerting](../../alerting/). Make sure to keep an eye out for additional documentation and tutorials that will be published after the Grafana v7.0 release. ## New tutorials @@ -180,27 +180,27 @@ Since then we have been working towards removing PhantomJS. In October 2019, whe As a replacement for PhantomJS we’ve developed the [Grafana Image Renderer plugin](/grafana/plugins/grafana-image-renderer) which is a plugin that runs on the backend and handles rendering panels and dashboards as PNG images using headless Chromium/Chrome. The [Grafana Image Renderer plugin](/grafana/plugins/grafana-image-renderer) can either be installed as a Grafana plugin running in its own process side-by-side with Grafana. or runs as an external HTTP service, hosted using Docker or as a standalone application. -Read more about [Image Rendering]({{< relref "../setup-grafana/image-rendering" >}}) in the documentation for further instructions. +Read more about [Image Rendering](../../setup-grafana/image-rendering/) in the documentation for further instructions. ## Query history in Explore out of beta The Query history feature lets you view and interact with the queries that you have previously run in Explore. You can add queries to the Explore query editor, write comments, create and share URL links, star your favorite queries, and much more. Starred queries are displayed in the Starred tab, so it is easier to reuse queries that you run often without typing them from scratch. -It was released as a beta feature in Grafana 6.7. The feedback has been really positive and it is now out of beta for the 7.0 release. Learn more about query history in [Explore]({{< relref "../explore" >}}). +It was released as a beta feature in Grafana 6.7. The feedback has been really positive and it is now out of beta for the 7.0 release. Learn more about query history in [Explore](../../explore/). ## Stackdriver data source supports Service Monitoring -[Service monitoring](https://cloud.google.com/service-monitoring) in Google Cloud Platform (GCP) enables you to monitor based on Service Level Objectives (SLOs) for your GCP services. The new SLO query builder in the Stackdriver data source allows you to display SLO data in Grafana. Read more about it in the [Stackdriver data source documentation]({{< relref "../datasources/google-cloud-monitoring#slo-service-level-objective-queries" >}}). +[Service monitoring](https://cloud.google.com/service-monitoring) in Google Cloud Platform (GCP) enables you to monitor based on Service Level Objectives (SLOs) for your GCP services. The new SLO query builder in the Stackdriver data source allows you to display SLO data in Grafana. Read more about it in the [Stackdriver data source documentation](../../datasources/google-cloud-monitoring/#slo-service-level-objective-queries). ## Time zone support -You can now override the [time zone]({{< relref "../dashboards/manage-dashboards#dashboard-time-settings" >}}) used to display date and time values in a dashboard. One benefit of this is that you can specify the local time zone of the service or system that you are monitoring which can be helpful when monitoring a system or service that operates across several time zones. +You can now override the [time zone](../../dashboards/manage-dashboards/#dashboard-time-settings) used to display date and time values in a dashboard. One benefit of this is that you can specify the local time zone of the service or system that you are monitoring which can be helpful when monitoring a system or service that operates across several time zones. ## Alerting and deep linking for Azure Log Analytics The Azure Monitor data source supports multiple Azure services. Log Analytics queries in the data source now have alerting support too (Azure Monitor and Application Insights already had alerting support). -A new feature is [deep linking from the graph panel to the Log Analytics query editor in the Azure Portal]({{< relref "../datasources/azure-monitor#deep-link-from-grafana-panels-to-the-log-analytics-query-editor-in-azure-portal" >}}). Click on a time series in the panel to see a context menu with a link to View in Azure Portal. Clicking that link opens the Azure Log Analytics query editor in the Azure Portal and runs the query from the Grafana panel. +A new feature is [deep linking from the graph panel to the Log Analytics query editor in the Azure Portal](../../datasources/azure-monitor/#deep-link-from-grafana-panels-to-the-log-analytics-query-editor-in-azure-portal). Click on a time series in the panel to see a context menu with a link to View in Azure Portal. Clicking that link opens the Azure Log Analytics query editor in the Azure Portal and runs the query from the Grafana panel. ## Grafana Enterprise @@ -219,17 +219,17 @@ This includes problems like: ### Usage insights and Presence indicator -This release includes a series of features that build on our new usage analytics engine. This “Grafana about Grafana” feature will help our large customers get better insight into the behavior and utilization of their users, dashboards, and data sources. The improved [dashboard search]({{< relref "../dashboards/assess-dashboard-usage#sort-dashboards-by-using-insights-data" >}}) allows you to sort dashboards by usage and errors. When a user opens a dashboard, they will see a [presence indicator]({{< relref "../dashboards/assess-dashboard-usage#presence-indicator" >}}) of who else is viewing the same dashboard. And finally [Dashboard insights]({{< relref "../dashboards/assess-dashboard-usage#dashboard-insights" >}}) allows you to view recent dashboard usage. +This release includes a series of features that build on our new usage analytics engine. This “Grafana about Grafana” feature will help our large customers get better insight into the behavior and utilization of their users, dashboards, and data sources. The improved [dashboard search](../../dashboards/assess-dashboard-usage/#sort-dashboards-by-using-insights-data) allows you to sort dashboards by usage and errors. When a user opens a dashboard, they will see a [presence indicator](../../dashboards/assess-dashboard-usage/#presence-indicator) of who else is viewing the same dashboard. And finally [Dashboard insights](../../dashboards/assess-dashboard-usage/#dashboard-insights) allows you to view recent dashboard usage. {{< figure src="/static/img/docs/v70/presence_indicator.jpg" max-width="1024px" caption="Grafana Enterprise - Presence indicator" >}} ### SAML Role and Team Sync -SAML support in Grafana Enterprise is improved by adding Role and Team Sync. Read more about how to use these features in the [SAML team sync documentation]({{< relref "../setup-grafana/configure-security/configure-authentication/saml#configure-team-sync" >}}). +SAML support in Grafana Enterprise is improved by adding Role and Team Sync. Read more about how to use these features in the [SAML team sync documentation](../../setup-grafana/configure-security/configure-authentication/saml/#configure-team-sync). ### Okta OAuth Team Sync -Okta gets its own provider which adds support for Team Sync. Read more about it in the [Okta documentation]({{< relref "../setup-grafana/configure-security/configure-authentication/okta" >}}). +Okta gets its own provider which adds support for Team Sync. Read more about it in the [Okta documentation](../../setup-grafana/configure-security/configure-authentication/okta/). ## Changelog diff --git a/docs/sources/whatsnew/whats-new-in-v7-1.md b/docs/sources/whatsnew/whats-new-in-v7-1.md index 65e9b5f8544..f6ecb1537c7 100644 --- a/docs/sources/whatsnew/whats-new-in-v7-1.md +++ b/docs/sources/whatsnew/whats-new-in-v7-1.md @@ -25,19 +25,19 @@ This topic includes the release notes for the Grafana v7.1. For all details, rea The main highlights are: -- [**Flux and InfluxDB 2.x support in the Influx Datasource**]({{< relref "#influx-data-source" >}}) -- [**Query history search**]({{< relref "#query-history-search" >}}) -- [**Unification of Explore modes**]({{< relref "#explore-modes-unified" >}}) -- [**Elasticsearch- link to another data source from Explore**]({{< relref "#internal-links-for-elasticsearch" >}}) -- [**Merge on time transform for the new table panel**]({{< relref "#transformations" >}}) -- [**Stat panel text mode**]({{< relref "#stat-panel-text-mode" >}}) -- [**Time range picker update**]({{< relref "#time-range-picker-update" >}}) -- [**Provisioning of apps**]({{< relref "#provisioning-of-apps" >}}) -- [**Azure Monitor Datasource**]({{< relref "#azure-monitor-data-source" >}}) -- [**Deep linking for Google Cloud Monitoring (formerly named Google Stackdriver) datasource**]({{< relref "#deep-linking-for-google-cloud-monitoring-formerly-named-google-stackdriver-data-source" >}}) -- [**Grafana Enterprise features**]({{< relref "#grafana-enterprise-features" >}}) - - [**Secret management with HashiCorp Vault**]({{< relref "#support-for-hashicorp-vault" >}}) - - [**Monthly schedules in reports**]({{< relref "#support-for-monthly-schedules-in-reports" >}}) +- [**Flux and InfluxDB 2.x support in the Influx Datasource**](#influx-data-source) +- [**Query history search**](#query-history-search) +- [**Unification of Explore modes**](#explore-modes-unified) +- [**Elasticsearch- link to another data source from Explore**](#internal-links-for-elasticsearch) +- [**Merge on time transform for the new table panel**](#transformations) +- [**Stat panel text mode**](#stat-panel-text-mode) +- [**Time range picker update**](#time-range-picker-update) +- [**Provisioning of apps**](#provisioning-of-apps) +- [**Azure Monitor Datasource**](#azure-monitor-data-source) +- [**Deep linking for Google Cloud Monitoring (formerly named Google Stackdriver) datasource**](#deep-linking-for-google-cloud-monitoring-formerly-named-google-stackdriver-data-source) +- [**Grafana Enterprise features**](#grafana-enterprise-features) + - [**Secret management with HashiCorp Vault**](#support-for-hashicorp-vault) + - [**Monthly schedules in reports**](#support-for-monthly-schedules-in-reports) ## Influx data source @@ -45,7 +45,7 @@ Support for Flux and Influx v2 has been added. The InfluxData blog post, [How to ## Query history search -In Grafana v 7.1 we are introducing search functionality in Query history. You can search across queries and your comments. It is especially useful in combination with a time filter and data source filter. Read more about [Query history here]({{< relref "../explore#query-history" >}}). +In Grafana v 7.1 we are introducing search functionality in Query history. You can search across queries and your comments. It is especially useful in combination with a time filter and data source filter. Read more about [Query history here](../../explore/#query-history). {{< figure src="/static/img/docs/v71/query_history_search.gif" max-width="800px" caption="Query history search" >}} @@ -67,11 +67,11 @@ The new table panel introduced in 7.0 was missing a few features that the old ta ## Ad hoc filtering in the new table panel -[Ad hoc filtering]({{< relref "../dashboards/variables/add-template-variables#add-ad-hoc-filters" >}}), a way to automatically add filters to queries without having to define template variables is now supported in the new Table panel. +[Ad hoc filtering](../../dashboards/variables/add-template-variables/#add-ad-hoc-filters), a way to automatically add filters to queries without having to define template variables is now supported in the new Table panel. ## Stat panel text mode -The [stat panel]({{< relref "../panels-visualizations/visualizations/stat#text-mode" >}}) has a new **Text mode** option to control what text to show. +The [stat panel](../../panels-visualizations/visualizations/stat/#text-mode) has a new **Text mode** option to control what text to show. By default, the Stat panel displays: @@ -84,7 +84,7 @@ You can use the Text mode option to control what text the panel renders. If the ## Provisioning of apps -Grafana v7.1 adds support for provisioning of app plugins. This allows app plugins to be configured and enabled/disabled using configuration files. For more information about provisioning of app, refer to [provisioning plugin]({{< relref "../administration/provisioning#plugins" >}}). +Grafana v7.1 adds support for provisioning of app plugins. This allows app plugins to be configured and enabled/disabled using configuration files. For more information about provisioning of app, refer to [provisioning plugin](../../administration/provisioning/#plugins). ## Azure Monitor data source @@ -94,7 +94,7 @@ Additionally, the Raw Edit mode for Application Insights Analytics has been repl ## Deep linking for Google Cloud Monitoring (formerly named Google Stackdriver) data source -A new feature in Grafana 7.1 is [deep linking from Grafana panels to the Metrics Explorer in Google Cloud Console]({{< relref "../datasources/google-cloud-monitoring#deep-linking-from-grafana-panels-to-the-metrics-explorer-in-google-cloud-console" >}}). Click on a time series in the panel to see a context menu with a link to View in Metrics explorer in Google Cloud Console. Clicking that link opens the Metrics explorer in the Monitoring Google Cloud Console and runs the query from the Grafana panel there. +A new feature in Grafana 7.1 is [deep linking from Grafana panels to the Metrics Explorer in Google Cloud Console](../../datasources/google-cloud-monitoring/#deep-linking-from-grafana-panels-to-the-metrics-explorer-in-google-cloud-console). Click on a time series in the panel to see a context menu with a link to View in Metrics explorer in Google Cloud Console. Clicking that link opens the Metrics explorer in the Monitoring Google Cloud Console and runs the query from the Grafana panel there. ## Time range picker update @@ -108,11 +108,11 @@ General features are included in the Grafana Enterprise edition software. ### Support for HashiCorp Vault -You can now use HashiCorp Vault to get secrets for configuration and provisioning of Grafana Enterprise. For more information about HashiCorp Vault, refer to [vault]({{< relref "../setup-grafana/configure-security/configure-database-encryption/integrate-with-hashicorp-vault" >}}). +You can now use HashiCorp Vault to get secrets for configuration and provisioning of Grafana Enterprise. For more information about HashiCorp Vault, refer to [vault](../../setup-grafana/configure-security/configure-database-encryption/integrate-with-hashicorp-vault/). ### Support for monthly schedules in reports -With Grafana Enterprise 7.1, you can generate reports on a [monthly schedule]({{< relref "../dashboards/share-dashboards-panels#scheduling" >}}). +With Grafana Enterprise 7.1, you can generate reports on a [monthly schedule](../../dashboards/share-dashboards-panels/#scheduling). ## Changelog diff --git a/docs/sources/whatsnew/whats-new-in-v7-2.md b/docs/sources/whatsnew/whats-new-in-v7-2.md index 0020f4c71e1..b6b08749e53 100644 --- a/docs/sources/whatsnew/whats-new-in-v7-2.md +++ b/docs/sources/whatsnew/whats-new-in-v7-2.md @@ -25,23 +25,23 @@ This topic includes the release notes for the Grafana v7.2. For all details, rea The main highlights are: -- [**New date formatting options added**]({{< relref "#new=date-formatting-options-added" >}}) -- [**Field options are out of beta!**]({{< relref "#field-options-are-out-of-beta" >}}) - - [**Added table column filters**]({{< relref "#added-table-column-filters" >}}) - - [**New field override selection options**]({{< relref "#new-field-override-selection-options" >}}) -- [**New transformations and enhancements**]({{< relref "#new-transformations-and-enhancements" >}}) -- [**Drag to reorder queries**]({{< relref "#drag-to-reorder-queries" >}}) -- [**Inspect queries in Explore**]({{< relref "#inspect-queries-in-explore" >}}) -- [**$__rate_interval for Prometheus**]({{< relref "#__rate_interval-for-prometheus" >}}) -- [**Toggle parsed log fields**]({{< relref "#toggle-parsed-log-fields" >}}) -- [**Sensitive alert channel settings are now encrypted**]({{< relref "#sensitive-alert-channel-settings-are-now-encrypted" >}}) -- [**Grafana Enterprise features**]({{< relref "#grafana-enterprise-features" >}}) - - [**Report time range**]({{< relref "#report-time-range" >}}) - - [**Organization-wide report settings**]({{< relref "#organization-wide-report-settings" >}}) - - [**Report grid layout**]({{< relref "#report-grid-layout" >}}) -- [**What's new in other parts of the Grafana ecosystem**]({{< relref "#whats-new-in-other-parts-of-the-grafana-ecosystem" >}}) - - [**ADX (Azure Data Explorer) plugin**]({{< relref "#adx-azure-data-explorer-plugin" >}}) - - [**X-Ray data source plugin**]({{< relref "#x-ray-data-source-plugin" >}}) +- [**New date formatting options added**](#new=date-formatting-options-added) +- [**Field options are out of beta!**](#field-options-are-out-of-beta) + - [**Added table column filters**](#added-table-column-filters) + - [**New field override selection options**](#new-field-override-selection-options) +- [**New transformations and enhancements**](#new-transformations-and-enhancements) +- [**Drag to reorder queries**](#drag-to-reorder-queries) +- [**Inspect queries in Explore**](#inspect-queries-in-explore) +- [**$\_\_rate_interval for Prometheus**](#__rate_interval-for-prometheus) +- [**Toggle parsed log fields**](#toggle-parsed-log-fields) +- [**Sensitive alert channel settings are now encrypted**](#sensitive-alert-channel-settings-are-now-encrypted) +- [**Grafana Enterprise features**](#grafana-enterprise-features) + - [**Report time range**](#report-time-range) + - [**Organization-wide report settings**](#organization-wide-report-settings) + - [**Report grid layout**](#report-grid-layout) +- [**What's new in other parts of the Grafana ecosystem**](#whats-new-in-other-parts-of-the-grafana-ecosystem) + - [**ADX (Azure Data Explorer) plugin**](#adx-azure-data-explorer-plugin) + - [**X-Ray data source plugin**](#x-ray-data-source-plugin) ## New date formatting options added @@ -51,7 +51,7 @@ This screenshot shows both a custom full date format with a 12 hour clock and am {{< figure src="/static/img/docs/v72/date_formats.png" max-width="800px" caption="Custom date time formats" >}} -Date formats are set for a Grafana instance by adjusting [server-wide settings]({{< relref "../setup-grafana/configure-grafana#date_formats" >}}) in the Grafana configuration file. We hope to add org- and user-level settings in the future. +Date formats are set for a Grafana instance by adjusting [server-wide settings](../../setup-grafana/configure-grafana/#date_formats) in the Grafana configuration file. We hope to add org- and user-level settings in the future. ``` [date_formats] @@ -66,7 +66,7 @@ interval_year = YYYY There is also experimental support to use the browser location and language to dynamically change the current date format for each user. This feature is disabled by default. -The [Configuration]({{< relref "../setup-grafana/configure-grafana#date_formats" >}}) topic has been updated as a result of this change. +The [Configuration](../../setup-grafana/configure-grafana/#date_formats) topic has been updated as a result of this change. ## Field options are out of beta! @@ -78,7 +78,7 @@ You can now dynamically apply value filters to any table column. This option can {{< figure src="/static/img/docs/v72/table_column_filters.png" max-width="800px" caption="Table column filters" >}} -[Filter table columns]({{< relref "../panels-visualizations/visualizations/table#filter-table-columns" >}}) has been added as a result of this feature. +[Filter table columns](../../panels-visualizations/visualizations/table/#filter-table-columns) has been added as a result of this feature. ### New field override selection options @@ -88,8 +88,8 @@ You can now add override rules that use a regex matcher to choose which fields t Grafana 7.2 includes the following transformation enhancements: -- A new [Group By]({{< relref "../panels-visualizations/query-transform-data/transform-data#group-by" >}}) transformation that allows you to group by multiple fields and add any number of aggregations for other fields. -- The [Labels to fields]({{< relref "../panels-visualizations/query-transform-data/transform-data#labels-to-fields" >}}) transformation now allows you to pick one label and use that as the name of the value field. +- A new [Group By](../../panels-visualizations/query-transform-data/transform-data/#group-by) transformation that allows you to group by multiple fields and add any number of aggregations for other fields. +- The [Labels to fields](../../panels-visualizations/query-transform-data/transform-data/#labels-to-fields) transformation now allows you to pick one label and use that as the name of the value field. - You can drag transformations to reorder them. Remember that transformations are processed in the order they are listed in the UI, so think before you move something! {{< figure src="/static/img/docs/v72/transformations.gif" max-width="800px" caption="Group by and reordering of transformations" >}} @@ -100,15 +100,15 @@ The up and down arrows, which were previously the only way to change query order {{< figure src="/static/img/docs/v72/drag-queries.gif" max-width="800px" caption="Drag to reorder queries" >}} -The [Queries]({{< relref "../panels-visualizations#add-a-query" >}}) topic has been updated as a result of this change. +The [Queries](../../panels-visualizations/#add-a-query) topic has been updated as a result of this change. ## Inspect queries in Explore -You can enjoy all the details query inspector gave you in dashboards now in Explore as well. You can open query inspector tab with the button next to query history. See [Query inspector in Explore]({{< relref "../explore#query-inspector" >}}) for more details. +You can enjoy all the details query inspector gave you in dashboards now in Explore as well. You can open query inspector tab with the button next to query history. See [Query inspector in Explore](../../explore/#query-inspector) for more details. ## \$\_\_rate_interval for Prometheus -You can now use the new variable `$__rate_interval` in Prometheus for rate functions mainly. `$__rate_interval` in general is one scrape interval larger than `$__interval` but is never smaller than four times the scrape interval (which is 15s by default). See the [Prometheus data source]({{< relref "../datasources/prometheus#using-__rate_interval-variable" >}}) for more details. +You can now use the new variable `$__rate_interval` in Prometheus for rate functions mainly. `$__rate_interval` in general is one scrape interval larger than `$__interval` but is never smaller than four times the scrape interval (which is 15s by default). See the [Prometheus data source](../../datasources/prometheus/#using-__rate_interval-variable) for more details. ## Toggle parsed log fields @@ -116,7 +116,7 @@ With this awesome contribution from one of our community members, you can now to {{< figure src="/static/img/docs/v72/explore-toggle-parsed-fields.gif" max-width="800px" caption="Toggling parsed fields in Explore" >}} -The [Toggle parsed fields]({{< relref "../explore#toggle-detected-fields" >}}) section has been added to [Explore]({{< relref "../explore" >}}) as a result of this feature. +The [Toggle parsed fields](../../explore/#toggle-detected-fields) section has been added to [Explore](../../explore/) as a result of this feature. ## Sensitive alert channel settings are now encrypted @@ -128,9 +128,9 @@ These features are included in the Grafana Enterprise edition software. ### Report and export dashboards in grid layout -A new layout option is available when rendering reports: the grid layout. With this option, your report uses the panel layout from your dashboard, so that what you see is what you get. Learn more about the [grid layout]({{< relref "../dashboards/share-dashboards-panels#layout-and-orientation" >}}) in the documentation. +A new layout option is available when rendering reports: the grid layout. With this option, your report uses the panel layout from your dashboard, so that what you see is what you get. Learn more about the [grid layout](../../dashboards/share-dashboards-panels/#layout-and-orientation) in the documentation. -The grid layout is also available for the [Export dashboard as PDF]({{< relref "../dashboards/share-dashboards-panels#export-dashboard-as-pdf" >}}) feature. +The grid layout is also available for the [Export dashboard as PDF](../../dashboards/share-dashboards-panels/#export-dashboard-as-pdf) feature. {{< figure src="/static/img/docs/enterprise/reports_grid_landscape_preview.png" max-width="500px" class="docs-image--no-shadow" alt="Report in grid layout" >}} @@ -138,7 +138,7 @@ The grid layout is also available for the [Export dashboard as PDF]({{< relref " You can now generate a report with a different time range from the dashboard it is based on. This means that you no longer have to apply workarounds, such as copying dashboards or carefully aligning report generation with the end of the month, to generate reports that cover the period you want. -For more information, refer to [Reports time range]({{< relref "../dashboards/share-dashboards-panels#report-time-range" >}}). +For more information, refer to [Reports time range](../../dashboards/share-dashboards-panels/#report-time-range). ### Organization-wide report settings @@ -146,7 +146,7 @@ You can now configure organization-wide report settings, such as report branding {{< figure src="/static/img/docs/enterprise/reports_settings.png" max-width="500px" class="docs-image--no-shadow" caption="Reports settings" >}} -For more information, refer to [Report settings]({{< relref "../dashboards/share-dashboards-panels#report-settings" >}}). +For more information, refer to [Report settings](../../dashboards/share-dashboards-panels/#report-settings). ## Changelog diff --git a/docs/sources/whatsnew/whats-new-in-v7-3.md b/docs/sources/whatsnew/whats-new-in-v7-3.md index ca2c0d75c66..9f2f5882475 100644 --- a/docs/sources/whatsnew/whats-new-in-v7-3.md +++ b/docs/sources/whatsnew/whats-new-in-v7-3.md @@ -25,12 +25,12 @@ This topic includes the release notes for Grafana v7.3. For all details, read th The main highlights are: -- [**Google Cloud Monitoring:** Out of the box dashboards]({{< relref "#cloud-monitoring-out-of-the-box-dashboards" >}}) -- [**Shorten URL for dashboards and Explore**]({{< relref "#shorten-url-for-dashboards-and-explore" >}}) -- [**Table improvements and new image cell mode**]({{< relref "#table-improvements-and-new-image-cell-mode" >}}) -- [**New color scheme option**]({{< relref "#new-color-scheme-option" >}}) -- [**SigV4 Authentication for Amazon Elasticsearch Service**]({{< relref "#sigv4-authentication-for-aws-users" >}}) -- [**CSV exports for Excel**]({{< relref "#csv-exports-for-excel" >}}) +- [**Google Cloud Monitoring:** Out of the box dashboards](#cloud-monitoring-out-of-the-box-dashboards) +- [**Shorten URL for dashboards and Explore**](#shorten-url-for-dashboards-and-explore) +- [**Table improvements and new image cell mode**](#table-improvements-and-new-image-cell-mode) +- [**New color scheme option**](#new-color-scheme-option) +- [**SigV4 Authentication for Amazon Elasticsearch Service**](#sigv4-authentication-for-aws-users) +- [**CSV exports for Excel**](#csv-exports-for-excel) ## Table improvements and new image cell mode @@ -45,7 +45,7 @@ Another new feature that can be seen in the image above is the new image cell di {{< figure src="/static/img/docs/v73/color_scheme_dropdown.png" max-width="450px" caption="Color scheme" class="pull-right" >}} -A new standard field color scheme option has been added. This new option will provide a unified way for all new panels to specify how colors should be assigned. For more information, refer to [Apply color to series and fields]({{< relref "../panels-visualizations/configure-standard-options#color-scheme" >}}). +A new standard field color scheme option has been added. This new option will provide a unified way for all new panels to specify how colors should be assigned. For more information, refer to [Apply color to series and fields](../../panels-visualizations/configure-standard-options/#color-scheme). - **Single color**: Specifies a single color. Useful in an override rule. - **From thresholds**: Informs Grafana to take color from the matching threshold. @@ -64,7 +64,7 @@ Another thing to highlight is that all these new color schemes are theme aware a {{< figure src="/static/img/docs/v73/table_color_scheme_mono_light.png" max-width="900px" caption="table color monochrome scheme" >}} -As this new option is a standard field option it works in every panel. Here is another example from the [Bar Gauge]({{< relref "../panels-visualizations/visualizations/bar-gauge" >}}) panel. +As this new option is a standard field option it works in every panel. Here is another example from the [Bar Gauge](../../panels-visualizations/visualizations/bar-gauge/) panel. {{< figure src="/static/img/docs/v73/bar_gauge_gradient_color_scheme.png" max-width="900px" caption="bar gauge color scheme" >}} @@ -72,7 +72,7 @@ As this new option is a standard field option it works in every panel. Here is a In v7.0, we introduced a new table panel and inspect mode with Download CSV enabled. However, CSV export to Excel was removed. Due to a large number of inquiries and requests, this [community contribution from tomdaly](https://github.com/grafana/grafana/pull/27284) brought the feature back. -For more information, refer to [Download raw query results]({{< relref "../panels-visualizations/panel-inspector#download-raw-query-results" >}}). +For more information, refer to [Download raw query results](../../panels-visualizations/panel-inspector/#download-raw-query-results). ## Google Cloud monitoring out-of-the-box dashboards @@ -86,7 +86,7 @@ The updated Google Cloud monitoring data source is shipped with pre-configured d To import the pre-configured dashboards, go to the configuration page of your Google Cloud Monitoring data source and click on the `Dashboards` tab. Click `Import` for the dashboard you would like to use. To customize the dashboard, we recommend to save the dashboard under a different name, because otherwise the dashboard will be overwritten when a new version of the dashboard is released. -For more details, see the [Google Cloud Monitoring docs]({{< relref "../datasources/google-cloud-monitoring#out-of-the-box-dashboards" >}}) +For more details, see the [Google Cloud Monitoring docs](../../datasources/google-cloud-monitoring/#out-of-the-box-dashboards) ## Shorten URL for dashboards and Explore @@ -96,7 +96,7 @@ This is an amazing new feature that was created in cooperation with one of our c You can now configure your Elasticsearch data source to access your Amazon Elasticsearch Service domain directly from Grafana. -For more details, refer to the [Elasticsearch docs]({{< relref "../datasources/elasticsearch#aws-signature-version-4-authentication" >}}). +For more details, refer to the [Elasticsearch docs](../../datasources/elasticsearch/#aws-signature-version-4-authentication). ## Chaining pipeline aggregation in Elasticsearch @@ -132,7 +132,7 @@ Example of a login event: } ``` -For more details, see the [Auditing docs]({{< relref "../setup-grafana/configure-security/audit-grafana" >}}). +For more details, see the [Auditing docs](../../setup-grafana/configure-security/audit-grafana/). ### Data source usage insights @@ -146,11 +146,11 @@ Insights: ### SAML single logout -SAML’s single logout (SLO) capability allows users to log out from all applications associated with the current identity provider (IdP) session established via SAML SSO. For more information, refer to the [docs]({{< relref "../setup-grafana/configure-security/configure-authentication/saml#single-logout" >}}). +SAML’s single logout (SLO) capability allows users to log out from all applications associated with the current identity provider (IdP) session established via SAML SSO. For more information, refer to the [docs](../../setup-grafana/configure-security/configure-authentication/saml/#single-logout). ### SAML IdP-initiated single sign on -IdP-initiated single sign on (SSO) allows the user to log in directly from the SAML identity provider (IdP). It is disabled by default for security reasons. For more information, refer to the [docs]({{< relref "../setup-grafana/configure-security/configure-authentication/saml#idp-initiated-single-sign-on-sso" >}}). +IdP-initiated single sign on (SSO) allows the user to log in directly from the SAML identity provider (IdP). It is disabled by default for security reasons. For more information, refer to the [docs](../../setup-grafana/configure-security/configure-authentication/saml/#idp-initiated-single-sign-on-sso). ## Changelog @@ -158,11 +158,11 @@ Check out [CHANGELOG.md](https://github.com/grafana/grafana/blob/main/CHANGELOG. ## Patch release notes -- [Grafana 7.3.0 release notes]({{< relref "../release-notes/release-notes-7-3-0" >}}) -- [Grafana 7.3.1 release notes]({{< relref "../release-notes/release-notes-7-3-1" >}}) -- [Grafana 7.3.2 release notes]({{< relref "../release-notes/release-notes-7-3-2" >}}) -- [Grafana 7.3.3 release notes]({{< relref "../release-notes/release-notes-7-3-3" >}}) -- [Grafana 7.3.4 release notes]({{< relref "../release-notes/release-notes-7-3-4" >}}) -- [Grafana 7.3.5 release notes]({{< relref "../release-notes/release-notes-7-3-5" >}}) -- [Grafana 7.3.6 release notes]({{< relref "../release-notes/release-notes-7-3-6" >}}) -- [Grafana 7.3.7 release notes]({{< relref "../release-notes/release-notes-7-3-7" >}}) +- [Grafana 7.3.0 release notes](../../release-notes/release-notes-7-3-0/) +- [Grafana 7.3.1 release notes](../../release-notes/release-notes-7-3-1/) +- [Grafana 7.3.2 release notes](../../release-notes/release-notes-7-3-2/) +- [Grafana 7.3.3 release notes](../../release-notes/release-notes-7-3-3/) +- [Grafana 7.3.4 release notes](../../release-notes/release-notes-7-3-4/) +- [Grafana 7.3.5 release notes](../../release-notes/release-notes-7-3-5/) +- [Grafana 7.3.6 release notes](../../release-notes/release-notes-7-3-6/) +- [Grafana 7.3.7 release notes](../../release-notes/release-notes-7-3-7/) diff --git a/docs/sources/whatsnew/whats-new-in-v7-4.md b/docs/sources/whatsnew/whats-new-in-v7-4.md index d7143caee18..0d0b9cc4806 100644 --- a/docs/sources/whatsnew/whats-new-in-v7-4.md +++ b/docs/sources/whatsnew/whats-new-in-v7-4.md @@ -41,11 +41,11 @@ Apart from major performance improvements, the new Time series panel implements The following documentation topics were added for this feature: -- [Time series panel]({{< relref "../panels-visualizations/visualizations/time-series" >}}) -- [Graph time series as lines]({{< relref "../panels-visualizations/visualizations/time-series#line-style" >}}) -- [Graph time series as bars]({{< relref "../panels-visualizations/visualizations/time-series#bar-alignment" >}}) -- [Graph time series as points]({{< relref "../panels-visualizations/visualizations/time-series#show-points" >}}) -- [Change axis display]({{< relref "../panels-visualizations/visualizations/time-series#axis-options" >}}) +- [Time series panel](../../panels-visualizations/visualizations/time-series/) +- [Graph time series as lines](../../panels-visualizations/visualizations/time-series/#line-style) +- [Graph time series as bars](../../panels-visualizations/visualizations/time-series/#bar-alignment) +- [Graph time series as points](../../panels-visualizations/visualizations/time-series/#show-points) +- [Change axis display](../../panels-visualizations/visualizations/time-series/#axis-options) ### Node graph panel visualization (Beta) @@ -55,7 +55,7 @@ All the information and stats shown in the Node graph beta are driven by the dat For more details about how to use the X-Ray service map feature, see the [X-Ray plugin documentation](/grafana/plugins/grafana-x-ray-datasource). -For more information, refer to [Node graph panel]({{< relref "../panels-visualizations/visualizations/node-graph" >}}). +For more information, refer to [Node graph panel](../../panels-visualizations/visualizations/node-graph/). ### New transformations @@ -65,7 +65,7 @@ The following transformations were added in Grafana 7.4. The _Sort by_ transformation allows you to sort data before sending it to the visualization. -For more information, refer to [Sort by]({{< relref "../panels-visualizations/query-transform-data/transform-data#sort-by" >}}). +For more information, refer to [Sort by](../../panels-visualizations/query-transform-data/transform-data/#sort-by). #### Filter data by value transform @@ -73,13 +73,13 @@ The new _Filter data by value_ transformation allows you to filter your data dir This transformation is very useful if your data source does not natively filter by values. You might also use this to narrow values to display if you are using a shared query. -For more information, refer to [Filter data by value]({{< relref "../panels-visualizations/query-transform-data/transform-data#filter-data-by-value" >}}). +For more information, refer to [Filter data by value](../../panels-visualizations/query-transform-data/transform-data/#filter-data-by-value). ### New override option On the Overrides tab, you can now set properties for fields returned by a specific query. -For more information, refer to [About field overrides]({{< relref "../panels-visualizations/configure-overrides" >}}). +For more information, refer to [About field overrides](../../panels-visualizations/configure-overrides/). ### Exemplar support @@ -89,7 +89,7 @@ Grafana graphs now support Prometheus _exemplars_. They are displayed as diamond {{< figure src="/static/img/docs/v74/exemplars.png" max-width="900px" caption="Exemplar example" >}} -For more information, refer to [Exemplars]({{< relref "../fundamentals/exemplars" >}}). +For more information, refer to [Exemplars](../../fundamentals/exemplars/). ### Trace to logs @@ -97,20 +97,20 @@ You can now navigate from a span in a trace view directly to logs relevant for t The following topics were updated as a result of this feature: -- [Explore]({{< relref "../explore/trace-integration" >}}) -- [Jaeger]({{< relref "../datasources/jaeger#configure-trace-to-logs" >}}) -- [Tempo]({{< relref "../datasources/tempo#configure-trace-to-logs" >}}) -- [Zipkin]({{< relref "../datasources/zipkin#configure-trace-to-logs" >}}) +- [Explore](../../explore/trace-integration/) +- [Jaeger](../../datasources/jaeger/#configure-trace-to-logs) +- [Tempo](../../datasources/tempo/#configure-trace-to-logs) +- [Zipkin](../../datasources/zipkin/#configure-trace-to-logs) ### Server-side expressions _Server-side expressions_ is an experimental feature that allows you to manipulate data returned from backend data source queries. Expressions allow you to manipulate data with math and other operations when the data source is a backend data source or a **--Mixed--** data source. -The main use case is for [multi-dimensional]({{< relref "../fundamentals/timeseries-dimensions" >}}) data sources used with the upcoming next generation alerting, but expressions can be used with backend data sources and visualization as well. +The main use case is for [multi-dimensional](../../fundamentals/timeseries-dimensions/) data sources used with the upcoming next generation alerting, but expressions can be used with backend data sources and visualization as well. > **Note:** Queries built with this feature might break with minor version upgrades until Grafana 8 is released. This feature does not work with the current Grafana Alerting. -For more information, refer to [Write expression queries]({{< relref "../panels-visualizations/query-transform-data/expression-queries" >}}). [About queries]({{< relref "../panels-visualizations/query-transform-data#about-queries" >}}) was also updated as a result of this feature. +For more information, refer to [Write expression queries](../../panels-visualizations/query-transform-data/expression-queries/). [About queries](../../panels-visualizations/query-transform-data/#about-queries) was also updated as a result of this feature. ### Alert notification query label interpolation @@ -126,13 +126,13 @@ CSP support is disabled by default, to enable it you must set `content_security_ You can lock down what can be done in the frontend code. Lock down what can be loaded, what JavaScript is executed. Not compatible with some plugins. -[content_security_policy]({{< relref "../setup-grafana/configure-grafana#content_security_policy" >}}) and [content_security_policy_template]({{< relref "../setup-grafana/configure-grafana#content_security_policy_template" >}}) were added to [Configuration]({{< relref "../setup-grafana/configure-grafana" >}}) as a result of this change. +[content_security_policy](../../setup-grafana/configure-grafana/#content_security_policy) and [content_security_policy_template](../../setup-grafana/configure-grafana/#content_security_policy_template) were added to [Configuration](../../setup-grafana/configure-grafana/) as a result of this change. ### Hide users in UI You can now use the `hidden_users` configuration setting to hide specific users in the UI. For example, this feature can be used to hide users that are used for automation purposes. -[Configuration]({{< relref "../setup-grafana/configure-grafana#hidden_users" >}}) has been updated for this feature. +[Configuration](../../setup-grafana/configure-grafana/#hidden_users) has been updated for this feature. ### Elasticsearch data source updates @@ -145,13 +145,13 @@ Grafana 7.4 includes the following enhancements > **Note:** We have deprecated browser access mode. It will be removed in a future release. -For more information, refer to the [Elasticsearch docs]({{< relref "../datasources/elasticsearch" >}}). +For more information, refer to the [Elasticsearch docs](../../datasources/elasticsearch/). ### Azure Monitor updates The Azure Monitor query type was renamed to Metrics and Azure Logs Analytics was renamed to Logs to match the service names in Azure and align the concepts with the rest of Grafana. -[Azure Monitor]({{< relref "../datasources/azure-monitor" >}}) was updated to reflect this change. +[Azure Monitor](../../datasources/azure-monitor/) was updated to reflect this change. ### MQL support added for Google Cloud Monitoring @@ -161,7 +161,7 @@ Unlike the visual query builder, MQL allows you to control the time range and pe MQL uses a set of operations and functions. Operations are linked together using the common pipe mechanism, where the output of one operation becomes the input to the next. Linking operations makes it possible to build up complex queries incrementally. -Once query type Metrics is selected in the Cloud Monitoring query editor, you can toggle between the editor modes for visual query builder and MQL. For more information, refer to the [Google Cloud Monitoring docs]({{< relref "../datasources/google-cloud-monitoring#import-pre-configured-dashboards" >}}). +Once query type Metrics is selected in the Cloud Monitoring query editor, you can toggle between the editor modes for visual query builder and MQL. For more information, refer to the [Google Cloud Monitoring docs](../../datasources/google-cloud-monitoring/#import-pre-configured-dashboards). Many thanks to [mtanda](https://github.com/mtanda) this contribution! @@ -173,13 +173,13 @@ Google Cloud Monitoring data source ships with pre-configured dashboards for som If you want to customize a dashboard, we recommend that you save it under a different name. Otherwise the dashboard will be overwritten when a new version of the dashboard is released. -For more information, refer to the [Google Cloud Monitoring docs]({{< relref "../datasources/google-cloud-monitoring#import-pre-configured-dashboards" >}}). +For more information, refer to the [Google Cloud Monitoring docs](../../datasources/google-cloud-monitoring/#import-pre-configured-dashboards). ### Query Editor Help The feature previously referred to as DataSource Start Pages or Cheat Sheets has been renamed to Query Editor Help, and is now supported in panel query editors (depending on the data source), as well as in Explore. -[Queries]({{< relref "../panels-visualizations/query-transform-data#manage-queries" >}}) was updated as a result of this feature. +[Queries](../../panels-visualizations/query-transform-data/#manage-queries) was updated as a result of this feature. For more information on adding a query editor help component to your plugin, refer to [Add a query editor help component](https://grafana.com/developers/plugin-tools/how-to-guides/data-source-plugins/add-query-editor-help). @@ -187,7 +187,7 @@ For more information on adding a query editor help component to your plugin, ref The variables list has an additional column indicating whether variables are referenced in queries and panel names or not. The dependencies graph provides an easy way to check variable dependencies. You can click on a variable name within the graph to make updates to the variable as needed. -For more information, refer to [Inspect variables and their dependencies]({{< relref "../dashboards/variables/inspect-variable" >}}). +For more information, refer to [Inspect variables and their dependencies](../../dashboards/variables/inspect-variable/). ## Grafana Enterprise features @@ -195,39 +195,39 @@ These features are included in the Grafana Enterprise edition. ### Licensing changes -When determining a user’s role for billing purposes, a user who has the ability to edit and save dashboards is considered an Editor. This includes any user who is an Editor or Admin at the Org level, and who has granted Admin or Edit permissions via [Dashboard permissions]({{< relref "../administration/user-management/manage-dashboard-permissions" >}}). +When determining a user’s role for billing purposes, a user who has the ability to edit and save dashboards is considered an Editor. This includes any user who is an Editor or Admin at the Org level, and who has granted Admin or Edit permissions via [Dashboard permissions](../../administration/user-management/manage-dashboard-permissions/). After the number of Viewers or Editors has reached its license limit, only Admins will see a banner in Grafana indicating that the license limit has been reached. Previously, all users saw the banner. Grafana Enterprise license tokens update automatically on a daily basis, which means you no longer need to manually update your license, and the process for adding additional users to a license is smoother than it was before. -Refer to [Licensing restrictions]({{< relref "../administration/enterprise-licensing#license-restrictions" >}}) for more information. +Refer to [Licensing restrictions](../../administration/enterprise-licensing/#license-restrictions) for more information. ### Export usage insights to Loki You can now export usage insights logs to Loki and query them from Grafana. Usage insights logs include dashboard visits, data source views, queries and errors, and more. -For more information, refer to [Export logs of usage insights]({{< relref "../setup-grafana/configure-security/export-logs" >}}). +For more information, refer to [Export logs of usage insights](../../setup-grafana/configure-security/export-logs/). ### New audit log events -New log out events are logged based on when a token expires or is revoked, as well as [SAML Single Logout]({{< relref "../setup-grafana/configure-security/configure-authentication/saml#single-logout" >}}). A `tokenId` field was added to all audit logs to help understand which session was logged out of. +New log out events are logged based on when a token expires or is revoked, as well as [SAML Single Logout](../../setup-grafana/configure-security/configure-authentication/saml/#single-logout). A `tokenId` field was added to all audit logs to help understand which session was logged out of. Also, a counter for audit log writing actions with status (success / failure) and logger (loki / file / console) labels was added. -[Auditing]({{< relref "../setup-grafana/configure-security/audit-grafana" >}}) was updated to reflect these changes. +[Auditing](../../setup-grafana/configure-security/audit-grafana/) was updated to reflect these changes. ### Reports support Unicode You can now select a font, other than the default, for Unicode-based scripts. As a result, an automatically generated PDF of a dashboard, which contains for example Chinese or Cyrillic text, can display them. Because the size of a report increases as additional fonts are added, this feature is not on by default. -[Reporting]({{< relref "../dashboards/share-dashboards-panels#rendering-configuration" >}}) was updated as a result of this change. +[Reporting](../../dashboards/share-dashboards-panels/#rendering-configuration) was updated as a result of this change. ### Request security Request security introduces ways to limit requests from the Grafana server, and it targets requests that are generated by users. -For more information, refer to [Request security]({{< relref "../setup-grafana/configure-security/configure-request-security" >}}). +For more information, refer to [Request security](../../setup-grafana/configure-security/configure-request-security/). ## Breaking changes diff --git a/docs/sources/whatsnew/whats-new-in-v7-5.md b/docs/sources/whatsnew/whats-new-in-v7-5.md index 6f842b4baf6..daf27ad217e 100644 --- a/docs/sources/whatsnew/whats-new-in-v7-5.md +++ b/docs/sources/whatsnew/whats-new-in-v7-5.md @@ -33,7 +33,7 @@ Grafana 7.5 adds a beta version of the next-generation pie chart panel. ![Pie chart panel](/static/img/docs/pie-chart-panel/pie-chart-panel-7-5.png) -For more information, refer to [Pie chart panel]({{< relref "../panels-visualizations/visualizations/pie-chart" >}}). +For more information, refer to [Pie chart panel](../../panels-visualizations/visualizations/pie-chart/). ### Alerting for Loki @@ -41,7 +41,7 @@ Grafana 7.5 comes with alerting support for Loki. With LogQL you can wrap a log With alerting support for Loki, you can now create alerts on Loki metrics queries. -[Alerting]({{< relref "../alerting" >}}) was updated as a result of this change. +[Alerting](../../alerting/) was updated as a result of this change. ![Loki alerting](/static/img/docs/alerting/alerting-for-loki-7-5.png) @@ -55,7 +55,7 @@ For new Prometheus data sources, we have changed the default HTTP method to POST > **Note:** This is not going to affect provisioned data sources or already created data sources. -[Prometheus data source]({{< relref "../datasources/prometheus" >}}) was updated as a result of this change. +[Prometheus data source](../../datasources/prometheus/) was updated as a result of this change. ### Word highlighting for Elasticsearch @@ -67,7 +67,7 @@ When searching for text in Elasticsearch logs, matching words in the log line re In Grafana 7.5, we changed how data for the trace view is sent from the data source. The required data frame has a clear format, which is more aligned with how data is generally represented in Grafana. This makes it easier for third-party developers to implement data sources leveraging the trace view. -For more information, refer to [trace data API docs]({{< relref "../explore/trace-integration#data-api" >}}). +For more information, refer to [trace data API docs](../../explore/trace-integration/#data-api). ### Paste in SSL certs for Postgres data source @@ -77,7 +77,7 @@ Instead of the file path, users can now paste the SSL certification content in t > **Note:** It remains as limitation for the Grafana Cloud, as users may not have access to the server configuration. -[Postgres data source]({{< relref "../datasources/postgres" >}}) and [Provisioning]({{< relref "../administration/provisioning" >}}) were updated as a result of this change. +[Postgres data source](../../datasources/postgres/) and [Provisioning](../../administration/provisioning/) were updated as a result of this change. ### Deprecation notice for some Azure Monitor queries @@ -85,16 +85,16 @@ In the upcoming Grafana 8.0 release, Application Insights and Insights Analytics Grafana 7.5 includes a deprecation notice for these queries, and some documentation to help users prepare for the upcoming changes. -For more information, refer to [Deprecating Application Insights and Insights Analytics]({{< relref "../datasources/azure-monitor#application-insights-and-insights-analytics--removed-" >}}). +For more information, refer to [Deprecating Application Insights and Insights Analytics](../../datasources/azure-monitor/#application-insights-and-insights-analytics--removed-). ### Cloudwatch data source enhancements - Support for region eu-south-1 has been added to the CloudWatch data source. New metrics have also been added to the namespaces AWS/Timestream, AWS/RDS (RDS Proxy metrics), AWS/NetworkFirewall, AWS/GroundStation, and AWS/DDoSProtection. Many thanks to [relvira](https://github.com/relvira), [ilyastoli](https://github.com/ilyastoli), and [rubycut](https://github.com/rubycut) for contributing! -- Added a page limit to the List Metrics API call to improve speed and reduce memory consumption. You can change this limit by entering a higher value in [list_metrics_page_limit]({{< relref "../setup-grafana/configure-grafana#list-metrics-page-limit" >}}) in the Grafana configuration file. -- You can now enable or disable authentication providers and assume a role other than default by changing the [allowed_auth_providers]({{< relref "../setup-grafana/configure-grafana#allowed_auth_providers" >}}) and [assume_role_enabled]({{< relref "../setup-grafana/configure-grafana#assume_role_enabled" >}}) options in the Grafana configuration file. By default, the allowed authentication providers are _AWS SDK Default_, _Access and secret key_, and _Credentials File_, and role is _Assume role (ARN)_. +- Added a page limit to the List Metrics API call to improve speed and reduce memory consumption. You can change this limit by entering a higher value in [list_metrics_page_limit](../../setup-grafana/configure-grafana/#list-metrics-page-limit) in the Grafana configuration file. +- You can now enable or disable authentication providers and assume a role other than default by changing the [allowed_auth_providers](../../setup-grafana/configure-grafana/#allowed_auth_providers) and [assume_role_enabled](../../setup-grafana/configure-grafana/#assume_role_enabled) options in the Grafana configuration file. By default, the allowed authentication providers are _AWS SDK Default_, _Access and secret key_, and _Credentials File_, and role is _Assume role (ARN)_. - You can now specify a custom endpoint in the CloudWatch data source configuration page. This field is optional, and if it is left empty, then the default endpoint for CloudWatch is used. By specifying a regional endpoint, you can reduce request latency. - [AWS Cloudwatch data source]({{< relref "../datasources/aws-cloudwatch" >}}) was updated as a result of this change. + [AWS Cloudwatch data source](../../datasources/aws-cloudwatch/) was updated as a result of this change. ### Increased API limit for CloudMonitoring Services @@ -109,7 +109,7 @@ server: http_listen_port: 3101 ``` -[Azure Monitor data source]({{< relref "../datasources/azure-monitor" >}}) was updated as a result of this change. +[Azure Monitor data source](../../datasources/azure-monitor/) was updated as a result of this change. ## Enterprise features @@ -127,7 +127,7 @@ Query caching advantages: Caching currently works for all backend data sources. You can enable the cache globally or per data source, and you can configure the cache duration per data source. The cache is currently in-memory. -For more information, refer to [Query caching]({{< relref "../administration/data-source-management#query-and-resource-caching" >}}). +For more information, refer to [Query caching](../../administration/data-source-management/#query-and-resource-caching). ### Use template variable in reports @@ -135,7 +135,7 @@ If you have created dashboards with template variables, then you can choose whic Enable this feature in configuration settings using the `templateVariables` flag. -For more information, refer to [Reporting]({{< relref "../dashboards/share-dashboards-panels#choose-template-variables" >}}). +For more information, refer to [Reporting](../../dashboards/share-dashboards-panels/#choose-template-variables). ### Active user limits @@ -157,7 +157,7 @@ Each Grafana Enterprise user will be limited to three concurrent user sessions. A new session is created when you sign in to Grafana from a different device or a different browser. Multiple windows and tabs in the same browser are all part of the same session, so having many Grafana tabs open will not cause any issues. -For more information on Grafana Enterprise licensing and restrictions, refer to [License restrictions]({{< relref "../administration/enterprise-licensing#license-restrictions" >}}). +For more information on Grafana Enterprise licensing and restrictions, refer to [License restrictions](../../administration/enterprise-licensing/#license-restrictions). ## Breaking changes diff --git a/docs/sources/whatsnew/whats-new-in-v8-0.md b/docs/sources/whatsnew/whats-new-in-v8-0.md index c63d3f40f6f..0d41ace7f4c 100644 --- a/docs/sources/whatsnew/whats-new-in-v8-0.md +++ b/docs/sources/whatsnew/whats-new-in-v8-0.md @@ -29,9 +29,9 @@ These features are included in the Grafana open source edition. ### Grafana v8.0 alerts -The new alerts in Grafana 8.0 are an opt-in feature that centralizes alerting information for Grafana managed alerts and alerts from Prometheus-compatible data sources in one UI and API. You can create and edit alerting rules for Grafana managed alerts, Mimir alerts, and Loki alerts as well as see alerting information from prometheus-compatible data sources in a single, searchable view. For more information, on how to create and edit alerts and notifications, refer to [Grafana Alerting]({{< relref "../alerting" >}}). +The new alerts in Grafana 8.0 are an opt-in feature that centralizes alerting information for Grafana managed alerts and alerts from Prometheus-compatible data sources in one UI and API. You can create and edit alerting rules for Grafana managed alerts, Mimir alerts, and Loki alerts as well as see alerting information from prometheus-compatible data sources in a single, searchable view. For more information, on how to create and edit alerts and notifications, refer to [Grafana Alerting](../../alerting/). -As part of the new alert changes, we have introduced a new data source, Alertmanager, which includes built-in support for Prometheus Alertmanager. It is presently in alpha and it not accessible unless alpha plugins are enabled in Grafana settings. For more information, refer to [Alertmanager data source]({{< relref "../datasources/alertmanager" >}}). +As part of the new alert changes, we have introduced a new data source, Alertmanager, which includes built-in support for Prometheus Alertmanager. It is presently in alpha and it not accessible unless alpha plugins are enabled in Grafana settings. For more information, refer to [Alertmanager data source](../../datasources/alertmanager/). > **Note:** Out of the box, Grafana still supports old Grafana alerts. They are legacy alerts at this time, and will be deprecated in a future release. @@ -39,7 +39,7 @@ To learn more about the differences between new alerts and the legacy alerts, re ### Library panels -Library panels allow users to build panels that can be used in multiple dashboards. Any updates made to that shared panel will then automatically be applied to all the dashboards that have that panel. For instructions on how to create, add, unlink and manage library panels, refer to [Library panels]({{< relref "../dashboards/build-dashboards/manage-library-panels" >}}). +Library panels allow users to build panels that can be used in multiple dashboards. Any updates made to that shared panel will then automatically be applied to all the dashboards that have that panel. For instructions on how to create, add, unlink and manage library panels, refer to [Library panels](../../dashboards/build-dashboards/manage-library-panels/). ### Real-time streaming @@ -49,11 +49,11 @@ In addition to data source integration, events can be sent to dashboards by post These metrics will be broadcast to all dashboards connected to that stream endpoint. -For more information about real-time streaming, refer to [Grafana Live documentation]({{< relref "../setup-grafana/set-up-grafana-live" >}}). +For more information about real-time streaming, refer to [Grafana Live documentation](../../setup-grafana/set-up-grafana-live/). ### Prometheus metrics browser -The Prometheus metrics browser allows you to quickly find metrics and select relevant labels to build basic queries. If supported by your Prometheus instance, each metric will show its HELP and TYPE as a tooltip. For more information, refer to [Metrics browser documentation]({{< relref "../datasources/prometheus#metrics-browser" >}}). +The Prometheus metrics browser allows you to quickly find metrics and select relevant labels to build basic queries. If supported by your Prometheus instance, each metric will show its HELP and TYPE as a tooltip. For more information, refer to [Metrics browser documentation](../../datasources/prometheus/#metrics-browser). ### Bar chart visualization (beta) @@ -63,7 +63,7 @@ The Bar chart panel is a new visualization that supports categorical data. It on To use it with time series you first have to add a **Reduce** transform. -For more information, refer to [Bar chart visualization]({{< relref "../panels-visualizations/visualizations/bar-chart" >}}). +For more information, refer to [Bar chart visualization](../../panels-visualizations/visualizations/bar-chart/). ### State timeline visualization (beta) @@ -77,11 +77,11 @@ Example with string values: With time series data and thresholds: {{< figure src="/static/img/docs/v8/state_timeline_time_series.png" max-width="800px" caption="state timeline with time series" >}} -For more information, refer to [State timeline visualization]({{< relref "../panels-visualizations/visualizations/state-timeline" >}}). +For more information, refer to [State timeline visualization](../../panels-visualizations/visualizations/state-timeline/). ### Status history visualization (beta) -A sister panel to the state timeline is the new Status history panel visualization. It can display periodic states in a grid view. It supports both numerical, string, or boolean states. You can assign colors using value mappings, thresholds, or gradient color. For more information, refer to [Status history]({{< relref "../panels-visualizations/visualizations/status-history" >}}). +A sister panel to the state timeline is the new Status history panel visualization. It can display periodic states in a grid view. It supports both numerical, string, or boolean states. You can assign colors using value mappings, thresholds, or gradient color. For more information, refer to [Status history](../../panels-visualizations/visualizations/status-history/). schemes. ![Status grid visualization](/static/img/docs/status-grid/status-grid-8-0.png) @@ -92,20 +92,20 @@ This hidden feature of the old Graph panel is now a standalone visualization. It {{< figure src="/static/img/docs/histogram/histogram-8-0.png" max-width="1025px" caption="Histogram example" >}} -For more information, refer to [Histogram]({{< relref "../panels-visualizations/visualizations/histogram" >}}) +For more information, refer to [Histogram](../../panels-visualizations/visualizations/histogram/) ### Time series visualization updates The Time series is out of beta! We are removing the `Beta` tag and graduating the Time series visualization to a stable state. - **Time series** is now the default visualization option, replacing the **Graph (old)**. -- The Time series panel now supports stacking. For more information, refer to [Graph stacked time series]({{< relref "../panels-visualizations/visualizations/time-series#stack-series" >}}). +- The Time series panel now supports stacking. For more information, refer to [Graph stacked time series](../../panels-visualizations/visualizations/time-series/#stack-series). - You can now add alerts in the Time series panel, just like the old Graph panel. -- Updated [connect null values]({{< relref "../panels-visualizations/visualizations/time-series#connect-null-values" >}}) options. +- Updated [connect null values](../../panels-visualizations/visualizations/time-series/#connect-null-values) options. - We added support for a shared crosshair and a tooltip that’s now smarter when it comes to data display in the tooltip. - Various performance improvements. -[Time series panel]({{< relref "../panels-visualizations/visualizations/time-series" >}}) topics have been updated as a result of these changes. +[Time series panel](../../panels-visualizations/visualizations/time-series/) topics have been updated as a result of these changes. ### Node graph visualization updates @@ -113,7 +113,7 @@ You can now expand the node graph for the displayed trace when using the Trace t We also added a grid view and the ability to explore hidden nodes. -[Tracing in Explore]({{< relref "../explore/trace-integration" >}}) and [Node graph]({{< relref "../panels-visualizations/visualizations/node-graph" >}}) were updated as a result of these changes. +[Tracing in Explore](../../explore/trace-integration/) and [Node graph](../../panels-visualizations/visualizations/node-graph/) were updated as a result of these changes. ### Pie chart visualization updates @@ -125,10 +125,10 @@ Lots of panel editor improvements, heavily informed by user research and communi - All options are now shown in a single pane. - You can now search panel options. -- The Value mappings feature has been completely redesigned. For more information, refer to [Configure value mappings]({{< relref "../panels-visualizations/configure-value-mappings" >}}). +- The Value mappings feature has been completely redesigned. For more information, refer to [Configure value mappings](../../panels-visualizations/configure-value-mappings/). - New **Table view** option is always available. -The [Panels]({{< relref "../panels-visualizations" >}}) section has been updated to reflect these changes. +The [Panels](../../panels-visualizations/) section has been updated to reflect these changes. ### Look and feel update @@ -140,19 +140,19 @@ Under the hood, the new theme architecture enables us to bring more sophisticate When you inspect a panel, you can now download log results as a text (.txt) file. -[Download log results]({{< relref "../panels-visualizations/panel-inspector" >}}) was added as a result of this feature. +[Download log results](../../panels-visualizations/panel-inspector/) was added as a result of this feature. ### Inspector in Explore The new Explore inspector helps you understand and troubleshoot your queries. You can inspect the raw data, export that data to a comma-separated values (CSV) file, export log results in text format, and view query requests. -[Inspector in Explore]({{< relref "../explore/explore-inspector" >}}) was added as a result of this feature. +[Inspector in Explore](../../explore/explore-inspector/) was added as a result of this feature. ### Explore log improvements Log navigation in Explore has been significantly improved. We added pagination to logs, so you can click through older or newer logs as needed. -[Logs in Explore]({{< relref "../explore/logs-integration" >}}) was updated as a result of these changes. +[Logs in Explore](../../explore/logs-integration/) was updated as a result of these changes. ![Navigate logs in Explore](/static/img/docs/explore/navigate-logs-8-0.png) @@ -160,7 +160,7 @@ Log navigation in Explore has been significantly improved. We added pagination t You can now use the Plugin catalog app to easily manage your plugins from within Grafana. Install, update, and uninstall plugins without requiring a server restart. -[Plugin catalog]({{< relref "../administration/plugin-management#plugin-catalog" >}}) was added as a result of this feature. +[Plugin catalog](../../administration/plugin-management/#plugin-catalog) was added as a result of this feature. ### Performance improvements @@ -191,13 +191,13 @@ The Azure Monitor data source now supports Managed Identity for users hosting Gr Also, in addition to querying Log Analytics Workspaces, you can now query the logs for any individual [supported resource](https://docs.microsoft.com/en-us/azure/azure-monitor/essentials/metrics-supported), or for all resources in a subscription or resource group. -> **Note:** In Grafana 7.5 we started the deprecation for separate Application Insights queries, in favor of querying Application Insights resources through Metrics and Logs. In Grafana 8.0 new Application Insights and Insights Analytics queries cannot be made, and existing queries have been made read-only. For more details, refer to the [Deprecating Application Insights]({{< relref "../datasources/azure-monitor#application-insights-and-insights-analytics--removed-" >}}). +> **Note:** In Grafana 7.5 we started the deprecation for separate Application Insights queries, in favor of querying Application Insights resources through Metrics and Logs. In Grafana 8.0 new Application Insights and Insights Analytics queries cannot be made, and existing queries have been made read-only. For more details, refer to the [Deprecating Application Insights](../../datasources/azure-monitor/#application-insights-and-insights-analytics--removed-). -[Azure Monitor data source]({{< relref "../datasources/azure-monitor" >}}) was updated as a result of these changes. +[Azure Monitor data source](../../datasources/azure-monitor/) was updated as a result of these changes. #### Elasticsearch data source -[Elasticsearch data source]({{< relref "../datasources/elasticsearch" >}}) and [Provisioning]({{< relref "../administration/provisioning" >}}) were updated as a result of these changes. +[Elasticsearch data source](../../datasources/elasticsearch/) and [Provisioning](../../administration/provisioning/) were updated as a result of these changes. ##### Use semver strings to identify Elasticsearch version @@ -233,11 +233,11 @@ In a prior release, Cloud Monitoring added _preprocessing_ support in their quer Whenever a metric is selected in the query editor, a suitable preprocessing option is automatically selected for you. To avoid breaking changes, preprocessing is not enabled by default on existing queries. If you want to use preprocessing for existing queries, you have to manually select one in the query editor. -[Google Cloud Monitoring data source]({{< relref "../datasources/google-cloud-monitoring#pre-processing" >}}) was updated as a result of this change. +[Google Cloud Monitoring data source](../../datasources/google-cloud-monitoring/#pre-processing) was updated as a result of this change. #### Graphite data source -[Graphite data source]({{< relref "../datasources/graphite" >}}) was updated as a result of these changes. +[Graphite data source](../../datasources/graphite/) was updated as a result of these changes. ##### Variable metric names expand @@ -253,7 +253,7 @@ Graphite queries are now automatically transformed to Loki queries according to You can now use more parameters to find traces. -[Jaeger data source]({{< relref "../datasources/jaeger" >}}) was updated as a result of this change. +[Jaeger data source](../../datasources/jaeger/) was updated as a result of this change. ### Authentication updates @@ -267,11 +267,11 @@ JWT is a new authentication option in Grafana. You can now configure Grafana to accept a JWT token provided in the HTTP header. -[JWT authentication]({{< relref "../setup-grafana/configure-security/configure-authentication/jwt" >}}) was added and [Configuration]({{< relref "../setup-grafana/configure-grafana#authjwt" >}}) was updated as a result of this feature. +[JWT authentication](../../setup-grafana/configure-security/configure-authentication/jwt/) was added and [Configuration](../../setup-grafana/configure-grafana/#authjwt) was updated as a result of this feature. #### OAuth -[Generic OAuth authentication]({{< relref "../setup-grafana/configure-security/configure-authentication/generic-oauth" >}}) has been updated as a result of these changes. +[Generic OAuth authentication](../../setup-grafana/configure-security/configure-authentication/generic-oauth/) has been updated as a result of these changes. ##### Added OAuth support for empty scopes @@ -298,7 +298,7 @@ These features are included in the Grafana Enterprise edition. You can now add or remove detailed permissions from Viewer, Editor, and Admin org roles, to grant users just the right amount of access within Grafana. Available permissions include the ability to view and manage Users, Reports, and the Access Control API itself. Grafana will support more and more permissions over the coming months. -[Role-based access control docs]({{< relref "../administration/roles-and-permissions/access-control" >}}) were added as a result of this feature. +[Role-based access control docs](../../administration/roles-and-permissions/access-control/) were added as a result of this feature. ### Data source query caching @@ -308,7 +308,7 @@ This results in faster average load times for dashboards and fewer duplicate que You can enable caching per data source, and time-to-live (TTL) can be configured globally and per data source. Query caching can be set up with Redis, Memcached, or a simple in-memory cache. -For more information, refer to the [Data source query caching docs]({{< relref "../administration/data-source-management#query-and-resource-caching" >}}). +For more information, refer to the [Data source query caching docs](../../administration/data-source-management/#query-and-resource-caching). ### Reporting updates @@ -316,13 +316,13 @@ When creating a report, you can now choose to export Table panels as .csv files You can also link back to the dashboard directly from the email, for users who want to see the data live in Grafana. This release also includes some improvements to the Reports list view. -For more information, refer to [Reporting docs]({{< relref "../dashboards/share-dashboards-panels#reporting" >}}). +For more information, refer to [Reporting docs](../../dashboards/share-dashboards-panels/#reporting). ### License restrictions clarification in the docs The Grafana Enterprise documentation has been updated to describe more specifically how licensed roles are counted, how they can be updated, and where you can see details about dashboard and folder permissions that affect users' licensed roles. -For more information, refer to [License restrictions docs]({{< relref "../administration/enterprise-licensing#license-restrictions" >}}). +For more information, refer to [License restrictions docs](../../administration/enterprise-licensing/#license-restrictions). ## Breaking changes diff --git a/docs/sources/whatsnew/whats-new-in-v8-1.md b/docs/sources/whatsnew/whats-new-in-v8-1.md index d42b7b0b366..ca2a4dfe46f 100644 --- a/docs/sources/whatsnew/whats-new-in-v8-1.md +++ b/docs/sources/whatsnew/whats-new-in-v8-1.md @@ -35,7 +35,7 @@ These features are included in the Grafana open source edition. Grafana 8.1 introduces the foundation for our new map panel. This new panel leverages [OpenLayers](https://openlayers.org/) and gives us a flexible solution for extending the way we use the new Geomap panel moving forward. The new Geomap panel includes multiple base layer styles (map layer options), as well as a more open data layer. The data layer can use coordinates and geo-hashed data in addition to a lookup table. -The Geomap panel is also able to share views across multiple Geomap panels on the same dashboard, making it straightforward to visualize and explore multiple types of geospatial data using the same map zoom and focus settings. For more information, refer to [Geomap panel]({{< relref "../panels-visualizations/visualizations/geomap" >}}). +The Geomap panel is also able to share views across multiple Geomap panels on the same dashboard, making it straightforward to visualize and explore multiple types of geospatial data using the same map zoom and focus settings. For more information, refer to [Geomap panel](../../panels-visualizations/visualizations/geomap/). {{< figure src="/static/img/docs/geomap-panel/geomap_with_heatmap.png" max-width="850px" caption="Geomap panel: Heatmap" >}} ## Annotation panel @@ -54,9 +54,9 @@ Color scheme **From thresholds**: Color scheme: **Green-Yellow-Red (by value)** {{< figure src="/static/img/docs/time-series-panel/gradient_mode_scheme_line.png" max-width="1200px" caption="Color scheme: Green-Yellow-Red" >}} -For more on how to configure Graphs with by value color schemes read [Graph and color schemes]({{< relref "../panels-visualizations/visualizations/time-series" >}}). +For more on how to configure Graphs with by value color schemes read [Graph and color schemes](../../panels-visualizations/visualizations/time-series/). -You can also create annotations in the new Time series panel bringing it closer to parity with the legacy Graph panel. To learn more, refer to the [time series panel]({{< relref "../panels-visualizations/visualizations/time-series" >}}). +You can also create annotations in the new Time series panel bringing it closer to parity with the legacy Graph panel. To learn more, refer to the [time series panel](../../panels-visualizations/visualizations/time-series/). ### Transformations improvements @@ -64,7 +64,7 @@ Grafana 8.1 includes some significant enhancements to transformations, including #### Config from query (Beta) -This transformation enables panel config (Threshold, Min, Max, etc.) to be derived from query results. For more information, refer to [Config from query results]({{< relref "../panels-visualizations/query-transform-data/transform-data#config-from-query-results" >}}). +This transformation enables panel config (Threshold, Min, Max, etc.) to be derived from query results. For more information, refer to [Config from query results](../../panels-visualizations/query-transform-data/transform-data/#config-from-query-results). #### Rows to fields (Beta) @@ -86,7 +86,7 @@ Output: As you can see each row in the source data becomes a separate field. Each field now also has a max config option set. Options like **Min**, **Max**, **Unit** and **Thresholds** are all part of field configuration and if set like this will be used by the visualization instead of any options manually configured in the panel editor options pane. -For more on how to use this transformation, refer to [Rows to fields transform]({{< relref "../panels-visualizations/query-transform-data/transform-data#rows-to-fields" >}}). +For more on how to use this transformation, refer to [Rows to fields transform](../../panels-visualizations/query-transform-data/transform-data/#rows-to-fields). #### Contextual & Inline Help @@ -102,7 +102,7 @@ We have added timezone support. As a result, you can now specify the time zone u ### Trace to logs improvements -We changed the default behavior from creating a 1-hour span Loki query to the only query at the exact time the trace span started for the duration of it. For more fine grained control over this, you can shift this time in the tracing data source settings. Also, it is now possible to shift the start time and end time of the Loki query by the set amount. For more information, refer to [Trace to logs]({{< relref "../datasources/tempo#trace-to-logs" >}}). +We changed the default behavior from creating a 1-hour span Loki query to the only query at the exact time the trace span started for the duration of it. For more fine grained control over this, you can shift this time in the tracing data source settings. Also, it is now possible to shift the start time and end time of the Loki query by the set amount. For more information, refer to [Trace to logs](../../datasources/tempo/#trace-to-logs). ### Prettify JSON for Logs in Explore @@ -114,7 +114,7 @@ And here is the prettified JSON log. {{< figure src="/static/img/docs/panels/pretty-json/prettified-json.png" max-width="1200px" caption="Prettified JSON" >}} -For more on how to prettify JSON logs, refer to [Visualization]({{< relref "../panels-visualizations/visualizations" >}}) and [Display]({{< relref "../panels-visualizations/visualizations/logs" >}}) options. +For more on how to prettify JSON logs, refer to [Visualization](../../panels-visualizations/visualizations/) and [Display](../../panels-visualizations/visualizations/logs/) options. ### Plugin catalog - Updated UX and extended features @@ -122,7 +122,7 @@ We’ve made some changes to the plugins UI to help make it easier to discover a #### Documentation updates -New panel summaries and preview on the top level [Visualizations]({{< relref "../panels-visualizations/visualizations" >}}) page to help users pick or learn about specific visualizations more easily. +New panel summaries and preview on the top level [Visualizations](../../panels-visualizations/visualizations/) page to help users pick or learn about specific visualizations more easily. ### Upcoming changes to the Select component @@ -140,7 +140,7 @@ We’d love as much feedback as possible about this change, because we are consi ### High availability setup support for Grafana Live -We have added an experimental HA setup support for Grafana Live with Redis. This resolves the limitation when clients were connected to different Grafana instances and those instances had no shared state. For additional information, refer to [Configure Grafana Live HA setup]({{< relref "../setup-grafana/set-up-grafana-live#configure-grafana-live-ha-setup" >}}). +We have added an experimental HA setup support for Grafana Live with Redis. This resolves the limitation when clients were connected to different Grafana instances and those instances had no shared state. For additional information, refer to [Configure Grafana Live HA setup](../../setup-grafana/set-up-grafana-live/#configure-grafana-live-ha-setup). ## Enterprise features @@ -150,15 +150,15 @@ These features are included in the Grafana Enterprise edition. Role-based access control remains in beta. You can now grant or revoke permissions for Viewers, Editors, or Admins to use Explore mode, configure LDAP or SAML settings, or view the admin/stats page. These new permissions enhance the existing permissions that can be customized, namely permissions to access Users, Orgs, LDAP settings, and Reports in Grafana. -Fine grained access control allows you to customize roles and permissions in Grafana beyond the built-in Viewer, Editor, and Admin roles. As of 8.1, you can modify some of the permissions for any of these built-in roles. This is helpful if you’d like users to have more or fewer access permissions than a given role allows for by default. For an overview of role-based access control and a complete list of available permissions, refer to the [Fine grained access control]({{< relref "../administration/roles-and-permissions/access-control" >}}) documentation. +Fine grained access control allows you to customize roles and permissions in Grafana beyond the built-in Viewer, Editor, and Admin roles. As of 8.1, you can modify some of the permissions for any of these built-in roles. This is helpful if you’d like users to have more or fewer access permissions than a given role allows for by default. For an overview of role-based access control and a complete list of available permissions, refer to the [Fine grained access control](../../administration/roles-and-permissions/access-control/) documentation. ### New and improved reporting scheduler -We’ve enhanced the scheduler for Reports to be more flexible, so you can send reports at just the right time. When scheduling a report, you can now choose to send a report at custom intervals such as every 4 hours or every 2 weeks. You can also send a report for a limited time period by providing a start and end date, or send a report only on weekdays or on the last day of each month. This change accompanies some other recent improvements to Reporting, like the ability to choose template variables for reports and an improved UX for authoring reports. To learn more, refer to the [reporting]({{< relref "../dashboards/share-dashboards-panels#reporting" >}}) documentation. +We’ve enhanced the scheduler for Reports to be more flexible, so you can send reports at just the right time. When scheduling a report, you can now choose to send a report at custom intervals such as every 4 hours or every 2 weeks. You can also send a report for a limited time period by providing a start and end date, or send a report only on weekdays or on the last day of each month. This change accompanies some other recent improvements to Reporting, like the ability to choose template variables for reports and an improved UX for authoring reports. To learn more, refer to the [reporting](../../dashboards/share-dashboards-panels/#reporting) documentation. ### Encrypt data in the query cache -Query caching was released in Grafana 8.0 and allows you to temporarily store the results of data source queries in a cache, so that Grafana reads repeated queries from there instead of from the data source itself. This reduces load on data sources, improves dashboard load times, and can save money for data sources that charge per query. To learn more about query caching see its [overview]({{< relref "../administration/data-source-management#query-and-resource-caching" >}}) page. To find out how to turn on encryption, refer to the [caching configuration]({{< relref "../setup-grafana/configure-grafana/enterprise-configuration#caching" >}}) documentation. +Query caching was released in Grafana 8.0 and allows you to temporarily store the results of data source queries in a cache, so that Grafana reads repeated queries from there instead of from the data source itself. This reduces load on data sources, improves dashboard load times, and can save money for data sources that charge per query. To learn more about query caching see its [overview](../../administration/data-source-management/#query-and-resource-caching) page. To find out how to turn on encryption, refer to the [caching configuration](../../setup-grafana/configure-grafana/enterprise-configuration/#caching) documentation. You can now encrypt the query data cached by Grafana. This improves the security of query data, especially when your cache (like Redis) is shared with other services. @@ -166,7 +166,7 @@ You can now encrypt the query data cached by Grafana. This improves the security You can now customize Grafana’s loading logo, which displays while Grafana is loading in a user’s browser. White labeling in Grafana Enterprise allows you to customize the look and feel of Grafana to match your product’s or company’s brand. This makes Grafana a more integrated part of your observability stack and keep Grafana consistent with other visualizations displayed in public. -To find out how you can configure it along with other Grafana UI elements, like the corner logo and application footer, refer to the [White labeling]({{< relref "../setup-grafana/configure-grafana/configure-custom-branding" >}}) topic of the Grafana Enterprise docs. +To find out how you can configure it along with other Grafana UI elements, like the corner logo and application footer, refer to the [White labeling](../../setup-grafana/configure-grafana/configure-custom-branding/) topic of the Grafana Enterprise docs. ### Oauth2 - Team Sync to Group Mapping diff --git a/docs/sources/whatsnew/whats-new-in-v8-4.md b/docs/sources/whatsnew/whats-new-in-v8-4.md index 0827828511f..343599564cb 100644 --- a/docs/sources/whatsnew/whats-new-in-v8-4.md +++ b/docs/sources/whatsnew/whats-new-in-v8-4.md @@ -130,13 +130,13 @@ Enable role-based access control by adding the term `accesscontrol` to the list #### Assign SAML users different roles in different Organizations -You can use Grafana's SAML integration to map organizations in your SAML service to [Organizations]({{< relref "../setup-grafana/configure-security/configure-authentication/saml#configure-organization-mapping" >}}) in Grafana so that users who authenticate using SAML have the right permissions. Previously, you could only choose a single role (Viewer, Editor, or Admin) for users, which would apply to all of their Organizations. Now, you can map a given SAML user or org to different roles in different Organizations, so that, for example, they can be a Viewer in one Organization and an Admin in another. +You can use Grafana's SAML integration to map organizations in your SAML service to [Organizations](../../setup-grafana/configure-security/configure-authentication/saml/#configure-organization-mapping) in Grafana so that users who authenticate using SAML have the right permissions. Previously, you could only choose a single role (Viewer, Editor, or Admin) for users, which would apply to all of their Organizations. Now, you can map a given SAML user or org to different roles in different Organizations, so that, for example, they can be a Viewer in one Organization and an Admin in another. Additionally, you can now grant multiple SAML organizations access to Grafana, using the `allowed_organizations` attribute. Previously, you could only map one. {{< figure src="/static/img/docs/enterprise/8-4-SAML-auth.png" max-width="1200px" caption="Assign SAML users role" >}} -Learn more in our [SAML docs]({{< relref "../setup-grafana/configure-security/configure-authentication/saml" >}}). +Learn more in our [SAML docs](../../setup-grafana/configure-security/configure-authentication/saml/). ### Performance improvements diff --git a/docs/sources/whatsnew/whats-new-in-v9-0.md b/docs/sources/whatsnew/whats-new-in-v9-0.md index 9d9cc1818da..3391f04dcb9 100644 --- a/docs/sources/whatsnew/whats-new-in-v9-0.md +++ b/docs/sources/whatsnew/whats-new-in-v9-0.md @@ -102,7 +102,7 @@ Grafana Alerting now provides the ability to capture an image for Grafana manage ## Envelope encryption is generally available and enabled by default -Grafana now uses envelope encryption to encrypt secrets in the database. Envelope encryption adds a layer of indirection to the encryption process. Instead of encrypting all secrets in the database with a single key, Grafana uses a set of keys called data encryption keys (DEKs) to encrypt them. These data encryption keys are themselves encrypted with a single key encryption key (KEK). This allows you to rotate your KEK and quickly re-encrypt your DEKs in case a key is compromised. In Grafana Enterprise, you can also store your KEK in an external key management service (KMS) like AWS KMS or Azure Key Vault, for extra security. Learn more about envelope encryption in the [database encryption documentation]({{< relref "../setup-grafana/configure-security/configure-database-encryption#envelope-encryption" >}}). +Grafana now uses envelope encryption to encrypt secrets in the database. Envelope encryption adds a layer of indirection to the encryption process. Instead of encrypting all secrets in the database with a single key, Grafana uses a set of keys called data encryption keys (DEKs) to encrypt them. These data encryption keys are themselves encrypted with a single key encryption key (KEK). This allows you to rotate your KEK and quickly re-encrypt your DEKs in case a key is compromised. In Grafana Enterprise, you can also store your KEK in an external key management service (KMS) like AWS KMS or Azure Key Vault, for extra security. Learn more about envelope encryption in the [database encryption documentation](../../setup-grafana/configure-security/configure-database-encryption/#envelope-encryption). {{< figure src="/static/img/docs/enterprise/dashboards/envelope-encryption.png" max-width="750px" caption="Envelope encryption" >}} @@ -177,7 +177,7 @@ Reporting is all about convenience - getting info to eyeballs as quickly as poss ## Breaking changes -This is a partial list of notable breaking changes. For the complete list, see our [Release Notes]({{< relref "../release-notes/release-notes-9-0-0" >}}). +This is a partial list of notable breaking changes. For the complete list, see our [Release Notes](../../release-notes/release-notes-9-0-0/). ### Role-based access control: changes for general release @@ -212,7 +212,7 @@ In the Prometheus data source, when grafana receives numeric data from Prometheu +In the InfluxDB data source, browser access mode was deprecated in grafana 8.0.0 and we are removing this feature in 9.0.0. If you are using this mode, you need to [switch to server access mode](../../datasources/influxdb/##influxql-classic-influxdb-query) on the data source configuration page or you can do this via provisioning. --> ### Transformations: Allow more complex regex expressions in rename by regex @@ -251,7 +251,7 @@ Therefore, any secret created or updated in Grafana v9.0 won't be decryptable by We strongly recommend that you enable `envelopeEncryption` for older versions to deploy envelope encryption. You can alternatively configure the `disableEnvelopeEncryption` feature toggle before upgrading to v9.0; however, this feature toggle might be removed in a future Grafana release. -For more details, and workarounds for potential issues, refer to the [documentation]({{< relref "../setup-grafana/configure-security/configure-database-encryption" >}}). +For more details, and workarounds for potential issues, refer to the [documentation](../../setup-grafana/configure-security/configure-database-encryption/). ## A note on Grafana Enterprise licensing diff --git a/docs/sources/whatsnew/whats-new-in-v9-1.md b/docs/sources/whatsnew/whats-new-in-v9-1.md index 7a6aeb9f44a..839d36623a3 100644 --- a/docs/sources/whatsnew/whats-new-in-v9-1.md +++ b/docs/sources/whatsnew/whats-new-in-v9-1.md @@ -36,11 +36,11 @@ Service accounts are an evolution in machine access within Grafana. You can create multiple API tokens per service account with independent expiration dates, and temporarily disable a service account without deleting it. These benefits make service accounts a more flexible way for Terraform and other apps to authenticate with Grafana. -Service accounts also work with [role-based access control]({{< relref "../administration/roles-and-permissions/access-control" >}}) in [Grafana Enterprise]({{< relref "../introduction/grafana-enterprise" >}}). +Service accounts also work with [role-based access control](../../administration/roles-and-permissions/access-control/) in [Grafana Enterprise](../../introduction/grafana-enterprise/). You can improve security by granting service accounts specific roles to limit the functions they can perform. Service accounts have been in beta since Grafana v8.5. During that time, we've improved the UI and migration path from API keys, made it possible to add service accounts to teams, and inherit team permissions. -To learn more about service accounts, see the [documentation]({{< relref "../administration/service-accounts" >}}). +To learn more about service accounts, see the [documentation](../../administration/service-accounts/). {{< figure src="/static/img/docs/service-accounts/add-service-account-token-9-1.png" max-width="750px" caption="Adding a service account token" >}} @@ -56,9 +56,9 @@ To see JWT URL embedding in action, see the [sample project](https://github.com/ #### Organization role mapping for GitHub OAuth2 authentication -You can now use GitHub OAuth2 to map users or teams to specific [Grafana organization roles]({{< relref "../administration/roles-and-permissions#organization-roles" >}}) by using `role_attribute_path` configuration option. +You can now use GitHub OAuth2 to map users or teams to specific [Grafana organization roles](../../administration/roles-and-permissions/#organization-roles) by using `role_attribute_path` configuration option. Grafana will use [JMESPath](https://jmespath.org/examples.html) for path lookup and role mapping. -For more information, see the [documentation]({{< relref "../setup-grafana/configure-security/configure-authentication/github#map-roles" >}}). +For more information, see the [documentation](../../setup-grafana/configure-security/configure-authentication/github/#map-roles). Grafana Cloud users can access this feature by [opening a support ticket in the Cloud Portal](/profile/org#support). @@ -75,13 +75,13 @@ This feature will be rolled out to Grafana Cloud users over the course of severa Panel title search uses our updated dashboard search approach. Previously, Grafana used SQL database queries to find dashboards by title. With the feature toggle enabled, Grafana can build an in-memory index of all dashboards. -To learn more about search in Grafana, see the [documentation]({{< relref "../dashboards/use-dashboards#dashboard-search" >}}). +To learn more about search in Grafana, see the [documentation](../../dashboards/use-dashboards/#dashboard-search). {{< figure src="/static/img/docs/dashboards/panel-title-search-9-1.png" max-width="750px" caption="Searching for a panel title" >}} #### Starred dashboards in the navigation bar -As part of the upcoming improvements to Grafana's navigation, you can now directly access your [starred dashboards]({{< relref "../dashboards/use-dashboards" >}}) from the navigation bar. +As part of the upcoming improvements to Grafana's navigation, you can now directly access your [starred dashboards](../../dashboards/use-dashboards/) from the navigation bar. {{< figure src="/static/img/docs/dashboards/starred-dashboards-9-1.png" max-width="750px" caption="Accessing your starred dashboards" >}} @@ -90,15 +90,15 @@ As part of the upcoming improvements to Grafana's navigation, you can now direct #### Heatmap improvements The beta heatmap announced in version 9.0 is now used throughout Grafana. -Its performance is improved, and it now supports [exemplars]({{< relref "../fundamentals/exemplars" >}}). -To learn more about the heatmap panel, see the [documentation]({{< relref "../panels-visualizations/visualizations/heatmap" >}}). +Its performance is improved, and it now supports [exemplars](../../fundamentals/exemplars/). +To learn more about the heatmap panel, see the [documentation](../../panels-visualizations/visualizations/heatmap/). {{< figure src="/static/img/docs/panels/heatmap-panel-9-1.png" max-width="750px" caption="A heatmap panel" >}} #### Geomap -You can now measure both distances and areas on Geomap visualizations by using the panel's new [measure tools]({{< relref "../panels-visualizations/visualizations/geomap#show-measure-tools" >}}). -To learn more about the Geomap panel, see the [documentation]({{< relref "../panels-visualizations/visualizations/geomap" >}}). +You can now measure both distances and areas on Geomap visualizations by using the panel's new [measure tools](../../panels-visualizations/visualizations/geomap/#show-measure-tools). +To learn more about the Geomap panel, see the [documentation](../../panels-visualizations/visualizations/geomap/). {{< figure src="/static/img/docs/geomap-panel/geomap-map-controls-measure-area-9-1-0.png" max-width="750px" caption="Geomap panel measuring tool - area" >}} @@ -135,7 +135,7 @@ We also embedded several links directly into the table. These links direct you to a Prometheus query to further investigate the data. We also provide a link from the table directly to Tempo search, making it easier for you to investigate your APM metrics. -To learn more about the APM table, see the [documentation]({{< relref "../datasources/tempo#apm-table" >}}). +To learn more about the APM table, see the [documentation](../../datasources/tempo/#apm-table). {{< figure src="/static/img/docs/panels/apm-table-9-1.png" max-width="750px" caption="An APM table in the Explore view" >}} @@ -172,7 +172,7 @@ Provisioning for Grafana Alerting currently supports these resources: - Text templates For more information, see the -[provisioning documentation]({{< relref "../administration/provisioning" >}}). +[provisioning documentation](../../administration/provisioning/). ## Grafana Enterprise @@ -188,7 +188,7 @@ Reporting is better in a few specific ways in Grafana version 9.1: For example, you can share last month's numbers as compared to the numbers for this month. The dashboard uses the same template variables if you attach the dashboard to a report twice. -To learn more about reporting, see the [documentation]({{< relref "../dashboards/share-dashboards-panels#reporting" >}}). +To learn more about reporting, see the [documentation](../../dashboards/share-dashboards-panels/#reporting). {{< figure src="/static/img/docs/enterprise/reporting-draft-9-1.png" max-width="750px" caption="Saving a report as a draft" >}} @@ -215,17 +215,17 @@ In v9.1, you can determine which users, teams, and roles can access app plugins > This definition is planned for a future release. You can also control who can view, edit, or administer dashboard and data source usage insights, as well as data source query caching configuration. -For more details, see the [RBAC documentation]({{< relref "../administration/roles-and-permissions/access-control" >}}). +For more details, see the [RBAC documentation](../../administration/roles-and-permissions/access-control/). {{< figure src="/static/img/docs/enterprise/rbac-app-plugins-9-1.png" max-width="750px" caption="Configuring role-based-access to app plugins" >}} #### Rotate your database encryption keys using Grafana's API -In Grafana version 9.0, we [revamped]({{< relref "./whats-new-in-v9-0#envelope-encryption-is-generally-available-and-enabled-by-default" >}}) the method Grafana uses to encrypt secrets, like data source credentials, so that you can rotate encryption keys and integrate with a key management system like Hashicorp Vault, AWS Key Management Service, or Azure Key Vault. +In Grafana version 9.0, we [revamped](../whats-new-in-v9-0/#envelope-encryption-is-generally-available-and-enabled-by-default) the method Grafana uses to encrypt secrets, like data source credentials, so that you can rotate encryption keys and integrate with a key management system like Hashicorp Vault, AWS Key Management Service, or Azure Key Vault. Now, you can rotate keys and re-encrypt secrets via API. This makes it easier to configure Grafana to be secure while deploying it. -To learn more, see our guide to [configuring database encryption]({{< relref "../setup-grafana/configure-security/configure-database-encryption#configure-database-encryption" >}}). +To learn more, see our guide to [configuring database encryption](../../setup-grafana/configure-security/configure-database-encryption/#configure-database-encryption). #### Audit all actions in Grafana using verbose logging @@ -233,7 +233,7 @@ Auditing logs helps you manage and mitigate activity and meet compliance require By default, Grafana emits an audit log with every action that changes something (like a user creating or updating a dashboard or updating another user's permissions). If you want to record all actions on the Grafana server, including GETs and page views, you can now turn on `verbose mode`. This results in more logs, but it can be useful to debug specific issues or make sure you catch everything happening in Grafana for security or compliance reasons. -To learn more, see the [configuration documentation]({{< relref "../setup-grafana/configure-grafana/enterprise-configuration#verbose" >}}). +To learn more, see the [configuration documentation](../../setup-grafana/configure-grafana/enterprise-configuration/#verbose). {{< figure src="/static/img/docs/enterprise/verbose-audit-logs-9-1.png" max-width="750px" caption="Verbose audit logging output" >}} @@ -242,7 +242,7 @@ To learn more, see the [configuration documentation]({{< relref "../setup-grafan When you synchronize users from a SAML, LDAP, or OAuth provider, some user settings, such as name and email address, are synchronized from your identity provider. Previously, you could edit those settings in the Grafana UI, but they would revert back. To make user management clearer, you can now see which settings are synchronized from your identity provider, but you cannot edit those settings. -To learn more about authentication, see the [documentation]({{< relref "../setup-grafana/configure-security/configure-authentication" >}}). +To learn more about authentication, see the [documentation](../../setup-grafana/configure-security/configure-authentication/). {{< figure src="/static/img/docs/enterprise/oauth-synced-user-9-1.png" max-width="750px" caption="Non-interactive view of a user synced via OAuth" >}} diff --git a/docs/sources/whatsnew/whats-new-in-v9-2.md b/docs/sources/whatsnew/whats-new-in-v9-2.md index deb8c3f836d..ae19c749c10 100644 --- a/docs/sources/whatsnew/whats-new-in-v9-2.md +++ b/docs/sources/whatsnew/whats-new-in-v9-2.md @@ -45,7 +45,7 @@ Canvas visualizations are extensible form-built panels that allow you to explici For example, you can place image layers and then overlay text that's updated by Grafana data sources, and display icons that can change color conditionally based on data. -We've planned additional features and design elements for future releases to make Canvas panels even more powerful tools for creating custom, interactive, data-driven visualizations. To learn more about the Canvas panel, see the [documentation]({{< relref "../panels-visualizations/visualizations/canvas" >}}). +We've planned additional features and design elements for future releases to make Canvas panels even more powerful tools for creating custom, interactive, data-driven visualizations. To learn more about the Canvas panel, see the [documentation](../../panels-visualizations/visualizations/canvas/). {{< video-embed src="/static/img/docs/canvas-panel/canvas-beta-overview-9-2-0.mp4" max-width="750px" caption="Canvas panel beta overview" >}} @@ -145,8 +145,8 @@ For details on using this functionality, see [GitHub pull request #55313](https: ## Transformations: INNER JOINs -[Transformations]({{< relref "../panels-visualizations/query-transform-data/transform-data" >}}) allow you to shape raw data from data sources, like metrics series or GitHub issues, into a format that's appropriate for the chosen visualization. -We have extended the [Join transformation]({{< relref "../panels-visualizations/query-transform-data/transform-data#join-by-field" >}}) to support INNER JOINs in addition to OUTER JOINs. These work similarly to SQL JOINs. +[Transformations](../../panels-visualizations/query-transform-data/transform-data/) allow you to shape raw data from data sources, like metrics series or GitHub issues, into a format that's appropriate for the chosen visualization. +We have extended the [Join transformation](../../panels-visualizations/query-transform-data/transform-data/#join-by-field) to support INNER JOINs in addition to OUTER JOINs. These work similarly to SQL JOINs. {{< figure src="/static/img/docs/transformations/transform-outer-join-9-2.png" max-width="750px" caption="Query builder groupings for Google Cloud monitoring" >}} @@ -225,14 +225,14 @@ For more information, see the [authentication configuration documentation](/docs ## Match parameter support in prometheus labels API -Prometheus users running Prometheus v2.24 and higher can use the [labels endpoint](https://prometheus.io/docs/prometheus/latest/querying/api/#querying-label-values) instead of the [series endpoint](https://prometheus.io/docs/prometheus/latest/querying/api/#finding-series-by-label-matchers) for the [`label_values` function]({{< relref "../datasources/prometheus#query-variable" >}}). +Prometheus users running Prometheus v2.24 and higher can use the [labels endpoint](https://prometheus.io/docs/prometheus/latest/querying/api/#querying-label-values) instead of the [series endpoint](https://prometheus.io/docs/prometheus/latest/querying/api/#finding-series-by-label-matchers) for the [`label_values` function](../../datasources/prometheus/#query-variable). This decreases load times for templated high-cardinality Prometheus instances. -If you want to benefit from this endpoint you must first configure the Prometheus type and version in any Prometheus data sources' [configuration]({{< relref "../datasources/prometheus" >}}). +If you want to benefit from this endpoint you must first configure the Prometheus type and version in any Prometheus data sources' [configuration](../../datasources/prometheus/). ## New Prometheus streaming parser -In Grafana v9.2, you can enable the `prometheusStreamingJSONParser` [feature toggle]({{< relref "../setup-grafana/configure-grafana#feature_toggles" >}}) to use a better-performing, memory-efficient streaming JSON client for Prometheus. +In Grafana v9.2, you can enable the `prometheusStreamingJSONParser` [feature toggle](../../setup-grafana/configure-grafana/#feature_toggles) to use a better-performing, memory-efficient streaming JSON client for Prometheus. We'll make this client the default in Grafana v9.3. When Prometheus returns `NaN` values, this new client doesn't change them, neither to the value `null` nor to `0` as in recent Grafana versions. diff --git a/docs/sources/whatsnew/whats-new-in-v9-3.md b/docs/sources/whatsnew/whats-new-in-v9-3.md index 929381d679b..91981f5cf41 100644 --- a/docs/sources/whatsnew/whats-new-in-v9-3.md +++ b/docs/sources/whatsnew/whats-new-in-v9-3.md @@ -45,7 +45,7 @@ We have added four new languages to Grafana: Spanish, French, German, and Simpli With millions of users across the globe, Grafana has a global footprint. In order to make it accessible to a wider audience, we have taken the first steps in localizing key workflows. You can now set Grafana’s language for the navigation, viewing dashboards, and some settings. This will cover the main activities a Viewer performs within Grafana. -Read more about configuring the [default language for your organization]({{< relref "../administration/organization-preferences" >}}) and [updating your profile]({{< relref "../administration/user-management/user-preferences" >}}) in our documentation. +Read more about configuring the [default language for your organization](../../administration/organization-preferences/) and [updating your profile](../../administration/user-management/user-preferences/) in our documentation. {{< figure src="/static/img/docs/internationalization/internationalization-9-3.png" max-width="750px" caption="Grafana available in Spanish, French, German, and Simplified Chinese" >}} @@ -53,7 +53,7 @@ Read more about configuring the [default language for your organization]({{< rel Generally available in all editions of Grafana -We have added a new alpha layer type in Geomap called photo layer. This layer enables you to render a photo at each data point. To learn more about the photo layer and the geomap panel, refer to [Photos layer]({{< relref "../panels-visualizations/visualizations/geomap#photos-layer-alpha" >}}). +We have added a new alpha layer type in Geomap called photo layer. This layer enables you to render a photo at each data point. To learn more about the photo layer and the geomap panel, refer to [Photos layer](../../panels-visualizations/visualizations/geomap/#photos-layer-alpha). {{< figure src="/static/img/docs/geomap-panel/geomap-photos-9-3-0.png" max-width="750px" caption="Geomap panel photos layer" >}} @@ -63,7 +63,7 @@ Available in **beta** in all editions of Grafana Canvas is a new panel that combines the power of Grafana with the flexibility of custom elements. Canvas visualizations are extensible form-built panels that allow you to explicitly place elements within static and dynamic layouts. This empowers you to design custom visualizations and overlay data in ways that aren’t possible with standard Grafana panels, all within Grafana’s UI. If you’ve used popular UI and web design tools, then designing Canvas panels will feel very familiar. -In Grafana v9.3, we have added icon value mapping support to the Canvas panel. This enables you to dynamically set which icon to display based on your data. To learn more about the Canvas panel, refer to [Canvas]({{< relref "../panels-visualizations/visualizations/canvas" >}}). +In Grafana v9.3, we have added icon value mapping support to the Canvas panel. This enables you to dynamically set which icon to display based on your data. To learn more about the Canvas panel, refer to [Canvas](../../panels-visualizations/visualizations/canvas/). {{< video-embed src="/static/img/docs/canvas-panel/canvas-icon-value-mapping-support-9-3-0.mp4" max-width="750px" caption="Canvas panel icon value mapping support" >}} @@ -85,7 +85,7 @@ Available in **experimental** in Grafana Open Source, Enterprise, and Cloud Adva Annotations are now supported in public dashboards, with the exception of query annotations. They are turned off by default, but can be turned on in your public dashboard settings. -Note that because Public Dashboards is an experimental feature, you need to enable it in Grafana using the `publicDashboards` [feature toggle]({{< relref "../setup-grafana/configure-grafana#feature_toggles" >}}), or open a support ticket requesting public dashboards if you are a Cloud Advanced customer. +Note that because Public Dashboards is an experimental feature, you need to enable it in Grafana using the `publicDashboards` [feature toggle](../../setup-grafana/configure-grafana/#feature_toggles), or open a support ticket requesting public dashboards if you are a Cloud Advanced customer. To learn more about public dashboards, refer to [Public dashboards](https://grafana.com/docs/grafana//dashboards/share-dashboards-panels/shared-dashboards/). @@ -135,7 +135,7 @@ Generally available in Grafana Enterprise, Cloud Pro, and Cloud Advanced. Because dashboards appear on a screen and reports are PDFs, it can be challenging to render data just the way you want to. Sometimes the report doesn't show enough columns in a table, or the titles appear too small. Now you can adjust the scale of your report to zoom in and make each text field and panel larger or zoom out to show more data. -The zoom feature is located in the **Format Report** section of your reporting configuration. To learn more about reporting, refer to [Create and manage reports]({{< relref "../dashboards/create-reports" >}}). +The zoom feature is located in the **Format Report** section of your reporting configuration. To learn more about reporting, refer to [Create and manage reports](../../dashboards/create-reports/). {{< figure src="/static/img/docs/enterprise/reports/report-zoom.png" max-width="750px" caption="Report zoom feature with PDF documents at three different zoom levels" >}} @@ -151,7 +151,7 @@ As part of our efforts to improve the security of Grafana, we are introducing a Because this feature introduces a breaking change, it is behind the `accessTokenExpirationCheck` feature toggle and is disabled by default. Enabling this functionality without configuring refresh tokens for the specific OAuth provider will sign users out after their access token has expired, and they would need to sign in again every time. -Complete documentation on how to configure obtaining a refresh token can be found on the [authentication configuration page]({{< relref "../setup-grafana/configure-security/configure-authentication" >}}), in the instructions for your Oauth identity provider. +Complete documentation on how to configure obtaining a refresh token can be found on the [authentication configuration page](../../setup-grafana/configure-security/configure-authentication/), in the instructions for your Oauth identity provider. ### Resolve user conflicts in Grafana's CLI @@ -181,8 +181,7 @@ If you use an LDAP directory to authenticate to Grafana but prefer to assign org or via API, you can now skip user organization role synchronization with your LDAP directory. -Use the `skip_org_role_sync` [LDAP authentication configuration option]({{< relref -"../setup-grafana/configure-security/configure-authentication/ldap#disable-org-role-synchronization" >}}) +Use the `skip_org_role_sync` [LDAP authentication configuration option](../../setup-grafana/configure-security/configure-authentication/ldap/#disable-org-role-synchronization) when configuring LDAP authentication to prevent the synchronization between your LDAP groups and organization roles and make user roles editable manually. @@ -193,8 +192,7 @@ Generally available in all editions of Grafana If you use Azure AD OAuth2 authentication and use `SecurityEnabled` groups that you don't want Azure to embed in the authentication token, you can configure Grafana to use Microsoft's Graph API instead. -Use the [`force_use_graph_api` configuration option]({{< relref -"../setup-grafana/configure-security/configure-authentication/azuread#force-fetching-groups-from-microsoft-graph-api" >}}) +Use the [`force_use_graph_api` configuration option](../../setup-grafana/configure-security/configure-authentication/azuread/#force-fetching-groups-from-microsoft-graph-api) when configuring Azure AD authentication to force Grafana to fetch groups using Graph API. ### RBAC: List token's permissions @@ -202,23 +200,22 @@ when configuring Azure AD authentication to force Grafana to fetch groups using Generally available in Grafana Enterprise and Cloud Advanced We added a new endpoint to help users diagnose permissions-related issues with user and token authorization. -[This endpoint]({{< relref "../developers/http_api/access_control#list-your-permissions" >}}) allows users to get the +[This endpoint](../../developers/http_api/access_control/#list-your-permissions) allows users to get the full list of RBAC permissions associated with their token. -For more details, refer to [Debug the permissions of a service account token]({{< relref -"../administration/service-accounts#debug-the-permissions-of-a-service-account-token" >}}). +For more details, refer to [Debug the permissions of a service account token](../../administration/service-accounts/#debug-the-permissions-of-a-service-account-token). ### RBAC with Terraform: Extended support for provisioning permissions Generally available in Grafana Enterprise and Cloud Advanced -All Grafana users can now use the latest release of [Terraform's Grafana provider](https://registry.terraform.io/providers/grafana/grafana/latest/docs) (version 1.31.1+) to provision [user and team access to service accounts]({{< relref "../administration/service-accounts#manage-users-and-teams-permissions-for-a-service-account-in-grafana" >}}). +All Grafana users can now use the latest release of [Terraform's Grafana provider](https://registry.terraform.io/providers/grafana/grafana/latest/docs) (version 1.31.1+) to provision [user and team access to service accounts](../../administration/service-accounts/#manage-users-and-teams-permissions-for-a-service-account-in-grafana). This allows full management of service accounts through Terraform - from creating a service account and allowing users to access it to assigning roles to the service account and generating service account tokens. -Grafana Enterprise and Cloud Pro and Advanced users can now provision [access to data sources]({{< relref "../administration/data-source-management#data-source-permissions" >}}) for Grafana's `Viewer`, `Editor`, and `Admin` basic roles, as well as assign `Edit` permission. +Grafana Enterprise and Cloud Pro and Advanced users can now provision [access to data sources](../../administration/data-source-management/#data-source-permissions) for Grafana's `Viewer`, `Editor`, and `Admin` basic roles, as well as assign `Edit` permission. -We have also added [documentation on provisioning RBAC roles and role assignments]({{< relref "../administration/roles-and-permissions/access-control/rbac-terraform-provisioning" >}}) to guide our Grafana Enterprise and Cloud Pro and Advanced users through this process. +We have also added [documentation on provisioning RBAC roles and role assignments](../../administration/roles-and-permissions/access-control/rbac-terraform-provisioning/) to guide our Grafana Enterprise and Cloud Pro and Advanced users through this process. Finally, we have fixed several access control related bugs to ensure a smoother provisioning experience. diff --git a/docs/sources/whatsnew/whats-new-in-v9-4.md b/docs/sources/whatsnew/whats-new-in-v9-4.md index 4f6e9fb5e59..62717c01fd2 100644 --- a/docs/sources/whatsnew/whats-new-in-v9-4.md +++ b/docs/sources/whatsnew/whats-new-in-v9-4.md @@ -31,17 +31,17 @@ The command palette has been updated to provide a more efficient way to navigate To launch the command palette, use the keyboard shortcut `cmd + K` on Mac or `ctrl + K` on Linux/Windows. -To learn more about the command palette, refer to [Search]({{< relref "../search" >}}). +To learn more about the command palette, refer to [Search](../../search/). {{< figure src="/media/docs/grafana/screenshot-grafana-94-command-palette.png" max-width="750px" caption="Grafana command palette" >}} ### New navigation -_Generally available on Grafana Cloud, and available to preview using the `topnav` [feature toggle]({{< relref "../setup-grafana/configure-grafana#feature_toggles" >}}) in all editions of Grafana._ +_Generally available on Grafana Cloud, and available to preview using the `topnav` [feature toggle](../../setup-grafana/configure-grafana/#feature_toggles) in all editions of Grafana._ The navigation in Grafana has been updated with a new design and an improved structure to make it easier for you to access the data you need. With this update, you'll be able to quickly navigate between features, giving you full visibility into the health of your systems. -The new navigation is gradually rolling out to all users on Grafana Cloud. If you’re using Grafana Open Source and Enterprise, you can enable this feature using the `topnav` [feature toggle]({{< relref "../setup-grafana/configure-grafana#feature_toggles" >}}). +The new navigation is gradually rolling out to all users on Grafana Cloud. If you’re using Grafana Open Source and Enterprise, you can enable this feature using the `topnav` [feature toggle](../../setup-grafana/configure-grafana/#feature_toggles). > **Note:** The Grafana documentation has not yet been updated to reflect changes to the navigation. @@ -51,11 +51,11 @@ The new navigation is gradually rolling out to all users on Grafana Cloud. If yo ## Dashboards and visualizations -We've made the following changes to dashboards and visualizations. Learn more about dashboards in our [dashboards documentation]({{< relref "../dashboards" >}}). +We've made the following changes to dashboards and visualizations. Learn more about dashboards in our [dashboards documentation](../../dashboards/). ### Dashboard panel redesign -_Available to preview using the `newPanelChromeUI` [feature toggle]({{< relref "../setup-grafana/configure-grafana#feature_toggles" >}}) in all editions of Grafana_. +_Available to preview using the `newPanelChromeUI` [feature toggle](../../setup-grafana/configure-grafana/#feature_toggles) in all editions of Grafana_. Dashboard panels contain a lot of information, some of which is difficult to discover or access from the dashboard. With our redesigned panels, we've improved accessibility and made it easier to understand the status of a panel by adding and moving key elements. @@ -69,7 +69,7 @@ However, we have more planned: we’re going to make even more improvements to t ### New data source connection page in Dashboards and Explore -_Available to preview using the `datasourceOnboarding` [feature toggle]({{< relref "../setup-grafana/configure-grafana#feature_toggles" >}})._ +_Available to preview using the `datasourceOnboarding` [feature toggle](../../setup-grafana/configure-grafana/#feature_toggles)._ When you start your journey to create a dashboard or explore your data, but you don't have a data source connected yet, you’ll be shown a page that guides you to set up a first connection. @@ -85,7 +85,7 @@ We've updated the **Details** section of a log line. Previously some of the inte {{< figure src="/static/img/logs/log-details-whats-new-9-4.png" max-width="750px" caption="Log details redesign with interactions" >}} -Learn more about viewing logs in our [Logs panel documentation]({{< relref "../panels-visualizations/visualizations/logs" >}}). +Learn more about viewing logs in our [Logs panel documentation](../../panels-visualizations/visualizations/logs/). ### Loki datasource query validation @@ -95,7 +95,7 @@ We added support to validate queries and visually display errors as a query is b {{< figure src="/media/docs/grafana/logs-loki-query-validation-whats-new-9-4.png" max-width="750px" caption="Loki query validation" >}} -Learn more about viewing logs in our [Logs panel documentation]({{< relref "../panels-visualizations/visualizations/logs" >}}). +Learn more about viewing logs in our [Logs panel documentation](../../panels-visualizations/visualizations/logs/). ### Loki logs sample in Explore @@ -111,7 +111,7 @@ _Available in **beta** in all editions of Grafana_ Canvas is a new panel that combines the power of Grafana with the flexibility of custom elements. Canvas visualizations are extensible form-built panels that allow you to explicitly place elements within static and dynamic layouts. This empowers you to design custom visualizations and overlay data in ways that aren’t possible with standard Grafana panels, all within Grafana’s UI. If you’ve used popular UI and web design tools, then designing Canvas panels will feel very familiar. -In Grafana v9.4, we have added the ability to create connections (arrows). Connections enable you to connect elements together to create more complex visualizations. We also added support for data links and a brand new server element. To learn more about the Canvas panel, refer to [Canvas]({{< relref "../panels-visualizations/visualizations/canvas" >}}). +In Grafana v9.4, we have added the ability to create connections (arrows). Connections enable you to connect elements together to create more complex visualizations. We also added support for data links and a brand new server element. To learn more about the Canvas panel, refer to [Canvas](../../panels-visualizations/visualizations/canvas/). {{< video-embed src="/media/docs/grafana/canvas-connections-9-4-0.mp4" max-width="750px" caption="Canvas panel connections" >}} @@ -127,7 +127,7 @@ We have added a configuration option that enables you to require an expiration d This change will not affect existing tokens. However, newly created tokens will require an expiration date that doesn't exceed the configuration option `token_expiration_day_limit`. This option is disabled by default. -Learn more about service accounts in our [Service account documentation]({{< relref "../administration/service-accounts" >}}). +Learn more about service accounts in our [Service account documentation](../../administration/service-accounts/). ### OAuth providers setting for skip org role sync @@ -135,7 +135,7 @@ While Grafana integrates with many different auth providers, we have received re This option enables you to skip synchronization from your configured OAuth provider specifically in the auth provider section under `skip_org_role_sync`. Previously users could only do this for certain providers using the `oauth_skip_org_role_sync_update` option, but this would include all of the configured providers. -Learn more about Oauth in our [Oauth configuration guide]({{< relref "../setup-grafana/configure-security/configure-authentication/generic-oauth" >}}). +Learn more about Oauth in our [Oauth configuration guide](../../setup-grafana/configure-security/configure-authentication/generic-oauth/). ### RBAC support for Grafana OnCall plugin @@ -146,7 +146,7 @@ Before RBAC support in Grafana OnCall, it was only possible to allow your organi For example, you can assign a Viewer basic role to a user in your organization (users must still have a basic role assigned) and also assign them the new Grafana OnCall RBAC role of **Schedules Editor**. This assignment enables the user to view everything in Grafana OnCall, and edit OnCall schedules. -Learn more about role-based access control in our [RBAC docs]({{< relref "../administration/roles-and-permissions/access-control" >}}). +Learn more about role-based access control in our [RBAC docs](../../administration/roles-and-permissions/access-control/). ### SAML auto login @@ -154,13 +154,13 @@ We've added auto-login support for SAML authentication, which you can turn on wi have a unified configuration style among all authentication providers. Instead of using `oauth_auto_login`, use the new `auto_login` option to enable automatic login for specific OAuth providers. -Learn more about SAML setup in our [SAML configuration guide]({{< relref "../setup-grafana/configure-security/configure-authentication/saml" >}}). +Learn more about SAML setup in our [SAML configuration guide](../../setup-grafana/configure-security/configure-authentication/saml/). ## Auditing and Usage Insights: Support for Loki multi-tenancy _This feature is available for Enterprise customers_ -This feature adds support to push analytics events and auditing logs to Loki with multi-tenancy mode, by specifying a tenant id. Learn more about [auditing]({{< relref "../setup-grafana/configure-security/audit-grafana" >}}) and [usage insights]({{< relref "../setup-grafana/configure-security/export-logs" >}}) in our docs. +This feature adds support to push analytics events and auditing logs to Loki with multi-tenancy mode, by specifying a tenant id. Learn more about [auditing](../../setup-grafana/configure-security/audit-grafana/) and [usage insights](../../setup-grafana/configure-security/export-logs/) in our docs. ## Reporting: Zoom in and out on your dashboard in a report PDF @@ -173,11 +173,11 @@ You can modify the scale factor for each report in the report editor when you sh {{< figure src="/media/docs/grafana/FormatReportShare9.4.png" max-width="750px" caption="Scale factor feature in Share functionality" >}} -Learn more about reporting in our [documentation]({{< relref "../dashboards/create-reports" >}}) +Learn more about reporting in our [documentation](../../dashboards/create-reports/) ## Alerting -We've made major improvements to Grafana Alerts, from new contact points and search options to improved workflows between Alerting and OnCall. For all the details, refer to our [Alerting documentation]({{< relref "../alerting" >}}). +We've made major improvements to Grafana Alerts, from new contact points and search options to improved workflows between Alerting and OnCall. For all the details, refer to our [Alerting documentation](../../alerting/). ### Alerting: alert rules @@ -271,7 +271,7 @@ Grafana Alerting is now compatible with AWS Aurora, but does not provide technic ## Enterprise Datasources -We've made improvements to all [Enterprise Datasources]({{< relref "../introduction/grafana-enterprise#enterprise-data-sources" >}}), fixing small bugs, and updating libraries. We've also added many new features and support for additional APIs. Refer to each datasource's documentation and the change log for additional information. +We've made improvements to all [Enterprise Datasources](../../introduction/grafana-enterprise/#enterprise-data-sources), fixing small bugs, and updating libraries. We've also added many new features and support for additional APIs. Refer to each datasource's documentation and the change log for additional information. ### DataDog Datasource diff --git a/docs/sources/whatsnew/whats-new-in-v9-5.md b/docs/sources/whatsnew/whats-new-in-v9-5.md index 36751d91b5a..c2c2ff159ae 100644 --- a/docs/sources/whatsnew/whats-new-in-v9-5.md +++ b/docs/sources/whatsnew/whats-new-in-v9-5.md @@ -19,7 +19,7 @@ weight: -36 Welcome to Grafana 9.5! We're excited to share some major updates to Grafana's navigation, tons of usability improvements to Alerting, and some promising experiments to help you query your Prometheus metrics. Also, read on to learn about our continued migration from API keys to service accounts, as well as deprecation of plugins that use Angular and a field in the InfluxDB data source. -For more detail about all the changes in this release, refer to the [changelog](https://github.com/grafana/grafana/blob/main/CHANGELOG.md). For the specific steps we recommend when you upgrade to v9.5, check out our [Upgrade Guide]({{< relref "../upgrade-guide/upgrade-v9.5/index.md" >}}). +For more detail about all the changes in this release, refer to the [changelog](https://github.com/grafana/grafana/blob/main/CHANGELOG.md). For the specific steps we recommend when you upgrade to v9.5, check out our [Upgrade Guide](../../upgrade-guide/upgrade-v9.5/).