@grafana/create-plugin 4.3.0-canary.832.a1f8d8a.0 → 4.3.0

package/CHANGELOG.md

@@ -1,3 +1,20 @@
+# v4.3.0 (Fri Mar 22 2024)
+
+#### 🚀 Enhancement
+
+- Create Plugin: add support for remote debugging in docker dev env [#809](https://github.com/grafana/plugin-tools/pull/809) ([@oshirohugo](https://github.com/oshirohugo))
+
+#### 🐛 Bug Fix
+
+- Add condition about backend to success message [#830](https://github.com/grafana/plugin-tools/pull/830) ([@Ukochka](https://github.com/Ukochka))
+
+#### Authors: 2
+
+- Hugo Kiyodi Oshiro ([@oshirohugo](https://github.com/oshirohugo))
+- Yulia Shanyrova ([@Ukochka](https://github.com/Ukochka))
+
+---
+
 # v4.2.5 (Mon Mar 18 2024)
 
 #### 🐛 Bug Fix

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@grafana/create-plugin",
-  "version": "4.3.0-canary.832.a1f8d8a.0",
+  "version": "4.3.0",
   "repository": {
     "directory": "packages/create-plugin",
     "url": "https://github.com/grafana/plugin-tools"
@@ -87,5 +87,5 @@
   "engines": {
     "node": ">=20"
   },
-  "gitHead": "a1f8d8ab30d080e193cc25765da1bcd2742d7601"
+  "gitHead": "7c5dc7f0f55e8903d25e5fc1630d350a743fccaf"
 }

package/templates/common/.config/Dockerfile

@@ -3,6 +3,11 @@ ARG grafana_image=grafana-enterprise
 
 FROM grafana/${grafana_image}:${grafana_version}
 
+{{#if hasBackend}}
+ARG GO_VERSION=1.21.6
+ARG GO_ARCH=amd64
+{{/if}}
+
 # Make it as simple as possible to access the grafana instance for development purposes
 # Do NOT enable these settings in a public facing / production grafana instance
 ENV GF_AUTH_ANONYMOUS_ORG_ROLE "Admin"
@@ -11,6 +16,53 @@ ENV GF_AUTH_BASIC_ENABLED "false"
 # Set development mode so plugins can be loaded without the need to sign
 ENV GF_DEFAULT_APP_MODE "development"
 
-# Inject livereload script into grafana index.html
+
+LABEL maintainer="Grafana Labs <hello@grafana.com>"
+
+ENV GF_PATHS_HOME="/usr/share/grafana"
+WORKDIR $GF_PATHS_HOME
+
 USER root
+
+
+# Installing supervisor and inotify-tools
+RUN if grep -i -q alpine /etc/issue; then \
+      apk add supervisor inotify-tools git; \
+    elif grep -i -q ubuntu /etc/issue; then \
+      DEBIAN_FRONTEND=noninteractive && \
+      apt-get update && \
+      apt-get install -y supervisor inotify-tools git && \
+      rm -rf /var/lib/apt/lists/*; \
+    else \
+      echo 'ERROR: Unsupported base image' && /bin/false; \
+    fi
+
+COPY supervisord/supervisord.conf /etc/supervisor.d/supervisord.ini
+COPY supervisord/supervisord.conf /etc/supervisor/conf.d/supervisord.conf
+
+
+{{#if hasBackend}}
+# Installing Go
+RUN curl -O -L https://golang.org/dl/go${GO_VERSION}.linux-${GO_ARCH}.tar.gz && \
+    rm -rf /usr/local/go && \
+    tar -C /usr/local -xzf go${GO_VERSION}.linux-${GO_ARCH}.tar.gz && \
+    echo "export PATH=$PATH:/usr/local/go/bin:~/go/bin" >> ~/.bashrc && \
+    rm -f go${GO_VERSION}.linux-${GO_ARCH}.tar.gz
+
+# Installing delve for debugging
+RUN /usr/local/go/bin/go install github.com/go-delve/delve/cmd/dlv@latest
+
+# Installing mage for plugin (re)building
+RUN git clone https://github.com/magefile/mage; \
+    cd mage; \
+    export PATH=$PATH:/usr/local/go/bin; \
+    go run bootstrap.go
+{{/if}}
+
+# Inject livereload script into grafana index.html
 RUN sed -i 's|</body>|<script src="http://localhost:35729/livereload.js"></script></body>|g' /usr/share/grafana/public/views/index.html
+
+
+COPY entrypoint.sh /entrypoint.sh
+RUN chmod +x /entrypoint.sh
+ENTRYPOINT ["/entrypoint.sh"]

package/templates/common/.config/entrypoint.sh

@@ -0,0 +1,10 @@
+#!/bin/sh
+
+if grep -i -q alpine /etc/issue; then
+    exec /usr/bin/supervisord -c /etc/supervisord.conf
+elif grep -i -q ubuntu /etc/issue; then
+    exec /usr/bin/supervisord -c /etc/supervisor/supervisord.conf
+else
+    echo 'ERROR: Unsupported base image'
+    exit 1
+fi

package/templates/common/.config/supervisord/supervisord.conf

@@ -0,0 +1,49 @@
+[supervisord]
+nodaemon=true
+user=root
+
+[program:grafana]
+user=root
+directory=/var/lib/grafana
+command=/run.sh
+stdout_logfile=/dev/fd/1
+stdout_logfile_maxbytes=0
+redirect_stderr=true
+killasgroup=true
+stopasgroup=true
+autostart=true
+
+{{#if hasBackend}}
+[program:delve]
+user=root
+command=/bin/bash -c 'pid=""; while [ -z "$pid" ]; do pid=$(pgrep -f gpx_{{ snakeCase pluginName }}); done; /root/go/bin/dlv attach --api-version=2 --headless --continue --accept-multiclient --listen=:2345 $pid'
+stdout_logfile=/dev/fd/1
+stdout_logfile_maxbytes=0
+redirect_stderr=true
+killasgroup=false
+stopasgroup=false
+autostart=true
+autorestart=true
+
+[program:build-watcher]
+user=root
+command=/bin/bash -c 'while inotifywait -e modify,create,delete -r /var/lib/grafana/plugins/{{ pluginId }}; do echo "Change detected, restarting delve...";supervisorctl restart delve; done'
+stdout_logfile=/dev/fd/1
+stdout_logfile_maxbytes=0
+redirect_stderr=true
+killasgroup=true
+stopasgroup=true
+autostart=true
+
+[program:mage-watcher]
+user=root
+environment=PATH="/usr/local/go/bin:/root/go/bin:%(ENV_PATH)s"
+directory=/root/{{ pluginId }}
+command=/bin/bash -c 'git config --global --add safe.directory /root/{{ pluginId }} && mage -v watch'
+stdout_logfile=/dev/fd/1
+stdout_logfile_maxbytes=0
+redirect_stderr=true
+killasgroup=true
+stopasgroup=true
+autostart=true
+{{/if}}

package/templates/common/docker-compose.yaml

@@ -2,7 +2,9 @@ version: '3.0'
 
 services:
   grafana:
+    user: root
     container_name: '{{ pluginId }}'
+
     platform: 'linux/amd64'
     build:
       context: ./.config
@@ -11,6 +13,23 @@ services:
         grafana_version: ${GRAFANA_VERSION:-{{~grafanaVersion~}} }
     ports:
       - 3000:3000/tcp
+{{#if hasBackend}}
+      - 2345:2345/tcp # delve
+    security_opt:
+      - "apparmor:unconfined"
+      - "seccomp:unconfined"
+    cap_add:
+      - SYS_PTRACE
+{{/if}}
     volumes:
       - ./dist:/var/lib/grafana/plugins/{{ pluginId }}
       - ./provisioning:/etc/grafana/provisioning
+      - .:/root/{{ pluginId }}
+
+    environment:
+      NODE_ENV: development
+      GF_LOG_FILTERS: plugin.{{ pluginId }}:debug
+      GF_LOG_LEVEL: debug
+      GF_DATAPROXY_LOGGING: 1
+      GF_PLUGINS_ALLOW_LOADING_UNSIGNED_PLUGINS: {{ pluginId }}
+      GF_PLUGINS_DELVE_ENABLED: true