mirror of
https://github.com/grafana/grafana.git
synced 2025-07-28 07:52:16 +08:00
Docs: Replace links with relrefs (#32916)
* Update configuration.md * Update set-up-for-high-availability.md * Update glossary.md * Update glossary.md * Update cloudwatch.md * Update add-authentication-for-data-source-plugins.md * Update add-support-for-explore-queries.md * fix links * fix links * Update license-expiration.md * Update license-restrictions.md * Update _index.md * Update trace-integration.md * Update admin.md * Update graph-time-series-as-bars.md * Update graph-time-series-as-bars.md * Update graph-time-series-as-lines.md * Update graph-time-series-as-points.md * Update release-notes-7-3-0.md * fix links * fix links
This commit is contained in:
Diana Payton
@ -1,6 +1,6 @@
|
||||
+++
|
||||
title = "Add authentication for data source plugins"
|
||||
aliases = ["/docs/grafana/next/plugins/developing/auth-for-datasources/", "/docs/grafana/next/developers/plugins/authentication/"]
|
||||
aliases = ["/docs/grafana/next/plugins/developing/auth-for-datasources/", "/docs/grafana/next/developers/plugins/authentication/"]
|
||||
+++
|
||||
|
||||
# Add authentication for data source plugins
|
||||
@ -11,7 +11,7 @@ When a user saves a password or any other sensitive data as a data source option
|
||||
|
||||
To minimize the amount of sensitive information sent to and from the browser, data source plugins can use the Grafana _data source proxy_. When using the data source proxy, any requests containing sensitive information go through the Grafana server. No sensitive data is sent to the browser after the data is saved.
|
||||
|
||||
Some data sources, like [Prometheus](https://grafana.com/docs/grafana/next/features/datasources/prometheus/) and [InfluxDB](https://grafana.com/docs/grafana/next/features/datasources/influxdb/), allow users to configure whether to use the data source proxy, through a setting called _access modes_.
|
||||
Some data sources, like [Prometheus]({{< relref "../../datasources/prometheus.md" >}}) and [InfluxDB]({{< relref "../../datasources/influxdb" >}}), allow users to configure whether to use the data source proxy, through a setting called _access modes_.
|
||||
|
||||
## Add a proxy route to your plugin
|
||||
|
||||
|
||||
@ -101,4 +101,4 @@ const firstResult = new MutableDataFrame({
|
||||
});
|
||||
```
|
||||
|
||||
For possible options, refer to [PreferredVisualisationType](https://grafana.com/docs/grafana/next/packages_api/data/preferredvisualisationtype/).
|
||||
For possible options, refer to [PreferredVisualisationType](https://grafana.com/docs/grafana/latest/packages_api/data/preferredvisualisationtype/).
|
||||
|
||||
@ -76,7 +76,7 @@ Now, when users write `$service`, the query looks like this:
|
||||
SELECT * FROM services WHERE id IN (admin,auth,billing)
|
||||
```
|
||||
|
||||
For more information on the available variable formats, refer to [Advanced variable format options](https://grafana.com/docs/grafana/next/variables/advanced-variable-format-options/).
|
||||
For more information on the available variable formats, refer to [Advanced variable format options]({{< relref "../../variables/advanced-variable-format-options.md" >}}).
|
||||
|
||||
## Set a variable from your plugin
|
||||
|
||||
|
||||
@ -49,7 +49,7 @@ The resources capability allows a backend plugin to handle custom HTTP requests
|
||||
|
||||
Examples of use cases for implementing resources:
|
||||
|
||||
- Implement a custom data source proxy in case certain authentication/authorization or other requirements are required/needed that are not supported in Grafana's [built-in data proxy](https://grafana.com/docs/grafana/next/http_api/data_source/#data-source-proxy-calls).
|
||||
- Implement a custom data source proxy in case certain authentication/authorization or other requirements are required/needed that are not supported in Grafana's [built-in data proxy]({{< relref "../../../http_api/data_source.md#data-source-proxy-calls" >}}).
|
||||
- Return data or information in a format suitable to use within a data source query editor to provide auto-complete functionality.
|
||||
- Return static resources, such as images or files.
|
||||
- Send a command to a device, such as a micro controller or IOT device.
|
||||
|
||||
@ -33,7 +33,7 @@ The plugin.json file is required for all plugins. When Grafana starts, it scans
|
||||
| `metrics` | boolean | No | For data source plugins. If the plugin supports metric queries. Used in the Explore feature. |
|
||||
| `preload` | boolean | No | Initialize plugin on startup. By default, the plugin initializes on first use. |
|
||||
| `queryOptions` | [object](#queryoptions) | No | For data source plugins. There is a query options section in the plugin's query editor and these options can be turned on if needed. |
|
||||
| `routes` | [object](#routes)[] | No | For data source plugins. Proxy routes used for plugin authentication and adding headers to HTTP requests made by the plugin. For more information, refer to [Authentication for data source plugins](https://grafana.com/docs/grafana/next/developers/plugins/authentication/). |
|
||||
| `routes` | [object](#routes)[] | No | For data source plugins. Proxy routes used for plugin authentication and adding headers to HTTP requests made by the plugin. For more information, refer to [Add authentication for data source plugins]({{< relref "add-authentication-for-data-source-plugins.md">}}). |
|
||||
| `skipDataQuery` | boolean | No | For panel plugins. Hides the query editor. |
|
||||
| `state` | string | No | Marks a plugin as a pre-release. Possible values are: `alpha`, `beta`. |
|
||||
| `streaming` | boolean | No | For data source plugins. If the plugin supports streaming. |
|
||||
@ -168,7 +168,7 @@ For data source plugins. There is a query options section in the plugin's query
|
||||
|
||||
## routes
|
||||
|
||||
For data source plugins. Proxy routes used for plugin authentication and adding headers to HTTP requests made by the plugin. For more information, refer to [Authentication for data source plugins](https://grafana.com/docs/grafana/next/developers/plugins/authentication/).
|
||||
For data source plugins. Proxy routes used for plugin authentication and adding headers to HTTP requests made by the plugin. For more information, refer to [Add authentication for data source plugins]({{< relref "add-authentication-for-data-source-plugins.md">}}).
|
||||
|
||||
### Properties
|
||||
|
||||
|
||||
@ -141,9 +141,9 @@ Before 7.0, data source and panel plugins exchanged data using either time serie
|
||||
|
||||
Grafana 7.0 is backward compatible with the old data format used in previous versions. Panels and data sources using the old format will still work with plugins using the new data frame format.
|
||||
|
||||
The `DataQueryResponse` returned by the `query` method can be either a [LegacyResponseData](https://grafana.com/docs/grafana/next/packages_api/data/legacyresponsedata/) or a [DataFrame](https://grafana.com/docs/grafana/next/packages_api/data/dataframe/).
|
||||
The `DataQueryResponse` returned by the `query` method can be either a [LegacyResponseData](https://grafana.com/docs/grafana/latest/packages_api/data/legacyresponsedata/) or a [DataFrame](https://grafana.com/docs/grafana/latest/packages_api/data/dataframe/).
|
||||
|
||||
The [toDataFrame()](https://grafana.com/docs/grafana/next/packages_api/data/todataframe/) function converts a legacy response, such as `TimeSeries` or `Table`, to a `DataFrame`. Use it to gradually move your code to the new format.
|
||||
The [toDataFrame()](https://grafana.com/docs/grafana/latest/packages_api/data/todataframe/) function converts a legacy response, such as `TimeSeries` or `Table`, to a `DataFrame`. Use it to gradually move your code to the new format.
|
||||
|
||||
```ts
|
||||
import { toDataFrame } from '@grafana/data';
|
||||
@ -160,8 +160,8 @@ async query(options: DataQueryRequest<MyQuery>): Promise<DataQueryResponse> {
|
||||
}
|
||||
```
|
||||
|
||||
For more information, refer to [Data frames](https://grafana.com/docs/grafana/next/developers/plugins/data-frames/).
|
||||
For more information, refer to [Data frames]({{< relref "data-frames.md">}}).
|
||||
|
||||
## Troubleshoot plugin migration
|
||||
|
||||
With Grafana 7.0, backend plugins can now be cryptographically signed to verify their origin. By default, Grafana will ignore unsigned plugins. For more information, refer to [Allow unsigned plugins]({{< relref "../../plugins/plugin-signatures.md#allow-unsigned-plugins" >}}).
|
||||
As of Grafana 7.0, backend plugins can now be cryptographically signed to verify their origin. By default, Grafana ignores unsigned plugins. For more information, refer to [Allow unsigned plugins]({{< relref "../../plugins/plugin-signatures.md#allow-unsigned-plugins" >}}).
|
||||
|
||||
@ -322,10 +322,10 @@
|
||||
},
|
||||
"routes": {
|
||||
"type": "array",
|
||||
"description": "For data source plugins. Proxy routes used for plugin authentication and adding headers to HTTP requests made by the plugin. For more information, refer to [Authentication for data source plugins](https://grafana.com/docs/grafana/next/developers/plugins/authentication/).",
|
||||
"description": "For data source plugins. Proxy routes used for plugin authentication and adding headers to HTTP requests made by the plugin. For more information, refer to [Authentication for data source plugins](https://grafana.com/docs/grafana/latest/developers/plugins/authentication/).",
|
||||
"items": {
|
||||
"type": "object",
|
||||
"description": "For data source plugins. Proxy routes used for plugin authentication and adding headers to HTTP requests made by the plugin. For more information, refer to [Authentication for data source plugins](https://grafana.com/docs/grafana/next/developers/plugins/authentication/).",
|
||||
"description": "For data source plugins. Proxy routes used for plugin authentication and adding headers to HTTP requests made by the plugin. For more information, refer to [Authentication for data source plugins](https://grafana.com/docs/grafana/latest/developers/plugins/authentication/).",
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"path": {
|
||||
|
||||
Reference in New Issue
Block a user