diff --git a/docs/sources/_index.md b/docs/sources/_index.md index 6ab6539cf70..0b14bc75db5 100644 --- a/docs/sources/_index.md +++ b/docs/sources/_index.md @@ -23,26 +23,26 @@ title: Grafana documentation ## Installing Grafana
- }}" class="nav-cards__item nav-cards__item--install"> +
Install on Linux
 - }}" class="nav-cards__item nav-cards__item--install"> +
Install on macOS
 - }}" class="nav-cards__item nav-cards__item--install"> +
Install on Windows
 - }}" class="nav-cards__item nav-cards__item--install"> +
Run Docker image
 - }}" class="nav-cards__item nav-cards__item--install"> +
Run on Kubernetes
 @@ -61,27 +61,27 @@ title: Grafana documentation ## Guides
- }}" class="nav-cards__item nav-cards__item--guide"> +

Getting started

Learn the basics of using Grafana.

 - }}" class="nav-cards__item nav-cards__item--guide"> +

Grafana fundamentals

Learn basic observability.

 - }}" class="nav-cards__item nav-cards__item--guide"> +

Configure Grafana

Review the configuration and setup options.

 - }}" class="nav-cards__item nav-cards__item--guide"> +

Intro to time series

Learn about time series data.

 - }}" class="nav-cards__item nav-cards__item--guide"> +

Provisioning

Learn how to automate your Grafana configuration.

 - }}" class="nav-cards__item nav-cards__item--guide"> +

What's new in v11.0

Explore the features and enhancements in the latest release.

 @@ -91,51 +91,51 @@ title: Grafana documentation ## Data source guides
- }}" class="nav-cards__item nav-cards__item--ds"> +
Graphite
 - }}" class="nav-cards__item nav-cards__item--ds"> +
Elasticsearch
 - }}" class="nav-cards__item nav-cards__item--ds"> +
InfluxDB
 - }}" class="nav-cards__item nav-cards__item--ds"> +
Prometheus
 - }}" class="nav-cards__item nav-cards__item--ds"> +
Google Cloud Monitoring
 - }}" class="nav-cards__item nav-cards__item--ds"> +
AWS CloudWatch
 - }}" class="nav-cards__item nav-cards__item--ds"> +
Azure Monitor
 - }}" class="nav-cards__item nav-cards__item--ds"> +
Loki
 - }}" class="nav-cards__item nav-cards__item--ds"> +
MySQL
 - }}" class="nav-cards__item nav-cards__item--ds"> +
Postgres
 - }}" class="nav-cards__item nav-cards__item--ds"> +
Microsoft SQL Server
 - }}" class="nav-cards__item nav-cards__item--ds"> +
