Estructura de Proyecto Node-RED

Estructura General del Proyecto Node-RED

• Un proyecto personalizado de Node-RED se organiza con archivos y carpetas esenciales para la gestión de nodos, configuración, logs y automatización.
• La carpeta custom-nodes alberga los nodos personalizados, clasificados por categorías y secciones.
• Dentro de cada sección, las carpetas de nodos contienen archivos JavaScript (.js) para la lógica y HTML (.html) para la interfaz gráfica.
• El Dockerfile contiene la configuración específica para la imagen de Docker.
• loggers.js gestiona la configuración de logs del sistema.
• loggerUtils.js proporciona funciones de utilidad para la gestión y estructuración de logs.
• settings_instance.js ofrece una configuración personalizada para la instancia de Node-RED.
• El script commit-push.sh automatiza los commits y push a un repositorio Git.
• El script git-sync.sh sincroniza el repositorio Git con el entorno de Node-RED.

Carpeta /custom-nodes – Desarrollo de Nodos Personalizados

• Esta carpeta organiza los nodos personalizados en subcarpetas por categoría.
• Cada nodo incluye dos archivos principales:
• Un archivo .js que contiene la lógica y la funcionalidad del nodo.
• Un archivo .html que define la interfaz gráfica del nodo.

Dockerfile – Configuración de la Imagen de Docker

• Este archivo define la construcción de una imagen de Node-RED personalizada dentro de un contenedor Docker.
• Se usa la imagen oficial de Node-RED más reciente como base: FROM --platform=linux/amd64 nodered/node-red:latest.
• El directorio de trabajo se establece en /data, donde Node-RED almacena configuraciones y flujos: WORKDIR /data.
• Se crean los directorios /data/custom-nodes y /data/node_modules para nodos personalizados y módulos de Node.js: RUN mkdir -p /data/custom-nodes y RUN mkdir -p /data/node_modules.
• Se copian los nodos personalizados, archivos de logs y utilidades a sus respectivas carpetas en el contenedor: COPY custom-nodes /data/custom-nodes, COPY logger.js /data/logger.js, y COPY loggerUtils.js /data/loggerUtils.js.
• Se instalan las dependencias específicas de cada nodo personalizado usando npm install en cada subcarpeta dentro de custom-nodes.
• Se instalan dependencias globales como winston, winston-daily-rotate-file, express-jwt, jwks-rsa, jsonwebtoken, y passport-azure-ad para logs y autenticación.
• Se copia el archivo settings_instance.js a /data/settings.js para aplicar una configuración personalizada a Node-RED, lo que permite definir seguridad, puertos, logs y autenticación.
• Se copian los scripts git-sync.sh y commit-push.sh a /data/ para automatizar la sincronización con Git.
• Se expone el puerto 1880: EXPOSE 1880.
• El comando de inicio ejecuta scripts de sincronización con Git y arranca Node-RED con la configuración personalizada: ENTRYPOINT ["bash", "-c", "bash /data/git-sync.sh && bash /data/commit-push.sh & exec node-red --userDir /data --flowFile /data/flows.json"].

loggers.js y loggerUtils.js – Configuración de los Logs

• loggers.js define la generación de logs para depuración y monitoreo del sistema.
• loggerUtils.js contiene funciones reutilizables para manejar logs de manera estructurada.

settings_instance.js – Configuración de Node-RED

• Este archivo personaliza la configuración de Node-RED en entornos específicos.

commit-push.sh – Automatización de Commits y Push

• Este script sincroniza el archivo flows.json de Node-RED con un repositorio Git.
• Las variables clave incluyen:
• FLOW_FILE: Ruta del archivo de flujos en ejecución en Node-RED.
• REPO_FLOW_FILE: Archivo flows.json dentro del repositorio Git.
• REPO_DIR: Ruta del repositorio Git en Node-RED.
• CHECK_INTERVAL: Intervalo de 30 segundos entre cada verificación.
• Si flows.json existe en el repositorio, se copia a /data/flows.json.
• Se monitorean continuamente los cambios en flows.json cada 30 segundos.
• El script descarga y sincroniza el repositorio con la última versión antes de aplicar cambios.
• Utiliza git add, git commit, y git push para subir automáticamente los cambios detectados en Node-RED al repositorio Git.

git-sync.sh – Sincronización Automática con Git

• Este script clona y sincroniza automáticamente un repositorio Git de Azure DevOps con un directorio en el contenedor de Node-RED.
• Las variables clave incluyen:
• REPO_URL: URL del repositorio Git en Azure DevOps.
• REPO_DIR: Carpeta donde se clonará el repositorio en el contenedor.
• FLOW_FILE: Ubicación del archivo flows.json dentro del repositorio.
• BRANCH: Rama de Git que se va a sincronizar (main).
• REMOTE_NAME: Nombre del repositorio remoto (origin).
• Verifica si el repositorio ya está clonado; si no lo está, lo clona desde Azure DevOps.
• Si el repositorio ya existe, lo actualiza con git pull.
• Si el directorio existe pero no contiene .git/, se elimina y se vuelve a crear para evitar errores.