@flowfuse/driver-docker 2.6.0 → 2.7.0

package/.github/workflows/release-publish.yml

@@ -11,8 +11,8 @@ jobs:
             - uses: actions/checkout@v4
             - uses: actions/setup-node@v4
               with:
-                  node-version: 16
+                  node-version: 18
             - run: npm ci --omit dev
-            - uses: JS-DevTools/npm-publish@v2
+            - uses: JS-DevTools/npm-publish@v3
               with:
                   token: ${{ secrets.NPM_PUBLISH_TOKEN }}

package/CHANGELOG.md

@@ -1,3 +1,11 @@
+#### 2.7.0: Release
+
+ - Persistent storage - Docker (#103) @hardillb
+ - Fix LOG_PASSTHROUGH (#104) @hardillb
+ - Fix network selection if more than one network labeled 'flowforge' (#102) @hardillb
+ - Update release-publish.yml to use NodeJS v18 (#101) @hardillb
+ - Bump JS-DevTools/npm-publish from 2 to 3 (#96) @app/dependabot
+
 #### 2.6.0: Release
 
 

package/README.md

@@ -15,12 +15,17 @@ driver:
     registry: containers.flowforge.com
     privateCA: /full/path/to/chain.pem
     logPassthrough: true
+    storage:
+      enabled: true
+      path: /opt/flowfuse/storage
 ```
 
  - `registry` is the Docker Registry to load Stack Containers from (default: Docker Hub)
  - `socket` is the path to the docker unix domain socket (default: /var/run/docker.sock)
  - `privateCA`: is the fully qualified path to a pem file containing trusted CA cert chain (default: not set)
  - `logPassthrough` Have Node-RED logs printed in JSON format to container stdout (default: false)
+ - `storage.enabled` enables mounting a directory into each Node-RED instance as persistence storage (default: false)
+ - `storage.path` is the fully qualified path to the root directory for the storage on the host (default: not set)
 
 ### Configuration via environment variables
 

package/docker.js

@@ -1,8 +1,9 @@
 const got = require('got')
 const Docker = require('dockerode')
+const path = require('path')
+const { chownSync, mkdirSync, rmSync } = require('fs')
 
 const createContainer = async (project, domain) => {
-    const networks = await this._docker.listNetworks({ filters: { label: ['com.docker.compose.network=flowforge'] } })
     const stack = project.ProjectStack.properties
     const contOptions = {
         Image: stack.container,
@@ -15,7 +16,7 @@ const createContainer = async (project, domain) => {
         AttachStdout: false,
         AttachStderr: false,
         HostConfig: {
-            NetworkMode: networks[0].Name
+            NetworkMode: this._network
         }
     }
 
@@ -85,7 +86,7 @@ const createContainer = async (project, domain) => {
         contOptions.Env.push(`FORGE_NR_SECRET=${credentialSecret}`)
     }
 
-    if (this._options?.logPassthrough) {
+    if (this._app.driver.options?.logPassthrough) {
         contOptions.Env.push('FORGE_LOG_PASSTHROUGH=true')
     }
 
@@ -100,6 +101,25 @@ const createContainer = async (project, domain) => {
         contOptions.Env.push('NODE_EXTRA_CA_CERTS=/usr/local/ssl-certs/chain.pem')
     }
 
+    if (this._app.config.driver.options?.storage?.enabled || this._app.config.driver.options?.storage?.path) {
+        try {
+            const localPath = path.join('/opt/persistent-storage', project.id)
+            console.log(`Creating dir in container ${localPath}`)
+            mkdirSync(localPath)
+            chownSync(localPath, 1000, 1000)
+        } catch (err) {
+            this._app.log.info(`[docker] problem creating persistent storage for ${project.id}`)
+        }
+        const projectPath = path.join(this._app.config.driver.options?.storage?.path, project.id)
+        if (Array.isArray(contOptions.HostConfig?.Binds)) {
+            contOptions.HostConfig.Binds.push(`${projectPath}:/data/storage`)
+        } else {
+            contOptions.HostConfig.Binds = [
+                `${projectPath}:/data/storage`
+            ]
+        }
+    }
+
     const containerList = await this._docker.listImages()
     let containerFound = false
     let stackName = stack.container
@@ -180,6 +200,35 @@ module.exports = {
             options.registry = app.config.driver.options?.registry || '' // use docker hub
         }
 
+        const networks = await this._docker.listNetworks({ filters: { label: ['com.docker.compose.network=flowforge'] } })
+        if (networks.length > 1) {
+            const filteredNetworks = []
+            for (let j = 0; j < networks.length; j++) {
+                const details = await this._docker.getNetwork(networks[j].Id).inspect()
+                const containers = Object.keys(details.Containers)
+                for (let i = 0; i < containers.length; i++) {
+                    // console.log(containers[i])
+                    if (containers[i].startsWith(process.env.HOSTNAME)) {
+                        filteredNetworks.push(networks[j])
+                    }
+                }
+            }
+            // console.log(JSON.stringify(filteredNetworks, null, 2))
+            if (filteredNetworks[0]) {
+                this._app.log.info(`[docker] using network ${filteredNetworks[0].Name}`)
+                this._network = filteredNetworks[0].Name
+            } else {
+                this._app.log.info('[docker] unable to find network')
+                process.exit(-9)
+            }
+        } else if (networks.length === 1) {
+            this._app.log.info(`[docker] using network ${networks[0].Name}`)
+            this._network = networks[0].Name
+        } else {
+            this._app.log.info('[docker] unable to find network')
+            process.exit(-9)
+        }
+
         // Get a list of all projects - with the absolute minimum of fields returned
         const projects = await app.db.models.Project.findAll({
             attributes: [
@@ -314,6 +363,16 @@ module.exports = {
                 await container.remove()
             } catch (err) {}
         }
+        if (this._app.config.driver.options?.storage?.enabled) {
+            // need to be sure we have permission to delete the dir and it's contents?
+            try {
+                // This is better and assumes that directory is mounted on `/opt/storage`
+                const projectPersistentPath = path.join('/opt/persistent-storage', project.id)
+                rmSync(projectPersistentPath, { recursive: true, force: true })
+            } catch (err) {
+                this._app.log.error(`[docker] Project ${project.id} - error deleting persistent storage: ${err.stack}`)
+            }
+        }
         delete this._projects[project.id]
     },
     /**

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@flowfuse/driver-docker",
-    "version": "2.6.0",
+    "version": "2.7.0",
     "description": "Docker driver for FlowFuse",
     "main": "docker.js",
     "scripts": {