Skip to content

Latest commit

 

History

History
78 lines (59 loc) · 2.8 KB

README.md

File metadata and controls

78 lines (59 loc) · 2.8 KB

RIoT

  • Information system for Real-time IoT data processing and state monitoring through user-defined criteria – KPIs
  • a Bachelor thesis project of Michal Bureš, made at BUT FIT

Prerequisites

  • Docker 20.10.20 or later
  • Docker Compose 2.12.0 or later

Important notes: read before proceeding

  • Check that the ports required by the system, and its complementary services are free on your system:
    • System
      • GraphQL API of the 'Backend core' backend service
        • 9090
      • Frontend of the system
        • 8080
    • Complementary services
      • Mosquitto MQTT broker
        • 9001 (optional)
        • 1883
      • PostgreSQL relational database
        • 5432
      • RabbitMQ messaging and streaming broker
        • 5672
        • 15672 (optional)
        • 15692 (optional)
      • Prometheus (optional, useful for monitoring)
        • 9091
      • MQTT Prometheus Exporter (optional, useful for monitoring)
        • 9000
      • Grafana (optional, useful for monitoring)
        • 3000
      • pgAdmin database administration tool (optional, useful mainly for debugging purposes)
        • 8081

Running the system

Start all services

The following command can be used to start the complementary services and the system in configuration 1-1-1.

docker-compose up --build -d
  • the --build flag ensures that the Docker images of the system services are built from the latest source code...
  • the -d flag ensures that the containers keep running in case the terminal is closed...

Start multiple instances of 'Message processing unit'

To start multiple instance of 'Message processing unit', one uses the parameter --scale together with the service identifier riot-message-processing-unit and number of instances he plans to start. The following command can be used to start the system in configuration 1-4-1: 1 instance of 'Backend core', 4 instances of 'Message processing unit' and 1 instance of 'MQTT preprocessor'.

docker-compose up --build -d --scale riot-message-processing-unit=4

Stop all services

docker-compose down

Using and testing the system

Upon the completion of the docker-compose up --build -d command, the system should be fully operational and ready for usage and testing. You can access the system through its frontend. Remember that while running the system this way is fine for functionality testing, it may lead to suboptimal performance characteristics, as the system running on a single node (machine) in 1-1-1 configuration does not represent an optimal deployment.

License notice

This is an open-source project, licensed under the MIT License.