Skip to content

Commit

Permalink
chore: Grafana Labs review changes
Browse files Browse the repository at this point in the history
* Grafana labs declined to published plugin due to similar offering on their enterprise edition

* Update README about how to install plugin as an unsigned one

* Fix plugin installation script

* Remove policy_token input var from release workflow. We are not going to sign plugin in CI

Signed-off-by: Mahendra Paipuri <mahendra.paipuri@gmail.com>
  • Loading branch information
mahendrapaipuri committed Feb 2, 2024
1 parent d3096bb commit 8ec2272
Show file tree
Hide file tree
Showing 4 changed files with 23 additions and 9 deletions.
6 changes: 3 additions & 3 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -98,8 +98,8 @@ jobs:
uses: softprops/action-gh-release@v1
with:
prerelease: true
name: review
tag_name: review
name: nightly
tag_name: nightly
files: |
mahendrapaipuri-dashboardreporter-app.zip
mahendrapaipuri-dashboardreporter-app.zip.sha1
Expand All @@ -108,4 +108,4 @@ jobs:
# Latest Build Complete! :rocket:
For the public download links of these build artifacts, please see:
<https://github.com/mahendrapaipuri/grafana-dashboard-reporter-app/releases/tag/review>
<https://github.com/mahendrapaipuri/grafana-dashboard-reporter-app/releases/tag/nightly>
2 changes: 1 addition & 1 deletion .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,4 +15,4 @@ jobs:
- uses: actions/checkout@v3
- uses: grafana/plugin-actions/build-plugin@release
with:
policy_token: ${{ secrets.GRAFANA_ACCESS_POLICY_TOKEN }} # Requires a Grafana access policy token from Grafana.com.
policy_token: '' # We cannot sign plugin as it will not be published in grafana catalog
4 changes: 2 additions & 2 deletions scripts/bootstrap-dashboard-reporter-app.sh
Original file line number Diff line number Diff line change
Expand Up @@ -24,5 +24,5 @@ fi

echo "The latest release tag of $REPO_NAME is: $LATEST_RELEASE_TAG"

curl -L https://github.com/mahendrapaipuri/grafana-dashboard-reporter-app/releases/download/$LATEST_RELEASE_TAG/influxdata-flightsql-datasource-$VERSION.zip --output dashboard-reporter-app.zip
unzip dashboard-reporter-app.zip -d .
curl -L https://github.com/mahendrapaipuri/grafana-dashboard-reporter-app/releases/download/$LATEST_RELEASE_TAG/mahendrapaipuri-dashboardreporter-app.zip --output mahendrapaipuri-dashboardreporter-app.zip
unzip mahendrapaipuri-dashboardreporter-app.zip -d .
20 changes: 17 additions & 3 deletions src/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,18 @@ panels into PNG files

### Installation via `grafana-cli`

TODO
Grafana Enterprise offers a very similar plugin [reports](https://grafana.com/docs/grafana/latest/dashboards/create-reports/#export-dashboard-as-pdf)
and hence, their plugin policies do not allow to publish the current plugin in their
official catalog.

It is important to note that the current plugin do not offer all the functionalities
offered by Enterprise plugin and it is only relevant if users would like to create a
PDF report of a given dashboard. If users needs more advanced functionalities like
generating and sending reports automatically, they should look into official plugin.

However, it is still possible to install this plugin on on-premise Grafana installations
as an unsigned plugin. The installation procedure is briefed in
[Local installation](#local-installation) section below.

### Local installation

Expand All @@ -39,9 +50,12 @@ plugin directory:

```
cd /var/lib/grafana/plugins
./scripts/bootstrap-dashboard-reporter-app.sh
curl https://raw.githubusercontent.com/mahendrapaipuri/grafana-dashboard-reporter-app/grafana_labs_review/scripts/bootstrap-dashboard-reporter-app.sh | bash
```

This will install the plugin in the `/var/lib/grafana/plugins` folder and upon Grafana
restart, the plugin will be loaded.

The current example assumes the following configuration is set for Grafana

- Edit the `paths.plugins` directive in your `grafana.ini`:
Expand Down Expand Up @@ -75,7 +89,7 @@ want to create a PDF report. After the user authenticates with Grafana, creating
dashboard report is done by visiting the following end point

```
<grafanaAppUrl>/api/plugins/dashboard-reporter-app/resources/api?dashUid=<UID of dashboard>
<grafanaAppUrl>/api/plugins/mahendrapaipuri-reporter-app/resources/api?dashUid=<UID of dashboard>
```

In addition to `dashUid` query parameter, it is possible to pass time range query
Expand Down

0 comments on commit 8ec2272

Please sign in to comment.