OpenTSDB
 diff --git a/docs/sources/administration/api-keys/index.md b/docs/sources/administration/api-keys/index.md index fa3bb643b08..7ecfcfdc6d3 100644 --- a/docs/sources/administration/api-keys/index.md +++ b/docs/sources/administration/api-keys/index.md @@ -18,7 +18,7 @@ weight: 700 # API keys {{% admonition type="note" %}} -Deprecated: [Service accounts]({{< relref "../service-accounts/" >}}) have replaced API keys as the primary way to authenticate applications that interact with Grafana. +Deprecated: [Service accounts](../service-accounts/) have replaced API keys as the primary way to authenticate applications that interact with Grafana. {{% /admonition %}} An API key is a randomly generated string that external systems use to interact with Grafana HTTP APIs. @@ -26,7 +26,7 @@ An API key is a randomly generated string that external systems use to interact When you create an API key, you specify a **Role** that determines the permissions associated with the API key. Role permissions control that actions the API key can perform on Grafana resources. {{% admonition type="note" %}} -If you use Grafana v9.1 or newer, use service accounts instead of API keys. For more information, refer to [Grafana service accounts]({{< relref "../service-accounts/" >}}). +If you use Grafana v9.1 or newer, use service accounts instead of API keys. For more information, refer to [Grafana service accounts](../service-accounts/). {{% /admonition %}} {{< section >}} @@ -35,7 +35,7 @@ If you use Grafana v9.1 or newer, use service accounts instead of API keys. For Create an API key when you want to manage your computed workload with a user. -This topic shows you how to create an API key using the Grafana UI. You can also create an API key using the Grafana HTTP API. For more information about creating API keys via the API, refer to [Create API key via API]({{< relref "../../developers/http_api/create-api-tokens-for-org/#how-to-create-a-new-organization-and-an-api-token" >}}). +This topic shows you how to create an API key using the Grafana UI. You can also create an API key using the Grafana HTTP API. For more information about creating API keys via the API, refer to [Create API key via API](../../developers/http_api/create-api-tokens-for-org/#how-to-create-a-new-organization-and-an-api-token). ### Before you begin @@ -45,7 +45,7 @@ To follow these instructions, you need at least one of the following: - Editor permissions - Service account writer -- To ensure you have permission to create and edit API keys, follow the instructions in [Roles and permissions]({{< relref "../roles-and-permissions/#" >}}). +- To ensure you have permission to create and edit API keys, follow the instructions in [Roles and permissions](../roles-and-permissions/#). ### Steps @@ -67,12 +67,12 @@ To create an API key, complete the following steps: As an alternative to using API keys for authentication, you can use a service account-based authentication system. When compared to API keys, service accounts have limited scopes that provide more security than using API keys. -For more information about the benefits of service accounts, refer to [Grafana service account benefits]({{< relref "../service-accounts/#service-account-benefits" >}}). +For more information about the benefits of service accounts, refer to [Grafana service account benefits](../service-accounts/#service-account-benefits). The service account endpoints generate a machine user for authentication instead of using API keys. When you migrate an API key to a service account, a service account will be created with a service account token. {{% admonition type="note" %}} -If you're currently using API keys for authentication, we strongly recommend to use Grafana Service Accounts instead. Rest assured, when migrating to Service Accounts, your existing API keys will continue working as before. To find the migrated API keys, navigate to the Service Accounts section and select the Service Account Tokens tab. For more information, please refer to the [Grafana service account tokens]({{< relref "../service-accounts/#service-account-tokens" >}}) details. +If you're currently using API keys for authentication, we strongly recommend to use Grafana Service Accounts instead. Rest assured, when migrating to Service Accounts, your existing API keys will continue working as before. To find the migrated API keys, navigate to the Service Accounts section and select the Service Account Tokens tab. For more information, please refer to the [Grafana service account tokens](../service-accounts/#service-account-tokens) details. {{% /admonition %}} ## Ways of migrating API keys to service accounts @@ -99,7 +99,7 @@ To follow these instructions, you need at least one of the following: - Editor permissions - Service account writer -For more information about permissions, refer to [Roles and permissions]({{< relref "../roles-and-permissions/#" >}}). +For more information about permissions, refer to [Roles and permissions](../roles-and-permissions/#). #### Steps @@ -120,7 +120,7 @@ To migrate a single API key to a service account, complete the following steps: ### Migrate API keys to Grafana service accounts for API calls -This section shows you how to migrate API keys to Grafana service accounts for Grafana API workflows. For references see: [Grafana Service Accounts for the Grafana API]({{< relref "../../developers/http_api/serviceaccount/#create-service-account" >}}). +This section shows you how to migrate API keys to Grafana service accounts for Grafana API workflows. For references see: [Grafana Service Accounts for the Grafana API](../../developers/http_api/serviceaccount/#create-service-account). #### Before you begin diff --git a/docs/sources/administration/correlations/_index.md b/docs/sources/administration/correlations/_index.md index 977849d2948..8e0f449aed7 100644 --- a/docs/sources/administration/correlations/_index.md +++ b/docs/sources/administration/correlations/_index.md @@ -14,21 +14,21 @@ weight: 900 You can create interactive links for Explore visualizations to run queries related to presented data by setting up Correlations. -A correlation defines how data in one [data source]({{< relref "../../datasources" >}}) is used to query data in another data source. +A correlation defines how data in one [data source](../../datasources/) is used to query data in another data source. 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 -[Explore]({{< relref "../../explore" >}}) takes user-defined correlations to display links inside the visualizations. -You can click on a 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. +You can click on a link to run the related query and see results in [Explore Split View](../../explore/#split-and-compare). 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 b57424f245e..44d080d16c3 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](/developers/plugin-tools/introduction/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. To verify that a data source works with query caching, follow the [instructions below](#enable-and-configure-query-caching) to **Enable and Configure query caching**. If caching is enabled in Grafana but the Caching tab is not visible for the given data source, then query caching is not available for that data source. @@ -118,7 +118,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: @@ -137,7 +137,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 @@ -148,7 +148,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/enterprise-licensing/_index.md b/docs/sources/administration/enterprise-licensing/_index.md index 5d793097684..fa0b2a8cae9 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,11 +244,11 @@ 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). **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. @@ -260,10 +260,10 @@ When a user reaches the session limit, the fourth connection succeeds and the lo You can request Grafana Labs to activate usage billing which allows an unlimited number of active users. When usage billing is enabled, Grafana does not enforce active user limits or display warning banners. Instead, you are charged for active users that exceed the limit, according to your customer contract. -Usage billing involves a contractual agreement between you and Grafana Labs, and it is only available if Grafana Enterprise 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 it is only available if Grafana Enterprise is configured to [automatically refresh its license token](../../setup-grafana/configure-grafana/enterprise-configuration/#auto_refresh_license). ### Request a change to your license 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). 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 fa06cd3aa02..ab809f77830 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 49060c0989d..5275bc44e4c 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 4257352637e..c2507adeff0 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/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 285292ea5a3..b5a96b2b867 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/#about-rbac" >}}). +Customize access to app plugins with [RBAC](../roles-and-permissions/access-control/#about-rbac). 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 "../administration/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 %}} @@ -153,7 +153,7 @@ If you're logged in to Grafana Cloud when you add a plugin, log out and then log Follow the instructions on the **Install** tab. You can either install the plugin with a Grafana CLI command or by downloading and uncompressing a zip file into the Grafana plugins directory. We recommend using Grafana CLI in most instances. The zip option is available if your Grafana server doesn't have access to the internet. -For more information about Grafana CLI plugin commands, refer to [Plugin commands]({{< relref "../../cli/#plugins-commands" >}}). +For more information about Grafana CLI plugin commands, refer to [Plugin commands](../../cli/#plugins-commands). #### Install a packaged plugin @@ -163,7 +163,7 @@ After the user has downloaded the archive containing the plugin assets, they can 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). ## Plugin signatures @@ -203,7 +203,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: diff --git a/docs/sources/administration/provisioning/index.md b/docs/sources/administration/provisioning/index.md index 0b6d76bc92c..67f8447e204 100644 --- a/docs/sources/administration/provisioning/index.md +++ b/docs/sources/administration/provisioning/index.md @@ -19,7 +19,7 @@ In previous versions of Grafana, you could only use the API for provisioning dat ## Config File -See [Configuration]({{< relref "../../setup-grafana/configure-grafana/" >}}) for more information on what you can configure in `grafana.ini`. +See [Configuration](../../setup-grafana/configure-grafana/) for more information on what you can configure in `grafana.ini`. ### Config File Locations @@ -74,7 +74,7 @@ Currently we do not provide any scripts/manifests for configuring Grafana. Rathe Available in Grafana v5.0 and higher. {{% /admonition %}} -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 config 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. @@ -89,7 +89,7 @@ This prevents old configurations from overwriting newer ones if you have differe ### Example data source config file -This example provisions a [Graphite data source]({{< relref "../../datasources/graphite" >}}): +This example provisions a [Graphite data source](../../datasources/graphite/): ```yaml # Configuration file version @@ -165,14 +165,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 Since not all data sources have the same configuration settings, we include only the most common ones as fields. 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. @@ -233,11 +233,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 will be encrypted with [secret key]({{< relref "../../setup-grafana/configure-grafana#secret_key" >}}) from the Grafana config. The purpose of this is only to hide content from the users of the application. This should be used for storing TLS Cert and password that Grafana will append to the request on the server side. All of these settings are optional. +Secure JSON data is a map of settings that will be encrypted with [secret key](../../setup-grafana/configure-grafana/#secret_key) from the Grafana config. The purpose of this is only to hide content from the users of the application. This should be used for storing TLS Cert and password that Grafana will append to the request on the server side. All of these settings are optional. {{% admonition type="note" %}} The _HTTP\*_ tag denotes data sources that communicate using the HTTP protocol, including all core data source plugins except MySQL, PostgreSQL, and MSSQL. @@ -280,7 +280,7 @@ datasources: Available in Grafana v7.1 and higher. {{% /admonition %}} -You can manage plugin applications in Grafana by adding one or more YAML config files in the [`provisioning/plugins`]({{< relref "../../setup-grafana/configure-grafana#provisioning" >}}) directory. Each config file can contain a list of `apps` that will be updated during start up. Grafana updates each app to match the configuration file. +You can manage plugin applications in Grafana by adding one or more YAML config files in the [`provisioning/plugins`](../../setup-grafana/configure-grafana/#provisioning) directory. Each config file can contain a list of `apps` that will be updated during start up. Grafana updates each app to match the configuration file. {{% admonition type="note" %}} This feature enables you to provision plugin configurations, not the plugins themselves. @@ -313,7 +313,7 @@ apps: ## Dashboards -You can manage dashboards in Grafana by adding one or more YAML config files in the [`provisioning/dashboards`]({{< relref "../../setup-grafana/configure-grafana#dashboards" >}}) directory. Each config file can contain a list of `dashboards providers` that load dashboards into Grafana from the local filesystem. +You can manage dashboards in Grafana by adding one or more YAML config files in the [`provisioning/dashboards`](../../setup-grafana/configure-grafana/#dashboards) directory. Each config file can contain a list of `dashboards providers` that load dashboards into Grafana from the local filesystem. The dashboard provider config file looks somewhat like this: @@ -368,7 +368,7 @@ Note: The JSON definition in the input field when using `Copy JSON to Clipboard` ### 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. 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. +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/inserts all dashboards available in the configured folders. If you modify the file, then the dashboard is also updated. By default, Grafana deletes dashboards in the database if the file is removed. You can disable this behavior using the `disableDeletion` setting. @@ -425,7 +425,7 @@ This feature doesn't currently allow you to create nested folder structures, tha ## 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 @@ -610,5 +610,5 @@ Secure settings is supported since Grafana v7.2. 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 b233e5c54a0..f200954c290 100644 --- a/docs/sources/administration/roles-and-permissions/_index.md +++ b/docs/sources/administration/roles-and-permissions/_index.md @@ -33,14 +33,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. @@ -48,7 +48,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 @@ -68,11 +68,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: @@ -116,9 +116,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). ## Editors with administrator permissions @@ -130,18 +130,18 @@ This permission does not allow editors to manage folders, dashboards, and teams This setting can be used to enable self-organizing teams to administer their own dashboards. -For more information about assigning administrator permissions to editors, refer to [Grant editors administrator permissions]({{< relref "../user-management/server-user-management/grant-editor-admin-permissions/" >}}). +For more information about assigning administrator permissions to editors, refer to [Grant editors administrator permissions](../user-management/server-user-management/grant-editor-admin-permissions/). ## Viewers with dashboard preview and Explore permissions If you have access to the Grafana server, you can modify the default viewer role so that viewers can: - Edit and preview dashboards, but cannot save their changes or create new dashboards. -- Access and use [Explore]({{< relref "../../explore" >}}). +- Access and use [Explore](../../explore/). Extending the viewer role is useful for public Grafana installations where you want anonymous users to be able to edit panels and queries, but not be able to save or create new dashboards. -For more information about assigning dashboard preview permissions to viewers, refer to [Enable viewers to preview dashboards and use Explore]({{< relref "../user-management/manage-dashboard-permissions/#enable-viewers-to-edit-but-not-save-dashboards-and-use-explore" >}}). +For more information about assigning dashboard preview permissions to viewers, refer to [Enable viewers to preview dashboards and use Explore](../user-management/manage-dashboard-permissions/#enable-viewers-to-edit-but-not-save-dashboards-and-use-explore). ## Teams and permissions @@ -152,15 +152,15 @@ You can assign a team member one of the following permissions: - **Member**: Includes the user as a member of the team. Members do not have team administrator privileges. - **Admin**: Administrators have permission to manage various aspects of the team, including team membership, permissions, and settings. -Because teams exist inside an organization, the organization administrator can manage all teams. When the `editors_can_admin` setting is enabled, editors can create teams and manage teams that they create. For more information about the `editors_can_admin` setting, refer to [Grant editors administrator permissions]({{< relref "../user-management/server-user-management/grant-editor-admin-permissions/" >}}). +Because teams exist inside an organization, the organization administrator can manage all teams. When the `editors_can_admin` setting is enabled, editors can create teams and manage teams that they create. For more information about the `editors_can_admin` setting, refer to [Grant editors administrator permissions](../user-management/server-user-management/grant-editor-admin-permissions/). -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) @@ -169,13 +169,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/roles-and-permissions/access-control/_index.md b/docs/sources/administration/roles-and-permissions/access-control/_index.md index 967f2f440ad..a9c30d35f96 100644 --- a/docs/sources/administration/roles-and-permissions/access-control/_index.md +++ b/docs/sources/administration/roles-and-permissions/access-control/_index.md @@ -18,7 +18,7 @@ weight: 120 # Role-based access control (RBAC) {{% 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 %}} RBAC provides a standardized way of granting, changing, and revoking access when it comes to viewing and modifying Grafana resources, such as dashboards, reports, and administrative settings. @@ -77,8 +77,8 @@ You can use RBAC to modify the permissions associated with any basic role, which Note that any modification to any of these basic role is not propagated to the other basic roles. For example, if you modify Viewer basic role and grant additional permission, Editors or Admins won't have that additional grant. -For more information about the permissions associated with each basic role, refer to [Basic role definitions]({{< relref "./rbac-fixed-basic-role-definitions/#basic-role-assignments" >}}). -To interact with the API and view or modify basic roles permissions, refer to [the table]({{< relref "./manage-rbac-roles/#basic-role-uid-mapping" >}}) that maps basic role names to the associated UID. +For more information about the permissions associated with each basic role, refer to [Basic role definitions](rbac-fixed-basic-role-definitions/#basic-role-assignments). +To interact with the API and view or modify basic roles permissions, refer to [the table](manage-rbac-roles/#basic-role-uid-mapping) that maps basic role names to the associated UID. {{% admonition type="note" %}} You cannot use a service account to modify basic roles via the RBAC API. To update basic roles, you must be a Grafana administrator and use basic authentication with the request. @@ -86,31 +86,31 @@ You cannot use a service account to modify basic roles via the RBAC API. To upda ### Fixed roles -Grafana Enterprise includes the ability for you to assign discrete fixed roles to users, teams, and service accounts. This gives you fine-grained control over user permissions than you would have with basic roles alone. These roles are called "fixed" because you cannot change or delete fixed roles. You can also create _custom_ roles of your own; see more information in the [custom roles section]({{< relref "#custom-roles" >}}) below. +Grafana Enterprise includes the ability for you to assign discrete fixed roles to users, teams, and service accounts. This gives you fine-grained control over user permissions than you would have with basic roles alone. These roles are called "fixed" because you cannot change or delete fixed roles. You can also create _custom_ roles of your own; see more information in the [custom roles section](#custom-roles) below. Assign fixed roles when the basic roles do not meet your permission requirements. For example, you might want a user with the basic viewer role to also edit dashboards. Or, you might want anyone with the editor role to also add and manage users. Fixed roles provide users more granular access to create, view, and update the following Grafana resources: -- [Alerting]({{< relref "../../../alerting/" >}}) -- [Annotations]({{< relref "../../../dashboards/build-dashboards/annotate-visualizations" >}}) -- [API keys]({{< relref "../../api-keys/" >}}) -- [Dashboards and folders]({{< relref "../../../dashboards/" >}}) -- [Data sources]({{< relref "../../../datasources/" >}}) -- [Explore]({{< relref "../../../explore/" >}}) -- [Feature Toggles]({{< relref "../../feature-toggles/" >}}) -- [Folders]({{< relref "../../../dashboards/manage-dashboards/#create-a-dashboard-folder" >}}) -- [LDAP]({{< relref "../../../setup-grafana/configure-security/configure-authentication/ldap/" >}}) -- [Library panels]({{< relref "../../../dashboards/build-dashboards/manage-library-panels" >}}) -- [Licenses]({{< relref "../../stats-and-license/" >}}) -- [Organizations]({{< relref "../../organization-management/" >}}) -- [Provisioning]({{< relref "../../provisioning/" >}}) -- [Reports]({{< relref "../../../dashboards/create-reports/" >}}) -- [Roles]({{< relref "../../" >}}) -- [Settings]({{< relref "../../../setup-grafana/configure-grafana/settings-updates-at-runtime" >}}) -- [Service accounts]({{< relref "../../service-accounts/" >}}) -- [Teams]({{< relref "../../team-management/" >}}) -- [Users]({{< relref "../../user-management/" >}}) +- [Alerting](../../../alerting/) +- [Annotations](../../../dashboards/build-dashboards/annotate-visualizations/) +- [API keys](../../api-keys/) +- [Dashboards and folders](../../../dashboards/) +- [Data sources](../../../datasources/) +- [Explore](../../../explore/) +- [Feature Toggles](../../feature-toggles/) +- [Folders](../../../dashboards/manage-dashboards/#create-a-dashboard-folder) +- [LDAP](../../../setup-grafana/configure-security/configure-authentication/ldap/) +- [Library panels](../../../dashboards/build-dashboards/manage-library-panels/) +- [Licenses](../../stats-and-license/) +- [Organizations](../../organization-management/) +- [Provisioning](../../provisioning/) +- [Reports](../../../dashboards/create-reports/) +- [Roles](../../) +- [Settings](../../../setup-grafana/configure-grafana/settings-updates-at-runtime/) +- [Service accounts](../../service-accounts/) +- [Teams](../../team-management/) +- [Users](../../user-management/) -To learn more about the permissions you can grant for each resource, refer to [RBAC role definitions]({{< relref "./rbac-fixed-basic-role-definitions/" >}}). +To learn more about the permissions you can grant for each resource, refer to [RBAC role definitions](rbac-fixed-basic-role-definitions/). ### Custom roles @@ -126,11 +126,11 @@ Consider creating a custom role when fixed roles do not meet your permissions re You can use either of the following methods to create, assign, and manage custom roles: -- Grafana provisioning: You can use a YAML file to configure roles. For more information about using provisioning to create custom roles, refer to [Manage RBAC roles]({{< relref "./manage-rbac-roles/" >}}). For more information about using provisioning to assign RBAC roles to users or teams, refer to [Assign RBAC roles]({{< relref "./assign-rbac-roles/" >}}). -- RBAC API: As an alternative, you can use the Grafana HTTP API to create and manage roles. For more information about the HTTP API, refer to [RBAC API]({{< relref "../../../developers/http_api/access_control/" >}}). +- Grafana provisioning: You can use a YAML file to configure roles. For more information about using provisioning to create custom roles, refer to [Manage RBAC roles](manage-rbac-roles/). For more information about using provisioning to assign RBAC roles to users or teams, refer to [Assign RBAC roles](assign-rbac-roles/). +- RBAC API: As an alternative, you can use the Grafana HTTP API to create and manage roles. For more information about the HTTP API, refer to [RBAC API](../../../developers/http_api/access_control/). ### Limitation If you have created a folder with the name `General` or `general`, you cannot manage its permissions with RBAC. -If you set [folder permissions]({{< relref "../../user-management/manage-dashboard-permissions/#grant-dashboard-folder-permissions" >}}) for a folder named `General` or `general`, the system disregards the folder when RBAC is enabled. +If you set [folder permissions](../../user-management/manage-dashboard-permissions/#grant-dashboard-folder-permissions) for a folder named `General` or `general`, the system disregards the folder when RBAC is enabled. diff --git a/docs/sources/administration/roles-and-permissions/access-control/assign-rbac-roles/index.md b/docs/sources/administration/roles-and-permissions/access-control/assign-rbac-roles/index.md index 5f442a00dfa..664c6e69180 100644 --- a/docs/sources/administration/roles-and-permissions/access-control/assign-rbac-roles/index.md +++ b/docs/sources/administration/roles-and-permissions/access-control/assign-rbac-roles/index.md @@ -16,7 +16,7 @@ weight: 40 # Assign RBAC roles {{% 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 %}} In this topic you'll learn how to use the role picker, provisioning, and the HTTP API to assign fixed and custom roles to users and teams. @@ -34,10 +34,10 @@ In both cases, the assignment applies only to the user, team or service account **Before you begin:** -- [Plan your RBAC rollout strategy]({{< relref "./plan-rbac-rollout-strategy/" >}}). +- [Plan your RBAC rollout strategy](../plan-rbac-rollout-strategy/). - Identify the fixed roles that you want to assign to the user, team or service account. - For more information about available fixed roles, refer to [RBAC role definitions]({{< relref "./rbac-fixed-basic-role-definitions/" >}}). + For more information about available fixed roles, refer to [RBAC role definitions](../rbac-fixed-basic-role-definitions/). - Ensure that your own user account has the correct permissions: - If you are assigning permissions to a user, team or service account within an organization, you must have organization administrator or server administrator permissions. @@ -52,7 +52,7 @@ In both cases, the assignment applies only to the user, team or service account 1. Sign in to Grafana. 2. Switch to the organization that contains the user, team or service account. - For more information about switching organizations, refer to [Switch organizations]({{< relref "../../../user-management/user-preferences/_index.md#switch-organizations" >}}). + For more information about switching organizations, refer to [Switch organizations](../../../user-management/user-preferences/#switch-organizations). 3. In the left-side menu, click **Administration**, **Users and access**, and then **Users**, **Teams**, or **Service accounts**. 4. In the **Role** column, select the fixed role that you want to assign to the user, team, or service account. @@ -73,8 +73,8 @@ Instead of using the Grafana role picker, you can use file-based provisioning to **Before you begin:** -- Refer to [Role provisioning]({{< relref "./rbac-grafana-provisioning/" >}}) -- Ensure that the team to which you are adding the fixed role exists. For more information about creating teams, refer to [Manage teams]({{< relref "../../../team-management/" >}}) +- Refer to [Role provisioning](../rbac-grafana-provisioning/) +- Ensure that the team to which you are adding the fixed role exists. For more information about creating teams, refer to [Manage teams](../../../team-management/) **To assign a role to a team:** @@ -82,25 +82,25 @@ Instead of using the Grafana role picker, you can use file-based provisioning to 1. Refer to the following table to add attributes and values. - | Attribute | Description | - | ------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | - | `roles` | Enter the custom role or custom roles you want to create/update. | - | `roles > name` | Enter the name of the custom role. | - | `roles > version` | Enter the custom role version number. Role assignments are independent of the role version number. | - | `roles > global` | Enter `true`. You can specify the `orgId` otherwise. | - | `roles > permissions` | Enter the permissions `action` and `scope` values. For more information about permissions actions and scopes, refer to [RBAC permissions, actions, and scopes]({{< relref "./custom-role-actions-scopes/" >}}) | - | `teams` | Enter the team or teams to which you are adding the custom role. | - | `teams > orgId` | Because teams belong to organizations, you must add the `orgId` value. | - | `teams > name` | Enter the name of the team. | - | `teams > roles` | Enter the custom or fixed role or roles that you want to grant to the team. | - | `teams > roles > name` | Enter the name of the role. | - | `teams > roles > global` | Enter `true`, or specify `orgId` of the role you want to assign to the team. Fixed roles are global. | + | Attribute | Description | + | ------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | + | `roles` | Enter the custom role or custom roles you want to create/update. | + | `roles > name` | Enter the name of the custom role. | + | `roles > version` | Enter the custom role version number. Role assignments are independent of the role version number. | + | `roles > global` | Enter `true`. You can specify the `orgId` otherwise. | + | `roles > permissions` | Enter the permissions `action` and `scope` values. For more information about permissions actions and scopes, refer to [RBAC permissions, actions, and scopes](../custom-role-actions-scopes/) | + | `teams` | Enter the team or teams to which you are adding the custom role. | + | `teams > orgId` | Because teams belong to organizations, you must add the `orgId` value. | + | `teams > name` | Enter the name of the team. | + | `teams > roles` | Enter the custom or fixed role or roles that you want to grant to the team. | + | `teams > roles > name` | Enter the name of the role. | + | `teams > roles > global` | Enter `true`, or specify `orgId` of the role you want to assign to the team. Fixed roles are global. | - For more information about managing custom roles, refer to [Create custom roles using provisioning]({{< relref "./manage-rbac-roles/#create-custom-roles-using-provisioning" >}}). + For more information about managing custom roles, refer to [Create custom roles using provisioning](../manage-rbac-roles/#create-custom-roles-using-provisioning). 1. Reload the provisioning configuration file. - For more information about reloading the provisioning configuration at runtime, refer to [Reload provisioning configurations]({{< relref "../../../../developers/http_api/admin/#reload-provisioning-configurations" >}}). + For more information about reloading the provisioning configuration at runtime, refer to [Reload provisioning configurations](../../../../developers/http_api/admin/#reload-provisioning-configurations). The following example creates the `custom:users:writer` role and assigns it to the `user writers` and `user admins` teams along with the `fixed:users:writer` role: diff --git a/docs/sources/administration/roles-and-permissions/access-control/configure-rbac/index.md b/docs/sources/administration/roles-and-permissions/access-control/configure-rbac/index.md index c5e22b1f79e..ad63b7b3ee8 100644 --- a/docs/sources/administration/roles-and-permissions/access-control/configure-rbac/index.md +++ b/docs/sources/administration/roles-and-permissions/access-control/configure-rbac/index.md @@ -14,10 +14,10 @@ weight: 30 # Configure RBAC in Grafana {{% 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 table below describes all RBAC configuration options. Like any other Grafana configuration, you can apply these options as [environment variables]({{< relref "../../../../setup-grafana/configure-grafana/#configure-with-environment-variables" >}}). +The table below describes all RBAC configuration options. Like any other Grafana configuration, you can apply these options as [environment variables](../../../../setup-grafana/configure-grafana/#configure-with-environment-variables). | Setting | Required | Description | Default | | ------------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------- | diff --git a/docs/sources/administration/roles-and-permissions/access-control/custom-role-actions-scopes/index.md b/docs/sources/administration/roles-and-permissions/access-control/custom-role-actions-scopes/index.md index 3d2751e4009..f46aaaacd54 100644 --- a/docs/sources/administration/roles-and-permissions/access-control/custom-role-actions-scopes/index.md +++ b/docs/sources/administration/roles-and-permissions/access-control/custom-role-actions-scopes/index.md @@ -15,12 +15,12 @@ weight: 80 # RBAC permissions, actions, and scopes {{% 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 %}} A permission is comprised of an action and a scope. When creating a custom role, consider the actions the user can perform and the resource(s) on which they can perform those actions. -To learn more about the Grafana resources to which you can apply RBAC, refer to [Resources with RBAC permissions]({{< relref "../#fixed-roles" >}}). +To learn more about the Grafana resources to which you can apply RBAC, refer to [Resources with RBAC permissions](../#fixed-roles). - **Action:** An action describes what tasks a user can perform on a resource. - **Scope:** A scope describes where an action can be performed, such as reading a specific user profile. In this example, a permission is associated with the scope `users:` to the relevant role. @@ -111,7 +111,7 @@ The following list contains role-based access control actions. | `plugins.app:access` | `plugins:*`
