1. Home
  2. HOW TO: Deploy/Install your Snap4City Solution on private or public Clouds, VM with Docker Containers

HOW TO: Deploy/Install your Snap4City Solution on private or public Clouds, VM with Docker Containers

Version 2.6 of 10/04/2022

The Docker Config Generator x Snap4 Tools is presently accessible from the main menu under "Deploy and Installation".

Access to the Docker Config Generator x Snap4 Tools

This  web page aims to prepare you entering into the Docker Config Generator Tool, and to provide you the minimal suggested info of the VMs involved in the installation. 
This page is describing a tool for generating installation files for a number of different configuration models each of which with a set of parameters.
The main idea of the Snap4 Configuration Tool is to:

  • allow you to select a configuration on the basis of the purpose
  • provide you a wizard that is going to ask you information such as: IP, names, IDs, number of features interested 
  • generate for you a set of installation files to perform an almost automated configuration based on Containers on your VMs on any cloud/servers
  • save the installation files to be reused by you in other installations, also modifying some parameters.

The installation files are generated for a number of proposed configurations with a number of scalable parameters.
Depending on the configuration a different number of VMs will be suggested and the configurations will be provided for each VM.

  • We suggest you to use Debian distribution for the VM. You can get the ISO from https://www.debian.org We also suggest to execute your VM on cloud environment as Vmware or similar.
  • in each VM, the docker and docker-compose have to be installed, please verify their correct installation.
  • each VM should have at least 10 Gbyte of RAM, more than 50 Gbyte of HD, but this is going to depend  on the data you would like to have, and 8 cores or virtual cores. The precise size of the VM (in terms of Memory, CPU, Storage) can be computed only at the end of the Docker Config Generator process when all needed information for their computation will be provided by you to the tool, and when the number of VM are also known.
  • The VM have to provide a network connection with the IP  that you have to provide in the file generation process. If you execute the VM into VMWare player, the VM network has to be bridget and not NAT.

Once you decided for a Configuration Model, before entering on the Snap4 Docker Config Generator you need to have the IP addresses of those VMs.
if you are not capable to complete the Docker Config Generator process for the lack of data, the tool is providing you a CODE/Token to enter egain and restart from the configuraiton you performed.
Please note that, the Configurations are anonymous, so that you can use the Configurator without exposing your email or nickname.
Each configuration is saved as a TOKEN and you can access again to it any time, to download the produced configuration/deploy files, and to create other configurations starting from those you have already generated, by changing the detailed parameters but not the size of the configurations in terms of X, Y, Z, K. 

The Configuration Models described in the following are the evolution of the DataCitySmall/Large configurations which is accessible as installation and guidelines in other web pages https://www.snap4city.org/471

For each Configuration Model, we are providing a description of the typical usage and the meaning of the parameters.
The meaning of X, Y, Z of the Configuration Models are identiical in all models:

  • X: is the number of IoT Applications, which are Node-RED containers, X>=1
  • Y: is the number of IoT Orion Broker V2 FIWARE, Y>=1
  • Z: is the number of Knowledge Bases, KB, Service Maps created into the solution. Z>=1; they are typically 1:1 with the Organizations. You can have multiple KBs for the same org. as well. Please note that the KBs are the providers of Smart City API, and Super Smart City API.

In the following configurations what is OPTIONAL can be added at ANY TIME, such as:

