Merge branch 'master' into experimental

Author: Slyke

.internal/templates/services/adguardhome/build.js

@@ -7,12 +7,14 @@ const ServiceBuilder = ({
   const serviceName = 'adguardhome';
 
   const {
+    setImageTag,
     setModifiedPorts,
     setLoggingState,
     setNetworkMode,
     setNetworks,
-    setDevices,
-    setEnvironmentVariables
+    setVolumes,
+    setEnvironmentVariables,
+    setDevices
   } = require('../../../src/utils/commonCompileLogic');
 
   const {
@@ -54,7 +56,7 @@ if [[ ! -d ./volumes/adguardhome/confdir ]]; then
   HAS_ERROR="true"
 fi
 
-if [[ "$HAS_ERROR" == "true ]]; then
+if [[ "$HAS_ERROR" == "true" ]]; then
     sleep 1
 fi
 `;
@@ -69,10 +71,12 @@ fi
         console.info(`ServiceBuilder:compile() - '${serviceName}' started`);
 
         const compileResults = {
+          modifiedImage: setImageTag({ buildTemplate: outputTemplateJson, buildOptions, serviceName }),
           modifiedPorts: setModifiedPorts({ buildTemplate: outputTemplateJson, buildOptions, serviceName }),
           modifiedLogging: setLoggingState({ buildTemplate: outputTemplateJson, buildOptions, serviceName }),
           modifiedNetworkMode: setNetworkMode({ buildTemplate: outputTemplateJson, buildOptions, serviceName }),
           modifiedNetworks: setNetworks({ buildTemplate: outputTemplateJson, buildOptions, serviceName }),
+          modifiedVolumes: setVolumes({ buildTemplate: outputTemplateJson, buildOptions, serviceName }),
           modifiedEnvironment: setEnvironmentVariables({ buildTemplate: outputTemplateJson, buildOptions, serviceName }),
           modifiedDevices: setDevices({ buildTemplate: outputTemplateJson, buildOptions, serviceName })
         };

.internal/templates/services/mosquitto/build.js

@@ -8,10 +8,14 @@ const ServiceBuilder = ({
   const serviceName = 'mosquitto';
 
   const {
+    setImageTag,
     setModifiedPorts,
     setLoggingState,
     setNetworkMode,
-    setNetworks
+    setNetworks,
+    setVolumes,
+    setEnvironmentVariables,
+    setDevices
   } = require('../../../src/utils/commonCompileLogic');
 
   const {
@@ -34,7 +38,7 @@ const ServiceBuilder = ({
 
   const checkServiceFilesCopied = () => {
     return `
-if [[ ! -f ./services/mosquitto/mosquitto.conf ]]; then
+if [[ ! -f ./services/mosquitto/config/mosquitto.conf ]]; then
   echo "Mosquitto config file is missing!"
   sleep 2
 fi
@@ -44,6 +48,7 @@ fi
   const createVolumesDirectory = () => {
     return `
 mkdir -p ./volumes/mosquitto/data
+mkdir -p ./volumes/mosquitto/config
 mkdir -p ./volumes/mosquitto/pwfile
 mkdir -p ./volumes/mosquitto/log
 `;
@@ -57,8 +62,8 @@ if [[ ! -d ./volumes/mosquitto/data ]]; then
   HAS_ERROR="true"
 fi
 
-if [[ ! -d ./volumes/mosquitto/pwfile ]]; then
-  echo "Mosquitto pwfile directory is missing!"
+if [[ ! -d ./volumes/mosquitto/config ]]; then
+  echo "Mosquitto config directory is missing!"
   HAS_ERROR="true"
 fi
 
@@ -67,26 +72,18 @@ if [[ ! -d ./volumes/mosquitto/log ]]; then
   HAS_ERROR="true"
 fi
 
-if [[ "$HAS_ERROR" == "true ]]; then
+if [[ ! -d ./volumes/mosquitto/pwfile ]]; then
+  echo "Mosquitto pwfile directory is missing!"
+  HAS_ERROR="true"
+fi
+
+if [[ "$HAS_ERROR" == "true" ]]; then
   echo "Errors were detected when setting up Mosquitto"
   sleep 1
 fi
 `;
   };
 
-  const setupVolumePermissions = (setUser1883) => {
-    if (setUser1883) {
-    return `
-echo "Updating mosquitto permissions:"
-echo "  chown -R 1883:1883 ./volumes/mosquitto/"
-sudo chown -R 1883:1883 ./volumes/mosquitto/
-    `;
-    }
-    return `
-echo "Mosquitto volume permissions not changed."
-    `;
-  }
-
   retr.compile = ({
     outputTemplateJson,
     buildOptions,
@@ -96,10 +93,14 @@ echo "Mosquitto volume permissions not changed."
         console.info(`ServiceBuilder:compile() - '${serviceName}' started`);
 
         const compileResults = {
+          modifiedImage: setImageTag({ buildTemplate: outputTemplateJson, buildOptions, serviceName }),
           modifiedPorts: setModifiedPorts({ buildTemplate: outputTemplateJson, buildOptions, serviceName }),
           modifiedLogging: setLoggingState({ buildTemplate: outputTemplateJson, buildOptions, serviceName }),
           modifiedNetworkMode: setNetworkMode({ buildTemplate: outputTemplateJson, buildOptions, serviceName }),
-          modifiedNetworks: setNetworks({ buildTemplate: outputTemplateJson, buildOptions, serviceName })
+          modifiedNetworks: setNetworks({ buildTemplate: outputTemplateJson, buildOptions, serviceName }),
+          modifiedVolumes: setVolumes({ buildTemplate: outputTemplateJson, buildOptions, serviceName }),
+          modifiedEnvironment: setEnvironmentVariables({ buildTemplate: outputTemplateJson, buildOptions, serviceName }),
+          modifiedDevices: setDevices({ buildTemplate: outputTemplateJson, buildOptions, serviceName })
         };
         console.info(`ServiceBuilder:compile() - '${serviceName}' Results:`, compileResults);
 
@@ -171,13 +172,41 @@ echo "Mosquitto volume permissions not changed."
     return new Promise((resolve, reject) => {
       try {
         console.info(`ServiceBuilder:build() - '${serviceName}' started`);
-        const mosquittoConfFilePath = path.join(__dirname, settings.paths.serviceFiles, 'mosquitto.conf');
+        const mosquittoConfFilePath = path.join(__dirname, settings.paths.serviceFiles, 'config', 'mosquitto.conf');
         zipList.push({
           fullPath: mosquittoConfFilePath,
-          zipName: '/services/mosquitto/mosquitto.conf'
+          zipName: '/services/mosquitto/config/mosquitto.conf'
         });
         console.debug(`ServiceBuilder:build() - '${serviceName}' Added '${mosquittoConfFilePath}' to zip`);
 
+        const mosquittoAclFilePath = path.join(__dirname, settings.paths.serviceFiles, 'config', 'filter.acl');
+        zipList.push({
+          fullPath: mosquittoAclFilePath,
+          zipName: '/services/mosquitto/config/filter.acl'
+        });
+        console.debug(`ServiceBuilder:build() - '${serviceName}' Added '${mosquittoAclFilePath}' to zip`);
+
+        const mosquittoPwFilePath = path.join(__dirname, settings.paths.serviceFiles, 'pwfile', 'pwfile');
+        zipList.push({
+          fullPath: mosquittoPwFilePath,
+          zipName: '/services/mosquitto/pwfile/pwfile'
+        });
+        console.debug(`ServiceBuilder:build() - '${serviceName}' Added '${mosquittoPwFilePath}' to zip`);
+
+        const mosquittoDockerFilePath = path.join(__dirname, settings.paths.buildFiles, 'Dockerfile');
+        zipList.push({
+          fullPath: mosquittoDockerFilePath,
+          zipName: '/services/mosquitto/Dockerfile'
+        });
+        console.debug(`ServiceBuilder:build() - '${serviceName}' Added '${mosquittoDockerFilePath}' to zip`);
+
+        const mosquittoDockerEntryPointFilePath = path.join(__dirname, settings.paths.buildFiles, 'docker-entrypoint.sh');
+        zipList.push({
+          fullPath: mosquittoDockerEntryPointFilePath,
+          zipName: '/services/mosquitto/docker-entrypoint.sh'
+        });
+        console.debug(`ServiceBuilder:build() - '${serviceName}' Added '${mosquittoDockerEntryPointFilePath}' to zip`);
+
         postbuildScripts.push({
           serviceName,
           comment: 'Ensure required service files exist for launch',
@@ -199,13 +228,6 @@ echo "Mosquitto volume permissions not changed."
           code: checkVolumesDirectory()
         });
 
-        postbuildScripts.push({
-          serviceName,
-          comment: 'Setup correct permissions for volume',
-          multilineComment: null,
-          code: setupVolumePermissions(true)
-        });
-
         console.info(`ServiceBuilder:build() - '${serviceName}' completed`);
         return resolve({ type: 'service' });
       } catch (err) {

.internal/templates/services/mosquitto/buildFiles/Dockerfile

@@ -0,0 +1,22 @@
+# Download base image
+FROM eclipse-mosquitto:latest
+
+# Add support tools
+RUN apk update && apk add --no-cache rsync tzdata
+
+# where IOTstack template files are stored
+ENV MOSQUITTO_IOTSTACK_DEFAULTS="/iotstack_defaults"
+
+# copy template files to image
+COPY --chown=mosquitto:mosquitto . /${MOSQUITTO_IOTSTACK_DEFAULTS}
+
+# replace the docker entry-point script
+ENV IOTSTACK_ENTRY_POINT="docker-entrypoint.sh"
+COPY ${IOTSTACK_ENTRY_POINT} /${IOTSTACK_ENTRY_POINT}
+RUN chmod 755 /${IOTSTACK_ENTRY_POINT}
+ENV IOTSTACK_ENTRY_POINT=
+
+# IOTstack also declares these paths
+VOLUME ["/mosquitto/config", "/mosquitto/pwfile"]
+
+# EOF

.internal/templates/services/mosquitto/buildFiles/directoryfix.sh

@@ -0,0 +1,12 @@
+#!/bin/ash
+set -e
+
+# Set permissions
+user="$(id -u)"
+if [ "$user" = '0' -a -d "/mosquitto" ]; then
+  rsync -arp --ignore-existing /${MOSQUITTO_IOTSTACK_DEFAULTS}/ "/mosquitto"
+  chown -R mosquitto:mosquitto /mosquitto
+fi
+
+exec "$@"
+

.internal/templates/services/mosquitto/buildFiles/docker-entrypoint.sh

@@ -1,15 +1,16 @@
 mosquitto:
   container_name: mosquitto
-  image: eclipse-mosquitto
+  build: ./services/mosquitto/.
   restart: unless-stopped
-  user: "1883"
+  environment:
+    - TZ=Etc/UTC
   ports:
     - "1883:1883"
   volumes:
+    - ./volumes/mosquitto/config:/mosquitto/config
     - ./volumes/mosquitto/data:/mosquitto/data
     - ./volumes/mosquitto/log:/mosquitto/log
     - ./volumes/mosquitto/pwfile:/mosquitto/pwfile
-    - ./services/mosquitto:/mosquitto/config:ro
   networks:
     - iotstack_nw
   logging:

.internal/templates/services/mosquitto/serviceFiles/filter.acl renamed to .internal/templates/services/mosquitto/serviceFiles/config/filter.acl

@@ -10,12 +10,14 @@ const ServiceBuilder = ({
   const { byName } = require('../../../src/utils/interpolate');
 
   const {
+    setImageTag,
     setModifiedPorts,
     setLoggingState,
     setNetworkMode,
     setNetworks,
-    setDevices,
-    setEnvironmentVariables
+    setVolumes,
+    setEnvironmentVariables,
+    setDevices
   } = require('../../../src/utils/commonCompileLogic');
 
   const {
@@ -57,7 +59,7 @@ if [[ ! -d ./volumes/nextcloud/db ]]; then
   HAS_ERROR="true"
 fi
 
-if [[ "$HAS_ERROR" == "true ]]; then
+if [[ "$HAS_ERROR" == "true" ]]; then
     sleep 1
 fi
 `;
@@ -72,10 +74,12 @@ fi
         console.info(`ServiceBuilder:compile() - '${serviceName}', 'nextcloud_db' started`);
 
         const compileResults = {
+          modifiedImage: setImageTag({ buildTemplate: outputTemplateJson, buildOptions, serviceName }),
           modifiedPorts: setModifiedPorts({ buildTemplate: outputTemplateJson, buildOptions, serviceName }),
           modifiedLogging: setLoggingState({ buildTemplate: outputTemplateJson, buildOptions, serviceName }),
           modifiedNetworkMode: setNetworkMode({ buildTemplate: outputTemplateJson, buildOptions, serviceName }),
           modifiedNetworks: setNetworks({ buildTemplate: outputTemplateJson, buildOptions, serviceName }),
+          modifiedVolumes: setVolumes({ buildTemplate: outputTemplateJson, buildOptions, serviceName }),
           modifiedEnvironment: setEnvironmentVariables({ buildTemplate: outputTemplateJson, buildOptions, serviceName }),
           modifiedDevices: setDevices({ buildTemplate: outputTemplateJson, buildOptions, serviceName })
         };