Create Plugin: Extend the docker-compose file (#1485)

grafana · Jan 28, 2025 · d12e2ba · d12e2ba
1 parent 6da026b
commit d12e2ba
Show file tree

Hide file tree

Showing 4 changed files with 42 additions and 62 deletions.
diff --git a/docusaurus/docs/get-started/set-up-development-environment.mdx b/docusaurus/docs/get-started/set-up-development-environment.mdx
@@ -66,9 +66,10 @@ version: '3.7'
 
 services:
   grafana:
-    container_name: 'myorg-basic-app'
+    extends:
+      file: .config/docker-compose-base.yaml
+      service: grafana
     build:
-      context: ./.config
       args:
         grafana_version: ${GRAFANA_VERSION:-9.1.2}
         grafana_image: ${GRAFANA_IMAGE:-grafana}
@@ -107,33 +108,6 @@ For example, in VSCode, you can add a `launch.json` configuration like this:
 }
 ```
 
-You can control the go version and the architecure used to build your plugin in the docker compose by setting `GO_VERSION` and `GO_ARCH` environment variables:
-
-```yaml title="docker-compose.yaml"
-version: '3.7'
-
-services:
-  grafana:
-    container_name: 'myorg-basic-app'
-    build:
-      context: ./.config
-      args:
-        GO_VERSION: ${GO_VERSION:-1.22}
-        GO_ARCH: ${GO_ARCH:-amd64}
-```
-
-You will also notice that the `docker-compose.yaml` file also has the following settings:
-
-```yaml title="docker-compose.yaml"
-security_opt:
-  - 'apparmor:unconfined'
-  - 'seccomp:unconfined'
-cap_add:
-  - SYS_PTRACE
-```
-
-they are necessary to allow delve to attach to the running process and debug it and should not be used in production environments.
-
 ## Set up GitHub workflows
 
 Automate your development process to minimize errors and make it faster and more cost-efficient. The `create-plugin` tool helps you to configure your GitHub actions workflows to help automate your development process.

diff --git a/packages/create-plugin/templates/common/.config/README.md b/packages/create-plugin/templates/common/.config/README.md
@@ -151,9 +151,10 @@ version: '3.7'
 
 services:
   grafana:
-    container_name: 'myorg-basic-app'
+    extends:
+      file: .config/docker-compose-base.yaml
+      service: grafana
     build:
-      context: ./.config
       args:
         grafana_version: ${GRAFANA_VERSION:-9.1.2}
         grafana_image: ${GRAFANA_IMAGE:-grafana}

diff --git a/packages/create-plugin/templates/common/.config/docker-compose-base.yaml b/packages/create-plugin/templates/common/.config/docker-compose-base.yaml
@@ -0,0 +1,33 @@
+services:
+  grafana:
+    user: root
+    container_name: '{{ pluginId }}'
+
+    build:
+      context: .
+      args:
+        grafana_image: ${GRAFANA_IMAGE:-{{~grafanaImage~}} }
+        grafana_version: ${GRAFANA_VERSION:-11.3.2}
+        development: ${DEVELOPMENT:-false}
+        anonymous_auth_enabled: ${ANONYMOUS_AUTH_ENABLED:-true}
+    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 }}
diff --git a/packages/create-plugin/templates/common/docker-compose.yaml b/packages/create-plugin/templates/common/docker-compose.yaml
@@ -1,33 +1,5 @@
 services:
   grafana:
-    user: root
-    container_name: '{{ pluginId }}'
-
-    build:
-      context: ./.config
-      args:
-        grafana_image: ${GRAFANA_IMAGE:-{{~grafanaImage~}} }
-        grafana_version: ${GRAFANA_VERSION:-11.3.2}
-        development: ${DEVELOPMENT:-false}
-        anonymous_auth_enabled: ${ANONYMOUS_AUTH_ENABLED:-true}
-    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 }}
+    extends:
+      file: .config/docker-compose-base.yaml
+      service: grafana