The NEW Configuration Models are:

  • Micro X: configurations suitable for solutions for small verticals and industries, single VM, see in the following for the details.
    • it is more complete than the Alone configuration of ​https://www.snap4city.org/471
    • VM main all in:
      • ​10-16 Gbyte of RAM, more than 50-200 Gbyte of HD (this depends on data size you would like to have, we suggest 500 GByte in thin provisioning), and 8 cores or virtual cores, faster than 2GHz each.
      • larger sizes may depend on the number of users/data you have
    • Estimated Time to install: 3 hours (Micro 3), time estimated when the VM area ready, the Domain is known, the mailing server is known, and the rest is of default.
    • Estimated Time to test and validate: 1 day (Micro 3)
  • Normal X,Y: configurations with multple  IoT App and Multiple IoT Brokers. They are on 2 VM, the first VM contains almost  all, while the second only the Brokers and IoT Apps 
    • it is more complete than the Basic configuration of ​https://www.snap4city.org/471
    • VM1 MAIN: contains the main as Dashboards services, Knowlege Base, Resource Manager, Authentication and authorization, Synoptics, WSserver, etc.
      • ​10-16 Gbyte of RAM, more than 50-200 Gbyte of HD (this depends on data size you would like to have, we suggest 500 GByte in thin provisioning), and 8 cores or virtual cores, faster than 2GHz each.
      • larger sizes may depend on the number of users/data you have
    • VM2 IOT Apps and Brokers: X IoT Apps, Node-RED, MicroServices; and Y IoT Brokers. 
      • ​16-24 Gbyte of RAM, more than 200 Gbyte of HD (this depends on data size you would like to have, we suggest 500 GByte in thin provisioning), and 8 cores or virtual cores, faster than 2GHz each.
      • The memory size depends on the number of IOT App you request. Each IOT App takes about 140Mbyte and 10% of a core, in a VM of 24Gbyte, 6 Cores you can have 70 IoT Apps, 100 Gbytes Storage in thin provisioning
      • an IoT Orion Broker can work with 6 Gbyte Ram, 2 Cores, 50 Gbytes.
      • presently there is limitation at 50 IOT App and 2 Brokers but this limitation can be removed having more resources.
      • If more IOT App and Brokers are needed we suggest to clone di VM2 and change the configurations!!
    • Estimated Time to install: 6 hours (Normal 10,2), time estimated when the VM area ready, the Domain is known, the mailing server is known, and the rest is of default.
    • Estimated Time to test and validate: 1.5 day (Normal 10,2)
  • Small X,Y: configurations with multple IoT App and multiple IoT Brokers. It is suitable for solutions in which the storage is growing and thus can be managed into a separate VM, and may be clustered later on.
    They are on 4 VM
    • VM1 MAIN: contains the main as Dashboards services, Knowlege Base, Resource Manager, Synoptics, WS, etc.
      • ​10-16 Gbyte of RAM, more than 50-200 Gbyte of HD (this depends on data size you would like to have, we suggest 500 GByte in thin provisioning), and 8 cores or virtual cores, faster than 2GHz each.
      • larger sizes may depend on the number of users you have
    • VM2: authentication and authorisation: LDAP, KeyCloak, ....
      • ​10-16 Gbyte of RAM, more than 50-100 Gbyte of HD and 8 cores or virtual cores, faster than 2000GHz.
    • VM3 STORAGE: NIFI, Open Distro for Elastic Sarch/Kibana,
      • ​24-32 Gbyte of RAM, more than 200-500 Gbyte of HD (this depends on data size you would like to have, we suggest 500-1000 GByte in thin provisioning), and 8 cores or virtual cores, faster than 2GHz each.
      • larger sizes may depend on the number of data you have, please note that you can replicate and cluster them later
    • VM4 IOT APPs and Brokers: X IoT Apps, Node-RED, MicroServices; and Y IoT Brokers. 
      • ​16-24 Gbyte of RAM, more than 200 Gbyte of HD (this depends on data size you would like to have, we suggest 500 GByte in thin provisioning), and 8 cores or virtual cores, faster than 2GHz each.
      • The memory size depends on the number of IOT App you request. Each IOT App takes about 140Mbyte and 10% of a core, in a VM of 24Gbyte, 6 Cores you can have 70 IoT Apps, 100 Gbytes Storage in thin provisioning
      • an IoT Orion Broker can work with 6 Gbyte Ram, 2 Cores, 50 Gbytes.
    • Estimated Time to install: 16 hours (Small 10,2), time estimated when the VM area ready, the Domain is known, the mailing server is known, and the rest is of default.
    • Estimated Time to test and validate: 3 days (Small 10,2)
  • DataCitySmall X,Y,Z: configurations with multple IoT App, multiple IoT Brokers, and multiple KB/ServiceMap. It is suitable for more scalable solutions in which the storage is growing and thus can be managed into a separate VM, also IoT App can be managed separately, such as also the IoT Brokers. It is the perfect starting point for replicating VM for storage, Brokers and IoT according to the needs, and thus for supporting MultiTenant solutions.
    They are on 6 VM
    • VM1 MAIN: contains the main as Dashboards services, Resource Manager, Synoptics, WS, etc.
      • ​10-16 Gbyte of RAM, more than 50-200 Gbyte of HD (this depends on data size you would like to have, we suggest 500 GByte in thin provisioning), and 8 cores or virtual cores, faster than 2GHz each
      • larger sizes may depend on the number of users you have
    • VM2: authentication and authorisation: LDAP, KeyCloak, ....
      • ​10-16 Gbyte of RAM, more than 50-100 Gbyte of HD and 8 cores or virtual cores, faster than 2000GHz.
    • VM3 STORAGE: NIFI, Open Distro for Elastic Sarch/Kibana,
      • ​24-32 Gbyte of RAM, more than 200-500 Gbyte of HD (this depends on data size you would like to have, we suggest 500-1000 GByte in thin provisioning), and 8 cores or virtual cores, faster than 2GHz each.
      • larger sizes may depend on the number of data you have, please note that you can replicate and cluster them later
    • VM4 IOT APPs: X IoT Apps, Node-RED, MicroServices.
      • ​16-24 Gbyte of RAM, more than 200 Gbyte of HD (this depends on data size you would like to have, we suggest 500 GByte in thin provisioning), and 8 cores or virtual cores, faster than 2GHz each.
      • The memory size depends on the number of IOT App you request. Each IOT App takes about 140Mbyte and 10% of a core, in a VM of 24Gbyte, 6 Cores you can have 70 IoT Apps, 100 Gbytes Storage in thin provisioning
    • VM5 IOT BROKERS: Y IoT Brokers, secure filter, etc.
      • ​8-12 Gbyte of RAM, more than 100 Gbyte of HD (this depends on data size you would like to have, we suggest 100-200 GByte in thin provisioning), and 8 cores or virtual cores, faster than 2GHz each.
      • please note that each IoT Orion Broker can work with 6 Gbyte Ram, 2-4 Cores, 50 Gbytes of storage.
    • VM6 Knowledge Bases: Z KB, ServiceMap, one for each organization, they can be federated each other. 
      • ​24-32 Gbyte of RAM, more than 200-500 Gbyte of HD (this depends on data size you would like to have, we suggest 200-400 GByte in thin provisioning), and 8 cores or virtual cores, faster than 2GHz each.
      • larger sizes may depend on the number of data you have, please note that you can replicate and federate later
    • Estimated Time to install: 3 days (DataCitySmall 10,2,2), time estimated when the VM area ready, the Domain is known, the mailing server is known, and the rest is of default.
    • Estimated Time to test and validate: 5 days (DataCitySmall 10,2,2)
  • DataCityMid X, Y, Z, T: is a mid range solution for medium size cities, with 
    • VM1 MAIN: contains the main as Dashboards services, Resource Manager, Synoptics, WS, etc.
      • ​10-16 Gbyte of RAM, more than 50-200 Gbyte of HD (this depends on data size you would like to have, we suggest 500 GByte in thin provisioning), and 8 cores or virtual cores, faster than 2GHz each
      • larger sizes may depend on the number of users you have
    • VM2: authentication and authorisation: LDAP, KeyCloak, ....
      • ​10-16 Gbyte of RAM, more than 50-100 Gbyte of HD and 8 cores or virtual cores, faster than 2000GHz.
    • STORAGE a number of VM in cluster for managing: NIFI, Open Distro for Elastic Sarch/Kibana, each of them
      • ​24-32 Gbyte of RAM, more than 200-500 Gbyte of HD (this depends on data size you would like to have, we suggest 500-1000 GByte in thin provisioning), and 8 cores or virtual cores, faster than 2GHz each.
      • larger sizes may depend on the number of data you have, please note that you can replicate and cluster them later
      • Since each VM is 500Gbyte, the number of VM depends on the volume of your storage and of the redundancy you need.
    • IOT APPs: a number of VM in cluster for managing a large number of IoT Apps, Node-RED, MicroServices, each of them, in the ange of 70-100 for each VM
      • ​16-24-30 Gbyte of RAM, more than 200 Gbyte of HD (this depends on data size you would like to have, we suggest 500 GByte in thin provisioning), and 8 cores or virtual cores, faster than 2GHz each.
      • The memory size depends on the number of IOT App you request. Each IOT App takes about 140Mbyte and 10% of a core, in a VM of 24Gbyte, 6 Cores you can have 70 IoT Apps, 100 Gbytes Storage in thin provisioning
    • a number of VM for managing IoT Brokers, secure filter, etc., each of them
      • ​8-12-18 Gbyte of RAM, more than 100 Gbyte of HD (this depends on data size you would like to have, we suggest 100-200 GByte in thin provisioning), and 8 cores or virtual cores, faster than 2GHz each.
      • please note that each IoT Orion Broker can work with 6 Gbyte Ram, 2-4 Cores, 50 Gbytes of storage.
      • typically 2/3 Brokers for each VM
    • a number of VM for managing Federated Organizations each of which with KB, ServiceMap, each of them
      • 24-32 Gbyte of RAM, more than 200-500 Gbyte of HD (this depends on data size you would like to have, we suggest 200-400 GByte in thin provisioning), and 8 cores or virtual cores, faster than 2GHz each.
      • larger sizes may depend on the number of data you have, please note that you can replicate and federate later
      • typically 1-2 KB for each VM.
    • another VM for the Heatmap Manager, Traffic Flow Manager, GeoServer, etc. 
    • other VM for other services.....
  • DataCityLarge

