Merge pull request #3 from NeedleInAJayStack/feature/deployment

Deployment script for private distribution

Author: NeedleInAJayStack

.gitignore

@@ -33,3 +33,6 @@ e2e-results/
 
 .eslintcache
 pkg/.env
+
+# Private plugin releases
+release/

README.md

@@ -5,6 +5,11 @@ This is a [Grafana](https://grafana.com/grafana/) plugin that supports direct co
 and supports standard Haystack API operations as well as custom Axon execution, which is supported by
 [SkySpark](https://skyfoundry.com/product) and [Haxall](https://haxall.io/).
 
+## Installation
+
+Long term, the goal is to get this into the Grafana plugin repository. Until then, I must manually sign the plugin
+for your particular Grafana URL. If interested, please contact me at NeedleInAJayStack@protonmail.com.
+
 ## Usage
 
 To use this package, you should already have a working Grafana server. For instructions on how to install and configure
@@ -19,5 +24,7 @@ Contributions are very welcome! For details on how to develop this plugin, see t
 
 ## Continuing Work
 
+* [ ] Check variable support
+* [ ] Add alert support
 * [ ] Publish plugin
 * [ ] Consider enabling multi-point hisRead (through filters)

package.sh

@@ -0,0 +1,84 @@
+#! /bin/bash
+
+# This creates a deploy-able plugin zip file in the release directory.
+# 
+# Installation instructions:
+# 1. Determine the Grafana server URL. This may not be the public URL, and are defined in the `server` section
+#    of the Settings page or grafana.ini file. For example, the server URL may be http://localhost:3000.
+# 2. Run this script with the server URL.
+# 3. Copy the zip file to the machine hosting grafana and unzip into the grafana plugins directory 
+#    (/var/lib/grafana/plugins on linux).
+# 4. Restart grafana.
+
+set -eo pipefail
+
+usage() {
+cat << EOF
+Usage: $0 -u [root_urls] -k [api_key]
+
+Packages the project as a "private" plugin so it may be used on a grafana server.
+The end result is a zip file in the 'release' directory containing the plugin.
+
+Unfortunately, only NeedleInAJayStack can run this since the API key cloud account must match the datasource name.
+This is a workaround until the package is approved as a "public" plugin by Grafana.
+
+-u  root_urls:   Comma separated list of root urls for the grafana server.
+-k  api_key:     API key for the grafana server.
+EOF
+exit 1
+}
+
+# This follows the gitlab release.yml file.
+main() {
+  export GRAFANA_API_KEY=${api_key}
+
+  # Install dependencies
+  yarn install --immutable --prefer-offline
+
+  # Build and test frontend
+  yarn build
+
+  # Test backend
+  mage coverage
+
+  # Build backend
+  mage buildAll
+
+  # Sign plugin
+  npx --yes @grafana/sign-plugin --rootUrls ${rootUrls}
+
+  # Get plugin metadata
+  plugin_id=$(cat dist/plugin.json | jq -r .id)
+  archive=${plugin_id}.zip
+
+  # Package plugin
+  mv -f dist ${plugin_id}
+
+  if [ ! -d "release" ]; then
+    mkdir release
+  fi
+  zip release/${archive} ${plugin_id} -r
+
+  # Cleanup
+  rm -r ${plugin_id}
+}
+
+while getopts ":k:u:" option; do
+  case "$option" in
+    k) 
+      readonly api_key=${OPTARG}
+      ;;
+    u)
+      readonly rootUrls=${OPTARG}
+      ;;
+    *) 
+      usage
+      ;;
+  esac
+done
+
+if [ -z "${rootUrls}" ] || [ -z "${api_key}" ]; then
+    usage
+fi
+
+main

src/README.md

@@ -9,10 +9,6 @@ and supports standard Haystack API operations as well as custom Axon execution,
 
 ## Usage
 
-### Installation
-
-TODO
-
 ### Create a Data Source
 
 To create a new data source, select `Data Sources` from the Configuration menu represented by the gear icon on the left