Merge pull request #411 from flaviocirillo/fogflow-fcfork

Fixed tutorial files and documentation

Author: smartfog

broker/ngsild.go

@@ -38,21 +38,31 @@ func (tb *ThinBroker) NGSILD_CreateEntity(w rest.ResponseWriter, r *rest.Request
 
 	err := r.DecodeJsonPayload(&entity)
 	if err != nil {
-		DEBUG.Println("not able to decode the received message")
+		if LoggerIsEnabled(DEBUG) {
+			DEBUG.Println("not able to decode the received message")
+		}
 		rest.Error(w, err.Error(), http.StatusInternalServerError)
 		return
 	}
 
 	ngsildUpsert := make([]map[string]interface{}, 0)
 	ngsildUpsert = append(ngsildUpsert, entity)
 
+	if LoggerIsEnabled(DEBUG) {
+		DEBUG.Println("NGSI LD Upsert:")
+		DEBUG.Println(ngsildUpsert)
+	}
+
 	updateCtxReq := UpdateContextRequest{}
 	numUpdates := updateCtxReq.ReadFromNGSILD(ngsildUpsert)
 
 	// check and add the "Fiware-Correlator" header into the update message
 	updateCtxReq.Correlator = r.Header.Get("Fiware-Correlator")
 
-	// DEBUG.Println(updateCtxReq)
+	if LoggerIsEnabled(DEBUG) {
+		DEBUG.Println("NGSI updateCtxReq")
+		DEBUG.Println(updateCtxReq)
+	}
 
 	if numUpdates > 0 {
 		tb.handleInternalUpdateContext(&updateCtxReq)

broker/thinBroker.go

@@ -429,7 +429,9 @@ func (tb *ThinBroker) UpdateContext2RemoteSite(ctxElem *ContextElement, updateAc
 func (tb *ThinBroker) notifySubscribers(ctxElem *ContextElement, correlator string, checkSelectedAttributes bool) {
 	eid := ctxElem.Entity.ID
 
-	// DEBUG.Println("elements", ctxElem)
+	if LoggerIsEnabled(DEBUG) {
+		DEBUG.Println("elements to check against subscription", ctxElem)
+	}
 
 	tb.e2sub_lock.RLock()
 	defer tb.e2sub_lock.RUnlock()
@@ -480,7 +482,9 @@ func (tb *ThinBroker) notifySubscribers(ctxElem *ContextElement, correlator stri
 			elements = append(elements, *ctxElem)
 		}
 
-		// DEBUG.Println("elements", elements)
+		if LoggerIsEnabled(DEBUG) {
+			DEBUG.Println("elements", elements)
+		}
 		go tb.sendReliableNotify(elements, sid)
 	}
 }

common/communicator/communicator.go

@@ -155,8 +155,6 @@ func (communicator *Communicator) consumeOne(d amqp.Delivery, taskProcessor Task
 		return
 	}
 
-	//log.Printf("Received new message: %s", d.Body)
-
 	msg := RecvMessage{}
 	if err := json.Unmarshal(d.Body, &msg); err != nil {
 		d.Nack(false, false) // multiple, requeue

designer/package.json

@@ -4,10 +4,10 @@
     "description": "web portal for users to manage the system and applications",
     "author": "Bin Cheng<bin.cheng@neclab.eu>",
     "main": "main.js",
+    "type": "module",
     "scripts": {
         "start": "node main.js"
     },
-    "type": "module",
     "dependencies": {
         "amqplib": "^0.8.0",
         "axios": "*",

docs/en/source/conf.py

@@ -17,5 +17,5 @@
 # -- Options for HTML output ----------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
 
-#html_theme = 'alabaster'
+html_theme = 'sphinx_rtd_theme'
 #html_static_path = ['_static']

docs/en/source/onepage.rst

@@ -49,7 +49,8 @@ To install Docker CE, please refer to `Install Docker CE`_, required version > 1
 
 
 .. important:: 
-	**please also allow your user to execute the Docker Command without Sudo `Docker Post-Install`_**
+	
+	Please also allow your user to execute the Docker Command without Sudo `Docker Post-Install`_
 
 
 
@@ -76,7 +77,7 @@ Download the docker-compose file and the configuration files as below.
 	wget https://raw.githubusercontent.com/smartfog/fogflow/refs/heads/development/release/latest/cloud/docker-compose.yml
 	
 	# the template of the configuration file used by all FogFlow components
-	wget https://github.com/smartfog/fogflow/blob/development/release/latest/cloud/config-template.json
+	wget https://raw.githubusercontent.com/smartfog/fogflow/refs/heads/development/release/latest/cloud/config-template.json
 
 	# the configuration file for ngsix server
 	wget https://raw.githubusercontent.com/smartfog/fogflow/refs/heads/development/release/latest/cloud/nginx.conf
@@ -244,13 +245,13 @@ There are two ways to check if the FogFlow cloud node is started correctly:
 
 .. important:: 
 
-	if you see any container is missing, you can run "docker ps -a" to check if any FogFlow component is terminated with some 
+	If you see any container missing, you can run "docker ps -a" to check if any FogFlow component is terminated with some 
 	problem. If there is, you can further check its output log by running "docker logs [container ID]"
 
 
 - Check the system status from the FogFlow DashBoard
 
-You can open the FogFlow dashboard in your web browser to see the current system status via the URL: http://<my_hostip>/index.html
+You can open the FogFlow dashboard in your web browser to see the current system status via the URL: `http://<my_hostip>/index.html`
 
 
 .. important:: 
@@ -366,6 +367,8 @@ Let's first connect FogFlow to get the data from a NGSI-LD context broker. The i
 In order to do so, send the following request:
 
 .. code-block:: console  
+
+	
 	curl --silent --output /dev/null  --location "http://<SCORPIO_HOST>:9090/ngsi-ld/v1/subscriptions" \
         --header 'Content-Type: application/ld+json' \
         --data-raw '{ 
@@ -392,6 +395,8 @@ In order to connect FogFlow to forward data to the NGSI-LD context broker, we ne
 with a request that looks like the following (note that to set the destination as NGSI-LD we use a header):
 
 .. code-block:: console  
+
+
 	curl --location 'http://<FOGFLOW_BROKER>:8070/ngsi10/subscribeContext' \
 	--header 'Destination: NGSI-LD' \
 	--header 'Fiware-Correlator: http://<SCORPIO_HOST>:9090/' \

release/latest/cloud/config-template.json

@@ -13,7 +13,7 @@
     },
     "discovery": {
         "http_port": 8090,
-        "storeOnDisk": true,
+        "storeOnDisk": false,
         "delayStoreOnFile" : 3
     },
     "broker": {
@@ -37,7 +37,7 @@
         "webSrvPort": 8080,
         "agentPort": 1030,
         "ldAgentPort":1090,
-	"doNotInitApplications":true
+	    "doNotInitApplications":true
     },    
     "rabbitmq": {
         "port": 5672,

release/latest/cloud/config.json

@@ -1,5 +1,5 @@
 {
-    "my_hostip": "10.1.99.17",
+    "my_hostip": "host.docker.internal",
     "physical_location":{
         "longitude": 139,
         "latitude": 35
@@ -9,7 +9,7 @@
         "info":"stdout",
         "error":"stdout",
         "protocol": "stdout",
-        "debug": "stdout"
+        "debug": "discard"
     },
     "discovery": {
         "http_port": 8090,

release/latest/cloud/docker-compose.yml

@@ -1,19 +1,19 @@
 version: "3"
 services:     
-#    designer:
-#        image: fogflow/designer:latest
-#        volumes:
-#            - ./config.json:/app/config.json
+    designer:
+        image: fogflow/designer:latest
+        volumes:
+            - ./config.json:/app/config.json
 #            - ./designerDB/:/app/public/data/meta/
-#        ports:
-#            - 8080:8080
-#            - 1030:1030
-#            - 1090:1090
-#        depends_on: 
-#            - discovery
-#            - cloud_broker
-#            - rabbitmq
-#        restart: always
+        ports:
+            - 8080:8080
+            - 1030:1030
+            - 1090:1090
+        depends_on: 
+            - discovery
+            - cloud_broker
+            - rabbitmq
+        restart: always
 
     discovery:
         image: fogflow/discovery:latest
@@ -22,7 +22,7 @@ services:
 #            - ./discoveryDB/registrations.json:/registrations.json                        
 #            - ./discoveryDB/brokers.json:/brokers.json                        
 #            - ./discoveryDB/subscriptions.json:/subscriptions.json                        
-            - ./discoveryDB/:/discoveryDB/                        
+#            - ./discoveryDB/:/discoveryDB/                        
         ports:
             - 8090:8090
         restart: always

release/latest/cloud/nginx.conf

@@ -7,9 +7,9 @@ http {
         listen              80;
         server_name         www.fogflow.io;
 
-#        location / {
-#            proxy_pass   http://designer:8080/;
-#        }
+        location / {
+            proxy_pass   http://designer:8080/;
+        }
 
         location /ngsi9/ {
             proxy_pass   http://discovery:8090/ngsi9/;