If you have problems with some configuration produced you have to contact us by providing the configuration TOKEN you could get at the end of the generation of the configuration files. 

PLEASE NOTE  THAT

In the form for producing the  configuration we are not asking you the email and password for configuring the system for sending emails, etc., and usualy notifications are sent by email by the solutions. 

So that in all the configuration in the VM1 you can open the file and write there your: SMTP server, your email account for the server, the corresponding password, and the sender name all personal information, that we avoid to request you to respect your privacy. Once you have performed the genration of  configuration files, they can be downloaded as ZIP file in which you can find a folder for each VM (named as the provided IP, that is the IPVM). The files in which you can set that information are:

Micro X configurations

Micro X: for example you can realize Micro 3, Micro 1 configurations as explained in the following

  • The Micro X configurations are suitble for solutions for small verticals and industries. 

    • X represents the number of IoT Applications that will be available after the intallation
    • the X # of IoT-Apps is the first information requested
  • The Micro X includes all tools into a single VM so that before starting you have to provide the IP of the VM in which Dockers will have to be installed
    • the IP is the second information requested by the tool to you
  • Click on "Fill Placeholders" will allow you to provide the information needed to finalize the generation of the Docker compose files
    • the placeholders are divided into two categories:
      • mandatory to be provided: that are those that you have to provide to complete the installation
      • Default Fields: which can be changed if needed by selecting "Show default Fields"
    • The Mandatory fields are, for example:
      • SEE ABOVE TO GET WHERE THE smntp information can be imposed.
      • Geo Location, GPS on map or values to be provided, of the unique IoT Orion Broker Fiware created in the solution
      • please note that the Password for posting email is not requested so that you have to fill it into .......... 
    • After setting the Mandatory fields, You can SAVE Configuration and a TOKEN is provided to reload the configuration and create a new one, or get again the file for deploy
    • At the same time a button for Download Configuration is activated. The ZIP file provided includes a subdirectory for each VM with the IP value, 1 VM in this case and thus one IP.
    • For example a VM Micro-2 contains:
  • DEPLOY: To execute the installation/configuration you need to have a VM (for example wth Debian) with Docker and Docker-Compose installed.
    • verify that your Docker and Docker-Compose are operative and well installed
    • Unapack the ZIP file in a directory. Move into the directory of the VM IP with command CD <IP>. There there a number of files that are going to be used in the successive steps, such as
      • docker-compose.yml 
      • apache-proxy.conf
      • post-setup.sh
      • setup.sh
    • Thus you can execute the installation by executing the command:
      • setup directories write permissions and sets vm.max_map_count=262144 for elasticsearch consider adding this option into /etc/sysctl.conf otherwise have to be set after each reboot (please neglect eventual NON docker errors, the solution tries to create directories in multiple places)
        • sudo ./setup.sh
      • deploy the containers, or to put them in execution if they have been aready installed
        • sudo docker-compose up
          • to perform a detached process: "docker-compose up -d"
      • setup virtuoso and elasticsearch (to be done only the first time but no problem if you repeat) (please neglect eventual NON docker errors, the solution tries to create directories in multiple places, give time to complete at the last command)
        • sudo ./post-setup.sh
      • ​please  note that the above commands have to be executed at each boot of the system / VM.
  • VERIFY: The process downloads from internet all the docker images needed and deploy/configuration the whole entities and finally putting in execution all containers, for example resulting in 10 minutes the following log on your terminal:
    • Creating 192168125_nifi_1              ... done
      Creating 192168125_elasticsearch_1     ... done
      Creating 192168125_dashboard-cron_1    ... done
      Creating 192168125_kibana_1            ... done
      Creating 192168125_iotapp-001_1        ... done
      Creating 192168125_dashboarddb_1    ... done
      Creating 192168125_synoptics_1      ... done
      Creating 192168125_zookeeper_1         ... done
      Creating 192168125_virtuoso-kb_1       ... done
      Creating 192168125_iotapp-002_1        ... done
      Creating 192168125_mongo-001_1         ... done
      Creating 192168125_iotapp-003_1        ... done
      Creating 192168125_ldap-server_1       ... done
      Creating 192168125_proxy_1             ... done
      Creating 192168125_dashboard-backend_1 ... done
      Creating 192168125_orion-001_1         ... done
      Creating 192168125_servicemap_1            ... done
      Creating 192168125_kafka_1                 ... done
      Creating 192168125_keycloak_1              ... done
      Creating 192168125_myldap_1                ... done
      Creating 192168125_orionbrokerfilter-001_1 ... done
      Creating 192168125_wsserver_1              ... done
      Creating 192168125_personaldata_1          ... done
      Creating 192168125_dashboard-builder_1     ... done
    • the first time can be useful to put in exceution in that manner to see all the progress, while the successive execution could be performed in background by using the "-d" option for detached.
  • with command "sudo docker container ls" is possible to get the list of containers in execution on your VM. When they are you can something similarly to
    • 400d37ccb85a   disitlab/personaldata:v2                    "catalina.sh run"         2 minutes ago   Up 2 minutes   0.0.0.0:8080->8080/tcp, :::8080->8080/tcp                                                                             192168125_personaldata_1
      a31860d39e2e   disitlab/dashboard-builder:v5               "docker-php-entrypoi…"    2 minutes ago   Up 2 minutes   0.0.0.0:70->80/tcp, :::70->80/tcp                                                                                     192168125_dashboard-builder_1
      cbeae5e8d703   disitlab/websocketserver:v2                 "/bin/sh -c 'sh -c \"…"   2 minutes ago   Up 2 minutes   0.0.0.0:9000->9000/tcp, :::9000->9000/tcp                                                                             192168125_wsserver_1
      82bc327fa61e   disitlab/orionbrokerfilter:v3               "catalina.sh run"         2 minutes ago   Up 2 minutes   8080/tcp, 0.0.0.0:8443->8443/tcp, :::8443->8443/tcp                                                                   192168125_orionbrokerfilter-001_1
      88cda8f44f64   disitlab/preconf-keycloak:v4                "/opt/jboss/tools/do…"    2 minutes ago   Up 2 minutes   8080/tcp, 0.0.0.0:8088->8088/tcp, :::8088->8088/tcp                                                                   192168125_keycloak_1
      38ee6e7bb14a   osixia/phpldapadmin                         "/container/tool/run"     2 minutes ago   Up 2 minutes   80/tcp, 0.0.0.0:6443->443/tcp, :::6443->443/tcp                                                                       192168125_myldap_1
      3788cda8ba08   bitnami/kafka:latest                        "/opt/bitnami/script…"    2 minutes ago   Up 2 minutes   0.0.0.0:9092-9093->9092-9093/tcp, :::9092-9093->9092-9093/tcp                                                         192168125_kafka_1
      45a479936ae8   disitlab/servicemap:v1                      "catalina.sh run"         2 minutes ago   Up 2 minutes   0.0.0.0:8090->8080/tcp, :::8090->8080/tcp                                                                             192168125_servicemap_1
      0a6e7c767a0a   fiware/orion                                "/usr/bin/contextBro…"    2 minutes ago   Up 2 minutes   0.0.0.0:1026->1026/tcp, :::1026->1026/tcp                                                                             192168125_orion-001_1
      f86f355af8e6   disitlab/dashboard-backend:v0               "/bin/sh -c ./run.sh"     2 minutes ago   Up 2 minutes                                                                                                                         192168125_dashboard-backend_1
      8ece26409bb8   mongo:3.6                                   "docker-entrypoint.s…"    2 minutes ago   Up 2 minutes   27017/tcp                                                                                                             192168125_mongo-001_1
      dc5d03dd2b2e   nginx                                       "/docker-entrypoint.…"    2 minutes ago   Up 2 minutes   0.0.0.0:80->80/tcp, :::80->80/tcp                                                                                     192168125_proxy_1
      5620a1069817   disitlab/snap4city-nodered-v1.1.3-adv:v21   "npm start -- --user…"    2 minutes ago   Up 2 minutes   0.0.0.0:1882->1880/tcp, :::1882->1880/tcp                                                                             192168125_iotapp-003_1
      fd72bb4aa238   tenforce/virtuoso:1.3.1-virtuoso7.2.1       "/bin/bash /virtuoso…"    2 minutes ago   Up 2 minutes   0.0.0.0:1111->1111/tcp, :::1111->1111/tcp, 0.0.0.0:8890->8890/tcp, :::8890->8890/tcp                                  192168125_virtuoso-kb_1
      f6a20255b785   zookeeper                                   "/docker-entrypoint.…"    2 minutes ago   Up 2 minutes   2888/tcp, 3888/tcp, 0.0.0.0:2181->2181/tcp, :::2181->2181/tcp, 8080/tcp                                               192168125_zookeeper_1
      6318892a87fb   disitlab/preconf-openldap:v2                "/container/tool/run…"    2 minutes ago   Up 2 minutes   0.0.0.0:389->389/tcp, :::389->389/tcp, 0.0.0.0:636->636/tcp, :::636->636/tcp                                          192168125_ldap-server_1
      ac1514569e25   disitlab/snap4city-nodered-v1.1.3-adv:v21   "npm start -- --user…"    2 minutes ago   Up 2 minutes   0.0.0.0:1881->1880/tcp, :::1881->1880/tcp                                                                             192168125_iotapp-002_1
      84b4f4427765   disitlab/synoptics:v0                       "docker-entrypoint.s…"    2 minutes ago   Up 2 minutes   0.0.0.0:3001-3002->3001-3002/tcp, :::3001-3002->3001-3002/tcp                                                         192168125_synoptics_1
      c3760ddec79d   mariadb                                     "docker-entrypoint.s…"    2 minutes ago   Up 2 minutes   0.0.0.0:3306->3306/tcp, :::3306->3306/tcp                                                                             192168125_dashboarddb_1
      6e05d5d776b7   kibana:6.8.5                                "/usr/local/bin/kiba…"    2 minutes ago   Up 2 minutes   0.0.0.0:5601->5601/tcp, :::5601->5601/tcp                                                                             192168125_kibana_1
      c003cf40be0f   elasticsearch:6.8.5                         "/usr/local/bin/dock…"    2 minutes ago   Up 2 minutes   0.0.0.0:9200->9200/tcp, :::9200->9200/tcp, 9300/tcp                                                                   192168125_elasticsearch_1
      ab3490775ef1   disitlab/dashboard-builder:v4               "docker-php-entrypoi…"    2 minutes ago   Up 2 minutes   80/tcp                                                                                                                192168125_dashboard-cron_1
      16b397fa5dbb   apache/nifi:1.9.2                           "../scripts/start.sh"     2 minutes ago   Up 2 minutes   8080/tcp, 0.0.0.0:1030->1030/tcp, :::1030->1030/tcp, 8443/tcp, 0.0.0.0:9090->9090/tcp, :::9090->9090/tcp, 10000/tcp   192168125_nifi_1
      9c53e870f480   disitlab/snap4city-nodered-v1.1.3-adv:v21   "npm start -- --user…"    2 minutes ago   Up 2 minutes   0.0.0.0:1880->1880/tcp, :::1880->1880/tcp                                                                             192168125_iotapp-001_1
      CONTAINER ID   IMAGE                                       COMMAND                   CREATED         STATUS         PORTS                                                                                                                 NAMES
    • the resulting services will be at the following port on the main <IP>, for a schema see https://www.snap4city.org/docker-generator/micro_components_x​​
      • virtuoso: 8890, 1111
      • Servicemap: 8890, 8880
      • kafka: 9092, 9093
      • zookeeper: 2181
      • dashboard back end: 
      • dahboard front end: 80
      • database mysql: 3306
      • wsserver: 9000
      • ldap server 389, 636
      • nodered application 1, node-red editing 1880
      • nodered application 2, node.red editing 1881
      • orion broker. 1026:1026
      • Mongo on orion broker: 27017
      • elastic search: 9200
      • kibana 5601
      • nifi: 9090
      • personaldata service: 8080 
      • keycloak 8088 
      • synoptics: 3000, 3001
      • orionbrokerfilter 8443
      • phpldapadmin 6443, 443
  • OPEN the Interface You can test the correct installation from another computer in the same network. This computer has to present in its etc/hosts file the statement
  • GET MORE: See https://github.com/disit/snap4city-docker/blob/master/DataCity-Small/README.md for

