mirror of
https://github.com/grafana/grafana.git
synced 2025-07-28 02:42:08 +08:00
Docs: Plugins doc reorganization, part 1 (#69864)
* Initial commit * Prettier fixes * Doc-validator fixes part 1 * Doc-validator fixes part 2 * More doc-validator fixes * More doc-validator fixes * Test * link test * Linnk test * Link test * More fixes * More fixes * Doc-validator fixes * Doc-validator fixes * fix broken link * Fix * Testing * Doc fixes * Link fixes * Fix links * Update docs/sources/developers/plugins/create-a-grafana-plugin/_index.md Co-authored-by: David Harris <david.harris@grafana.com> * Testing * Testing * Testing * Testing * Doc-validator fixes * Doc-validator fixes * Doc-validator fixes * Fix broken links for plugins reorganization project * Prettier fixes * Prettier fixes * Incorporate reviewer feedback * Link fixes * Link fixes * Link fixes * Link fix * Deleted space * Codeowners fix * Change grafana.com links to absolute URLs for Hugo --------- Co-authored-by: David Harris <david.harris@grafana.com>
This commit is contained in:
Joseph Perez
@ -1,13 +1,15 @@
|
||||
---
|
||||
title: Migrate a plugin
|
||||
aliases:
|
||||
- ../../plugins/developing/migration-guide
|
||||
description: A guide for migrating and updating a Grafana plugin.
|
||||
keywords:
|
||||
- grafana
|
||||
- plugins
|
||||
- migration
|
||||
- plugin
|
||||
- documentation
|
||||
title: Migration guides
|
||||
weight: 500
|
||||
---
|
||||
|
||||
<script>
|
||||
@ -34,7 +36,7 @@ title: Migration guides
|
||||
})();
|
||||
</script>
|
||||
|
||||
# Plugin migration guide
|
||||
# Migrate a plugin
|
||||
|
||||
The following guides help you identify the steps required to update a plugin following changes between versions of Grafana.
|
||||
|
||||
|
||||
@ -1,13 +1,13 @@
|
||||
---
|
||||
description: Guide for migrating plugins from AngularJS to React
|
||||
title: Migrate a plugin from AngularJS to React
|
||||
menuTitle: Angular to React
|
||||
description: Guide for migrating plugins from AngularJS to React.
|
||||
keywords:
|
||||
- grafana
|
||||
- plugins
|
||||
- migration
|
||||
- plugin
|
||||
- documentation
|
||||
title: Migrate plugins from AngularJS to React
|
||||
menutitle: Angular to React
|
||||
weight: 1000
|
||||
---
|
||||
|
||||
|
||||
@ -1,4 +1,6 @@
|
||||
---
|
||||
title: Migrate plugins from Grafana version 6.x to 7.0
|
||||
menuTitle: v6.x to v7.x
|
||||
description: Guide for migrating plugins from Grafana v6.x to v7.x
|
||||
keywords:
|
||||
- grafana
|
||||
@ -6,8 +8,6 @@ keywords:
|
||||
- migration
|
||||
- plugin
|
||||
- documentation
|
||||
title: Migrate plugins from Grafana version 6.x to 7.x
|
||||
menutitle: v6.x to v7.x
|
||||
weight: 2500
|
||||
---
|
||||
|
||||
@ -23,7 +23,7 @@ Plugins built using Angular still work in the near term, but we strongly encoura
|
||||
|
||||
### New data format
|
||||
|
||||
Along with the move to React, the new plugin platform introduced a new internal data format called [data frames](data-frames.md).
|
||||
Along with the move to React, the new plugin platform introduced a new internal data format called [data frames]({{< relref "../../introduction-to-plugin-development/data-frames" >}}).
|
||||
|
||||
Previously, data source plugins could send data either as time series or tables. With data frames, data sources can send any data in a table-like structure. This gives you more flexibility to visualize your data in Grafana.
|
||||
|
||||
@ -78,7 +78,7 @@ async query(options: DataQueryRequest<MyQuery>): Promise<DataQueryResponse> {
|
||||
|
||||
## Troubleshoot plugin migration
|
||||
|
||||
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 "../../../../administration/plugin-management/#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 "../../../../administration/plugin-management#allow-unsigned-plugins" >}}).
|
||||
|
||||
## From version 6.5.x to 7.3.0
|
||||
|
||||
|
||||
@ -1,13 +1,13 @@
|
||||
---
|
||||
description: Guide for migrating plugins from Grafana v7.x to v8.x
|
||||
title: Migrate plugins from Grafana version 7.x.x to 8.x.x
|
||||
menuTitle: v7.x to v8.x
|
||||
description: Guide for migrating plugins from Grafana v7.x to v8.x.
|
||||
keywords:
|
||||
- grafana
|
||||
- plugins
|
||||
- migration
|
||||
- plugin
|
||||
- documentation
|
||||
title: Migrate plugins from Grafana version 7.x to 8.x
|
||||
menutitle: v7.x to v8.x
|
||||
weight: 2400
|
||||
---
|
||||
|
||||
@ -154,9 +154,9 @@ func (d *SampleDatasource) CheckHealth(_ context.Context, req *backend.CheckHeal
|
||||
|
||||
We strongly recommend that you not allow unsigned plugins in your Grafana installation. By allowing unsigned plugins, we can't guarantee the authenticity of the plugin, which could compromise the security of your Grafana installation.
|
||||
|
||||
To sign your plugin, see [Sign a plugin](https://grafana.com/docs/grafana/latest/developers/plugins/sign-a-plugin/#sign-a-plugin).
|
||||
To sign your plugin, see [Sign a plugin]({{< relref "../../publish-a-plugin/sign-a-plugin.md" >}}).
|
||||
|
||||
You can still run and develop an unsigned plugin by running your Grafana instance in [development mode](https://grafana.com/docs/grafana/latest/administration/configuration/#app_mode). Alternatively, you can use the [allow_loading_unsigned_plugins]({{< relref "../../../../setup-grafana/configure-grafana/#allow_loading_unsigned_plugins" >}}) configuration setting.
|
||||
You can still run and develop an unsigned plugin by running your Grafana instance in [development mode](/docs/grafana/latest/administration/configuration/#app_mode). Alternatively, you can use the [allow_loading_unsigned_plugins]({{< relref "../../../../setup-grafana/configure-grafana#allow_loading_unsigned_plugins" >}}) configuration setting.
|
||||
|
||||
## Update react-hook-form from v6 to v7
|
||||
|
||||
@ -198,7 +198,7 @@ import { cx, css } from '@emotion/css';
|
||||
|
||||
## Update needed for app plugins using dashboards
|
||||
|
||||
To make side navigation work properly - app plugins targeting Grafana `8.+` and integrating into the side menu via [addToNav]({{< relref "../../metadata/#properties-4" >}}) property need to adjust their `plugin.json` and all dashboard json files to have a matching `uid`.
|
||||
To make side navigation work properly - app plugins targeting Grafana `8.+` and integrating into the side menu via [addToNav]({{< relref "../../metadata#properties-4" >}}) property need to adjust their `plugin.json` and all dashboard json files to have a matching `uid`.
|
||||
|
||||
**`plugin.json`**
|
||||
|
||||
|
||||
@ -1,4 +1,6 @@
|
||||
---
|
||||
title: Migrate plugins from Grafana version 8.3.x to 8.4.x
|
||||
menuTitle: v8.3.x to v8.4.x
|
||||
description: Guide for migrating plugins from Grafana v8.3.x to v8.4.x
|
||||
keywords:
|
||||
- grafana
|
||||
@ -6,8 +8,6 @@ keywords:
|
||||
- migration
|
||||
- plugin
|
||||
- documentation
|
||||
title: Migrate plugins from Grafana version 8.3.x to 8.4.x
|
||||
menutitle: v8.3.x to v8.4.x
|
||||
weight: 2200
|
||||
---
|
||||
|
||||
|
||||
@ -1,4 +1,6 @@
|
||||
---
|
||||
title: Migrate plugins from Grafana version 8.x to 9.x
|
||||
menuTitle: v8.x to v9.x
|
||||
description: Guide for migrating plugins from Grafana v8.x to v9.x
|
||||
keywords:
|
||||
- grafana
|
||||
@ -6,8 +8,6 @@ keywords:
|
||||
- migration
|
||||
- plugin
|
||||
- documentation
|
||||
title: Migrate plugins from Grafana version 8.x to 9.x
|
||||
menutitle: v8.x to v9.x
|
||||
weight: 2300
|
||||
---
|
||||
|
||||
@ -73,7 +73,7 @@ We have removed the deprecated `getFormStyles` function from [grafana-ui](https:
|
||||
|
||||
### `/api/ds/query` replaces `/api/tsdb/query`
|
||||
|
||||
We have removed the deprecated `/api/tsdb/query` metrics endpoint. Use [/api/ds/query]({{< relref "../../../http_api/data_source/#query-a-data-source" >}}) instead.
|
||||
We have removed the deprecated `/api/tsdb/query` metrics endpoint. Use [/api/ds/query]({{< relref "../../../http_api/data_source#query-a-data-source" >}}) instead.
|
||||
|
||||
### `selectOptionInTest` has been removed
|
||||
|
||||
|
||||
@ -1,4 +1,6 @@
|
||||
---
|
||||
title: Migrate plugins from Grafana version 9.1.x to 9.2.x
|
||||
menuTitle: v9.1.x to v9.2.x
|
||||
description: Guide for migrating plugins from Grafana v9.1.x to v9.2.x
|
||||
keywords:
|
||||
- grafana
|
||||
@ -6,8 +8,6 @@ keywords:
|
||||
- migration
|
||||
- plugin
|
||||
- documentation
|
||||
title: Migrate plugins from Grafana 9.1.x to 9.2.x
|
||||
menutitle: v9.1.x to v9.2.x
|
||||
weight: 2100
|
||||
---
|
||||
|
||||
|
||||
@ -1,4 +1,6 @@
|
||||
---
|
||||
title: Migrate plugins from Grafana 9.3.x to 9.4.x
|
||||
menuTitle: v9.3.x to v9.4.x
|
||||
description: Guide for migrating plugins from Grafana v9.3.x to v9.4.x
|
||||
keywords:
|
||||
- grafana
|
||||
@ -6,8 +8,6 @@ keywords:
|
||||
- migration
|
||||
- plugin
|
||||
- documentation
|
||||
title: Migrate plugins from Grafana 9.3.x to 9.4.x
|
||||
menutitle: v9.3.x to v9.4.x
|
||||
weight: 2000
|
||||
---
|
||||
|
||||
@ -144,8 +144,8 @@ useEffect(() => {
|
||||
|
||||
## Forwarded HTTP headers in the plugin SDK for Go
|
||||
|
||||
We recommended to use the `<request>.GetHTTPHeader` or `<request>.GetHTTPHeaders` methods when retrieving forwarded HTTP headers. See [Forward OAuth identity for the logged-in user]({{< relref "add-authentication-for-data-source-plugins.md#forward-oauth-identity-for-the-logged-in-user" >}}), [Forward cookies for the logged-in user
|
||||
]({{< relref "add-authentication-for-data-source-plugins.md#forward-cookies-for-the-logged-in-user" >}}) or [Forward user header for the logged-in user]({{< relref "add-authentication-for-data-source-plugins.md#forward-user-header-for-the-logged-in-user" >}}) for example usages.
|
||||
We recommended to use the `<request>.GetHTTPHeader` or `<request>.GetHTTPHeaders` methods when retrieving forwarded HTTP headers. See [Forward OAuth identity for the logged-in user]({{< relref "../../create-a-grafana-plugin/extend-a-plugin/add-authentication-for-data-source-plugins.md#forward-oauth-identity-for-the-logged-in-user" >}}), [Forward cookies for the logged-in user
|
||||
]({{< relref "../../create-a-grafana-plugin/extend-a-plugin/add-authentication-for-data-source-plugins.md#forward-user-header-for-the-logged-in-user" >}}) or [Forward user header for the logged-in user]({{< relref "../../create-a-grafana-plugin/extend-a-plugin/add-authentication-for-data-source-plugins.md#forward-user-header-for-the-logged-in-user" >}}) for example usages.
|
||||
|
||||
### Technical details
|
||||
|
||||
|
||||
@ -1,4 +1,6 @@
|
||||
---
|
||||
title: Migrate plugins from Grafana version 9.x to 10.x
|
||||
menuTitle: v9.x to v10.x
|
||||
description: Guide for migrating plugins from Grafana v9.x to v10.x
|
||||
keywords:
|
||||
- grafana
|
||||
@ -6,8 +8,6 @@ keywords:
|
||||
- migration
|
||||
- plugin
|
||||
- documentation
|
||||
title: Migrate plugins from Grafana 9.x to 10.x
|
||||
menutitle: v9.x to v10.x
|
||||
weight: 1900
|
||||
---
|
||||
|
||||
|
||||
Reference in New Issue
Block a user