create-plugin
工具包括一个以Docker为特色的开发环境。它允许您为插件开发人员启动Grafana应用程序的实例,您可以根据该实例编写代码。
信息 在开发过程中不需要签署插件。使用
@grafana/create-plugin
脚手架的Docker开发环境将在没有签名的情况下加载插件。这是因为它默认配置为在开发模式下运行。
为什么要使用Docker环境
我们选择使用Docker,因为它简化了创建、部署和运行应用程序的过程。它允许您为您的插件创建一致和孤立的环境。这使得管理依赖项变得容易,并确保插件在不同的机器上以相同的方式运行。
使用create-plugin
工具,Docker容器配置了必要的变量,以便轻松访问Grafana,并无需签名即可加载插件。该插件工具还添加了实时重新加载功能,允许您更改前端代码以在浏览器中触发刷新。
开始使用Docker
要启动您的插件开发项目,请按照列出的顺序运行以下命令:
pnpm install
:安装前端依赖项。pnpm run dev
:构建并观看插件前端代码。mage -v build:linux
:构建插件后端代码。每次编辑后端文件时,请重新运行此命令。pnpm run server
:启动在http://localhost:3000上运行的Grafana开发服务器。每次运行mage
以运行新的后端代码时,请重新启动此命令。
配置Grafana版本
要在不同版本的Grafana上测试插件,请设置一个环境变量。使用GRAFANA_VERSION
设置Grafana版本:
- npm
GRAFANA_VERSION=10.0.0 npm run server
- pnpm
GRAFANA_VERSION=10.0.0 pnpm run server
- yarn
GRAFANA_VERSION=10.0.0 pnpm run server
配置Grafana镜像
插件工具中的默认Docker镜像是grafana-enterprise
。如果您想覆盖此图像,请通过更改grafana_image
构建参数来更改docker-compose.yaml
,例如:
docker-compose.yaml
version: '3.7'
services:
grafana:
container_name: 'myorg-basic-app'
build:
context: ./.config
args:
grafana_version: ${GRAFANA_VERSION:-9.1.2}
grafana_image: ${GRAFANA_IMAGE:-grafana}
此示例将环境变量GRAFANA_IMAGE
分配给默认值为grafana
的构建arg grafana_image
。这为您提供了在运行docker-compose
命令时设置值的选项。