Normal X,Y configurations:

  • it is more complete than the Basic configuration of ​https://www.snap4city.org/471
  • it is based on two VMs see the MICRO X Config. one for the MAIN and the second for the scaling of IOT APP and Orion Brokers. 
  • WE SUGGEST:
    • read carefully the MICRO X configuration since almost all steps are very similar and they are NOT repeated here-
    • the main difference is the fact that Two IPs are requested and the allocations of module is performed as above described.
  • DEPLOY: To execute the installation/configuration you need to have a VM (for example wth Debian) with Docker and Docker-Compose installed.
    • verify that your Docker and Docker-Compose are operative and well installed
    • Unapack the ZIP file in a directory. Move into the directory of the VM IP with command CD <IP>. There there a number of files that are going to be used in the successive steps, such as
      • docker-compose.yml, apache-proxy.conf, post-setup.sh, setup.sh
    • IN VM1 you have to execute the installation by executing the commands (please neglect eventual NON docker errors, the solution tries to create directories in multiple places, AND give time to complete the work at the last command):
      • verify the IP of the VM. It has to be the one of the configuration and the network has to reacheable
      • sudo ./setup.sh
      • sudo docker-compose up -d
      • sudo ./post-setup.sh
      • ​please  note that the above commands have to be executed at each boot of the system / VM.
    • IN VM2 you have to execute the installation by executing the commands:
  • VERIFY: The process downloads as in the MICRO X
    • OPEN the Interface
      • http:///dashboardSmartCity/ 
    • enter with the credentials of MICRO X
    • Go in the IoT App 01 to see the status of the solution as described in MICRO X
    •  