`plugins:id:*` | Access one or more application plugins (still enforcing the organization role) | | `plugins:install` | n/a | Install and uninstall plugins. | | `plugins:write` | `plugins:*`
`plugins:id:*` | Edit settings for one or more plugins. | -| `provisioning:reload` | `provisioners:*` | Reload provisioning files. To find the exact scope for specific provisioner, see [Scope definitions]({{< relref "#scope-definitions" >}}). | +| `provisioning:reload` | `provisioners:*` | Reload provisioning files. To find the exact scope for specific provisioner, see [Scope definitions](#scope-definitions). | | `reports:create` | n/a | Create reports. | | `reports:write` | `reports:*`
`reports:id:*` | Update reports. | | `reports.settings:read` | n/a | Read report settings. | @@ -131,8 +131,8 @@ The following list contains role-based access control actions. | `serviceaccounts:read` | `serviceaccounts:*`
`serviceaccounts:id:*` | Read Grafana service accounts. | | `serviceaccounts.permissions:write` | `serviceaccounts:*`
`serviceaccounts:id:*` | Update Grafana service account permissions to control who can do what with the service account. | | `serviceaccounts.permissions:read` | `serviceaccounts:*`
`serviceaccounts:id:*` | Read Grafana service account permissions to see who can do what with the service account. | -| `settings:read` | `settings:*`
`settings:auth.saml:*`
`settings:auth.saml:enabled` (property level) | Read the [Grafana configuration settings]({{< relref "../../../../setup-grafana/configure-grafana/" >}}) | -| `settings:write` | `settings:*`
`settings:auth.saml:*`
`settings:auth.saml:enabled` (property level) | Update any Grafana configuration settings that can be [updated at runtime]({{< relref "../../../../setup-grafana/configure-grafana/settings-updates-at-runtime" >}}). | +| `settings:read` | `settings:*`
`settings:auth.saml:*`
`settings:auth.saml:enabled` (property level) | Read the [Grafana configuration settings](../../../../setup-grafana/configure-grafana/) | +| `settings:write` | `settings:*`
`settings:auth.saml:*`
`settings:auth.saml:enabled` (property level) | Update any Grafana configuration settings that can be [updated at runtime](../../../../setup-grafana/configure-grafana/settings-updates-at-runtime/). | | `support.bundles:create` | n/a | Create support bundles. | | `support.bundles:delete` | n/a | Delete support bundles. | | `support.bundles:read` | n/a | List and download support bundles. | @@ -169,7 +169,7 @@ The following list contains role-based access control actions. > **Note:** Available from Grafana 9.4 in early access. > **Note:** This feature is behind the `accessControlOnCall` feature toggle. -> You can enable feature toggles through configuration file or environment variables. See configuration [docs]({{< relref "../../../../setup-grafana/configure-grafana/#feature_toggles" >}}) for details. +> You can enable feature toggles through configuration file or environment variables. See configuration [docs](../../../../setup-grafana/configure-grafana/#feature_toggles) for details. The following list contains role-based access control actions used by Grafana OnCall application plugin. @@ -218,7 +218,7 @@ The following list contains role-based access control scopes. | `permissions:type:delegate` | The scope is only applicable for roles associated with the Access Control itself and indicates that you can delegate your permissions only, or a subset of it, by creating a new role or making an assignment. | | `permissions:type:escalate` | The scope is required to trigger the reset of basic roles permissions. It indicates that users might acquire additional permissions they did not previously have. | | `plugins:*`
`plugins:id:*` | Restrict an action to a set of plugins. For example, `plugins:id:grafana-oncall-app` matches Grafana OnCall plugin, and `plugins:*` matches all plugins. | -| `provisioners:*` | Restrict an action to a set of provisioners. For example, `provisioners:*` matches any provisioner, and `provisioners:accesscontrol` matches the role-based access control [provisioner]({{< relref "./rbac-grafana-provisioning/" >}}). | +| `provisioners:*` | Restrict an action to a set of provisioners. For example, `provisioners:*` matches any provisioner, and `provisioners:accesscontrol` matches the role-based access control [provisioner](../rbac-grafana-provisioning/). | | `reports:*`
`reports:id:*` | Restrict an action to a set of reports. For example, `reports:*` matches any report and `reports:id:1` matches the report whose ID is `1`. | | `roles:*`
`roles:uid:*` | Restrict an action to a set of roles. For example, `roles:*` matches any role and `roles:uid:randomuid` matches only the role whose UID is `randomuid`. | | `services:accesscontrol` | Restrict an action to target only the role-based access control service. You can use this in conjunction with the `status:accesscontrol` actions. | diff --git a/docs/sources/administration/roles-and-permissions/access-control/manage-rbac-roles/index.md b/docs/sources/administration/roles-and-permissions/access-control/manage-rbac-roles/index.md index 98ec10b6308..ba1339d6785 100644 --- a/docs/sources/administration/roles-and-permissions/access-control/manage-rbac-roles/index.md +++ b/docs/sources/administration/roles-and-permissions/access-control/manage-rbac-roles/index.md @@ -17,7 +17,7 @@ weight: 50 # Manage RBAC roles {{% 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 %}} This section includes instructions for how to view permissions associated with roles, create custom roles, and update and delete roles. @@ -26,7 +26,7 @@ The following example includes the base64 username:password Basic Authorization. ## List permissions associated with roles -Use a `GET` command to see the actions and scopes associated with a role. For more information about seeing a list of permissions for each role, refer to [Get a role]({{< relref "../../../../developers/http_api/access_control/#get-a-role" >}}). +Use a `GET` command to see the actions and scopes associated with a role. For more information about seeing a list of permissions for each role, refer to [Get a role](../../../../developers/http_api/access_control/#get-a-role). To see the permissions associated with basic roles, refer to the following basic role UIDs: @@ -85,7 +85,7 @@ curl --location --request GET '/api/access-control/roles/qQui_LCMk' } ``` -Refer to the [RBAC HTTP API]({{< relref "../../../../developers/http_api/access_control/#get-a-role" >}}) for more details. +Refer to the [RBAC HTTP API](../../../../developers/http_api/access_control/#get-a-role) for more details. ## Create custom roles @@ -95,9 +95,9 @@ Create a custom role when basic roles and fixed roles do not meet your permissio **Before you begin:** -- [Plan your RBAC rollout strategy]({{< relref "./plan-rbac-rollout-strategy/" >}}). -- Determine which permissions you want to add to the custom role. To see a list of actions and scope, refer to [RBAC permissions, actions, and scopes]({{< relref "./custom-role-actions-scopes/" >}}). -- [Enable role provisioning]({{< relref "./rbac-grafana-provisioning/" >}}). +- [Plan your RBAC rollout strategy](../plan-rbac-rollout-strategy/). +- Determine which permissions you want to add to the custom role. To see a list of actions and scope, refer to [RBAC permissions, actions, and scopes](../custom-role-actions-scopes/). +- [Enable role provisioning](../rbac-grafana-provisioning/). - Ensure that you have permissions to create a custom role. - By default, the Grafana Admin role has permission to create custom roles. - A Grafana Admin can delegate the custom role privilege to another user by creating a custom role with the relevant permissions and adding the `permissions:type:delegate` scope. @@ -110,25 +110,25 @@ File-based provisioning is one method you can use to create custom roles. 1. Refer to the following table to add attributes and values. -| Attribute | Description | -| ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `name` | A human-friendly identifier for the role that helps administrators understand the purpose of a role. `name` is required and cannot be longer than 190 characters. We recommend that you use ASCII characters. Role names must be unique within an organization. | -| `uid` | A unique identifier associated with the role. The UID enables you to change or delete the role. You can either generate a UID yourself, or let Grafana generate one for you. You cannot use the same UID within the same Grafana instance. | -| `orgId` | Identifies the organization to which the role belongs. The [default org ID]({{< relref "../../../../setup-grafana/configure-grafana/#auto_assign_org_id" >}}) is used if you do not specify `orgId`. | -| `global` | Global roles are not associated with any specific organization, which means that you can reuse them across all organizations. This setting overrides `orgId`. | -| `displayName` | Human-friendly text that is displayed in the UI. Role display name cannot be longer than 190 ASCII-based characters. For fixed roles, the display name is shown as specified. If you do not set a display name the display name replaces `':'` (a colon) with `' '` (a space). | -| `description` | Human-friendly text that describes the permissions a role provides. | -| `group` | Organizes roles in the role picker. | -| `version` | A positive integer that defines the current version of the role, which prevents overwriting newer changes. | -| `hidden` | Hidden roles do not appear in the role picker. | -| `state` | State of the role. Defaults to `present`, but if set to `absent` the role will be removed. | -| `force` | Can be used in addition to state `absent`, to force the removal of a role and all its assignments. | -| `from` | An optional list of roles from which you want to copy permissions. | -| `permissions` | Provides users access to Grafana resources. For a list of permissions, refer to [RBAC permissions actions and scopes]({{< relref "./rbac-fixed-basic-role-definitions/" >}}). If you do not know which permissions to assign, you can create and assign roles without any permissions as a placeholder. Using the `from` attribute, you can specify additional permissions or permissions to remove by adding a `state` to your permission list. | +| Attribute | Description | +| ------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `name` | A human-friendly identifier for the role that helps administrators understand the purpose of a role. `name` is required and cannot be longer than 190 characters. We recommend that you use ASCII characters. Role names must be unique within an organization. | +| `uid` | A unique identifier associated with the role. The UID enables you to change or delete the role. You can either generate a UID yourself, or let Grafana generate one for you. You cannot use the same UID within the same Grafana instance. | +| `orgId` | Identifies the organization to which the role belongs. The [default org ID](../../../../setup-grafana/configure-grafana/#auto_assign_org_id) is used if you do not specify `orgId`. | +| `global` | Global roles are not associated with any specific organization, which means that you can reuse them across all organizations. This setting overrides `orgId`. | +| `displayName` | Human-friendly text that is displayed in the UI. Role display name cannot be longer than 190 ASCII-based characters. For fixed roles, the display name is shown as specified. If you do not set a display name the display name replaces `':'` (a colon) with `' '` (a space). | +| `description` | Human-friendly text that describes the permissions a role provides. | +| `group` | Organizes roles in the role picker. | +| `version` | A positive integer that defines the current version of the role, which prevents overwriting newer changes. | +| `hidden` | Hidden roles do not appear in the role picker. | +| `state` | State of the role. Defaults to `present`, but if set to `absent` the role will be removed. | +| `force` | Can be used in addition to state `absent`, to force the removal of a role and all its assignments. | +| `from` | An optional list of roles from which you want to copy permissions. | +| `permissions` | Provides users access to Grafana resources. For a list of permissions, refer to [RBAC permissions actions and scopes](../rbac-fixed-basic-role-definitions/). If you do not know which permissions to assign, you can create and assign roles without any permissions as a placeholder. Using the `from` attribute, you can specify additional permissions or permissions to remove by adding a `state` to your permission list. | 1. Reload the provisioning configuration file. - For more information about reloading the provisioning configuration at runtime, refer to [Reload provisioning configurations]({{< relref "../../../../developers/http_api/admin/#reload-provisioning-configurations" >}}). + For more information about reloading the provisioning configuration at runtime, refer to [Reload provisioning configurations](../../../../developers/http_api/admin/#reload-provisioning-configurations). The following example creates a local role: @@ -197,7 +197,7 @@ roles: ### Create custom roles using the HTTP API -The following examples show you how to create a custom role using the Grafana HTTP API. For more information about the HTTP API, refer to [Create a new custom role]({{< relref "../../../../developers/http_api/access_control/#create-a-new-custom-role" >}}). +The following examples show you how to create a custom role using the Grafana HTTP API. For more information about the HTTP API, refer to [Create a new custom role](../../../../developers/http_api/access_control/#create-a-new-custom-role). {{% admonition type="note" %}} You cannot create a custom role with permissions that you do not have. For example, if you only have `users:create` permissions, then you cannot create a role that includes other permissions. @@ -248,7 +248,7 @@ curl --location --request POST '/api/access-control/roles/' \ } ``` -Refer to the [RBAC HTTP API]({{< relref "../../../../developers/http_api/access_control/#create-a-new-custom-role" >}}) for more details. +Refer to the [RBAC HTTP API](../../../../developers/http_api/access_control/#create-a-new-custom-role) for more details. ## Update basic role permissions @@ -256,7 +256,7 @@ If the default basic role definitions do not meet your requirements, you can cha **Before you begin:** -- Determine the permissions you want to add or remove from a basic role. For more information about the permissions associated with basic roles, refer to [RBAC role definitions]({{< relref "./rbac-fixed-basic-role-definitions/#basic-role-assignments" >}}). +- Determine the permissions you want to add or remove from a basic role. For more information about the permissions associated with basic roles, refer to [RBAC role definitions](../rbac-fixed-basic-role-definitions/#basic-role-assignments). {{% admonition type="note" %}} You cannot modify the `No Basic Role` permissions. @@ -278,7 +278,7 @@ You cannot modify the `No Basic Role` permissions. 1. Reload the provisioning configuration file. - For more information about reloading the provisioning configuration at runtime, refer to [Reload provisioning configurations]({{< relref "../../../../developers/http_api/admin/#reload-provisioning-configurations" >}}). + For more information about reloading the provisioning configuration at runtime, refer to [Reload provisioning configurations](../../../../developers/http_api/admin/#reload-provisioning-configurations). The following example modifies the `Grafana Admin` basic role permissions. @@ -319,7 +319,7 @@ You can add multiple `fixed`, `basic` or `custom` roles to the `from` section. T Make sure to **increment** the role version for the changes to be accounted for. {{% /admonition %}} -You can also change basic roles' permissions using the API. Refer to the [RBAC HTTP API]({{< relref "../../../../developers/http_api/access_control/#update-a-role" >}}) for more details. +You can also change basic roles' permissions using the API. Refer to the [RBAC HTTP API](../../../../developers/http_api/access_control/#update-a-role) for more details. ## Reset basic roles to their default @@ -333,7 +333,7 @@ You have two options to reset the basic roles permissions to their default. > Warning: If this option is left to true, permissions will be reset on every boot. -Use the [reset_basic_roles]({{< relref "../configure-rbac/#configure-rbac-in-grafana" >}}) option to reset +Use the [reset_basic_roles](../configure-rbac/#configure-rbac-in-grafana) option to reset basic roles permissions to their default on Grafana instance boot up. 1. Open you configuration file and update the rbac section as follow: @@ -366,7 +366,7 @@ An alternative to the configuration option is to use the HTTP endpoint. scope: 'permissions:type:escalate' ``` -1. As a `Grafana Admin`, call the API endpoint to reset the basic roles to their default. Refer to the [RBAC HTTP API]({{< relref "../../../../developers/http_api/access_control/#reset-basic-roles-to-their-default" >}}) for more details. +1. As a `Grafana Admin`, call the API endpoint to reset the basic roles to their default. Refer to the [RBAC HTTP API](../../../../developers/http_api/access_control/#reset-basic-roles-to-their-default) for more details. ## Delete a custom role using Grafana provisioning @@ -392,7 +392,7 @@ Delete a custom role when you no longer need it. When you delete a custom role, 1. Reload the provisioning configuration file. - For more information about reloading the provisioning configuration at runtime, refer to [Reload provisioning configurations]({{< relref "../../../../developers/http_api/admin/#reload-provisioning-configurations" >}}). + For more information about reloading the provisioning configuration at runtime, refer to [Reload provisioning configurations](../../../../developers/http_api/admin/#reload-provisioning-configurations). The following example deletes a custom role: @@ -407,4 +407,4 @@ roles: force: true ``` -You can also delete a custom role using the API. Refer to the [RBAC HTTP API]({{< relref "../../../../developers/http_api/access_control/#delete-a-custom-role" >}}) for more details. +You can also delete a custom role using the API. Refer to the [RBAC HTTP API](../../../../developers/http_api/access_control/#delete-a-custom-role) for more details. diff --git a/docs/sources/administration/roles-and-permissions/access-control/plan-rbac-rollout-strategy/index.md b/docs/sources/administration/roles-and-permissions/access-control/plan-rbac-rollout-strategy/index.md index d6a4f3bc8a4..57cedf2ff7a 100644 --- a/docs/sources/administration/roles-and-permissions/access-control/plan-rbac-rollout-strategy/index.md +++ b/docs/sources/administration/roles-and-permissions/access-control/plan-rbac-rollout-strategy/index.md @@ -16,7 +16,7 @@ weight: 20 # Plan your RBAC rollout strategy {{% 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 %}} An RBAC rollout strategy helps you determine _how_ you want to implement RBAC prior to assigning RBAC roles to users and teams. @@ -35,8 +35,8 @@ As a first step in determining your permissions rollout strategy, we recommend t To learn more about basic roles and fixed roles, refer to the following documentation: -- [Basic role definitions]({{< relref "./rbac-fixed-basic-role-definitions/#basic-role-assignments" >}}) -- [Fixed role definitions]({{< relref "./rbac-fixed-basic-role-definitions/#fixed-role-definitions" >}}) +- [Basic role definitions](../rbac-fixed-basic-role-definitions/#basic-role-assignments) +- [Fixed role definitions](../rbac-fixed-basic-role-definitions/#fixed-role-definitions) ## User and team considerations @@ -56,7 +56,7 @@ For example: 1. Map SAML, LDAP, or Oauth roles to Grafana basic roles (viewer, editor, or admin). -2. Use the Grafana Enterprise team sync feature to synchronize teams from your SAML, LDAP, or Oauth provider to Grafana. For more information about team sync, refer to [Team sync]({{< relref "../../../../setup-grafana/configure-security/configure-team-sync/" >}}). +2. Use the Grafana Enterprise team sync feature to synchronize teams from your SAML, LDAP, or Oauth provider to Grafana. For more information about team sync, refer to [Team sync](../../../../setup-grafana/configure-security/configure-team-sync/). 3. Within Grafana, assign RBAC permissions to users and teams. @@ -67,7 +67,7 @@ Consider the following guidelines when you determine if you should modify basic - **Modify basic roles** when Grafana's definitions of what viewers, editors, and admins can do does not match your definition of these roles. You can add or remove permissions from any basic role. {{% admonition type="note" %}} - Changes that you make to basic roles impact the role definition for all [organizations]({{< relref "../../../organization-management/" >}}) in the Grafana instance. For example, when you add the `fixed:users:writer` role's permissions to the viewer basic role, all viewers in any org in the Grafana instance can create users within that org. + Changes that you make to basic roles impact the role definition for all [organizations](../../../organization-management/) in the Grafana instance. For example, when you add the `fixed:users:writer` role's permissions to the viewer basic role, all viewers in any org in the Grafana instance can create users within that org. {{% /admonition %}} {{% admonition type="note" %}} @@ -97,13 +97,13 @@ If you have a use case that you'd like to share, feel free to contribute to this 1. In Grafana, create a team with the name `Internal employees`. 1. Assign the `fixed:datasources:explorer` role to the `Internal employees` team. -1. Add internal employees to the `Internal employees` team, or map them from a SAML, LDAP, or Oauth team using [Team Sync]({{< relref "../../../../setup-grafana/configure-security/configure-team-sync/" >}}). +1. Add internal employees to the `Internal employees` team, or map them from a SAML, LDAP, or Oauth team using [Team Sync](../../../../setup-grafana/configure-security/configure-team-sync/). 1. Assign the viewer role to both internal employees and contractors. ### Limit viewer, editor, or admin permissions 1. Review the list of permissions associated with the basic role. -1. [Change the permissions of the basic role]({{< relref "./manage-rbac-roles/#update-basic-role-permissions" >}}). +1. [Change the permissions of the basic role](../manage-rbac-roles/#update-basic-role-permissions). ### Allow only members of one team to manage Alerts @@ -186,7 +186,7 @@ roles: global: true ``` -- Or add the following permissions to the `basic:editor` role, using provisioning or the [RBAC HTTP API]({{< relref "../../../../developers/http_api/access_control/#update-a-role" >}}): +- Or add the following permissions to the `basic:editor` role, using provisioning or the [RBAC HTTP API](../../../../developers/http_api/access_control/#update-a-role): | action | scope | | -------------- | --------------------------- | @@ -216,9 +216,9 @@ roles: global: true ``` -> **Note:** The `fixed:reports:writer` role assigns more permissions than just creating reports. For more information about fixed role permission assignments, refer to [Fixed role definitions]({{< relref "./rbac-fixed-basic-role-definitions/#fixed-role-definitions" >}}). +> **Note:** The `fixed:reports:writer` role assigns more permissions than just creating reports. For more information about fixed role permission assignments, refer to [Fixed role definitions](../rbac-fixed-basic-role-definitions/#fixed-role-definitions). -- Add the following permissions to the `basic:viewer` role, using provisioning or the [RBAC HTTP API]({{< relref "../../../../developers/http_api/access_control/#update-a-role" >}}): +- Add the following permissions to the `basic:viewer` role, using provisioning or the [RBAC HTTP API](../../../../developers/http_api/access_control/#update-a-role): | Action | Scope | | ---------------- | ------------------------------- | @@ -229,7 +229,7 @@ roles: ### Prevent a Grafana Admin from creating and inviting users -To prevent a Grafana Admin from creating users and inviting them to join an organization, you must [update a basic role permission]({{< relref "./manage-rbac-roles/#update-basic-role-permissions" >}}). +To prevent a Grafana Admin from creating users and inviting them to join an organization, you must [update a basic role permission](../manage-rbac-roles/#update-basic-role-permissions). The permissions to remove are: | Action | Scope | @@ -259,12 +259,12 @@ roles: state: 'absent' ``` -- Or use [RBAC HTTP API]({{< relref "../../../../developers/http_api/access_control/#update-a-role" >}}). +- Or use [RBAC HTTP API](../../../../developers/http_api/access_control/#update-a-role). ### Prevent Viewers from accessing an App Plugin By default, Viewers, Editors and Admins have access to all App Plugins that their organization role allows them to access. -To change this default behavior and prevent Viewers from accessing an App plugin, you must [update a basic role's permissions]({{< relref "./manage-rbac-roles/#update-basic-role-permissions" >}}). +To change this default behavior and prevent Viewers from accessing an App plugin, you must [update a basic role's permissions](../manage-rbac-roles/#update-basic-role-permissions). In this example, three App plugins have been installed and enabled: | Name | ID | Required Org role | @@ -309,7 +309,7 @@ roles: state: 'present' ``` -- Or use [RBAC HTTP API]({{< relref "../../../../developers/http_api/access_control/#update-a-role" >}}). +- Or use [RBAC HTTP API](../../../../developers/http_api/access_control/#update-a-role). ### Manage user permissions through teams diff --git a/docs/sources/administration/roles-and-permissions/access-control/rbac-fixed-basic-role-definitions/index.md b/docs/sources/administration/roles-and-permissions/access-control/rbac-fixed-basic-role-definitions/index.md index 05d1235169e..91338747473 100644 --- a/docs/sources/administration/roles-and-permissions/access-control/rbac-fixed-basic-role-definitions/index.md +++ b/docs/sources/administration/roles-and-permissions/access-control/rbac-fixed-basic-role-definitions/index.md @@ -16,20 +16,20 @@ weight: 70 # RBAC role definitions {{% 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 tables list permissions associated with basic and fixed roles. ## Basic role assignments -| Basic role | Associated fixed roles | Description | -| ------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | -| Grafana Admin | `fixed:roles:reader`
`fixed:roles:writer`
`fixed:users:reader`
`fixed:users:writer`
`fixed:org.users:reader`
`fixed:org.users:writer`
`fixed:ldap:reader`
`fixed:ldap:writer`
`fixed:stats:reader`
`fixed:settings:reader`
`fixed:settings:writer`
`fixed:provisioning:writer`
`fixed:organization:reader`
`fixed:organization:maintainer`
`fixed:licensing:reader`
`fixed:licensing:writer`
`fixed:datasources.caching:reader`
`fixed:datasources.caching:writer`
`fixed:dashboards.insights:reader`
`fixed:datasources.insights:reader`
`fixed:plugins:maintainer`
`fixed:authentication.config:writer`
`fixed:library.panels:creator`
`fixed:library.panels:reader`
`fixed:library.panels:general.reader`
`fixed:library.panels:writer`
`fixed:library.panels:general.writer` | Default [Grafana server administrator]({{< relref "../../#grafana-server-administrators" >}}) assignments. | -| Admin | `fixed:reports:reader`
`fixed:reports:writer`
`fixed:datasources:reader`
`fixed:datasources:writer`
`fixed:organization:writer`
`fixed:datasources.permissions:reader`
`fixed:datasources.permissions:writer`
`fixed:teams:writer`
`fixed:dashboards:reader`
`fixed:dashboards:writer`
`fixed:dashboards.permissions:reader`
`fixed:dashboards.permissions:writer`
`fixed:dashboards.public:writer`
`fixed:folders:reader`
`fixed:folders:writer`
`fixed:folders.permissions:reader`
`fixed:folders.permissions:writer`
`fixed:alerting:writer`
`fixed:apikeys:reader`
`fixed:apikeys:writer`
`fixed:alerting.provisioning.secrets:reader`
`fixed:alerting.provisioning:writer`
`fixed:datasources.caching:reader`
`fixed:datasources.caching:writer`
`fixed:dashboards.insights:reader`
`fixed:datasources.insights:reader`
`fixed:plugins:writer`
`fixed:library.panels:creator`
`fixed:library.panels:reader`
`fixed:library.panels:general.reader`
`fixed:library.panels:writer`
`fixed:library.panels:general.writer` | Default [Grafana organization administrator]({{< relref "../#basic-roles" >}}) assignments. | -| Editor | `fixed:datasources:explorer`
`fixed:dashboards:creator`
`fixed:folders:creator`
`fixed:annotations:writer`
`fixed:teams:creator` if the `editors_can_admin` configuration flag is enabled
`fixed:alerting:writer`
`fixed:dashboards.insights:reader`
`fixed:datasources.insights:reader`
`fixed:library.panels:creator`
`fixed:library.panels:general.reader`
`fixed:library.panels:general.writer` | Default [Editor]({{< relref "../#basic-roles" >}}) assignments. | -| Viewer | `fixed:datasources.id:reader`
`fixed:organization:reader`
`fixed:annotations:reader`
`fixed:annotations.dashboard:writer`
`fixed:alerting:reader`
`fixed:plugins.app:reader`
`fixed:dashboards.insights:reader`
`fixed:datasources.insights:reader`
`fixed:library.panels:general.reader` | Default [Viewer]({{< relref "../#basic-roles" >}}) assignments. | -| No Basic Role | | Default [No Basic Role]({{< relref "../#basic-roles" >}}) | +| Basic role | Associated fixed roles | Description | +| ------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | +| Grafana Admin | `fixed:roles:reader`
`fixed:roles:writer`
`fixed:users:reader`
`fixed:users:writer`
`fixed:org.users:reader`
`fixed:org.users:writer`
`fixed:ldap:reader`
`fixed:ldap:writer`
`fixed:stats:reader`
`fixed:settings:reader`
`fixed:settings:writer`
`fixed:provisioning:writer`
`fixed:organization:reader`
`fixed:organization:maintainer`
`fixed:licensing:reader`
`fixed:licensing:writer`
`fixed:datasources.caching:reader`
`fixed:datasources.caching:writer`
`fixed:dashboards.insights:reader`
`fixed:datasources.insights:reader`
`fixed:plugins:maintainer`
`fixed:authentication.config:writer`
`fixed:library.panels:creator`
`fixed:library.panels:reader`
`fixed:library.panels:general.reader`
`fixed:library.panels:writer`
`fixed:library.panels:general.writer` | Default [Grafana server administrator](../../#grafana-server-administrators) assignments. | +| Admin | `fixed:reports:reader`
`fixed:reports:writer`
`fixed:datasources:reader`
`fixed:datasources:writer`
`fixed:organization:writer`
`fixed:datasources.permissions:reader`
`fixed:datasources.permissions:writer`
`fixed:teams:writer`
`fixed:dashboards:reader`
`fixed:dashboards:writer`
`fixed:dashboards.permissions:reader`
`fixed:dashboards.permissions:writer`
`fixed:dashboards.public:writer`
`fixed:folders:reader`
`fixed:folders:writer`
`fixed:folders.permissions:reader`
`fixed:folders.permissions:writer`
`fixed:alerting:writer`
`fixed:apikeys:reader`
`fixed:apikeys:writer`
`fixed:alerting.provisioning.secrets:reader`
`fixed:alerting.provisioning:writer`
`fixed:datasources.caching:reader`
`fixed:datasources.caching:writer`
`fixed:dashboards.insights:reader`
`fixed:datasources.insights:reader`
`fixed:plugins:writer`
`fixed:library.panels:creator`
`fixed:library.panels:reader`
`fixed:library.panels:general.reader`
`fixed:library.panels:writer`
`fixed:library.panels:general.writer` | Default [Grafana organization administrator](../#basic-roles) assignments. | +| Editor | `fixed:datasources:explorer`
`fixed:dashboards:creator`
`fixed:folders:creator`
`fixed:annotations:writer`
`fixed:teams:creator` if the `editors_can_admin` configuration flag is enabled
`fixed:alerting:writer`
`fixed:dashboards.insights:reader`
`fixed:datasources.insights:reader`
`fixed:library.panels:creator`
`fixed:library.panels:general.reader`
`fixed:library.panels:general.writer` | Default [Editor](../#basic-roles) assignments. | +| Viewer | `fixed:datasources.id:reader`
`fixed:organization:reader`
`fixed:annotations:reader`
`fixed:annotations.dashboard:writer`
`fixed:alerting:reader`
`fixed:plugins.app:reader`
`fixed:dashboards.insights:reader`
`fixed:datasources.insights:reader`
`fixed:library.panels:general.reader` | Default [Viewer](../#basic-roles) assignments. | +| No Basic Role | | Default [No Basic Role](../#basic-roles) | ## Fixed role definitions @@ -119,7 +119,7 @@ Access to Grafana alert rules is an intersection of many permissions: There is only one exclusion at this moment. Role `fixed:alerting.provisioning:writer` does not require user to have any additional permissions and provides access to all aspects of the alerting configuration via special provisioning API. -For more information about the permissions required to access alert rules, refer to [Create a custom role to access alerts in a folder]({{< relref "./plan-rbac-rollout-strategy/#create-a-custom-role-to-access-alerts-in-a-folder" >}}). +For more information about the permissions required to access alert rules, refer to [Create a custom role to access alerts in a folder](../plan-rbac-rollout-strategy/#create-a-custom-role-to-access-alerts-in-a-folder). ### Grafana OnCall roles (beta) @@ -129,7 +129,7 @@ Available from Grafana 9.4 in early access. {{% admonition type="note" %}} This feature is behind the `accessControlOnCall` feature toggle. -You can enable feature toggles through configuration file or environment variables. See configuration [docs]({{< relref "../../../../setup-grafana/configure-grafana/#feature_toggles" >}}) for details. +You can enable feature toggles through configuration file or environment variables. See configuration [docs](../../../../setup-grafana/configure-grafana/#feature_toggles) for details. {{% /admonition %}} If you are using [Grafana OnCall](https://grafana.com/docs/oncall/latest/get-started/), you can try out the integration between Grafana OnCall and RBAC. @@ -137,9 +137,9 @@ For a detailed list of the available OnCall RBAC roles, refer to the table in [A The following table lists the default RBAC OnCall role assignments to the basic roles: -| Basic role | Associated fixed roles | Description | -| ------------- | ----------------------------------- | ------------------------------------------------------------------------------------------------------- | -| Grafana Admin | `plugins:grafana-oncall-app:admin` | Default [Grafana server administrator]({{< relref "../#grafana-server-administrators" >}}) assignments. | -| Admin | `plugins:grafana-oncall-app:admin` | Default [Grafana organization administrator]({{< relref "../#basic-roles" >}}) assignments. | -| Editor | `plugins:grafana-oncall-app:editor` | Default [Editor]({{< relref "../#basic-roles" >}}) assignments. | -| Viewer | `plugins:grafana-oncall-app:reader` | Default [Viewer]({{< relref "../#basic-roles" >}}) assignments. | +| Basic role | Associated fixed roles | Description | +| ------------- | ----------------------------------- | -------------------------------------------------------------------------------------- | +| Grafana Admin | `plugins:grafana-oncall-app:admin` | Default [Grafana server administrator](../#grafana-server-administrators) assignments. | +| Admin | `plugins:grafana-oncall-app:admin` | Default [Grafana organization administrator](../#basic-roles) assignments. | +| Editor | `plugins:grafana-oncall-app:editor` | Default [Editor](../#basic-roles) assignments. | +| Viewer | `plugins:grafana-oncall-app:reader` | Default [Viewer](../#basic-roles) assignments. | diff --git a/docs/sources/administration/roles-and-permissions/access-control/rbac-grafana-provisioning/index.md b/docs/sources/administration/roles-and-permissions/access-control/rbac-grafana-provisioning/index.md index 2d8b535c6a4..10a73ce17a7 100644 --- a/docs/sources/administration/roles-and-permissions/access-control/rbac-grafana-provisioning/index.md +++ b/docs/sources/administration/roles-and-permissions/access-control/rbac-grafana-provisioning/index.md @@ -16,10 +16,10 @@ weight: 60 # Provisioning RBAC with Grafana {{% 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 %}} -You can create, change or remove [Custom roles]({{< relref "./manage-rbac-roles/#create-custom-roles-using-provisioning" >}}) and create or remove [basic role assignments]({{< relref "./assign-rbac-roles/#assign-a-fixed-role-to-a-basic-role-using-provisioning" >}}), by adding one or more YAML configuration files in the `provisioning/access-control/` directory. +You can create, change or remove [Custom roles](../manage-rbac-roles/#create-custom-roles-using-provisioning) and create or remove [basic role assignments](../assign-rbac-roles/#assign-a-fixed-role-to-a-basic-role-using-provisioning), by adding one or more YAML configuration files in the `provisioning/access-control/` directory. Grafana performs provisioning during startup. After you make a change to the configuration file, you can reload it during runtime. You do not need to restart the Grafana server for your changes to take effect. @@ -37,13 +37,13 @@ Grafana performs provisioning during startup. After you make a change to the con 1. Add RBAC provisioning details to the configuration file. - Refer to [Manage RBAC roles]({{< relref "./manage-rbac-roles/" >}}) and [Assign RBAC roles]({{< relref "./assign-rbac-roles/" >}}) for instructions. + Refer to [Manage RBAC roles](../manage-rbac-roles/) and [Assign RBAC roles](../assign-rbac-roles/) for instructions. - Refer to [example role provisioning file]({{< relref "#example-role-configuration-file-using-grafana-provisioning" >}}) for a complete example of a provisioning file. + Refer to [example role provisioning file](#example-role-configuration-file-using-grafana-provisioning) for a complete example of a provisioning file. 1. Reload the provisioning configuration file. - For more information about reloading the provisioning configuration at runtime, refer to [Reload provisioning configurations]({{< relref "../../../../developers/http_api/admin/#reload-provisioning-configurations" >}}). + For more information about reloading the provisioning configuration at runtime, refer to [Reload provisioning configurations](../../../../developers/http_api/admin/#reload-provisioning-configurations). ## Example role configuration file using Grafana provisioning @@ -130,6 +130,6 @@ teams: ## Useful Links -[Provisioning RBAC setup with Terraform]({{< relref "./rbac-terraform-provisioning">}}) +[Provisioning RBAC setup with Terraform](../rbac-terraform-provisioning/) [Grafana provisioning](https://grafana.com/docs/grafana/latest/administration/provisioning/) diff --git a/docs/sources/administration/roles-and-permissions/access-control/rbac-terraform-provisioning/index.md b/docs/sources/administration/roles-and-permissions/access-control/rbac-terraform-provisioning/index.md index 5d841535473..d3f191582a3 100644 --- a/docs/sources/administration/roles-and-permissions/access-control/rbac-terraform-provisioning/index.md +++ b/docs/sources/administration/roles-and-permissions/access-control/rbac-terraform-provisioning/index.md @@ -15,7 +15,7 @@ weight: 60 # Provisioning RBAC with Terraform {{% 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 %}} You can create, change or remove [Custom roles](https://registry.terraform.io/providers/grafana/grafana/latest/docs/resources/role) and create or remove [basic and custom role assignments](https://registry.terraform.io/providers/grafana/grafana/latest/docs/resources/role_assignment), by using [Terraform's Grafana provider](https://registry.terraform.io/providers/grafana/grafana/latest/docs). @@ -28,15 +28,15 @@ You can create, change or remove [Custom roles](https://registry.terraform.io/pr ## Create a Service Account Token for provisioning -We recommend using service account tokens for provisioning. [Service accounts]({{< relref "../../../service-accounts/" >}}) support fine grained permissions, which allows you to easily authenticate and use the minimum set of permissions needed to provision your RBAC infrastructure. +We recommend using service account tokens for provisioning. [Service accounts](../../../service-accounts/) support fine grained permissions, which allows you to easily authenticate and use the minimum set of permissions needed to provision your RBAC infrastructure. To create a service account token for provisioning, complete the following steps. -1. [Create a new service account]({{< relref "../../../service-accounts/#create-a-service-account-in-grafana" >}}) for your CI pipeline. -1. [Assign permissions to service account]({{< relref "../../../service-accounts/#assign-roles-to-a-service-account-in-grafana" >}}): +1. [Create a new service account](../../../service-accounts/#create-a-service-account-in-grafana) for your CI pipeline. +1. [Assign permissions to service account](../../../service-accounts/#assign-roles-to-a-service-account-in-grafana): - You will need roles “Role reader”, "Role writer" and roles including any permissions that will be provisioned. For example, to create or assign a role that allows creating users, a service account needs permissions to create users. - Alternatively, you can assign "Admin" basic role to the service account. -1. [Create a new service account token]({{< relref "../../../service-accounts/#to-add-a-token-to-a-service-account" >}}) for use in Terraform. +1. [Create a new service account token](../../../service-accounts/#to-add-a-token-to-a-service-account) for use in Terraform. Alternatively, you can use basic authentication. To view all the supported authentication formats, see [here](https://registry.terraform.io/providers/grafana/grafana/latest/docs#authentication). @@ -152,6 +152,6 @@ Similarly, you can look up and use `id`s of users, teams and service accounts th ## Useful Links -[RBAC setup with Grafana provisioning]({{< relref "./rbac-grafana-provisioning">}}) +[RBAC setup with Grafana provisioning](../rbac-grafana-provisioning/) [Grafana Cloud Terraform provisioning](/docs/grafana-cloud/infrastructure-as-code/terraform/) diff --git a/docs/sources/administration/roles-and-permissions/access-control/troubleshooting/index.md b/docs/sources/administration/roles-and-permissions/access-control/troubleshooting/index.md index 006d91496d3..07ad6daf79f 100644 --- a/docs/sources/administration/roles-and-permissions/access-control/troubleshooting/index.md +++ b/docs/sources/administration/roles-and-permissions/access-control/troubleshooting/index.md @@ -27,7 +27,7 @@ filters = accesscontrol:debug accesscontrol.evaluator:debug dashboard.permission ## Enable audit logging {{% admonition type="note" %}} -Available in [Grafana Enterprise]({{< relref "../../../../introduction/grafana-enterprise/" >}}) version 7.3 and later, and [Grafana Cloud](/docs/grafana-cloud). +Available in [Grafana Enterprise](../../../../introduction/grafana-enterprise/) version 7.3 and later, and [Grafana Cloud](/docs/grafana-cloud). {{% /admonition %}} You can enable auditing in the Grafana configuration file. @@ -38,11 +38,11 @@ enabled = true ``` All permission and role updates, and role assignments are added to audit logs. -Learn more about [access control audit logs]({{< relref "../../../../setup-grafana/configure-security/audit-grafana/#access-control" >}}). +Learn more about [access control audit logs](../../../../setup-grafana/configure-security/audit-grafana/#access-control). ## Missing dashboard, folder or data source permissions -[Dashboard and folder permissions]({{< relref "../../#dashboard-permissions" >}}) and [data source permissions]({{< relref "../../#data-source-permissions" >}}) can go out of sync if a Grafana instance version is upgraded, downgraded and then upgraded again. +[Dashboard and folder permissions](../../#dashboard-permissions) and [data source permissions](../../#data-source-permissions) can go out of sync if a Grafana instance version is upgraded, downgraded and then upgraded again. This happens when an instance is downgraded from a version that uses RBAC to a version that uses the legacy access control, and dashboard, folder or data source permissions are updated. These permission updates will not be applied to RBAC, so permissions will be out of sync when the instance is next upgraded to a version with RBAC. diff --git a/docs/sources/administration/service-accounts/index.md b/docs/sources/administration/service-accounts/index.md index 4c3e71f63f3..6cb23e46fd3 100644 --- a/docs/sources/administration/service-accounts/index.md +++ b/docs/sources/administration/service-accounts/index.md @@ -22,7 +22,7 @@ weight: 800 You can use a service account to run automated workloads in Grafana, such as dashboard provisioning, configuration, or report generation. Create service accounts and tokens to authenticate applications, such as Terraform, with the Grafana API. {{% admonition type="note" %}} -Service accounts replace [API keys]({{< relref "../api-keys/" >}}) as the primary way to authenticate applications that interact with Grafana. +Service accounts replace [API keys](../api-keys/) as the primary way to authenticate applications that interact with Grafana. {{% /admonition %}} A common use case for creating a service account is to perform operations on automated or triggered tasks. You can use service accounts to: @@ -32,7 +32,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 "../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](../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. If you have the same task that is needed for multiple organizations, we recommend creating service accounts in each organization. @@ -40,7 +40,7 @@ Service accounts can only act in the organization they are created for. If you h {{< vimeo 742056367 >}} -_Video shows service accounts in Grafana v9.1. Refer to [Create a service account in Grafana]({{< relref "#create-a-service-account-in-grafana" >}}) for current instructions._ +_Video shows service accounts in Grafana v9.1. Refer to [Create a service account in Grafana](#create-a-service-account-in-grafana) for current instructions._ ## Service account tokens @@ -62,19 +62,19 @@ The added benefits of service accounts to API keys include: - Service accounts resemble Grafana users and can be enabled/disabled, granted specific permissions, and remain active until they are deleted or disabled. API keys are only valid until their expiry date. - Service accounts can be associated with multiple tokens. - Unlike API keys, service account tokens are not associated with a specific user, which means that applications can be authenticated even if a Grafana user is deleted. -- You can grant granular permissions to service accounts by leveraging [role-based access control]({{< relref "../roles-and-permissions/access-control/" >}}). For more information about permissions, refer to [About users and permissions]({{< relref "../roles-and-permissions/" >}}). +- You can grant granular permissions to service accounts by leveraging [role-based access control](../roles-and-permissions/access-control/). For more information about permissions, refer to [About users and permissions](../roles-and-permissions/). ## Create a service account in Grafana A service account can be used to run automated workloads in Grafana, like dashboard provisioning, configuration, or report generation. For more information about how you can use service accounts, refer to [About service accounts]({{< ref "#about-service-accounts" >}}). -For more information about creating service accounts via the API, refer to [Create a service account in the HTTP API]({{< relref "../../developers/http_api/serviceaccount/#create-service-account" >}}). +For more information about creating service accounts via the API, refer to [Create a service account in the HTTP API](../../developers/http_api/serviceaccount/#create-service-account). Note that the user who created a service account will also be able to read, update and delete the service account that they created, as well as permissions associated with that service account. ### Before you begin -- Ensure you have permission to create and edit service accounts. By default, the organization administrator role is required to create and edit service accounts. For more information about user permissions, refer to [About users and permissions]({{< relref "../roles-and-permissions/#" >}}). +- Ensure you have permission to create and edit service accounts. By default, the organization administrator role is required to create and edit service accounts. For more information about user permissions, refer to [About users and permissions](../roles-and-permissions/#). ### To create a service account @@ -92,11 +92,11 @@ Note that the user who created a service account will also be able to read, upda A service account token is a generated random string that acts as an alternative to a password when authenticating with Grafana’s HTTP API. For more information about service accounts, refer to [About service accounts in Grafana]({{< ref "#about-service-accounts" >}}). -You can create a service account token using the Grafana UI or via the API. For more information about creating a service account token via the API, refer to [Create service account tokens using the HTTP API]({{< relref "../../developers/http_api/serviceaccount/#create-service-account-tokens" >}}). +You can create a service account token using the Grafana UI or via the API. For more information about creating a service account token via the API, refer to [Create service account tokens using the HTTP API](../../developers/http_api/serviceaccount/#create-service-account-tokens). ### Before you begin -- Ensure you have permission to create and edit service accounts. By default, the organization administrator role is required to create and edit service accounts. For more information about user permissions, refer to [About users and permissions]({{< relref "../roles-and-permissions/#" >}}). +- Ensure you have permission to create and edit service accounts. By default, the organization administrator role is required to create and edit service accounts. For more information about user permissions, refer to [About users and permissions](../roles-and-permissions/#). ### Service account token expiration dates @@ -118,9 +118,9 @@ By default, service account tokens don't have an expiration date, meaning they w ## Assign roles to a service account in Grafana You can assign roles to a Grafana service account to control access for the associated service account tokens. -You can assign roles to a service account using the Grafana UI or via the API. For more information about assigning a role to a service account via the API, refer to [Update service account using the HTTP API]({{< relref "../../developers/http_api/serviceaccount/#update-service-account" >}}). +You can assign roles to a service account using the Grafana UI or via the API. For more information about assigning a role to a service account via the API, refer to [Update service account using the HTTP API](../../developers/http_api/serviceaccount/#update-service-account). -In [Grafana Enterprise]({{< relref "../../introduction/grafana-enterprise/" >}}), you can also [assign RBAC roles]({{< relref "../roles-and-permissions/access-control/assign-rbac-roles" >}}) to grant very specific permissions to applications that interact with Grafana. +In [Grafana Enterprise](../../introduction/grafana-enterprise/), you can also [assign RBAC roles](../roles-and-permissions/access-control/assign-rbac-roles/) to grant very specific permissions to applications that interact with Grafana. {{% admonition type="note" %}} Since Grafana 10.2.0, the `No Basic Role` is available for organization users or service accounts. This role has no permissions. Permissions can be granted with RBAC. @@ -128,7 +128,7 @@ Since Grafana 10.2.0, the `No Basic Role` is available for organization users or ### Before you begin -- Ensure you have permission to update service accounts roles. By default, the organization administrator role is required to update service accounts permissions. For more information about user permissions, refer to [About users and permissions]({{< relref "../roles-and-permissions/#" >}}). +- Ensure you have permission to update service accounts roles. By default, the organization administrator role is required to update service accounts permissions. For more information about user permissions, refer to [About users and permissions](../roles-and-permissions/#). ### To assign a role to a service account @@ -144,7 +144,7 @@ To control what and who can do with the service account you can assign permissio ### Before you begin -- Ensure you have permission to update user and team permissions of a service accounts. By default, the organization administrator role is required to update user and teams permissions for a service account. For more information about user permissions, refer to [About users and permissions]({{< relref "../roles-and-permissions/#" >}}). +- Ensure you have permission to update user and team permissions of a service accounts. By default, the organization administrator role is required to update user and teams permissions for a service account. For more information about user permissions, refer to [About users and permissions](../roles-and-permissions/#). - Ensure you have permission to read teams. ### User and team permissions for a service account @@ -183,7 +183,7 @@ This can help you diagnose permissions-related issues with token authorization. These endpoints provide details on a service account's token. If you haven't added a token to a service account, do so before proceeding. -For details, refer to [Add a token to a service account]({{< relref "#add-a-token-to-a-service-account-in-grafana" >}}). +For details, refer to [Add a token to a service account](#add-a-token-to-a-service-account-in-grafana). ### List a service account token's permissions 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 1bad26e3515..f3edd8ce79b 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**: @@ -81,7 +81,7 @@ If you use Grafana Enterprise and customize users' permissions using RBAC, the R 1. Open the Grafana configuration file. - For more information about the Grafana configuration file and its location, refer to [Configuration]({{< relref "../../../setup-grafana/configure-grafana/" >}}). + For more information about the Grafana configuration file and its location, refer to [Configuration](../../../setup-grafana/configure-grafana/). 1. Locate the `viewers_can_edit` parameter. 1. Set the `viewers_can_edit` value to `true`. @@ -89,7 +89,7 @@ If you use Grafana Enterprise and customize users' permissions using RBAC, the R ## 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 @@ -159,4 +159,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/server-user-management/grant-editor-admin-permissions/index.md b/docs/sources/administration/user-management/server-user-management/grant-editor-admin-permissions/index.md index 875c7babec7..8ec305e378e 100644 --- a/docs/sources/administration/user-management/server-user-management/grant-editor-admin-permissions/index.md +++ b/docs/sources/administration/user-management/server-user-management/grant-editor-admin-permissions/index.md @@ -17,8 +17,8 @@ This setting can be used to enable self-organizing teams to administer their own When `editors_can_admin` is enabled: -- Users with the Editor role in an organization are Administrators for new dashboards and folders they create, meaning they can edit dashboard permissions. To learn more about dashboard permissions, refer to [Manage dashboard permissions]({{< relref "../../manage-dashboard-permissions/" >}}). -- Users with the Editor role in an organization can create teams, and they are Administrators of the teams they create. To learn more about team permissions, refer to [Team management]({{< relref "../../../team-management/" >}}). +- Users with the Editor role in an organization are Administrators for new dashboards and folders they create, meaning they can edit dashboard permissions. To learn more about dashboard permissions, refer to [Manage dashboard permissions](../../manage-dashboard-permissions/). +- Users with the Editor role in an organization can create teams, and they are Administrators of the teams they create. To learn more about team permissions, refer to [Team management](../../../team-management/). {{% admonition type="note" %}} If you use Grafana Enterprise and customize users' permissions using RBAC, the RBAC permissions override the functionality enabled by the `editors_can_admin` flag. @@ -32,7 +32,7 @@ If you use Grafana Enterprise and customize users' permissions using RBAC, the R 1. Log in to the Grafana server and open the Grafana configuration file. - For more information about the Grafana configuration file and its location, refer to [Configuration]({{< relref "../../../../setup-grafana/configure-grafana/" >}}). + For more information about the Grafana configuration file and its location, refer to [Configuration](../../../../setup-grafana/configure-grafana/). 1. Locate the `editors_can_admin` parameter. 1. Set the `editors_can_admin` value to `true`. 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/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 750c713ee19..0fba5ecb356 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/). +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 7203aa87541..13323fd1814 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]({{< relref "../../administration/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]({{< relref "../../administration/api-keys#migrate-api-keys-to-grafana-service-accounts" >}}). +We are upgrading Grafana [API keys](../../administration/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](../../administration/api-keys/#migrate-api-keys-to-grafana-service-accounts). diff --git a/docs/sources/whatsnew/_index.md b/docs/sources/whatsnew/_index.md index d7211700cdf..b7e51ce72a7 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). @@ -83,23 +83,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 df622eac402..b30affed4b9 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" >}} @@ -225,7 +225,7 @@ With this update, we've made the following improvements: To try it out, enable the `publicDashboards` feature toggle. If you’re using Grafana Cloud, and would like to enable this feature, please contact customer support. -To learn more, refer to our [public dashboards documentation]({{< relref "../dashboards/dashboard-public" >}}). +To learn more, refer to our [public dashboards documentation](../../dashboards/dashboard-public/). ### Public dashboards insights @@ -255,7 +255,7 @@ This feature will have a cost by active users after being promoted into general {{% /admonition %}} -To learn more, refer to our [public dashboards documentation]({{< relref "../dashboards/dashboard-public" >}}). +To learn more, refer to our [public dashboards documentation](../../dashboards/dashboard-public/). ## Authentication and authorization @@ -266,11 +266,11 @@ To learn more, refer to our [public dashboards documentation]({{< relref "../das _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 eaf2dd2c16d..b9039c50cce 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](/developers/plugin-tools/introduction/backend-plugins). Next, in this [tutorial](/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](/developers/plugin-tools/introduction/backend-plugins). Next, in this [tutorial](/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 e9009182bd0..ed4c3b08973 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](/developers/plugin-tools/create-a-plugin/extend-a-plugin/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 cab0a2696d4..15fcef3ac7b 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" >}} @@ -50,15 +50,15 @@ You can now easily embed Grafana in other applications by adding a JWT token dir When the JWT token is passed through the request URL to Grafana, Grafana validates and authenticates the token linked to a specific user, allowing access to dashboards which that user can view. To see JWT URL embedding in action, see the [sample project](https://github.com/grafana/grafana-iframe-oauth-sample). -> **Note:** JWT URL Embedding and `allow_embedding` are not available to Grafana Cloud users. For Grafana Cloud, use the [Public Dashboards]({{< relref "../dashboards/dashboard-public" >}}) feature. To enable that, [open a ticket with our Support team](/docs/grafana-cloud/account-management/support/). +> **Note:** JWT URL Embedding and `allow_embedding` are not available to Grafana Cloud users. For Grafana Cloud, use the [Public Dashboards](../../dashboards/dashboard-public/) feature. To enable that, [open a ticket with our Support team](/docs/grafana-cloud/account-management/support/). {{< figure src="/static/img/docs/dashboards/jwt-url-embedding-9-1.png" max-width="750px" caption="A JWT token used to embed Grafana" >}} #### 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" >}} @@ -156,7 +156,7 @@ The public view of a dashboard has a few restrictions: - The public dashboard is displayed in a read-only kiosk view. - The time range is fixed to the dashboard default time range. -To learn more, see the [documentation]({{< relref "../dashboards/dashboard-public" >}}). +To learn more, see the [documentation](../../dashboards/dashboard-public/). #### Provisioning improvements for Grafana Alerting @@ -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 4deeb3a386a..19fc39d0d69 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 f780b4890af..c87f68ab7dc 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,9 +85,9 @@ 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]({{< relref "../dashboards/dashboard-public" >}}). +To learn more about public dashboards, refer to [Public dashboards](../../dashboards/dashboard-public/). ## New transformation: Partition by values @@ -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/).