Grafana Panel - Sign a Private Plugin

Grafana Plugin Development Signing & publishing
1

Hello Everybody,

I built a panel plugin successfully. I could also see it at grafana.
However, it is unsigned.
I tried to signed it, in accord with the tutorials. So, after creating the plugin, I did:
npx @grafana/toolkit plugin:sign --rootUrls http://grafana.staged-by-discourse.com

The rootUrls is correctly set at grafana.ini as:
root_url = http://grafana.staged-by-discourse.com

However, I am getting this error here:

image
image1904Ă—448 38.2 KB

Please, can someone explain to me what I am missing here.

Thanks!
Cheers,
Turtles

2

Looks like you might’ve discovered a bug :beetle:

Does it work if you sign it with a previous version? I think you should be able to run it with a specific version like this:

npx @grafana/toolkit@8.3.4 plugin:sign --rootUrls http://grafana.staged-by-discourse.com
4

Hallo @marcusolsson,

thanks for your help. I even used different versions of @grafana/toolkit I am getting another error. The error message is: Error signing manifest: Token invalid.

image
image1232Ă—214 12.6 KB

What can be invalid token?
The Grafana API Key was created at my grafana local host and is valid for about 6 months.
More information:
System: Ubuntu 20.04.3 LTS
Running on WSL2.
App: sample app template from grafana compiled and build with yarn.
I tried also with npm.

I appreciate any help!
Thank you vey much!
Cheers,
Turtles

5

You need to create an API key using your Grafana Cloud account and use it to sign the private plugin: Sign a plugin | Grafana Labs

6

I have the same issue as the image below with generating an API key on localhost Grafana.

I don’t think generating an API on Grafana cloud account will help it work on local Grafana. I’ve tried generating it on cloud even with --rootUrls http://127.0.0.1:3000 and the plugin doesn’t show up anymore in local Grafana (even in dev mode) once you sign it.

So is there no solution to this? If you host your own Grafana server you’re unable to use Private plugins?

7

@jn6091 When plugin signed it creates MANIFEST file with all included files and their properties. If any of the files modified, it will be skipped and plugin should be resigned.

If you enable the Dev mode, MANIFEST file should be deleted. It was recently updated in the documentation.

If you do the provided steps in the correct order, plugin should be loaded successfully.
You can take a look at our Panel template for example: GitHub - VolkovLabs/volkovlabs-abc-panel: Template to create a new @grafana panel plugin.

8

Here is the process i took:

  • Started grafana in production mode
  • cd /var/lib/grafana/plugins
  • npx @grafana/toolkit plugin:create randomname-defaultplugin
  • cd randomname-defaultplugin
  • yarn install
  • yarn dev
  • yarn build
  • Generated API key on grafana cloud account https://grafana.com/orgs/<username>/api-keys
  • export GRAFANA_API_KEY=<generated_key>
  • yarn sign --rootUrls http://127.0.0.1:3000
  • service grafana-server restart

This process above signs it successfully however the plugin does not show in the http://127.0.0.1:3000/plugins url.

9

I just followed your steps and saw the error that plugin was signed for “http://127.0.0.1:3000” when I have Grafana configured for “http://grafana.staged-by-discourse.com”. Do you see similar error when trying to load plugin? If you do, you should sign it with the correct Server Name.

grafana    | logger=plugin.loader t=2022-03-14T16:58:41.76+0000 lvl=warn msg="Could not find root URL that matches running application URL" plugin=volkovlabs-randomname-defaultplugin appUrl=http://grafana.staged-by-discourse.com/ rootUrls="unsupported value type"
grafana    | logger=plugin.loader t=2022-03-14T16:58:41.76+0000 lvl=warn msg="Skipping loading plugin due to problem with signature" pluginID=volkovlabs-randomname-defaultplugin status=invalid
1 Like
10

Indeed that was the issue. After signing it with http://grafana.staged-by-discourse.com instead of http://127.0.0.1:3000 it works now. Thank you very much!

1 Like
11

Hi there,
sorry for stealing this topic (I can create a new one if you find it necessary).
I’m following the steps from @jn6091

Possible differences:

  • Using Windows OS (git bash)
  • replacing the 127.0.0.0 for localhost
  • Not using the grafana plugins directory, I’ve a development directory and then copy the dist content directory to the grafana plugins directory

And I’m getting the error:

Error signing manifest: Token invalid

image
image1419Ă—941 73.5 KB

The API Key I used was generated at https://randomname.grafana.net/org/apikeys today and will expire in 2023.

Could you please indicate how can I identify why the token is invalid?

Thanks,
LuĂ­s Pinho

12

Did you manage to solve the issue ? And how did you solve it?

13

Don’t use Grafana API key (that’s for access to Grafana). Use Grafana Cloud API key (with correct role: PluginPublisher).

https://grafana.com/orgs/<your-grafana-cloud-org-here>/api-keys
14

Yes I did use Cloud API key. First I want to point out that Grafana will be running localy alwasy.

15

You should be able to sign it by following the guides here:

Sign a plugin (setup)

and

signing a private plugin