Small-X-Y configurations:

 

DataCitySmall-X-Y-Z configurations:

 

DataCityMid-X-Y-Z configurations:

 

DataCityLarge configurations:

 

 

 

  • Share

Comments

aliferisi - Wed, 06/08/2022 - 10:21

Running  root@snap4city-swtd:~/172.30.1.243# docker compose up I get

 Error response from daemon: driver failed programming external connectivity on endpoint 172301243-synoptics-1 (905884ff1c384c75857d0c7ea9d4562f5f2aaf462f757d053e5100b9d28cec4c): Bind for 0.0.0.0:3001 failed: port is already allocated

 

I see that both iot-directory-discover-api and synoptics:v1 publish the 3001 port.

 

I am attaching the parameters and docker compose file. Also note that this is a fresh Micro X install with docker compose files just created from  https://www.snap4city.org/docker-generator/selecting_model

 

 

 

root@snap4city-swtd:~/172.30.1.243# grep -B 10 3001 docker-compose.yml

- ./mariadb-conf:/etc/mysql/mariadb.conf.d:rw

- dashboarddb:/var/lib/mysql:rw

iot-discovery:

image: disitlab/iot-directory-discover-api:v0

logging:

driver: json-file

options:

max-file: '10'

max-size: 100m

ports:

- published: 3001

target: 3001

--

max-size: 100m

ports:

- published: 8983

target: 8983

restart: unless-stopped

volumes:

- solr-data:/var/solr:rw

synoptics:

image: disitlab/synoptics:v1

ports:

- published: 3001

target: 3001

 

roottooladmin1's picture

roottooladmin1 - Mon, 06/20/2022 - 08:58

means that on your host machine port 3001 is already used for some other service/process

you can comment the lines that map this port on the host

normally is not needed

synoptics:
    image: disitlab/synoptics:v1
#    ports:
#    - published: 3001
#      target: 3001
#    - published: 3002
#      target: 3002
    restart: always
    volumes:
    - ./synoptics-conf/config.js:/usr/src/synoptics/new-config.js:rw
    - ./synoptics-conf/v2-config.js:/usr/src/synoptics/v2/new-config.js:rw