search

janvda / balena-node-red-mqtt-nginx-TIG-stack

Composite docker application with "8" containers (2x Node-RED, 2x MQTT broker, Telegraf, InfluxDb, Grafana, Nginx) for deployment on Raspberry Pi through Balena.
Eclipse Public License 2.0
58 stars 42 forks source link
balena balenacloud grafana-dashboards influxdb mqtt-broker node-red raspberry-pi telegraf tig

readme

Composite docker application with "8" containers (2x Node-RED, 2x MQTT broker, Telegraf, InfluxDb, Grafana, Nginx) deployed on Raspberry Pi through Balena.

Features

This project is actually a proof of concept to demonstrate the following features:

  1. The ability to run many containers on a Raspberry Pi 3 Model B+ (see section 1. What).
  2. The Built and Deployment of this multi container application using the BalenaCloud services (see section 2. How to install ...).
  3. Monitoring the system resources of the raspberry pi using the TIG stack (see section 3. System resource monitoring ...):
  4. That Grafana is very nice and powerful tool to create dashboards (see section 4. Grafana) and that it is easy to create or update those dashboards (see section 4.1 Updating and adding ...).
  5. It is possible to run multiple Node-RED instances on the same device (see section 5. Node-RED).
  6. It is possible to run multiple MQTT brokers on the same device (see section 6. MQTT brokers).
  7. A USB memory stick connected to the pi can be used for storing specific data (in this case it is the influxdb data) (see section 7. USB memory stick).
  8. It is possible to access the Grafana user interface and the 2 Node-RED editors via the internet (see see section 8. Internet Access).

1. What

This github repository describes a composite docker application consisting of "8" containers that can be deployed through BalenaCloud on any arm device (e.g. a Raspberry Pi 3 Model B+) running the balena OS.

So, this application consists of the following 8 docker containers (= TIG stack + 2x Node-RED + 2x MQTT broker + Nginx )

  1. Telegraf - agent for collecting and reporting metrics and events
  2. Influxdb - Time Series Database
  3. Grafana - create, explore and share dashboards
  4. 2x Node-RED - flow based programming for the Internet of Things (accessible through path /nodered )
  5. 2x MQTT-broker - lightweight message broker
  6. nginx - is open source software for web serving, reverse proxying, caching, load balancing,....

2. How to install this application on an edge device

It is very easy to install this application using the BalenaCloud services through following steps:

  1. Balena Setup: you need a BalenaCloud account and your edge device must be running the BalenaOs. You also need to create an application in your balena dashboard and associate your edge device to it (see balena documentation).
  2. clone this github repository (this can be done on any device where git is installed) through the following command git clone https://github.com/janvda/balena-node-red-mqtt-nginx-TIG-stack.git (instead of directly cloning the repository it migh be better to fork the github repository and then clone this forked repository).
  3. Move into this repository by command cd balena-edge-device-monitoring
  4. Add balena git remote endpoint by running a command like git remote add balena <USERNAME>@git.www.balena.io:<USERNAME>/<APPNAME>.git
  5. push the repository to balena by the command git push balena master (maybe you need to add the option --force the first time you are deploying).

build finished successful

3. System resource monitoring using the TIG Stack (Telegraf, Influxdb & Grafana)

The system resource monitoring is realized by the TIG stack and happens as follows:

  1. The Telegraf container collects the system resource metrics (memory, CPU, disk, network, ...) of the raspberry pi device and sends them to
  2. the Influxdb container that will store them in the influx database.
  3. The Grafana container has a dashboard (see screenshot below) showing these system metrics that it has retrieved from the influxdb.

3.1 Telegraf

The table below specifies the environment variables that can be set in the Balena Device Service Variables panel for the Telegraf Service. Note that the Default Value is defined in docker-compose.yml

Name Default Value Description
interval 60s Frequency at which metrics are collected
flush_interval 60s Flushing interval (should not set < interval)

4. Grafana

The Grafana user interface can be accessed at port 3000 of the host OS. The login and password is admin. The name of the dashboard is system metrics.

Here below a screenshot of the system metrics dashboard that is also provisioned by this application ( file is grafana\dashboards\system metrics.json)

system metrics example top part system metrics example bottom part

4.1. Updating / Adding new Grafana Dashboards

If you want to add a new Grafana dashboard then this can be done through following steps (Updating an existing dashboard can be done in a similar way):

  1. Create the new dashboard using the Grafana UI.
  2. From the settings menu in Grafana UI select View JSON and copy the complete json file (don't use the grafana UI export feature as this will template the datasource and will not work due to that).
  3. Save the json contents you have copied in previous step into a new file in folder grafana\dashboards with extension .json (e.g. mydashboard-02.json)
  4. Substitute the ID number you can find in that file just after field "graphTooltip" by null. E.g. "id": 1, should be changed into "id": null,
  5. Commit your changes in git and push them to your balena git remote endpoint (git push balena master)

5. Node-RED

The application consists of 2 Node-RED containers:

  1. node-red: its editor is accessble through Host OS port and path : <Host OS>:1880/node-red/
  2. node-red-test : its editor is accessble through Host OS port and path : <Host OS>:1882/node-red-test/

Note that both Node-RED editors are protected by a user name and a hashed password that must be set through the environment variables USERNAME and PASSWORD. The Node-RED security page describes how a password hash can be generated. You can set these environment variables using your Balena dashboard either under:

Notes:

  1. node-red-data and node-red-test-data are 2 named volumed used for the \data folder of respectively node-red and node-red-test. Take care that the settings.js is only copied during the initial deployment of the application. So when the application is redeployed e.g. due to changes, then the settings.js is not recopied to the \data folder. (see also How to copy a file to a named volume?)
  2. In order to assure that nodes installed through npm install are not lost after a restart of the container, you must assure that they are installed in the \data directory. So you must first do a cd \data and then execute the npm install .... command. This will assure that the node is correctly installed under folder \data\node_modules\ and that it will persist after restarts of the container.

6. MQTT broker

This application consist of 2 Mosquitto MQTT-brokers:

  1. mqtt which is listening to Host OS port 1883
  2. mqtt-test which is listening to Host OS port 1884

7. Setup of the USB memory Stick for Influxdb

The data of the influxdb will be stored in the mount location \mnt\influxdb. The influxdb container is configured (see Dockerfile and my_entrypoint.sh) so that a USB drive (e.g. a USB memory stick) with label influxdb will be mounted to this mount location. It is currently also expecting (see Dockerfile) that this USB drive is formatted in ext4 format.

If no USB drive (or memory stick) with label influxdb is connected to the raspberry pi then the named volume influxdb-data will be mounted to this location as is specified in the docker-compose.yml file.

Notes

  1. the current Balena version doesn't yet support the definition of a volume for such a mounted drive in the docker compose yaml file therefore this is handled through the influxdb container setup as described here above.
  2. It is not possible to mount the same USB drive also in telegraf container (I have tried that) and consequently telegraf is not able to report the disk metrics for this USB drive.

8. Internet access via Balena's public URL and Nginx.

The nginx container has been configured so that when you enable the Balena public device URL that you can access the following applications over the internet:

In case you get a 502 Bad Gatewayerror or a message like Cannot GET /node-red-test/ when trying to access the above public URLs then this might be fixed by restarting the nginx container !

Credits

  1. Initializing Grafana with preconfigured dashboards (github repository)
  2. InfluxDB system metrics dashboard
  3. Grafana Series Part 1: Setting up InfluxDB, Grafana and Telegraf with Docker on Linux