Changes to v0.7.0 and some improvements (#133)

* changes to v0.7.0 * add miss break * add more info in release
dojot · Jun 22, 2021 · 2fc4fec · 2fc4fec
1 parent ca43c4a
commit 2fc4fec
Show file tree

Hide file tree

Showing 14 changed files with 1,216 additions and 1,340 deletions.
diff --git a/source/components-and-apis.rst b/source/components-and-apis.rst
@@ -441,57 +441,57 @@ dojot.
 .. _InfluxDB site: https://www.influxdata.com/
 .. _InfluxDB doc.: https://docs.influxdata.com/
 
-.. _GitHub - auth: https://github.com/dojot/auth/tree/v0.6.0
-.. _API - auth: https://dojot.github.io/auth/apiary_v0.6.0.html
-.. _Messages - auth: https://github.com/dojot/auth/tree/v0.6.0#kafka-messages
+.. _GitHub - auth: https://github.com/dojot/auth/tree/v0.7.0
+.. _API - auth: https://dojot.github.io/auth/apiary_v0.7.0.html
+.. _Messages - auth: https://github.com/dojot/auth/tree/v0.7.0#kafka-messages
 
-.. _GitHub - Dojot Kong: https://github.com/dojot/kong/tree/v0.6.0
+.. _GitHub - Dojot Kong: https://github.com/dojot/kong/tree/v0.7.0
 
-.. _GitHub - history: https://github.com/dojot/history/tree/v0.6.0
-.. _API - history: https://dojot.github.io/history/apiary_v0.6.0.html
+.. _GitHub - history: https://github.com/dojot/history/tree/v0.7.0
+.. _API - history: https://dojot.github.io/history/apiary_v0.7.0.html
 
 
-.. _GitHub - DeviceManager: https://github.com/dojot/device-manager/tree/v0.6.0
-.. _API - DeviceManager: https://dojot.github.io/device-manager/apiary_v0.6.0.html
-.. _Messages - DeviceManager: https://github.com/dojot/device-manager/tree/v0.6.0#events
+.. _GitHub - DeviceManager: https://github.com/dojot/device-manager/tree/v0.7.0
+.. _API - DeviceManager: https://dojot.github.io/device-manager/apiary_v0.7.0.html
+.. _Messages - DeviceManager: https://github.com/dojot/device-manager/tree/v0.7.0#events
 
-.. _GitHub - image-manager: https://github.com/dojot/image-manager/tree/v0.6.0
-.. _API - image-manager: https://dojot.github.io/image-manager/apiary_v0.6.0.html
+.. _GitHub - image-manager: https://github.com/dojot/image-manager/tree/v0.7.0
+.. _API - image-manager: https://dojot.github.io/image-manager/apiary_v0.7.0.html
 
 
-.. _GitHub - GUI: https://github.com/dojot/gui/tree/v0.6.0
+.. _GitHub - GUI: https://github.com/dojot/gui/tree/v0.7.0
 
 
-.. _GitHub - flowbroker: https://github.com/dojot/flowbroker/tree/v0.6.0
-.. _API - flowbroker: https://dojot.github.io/flowbroker/apiary_v0.6.0.html
+.. _GitHub - flowbroker: https://github.com/dojot/flowbroker/tree/v0.7.0
+.. _API - flowbroker: https://dojot.github.io/flowbroker/apiary_v0.7.0.html
 
-.. _GitHub - data-broker: https://github.com/dojot/data-broker/tree/v0.6.0
-.. _API - data-broker: https://dojot.github.io/data-broker/apiary_v0.6.0.html
+.. _GitHub - data-broker: https://github.com/dojot/data-broker/tree/v0.7.0
+.. _API - data-broker: https://dojot.github.io/data-broker/apiary_v0.7.0.html
 
 .. _Messages - iotagent-mosca: http://dojotdocs.readthedocs.io/projects/iotagent-mosca/en/latest/operation.html#sending-messages-to-other-components-via-kafka
-.. _GitHub - iotagent-mosca: https://github.com/dojot/iotagent-mosca/tree/v0.6.0
+.. _GitHub - iotagent-mosca: https://github.com/dojot/iotagent-mosca/tree/v0.7.0
 
-.. _GitHub - iotagent-vernemq: https://github.com/dojot/dojot/tree/v0.6.0/connector/mqtt/vernemq
+.. _GitHub - iotagent-vernemq: https://github.com/dojot/dojot/tree/v0.7.0/connector/mqtt/vernemq
 
-.. _GitHub - iotagent-leshan: https://github.com/dojot/iotagent-leshan/tree/v0.6.0
+.. _GitHub - iotagent-leshan: https://github.com/dojot/iotagent-leshan/tree/v0.7.0
 
 
-.. _GitHub - Data Manager: https://github.com/dojot/data-manager/tree/v0.6.0
-.. _API - Data Manager: https://dojot.github.io/data-manager/apiary_v0.6.0.html
+.. _GitHub - Data Manager: https://github.com/dojot/data-manager/tree/v0.7.0
+.. _API - Data Manager: https://dojot.github.io/data-manager/apiary_v0.7.0.html
 
-.. _GitHub - Cron: https://github.com/dojot/cron/tree/v0.6.0
-.. _API - Cron: https://dojot.github.io/cron/apiary_v0.6.0.html
+.. _GitHub - Cron: https://github.com/dojot/cron/tree/v0.7.0
+.. _API - Cron: https://dojot.github.io/cron/apiary_v0.7.0.html
 
-.. _GitHub - x509-identity-mgmt: https://github.com/dojot/dojot/tree/v0.6.0/x509-identity-mgmt
-.. _API - x509-identity-mgmt: https://dojot.github.io/dojot/x509-identity-mgmt/apiary_v0.6.0.html
+.. _GitHub - x509-identity-mgmt: https://github.com/dojot/dojot/tree/v0.7.0/iam/x509-identity-mgmt
+.. _API - x509-identity-mgmt: https://dojot.github.io/dojot/iam/x509-identity-mgmt/apiary_v0.7.0.html
 
-.. _GitHub - Kafka2Ftp: https://github.com/dojot/dojot/tree/v0.6.0/connector/kafka2ftp
+.. _GitHub - Kafka2Ftp: https://github.com/dojot/dojot/tree/v0.7.0/connector/kafka2ftp
 
-.. _GitHub - Kafka WS: https://github.com/dojot/dojot/tree/v0.6.0/subscription-engine/kafka-ws
-.. _API - kafka-ws: https://dojot.github.io/dojot/subscription-engine/kafka-ws/apiary_v0.6.0.html
+.. _GitHub - Kafka WS: https://github.com/dojot/dojot/tree/v0.7.0/subscription-engine/kafka-ws
+.. _API - kafka-ws: https://dojot.github.io/dojot/subscription-engine/kafka-ws/apiary_v0.7.0.html
 
-.. _GitHub - V2: https://github.com/dojot/gui-v2/tree/v0.6.0
+.. _GitHub - V2: https://github.com/dojot/gui-v2/tree/v0.7.0
 
 
-.. _GitHub - InfluxDB Storer and Retriever: https://github.com/dojot/dojot/tree/v0.6.0/storage/time-series/influxdb
-.. _API - InfluxDB-Retriever: https://dojot.github.io/dojot/storage/time-series/influxdb/retriever/doc.html?version=v0.6.0
+.. _GitHub - InfluxDB Storer and Retriever: https://github.com/dojot/dojot/tree/v0.7.0/storage/time-series/influxdb
+.. _API - InfluxDB-Retriever: https://dojot.github.io/dojot/storage/time-series/influxdb/retriever/doc.html?version=v0.7.0
diff --git a/source/conf.py b/source/conf.py
@@ -54,9 +54,9 @@
 # built documents.
 #
 # The short X.Y version.
-version = u'v0.6.0'
+version = u'v0.7.0'
 # The full version, including alpha/beta/rc tags.
-release = u'v0.6.0'
+release = u'v0.7.0'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

diff --git a/source/faq/faq.rst b/source/faq/faq.rst
@@ -128,9 +128,10 @@ If you need another version, you could checkout a tag instead:
     v0.5.1
     v0.5.2
     v0.6.0
+    v0.7.0
 
 
-  $ git checkout v0.6.0
+  $ git checkout v0.7.0
 
 
 Devices
@@ -455,5 +456,5 @@ Check the documentation API for  *History* and *Kafka WS* in :doc:`./../componen
 And to a tutorial on how to use the flow, check :doc:`../flow`.
 
 
-.. _flowbroker library : https://github.com/dojot/flowbroker/tree/v0.6.0/lib
+.. _flowbroker library : https://github.com/dojot/flowbroker/tree/master/lib
 
diff --git a/source/flow.rst b/source/flow.rst
@@ -31,25 +31,7 @@ Device Event in
 
 This node specifies that messages received from or sent to a particular device.
 The message created by this node is somewhat different than the one created by
-DeviceIn node:
-
-.. code-block:: json
-
-    {
-        "data": {
-            "attrs": {
-                "temperature": 10,
-                "some-static-attr": "efac"
-            }
-        }
-    }
-
-This structure can be referenced in nodes like `Template`_ such as:
-
-.. code-block:: handlebars
-
-    Sample message {{payload.data.attrs.temperature}}
-
+DeviceIn node.
 
 
 To configure the device in node, a window like :numref:`event-device-in-panel`
@@ -71,6 +53,54 @@ Fields:
   `Actuation` option will select actuation messages (those sent to the device)
   and `Publication` will select all messages published by the device.
 
+Messages examples generated by this node:
+
+**For a `Publication` event:**
+
+.. code-block:: json
+
+    {
+        "data": {
+            "attrs": {
+                "temperature": 10,
+            },
+            "id":"9face8"
+        },
+        "metadata": {
+            "timestamp":1623163659936,
+            "tenant":"admin"
+        },
+        "event": "publish"
+    }
+
+
+**For a `Actuation` event:**
+
+.. code-block:: json
+
+    {
+        "data": {
+            "attrs": {
+                "temperature": 10,
+            },
+            "id":"9face8"
+        },
+        "metadata": {
+            "timestamp":1623163659936,
+            "tenant":"admin"
+        },
+        "event": "configure"
+    }
+
+
+This structure can be referenced in nodes like `Template`_ and others such as:
+
+
+.. code-block:: handlebars
+
+    Sample message {{payload.data.attrs.temperature}}
+
+
 .. note::
     If the the device that triggers a flow is removed, the flow won't work
     anymore.
@@ -92,6 +122,7 @@ trigger the flow. For example: *device1* is composed by templates [A,B],
 only messages from *device1* and *device2* will initiate the flow, because
 template A is one of the templates that compose those devices.
 
+To better understand the JSON within the `data` key for the `Creation`, `Update`, `Removal` events see the `device-manager` documentation.
 
 .. _event-template-in-panel:
 .. figure:: images/nodes/event-template-in-panel.png
@@ -111,6 +142,134 @@ Fields:
   the device and `Publication` will trigger this flow whenever a device
   publishes a message to dojot.
 
+Messages examples generated by this node:
+
+**For a `Publication` event:**
+
+.. code-block:: json
+
+    {
+        "data": {
+            "attrs": {
+                "temperature": 10,
+            },
+            "id":"9face8"
+        },
+        "metadata": {
+            "timestamp":1623163659936,
+            "tenant":"admin"
+        },
+        "event": "publish"
+    }
+
+
+**For a `Actuation` event:**
+
+.. code-block:: json
+
+    {
+        "data": {
+            "attrs": {
+                "temperature": 10,
+            },
+            "id":"9face8"
+        },
+        "metadata": {
+            "timestamp":1623163659936,
+            "tenant":"admin"
+        },
+        "event": "configure"
+    }
+
+
+**For a `Creation` event (creating a device using that template):**
+
+.. code-block:: json
+
+    {
+        "data": {
+            "label":"template_name"
+            "id":"9face8"
+            "templates":["1"]
+            "created":"2021-06-08T14:46:27.008321+00:00"
+            "attrs": {
+                "temperature": {
+                        "id":1,
+                        "value_type":"float",
+                        "static_value":"",
+                        "type":"dynamic",
+                        "template_id":"1",
+                        "created":"2021-06-08T14:33:24.330779+00:00",
+                        "is_static_overridden":false
+                    }
+                },
+        },
+        "metadata": {
+            "tenant":"admin"
+        },
+        "event": "create"
+    }
+
+
+**For a `Update` event (Generated by changing a template or adding a template to an existing device):**
+
+
+.. code-block:: json
+
+    {
+        "data": {
+            "label":"template_name"
+            "id":"9face8"
+            "templates":["1"]
+            "created":"2021-06-08T14:46:27.008321+00:00"
+            "updated":"2021-06-08T14:51:16.003916+00:00"
+            "attrs": {
+                "temperature": {
+                        "id":1,
+                        "value_type":"float",
+                        "static_value":"",
+                        "type":"dynamic",
+                        "template_id":"1",
+                        "created":"2021-06-08T14:33:24.330779+00:00",
+                        "is_static_overridden":false
+                    }
+                },
+        },
+        "metadata": {
+            "tenant":"admin"
+        },
+        "event": "update"
+    }
+
+
+**For a `Removal` event (When removing a template from a device):**
+
+.. code-block:: json
+
+    {
+        "data": {
+            "label":"template_name"
+            "id":"9face8"
+            "templates":["1"]
+            "created":"2021-06-08T14:46:27.008321+00:00"
+            "updated":"2021-06-08T14:51:16.003916+00:00"
+            "attrs": {
+                "temperature": {
+                        "id":1,
+                },
+        },
+        "metadata": {
+            "tenant":"admin"
+        },
+        "event": "remove"
+    }
+
+This structure can be referenced in nodes like `Template`_ and others such as:
+
+.. code-block:: handlebars
+
+    Sample message {{payload.data.attrs.temperature}}
+
 
 Multi device out
 ****************

diff --git a/source/installation-guide.rst b/source/installation-guide.rst
@@ -68,7 +68,9 @@ Docker Compose
     src="https://www.youtube.com/embed/aZ-Wtcd_Ydw?rel=0" frameborder="0"
     allowfullscreen></iframe><br/>
 
-In this video tutorial above, version v0.4.2 is used, but the same video is valid for the current version, it is only necessary to change to version v0.6.0.
+In this video tutorial above, version v0.4.2 is used, but the same video is valid for the current version, it is only necessary to change to version v0.7.0.
+
+For a guide on how to use **HTTPS** go to this link: https://github.com/dojot/docker-compose/tree/v0.7.0#how-to-secure-dojot-with-nginx-and-lets-encrypt
 
 This document provides instructions on how to create a trivial deployment
 environment on single host for *dojot*, using Compose as the processes
@@ -142,7 +144,7 @@ replaced): ::
 
 For instance: ::
 
-  git checkout v0.6.0 -b v0.6.0
+  git checkout v0.7.0 -b v0.7.0
 
 
 That done, the environment can be brought up by: ::

diff --git a/source/load-testing-dojot-platform.rst b/source/load-testing-dojot-platform.rst
@@ -23,7 +23,7 @@ the same version as your current environment:
 
   git clone https://github.com/dojot/dojot.git
   cd dojot
-  git checkout v0.6.0
+  git checkout v0.7.0
 
 Enter in Locust directory:
 

diff --git a/source/locale/pt_BR/LC_MESSAGES/copyright-and-license.po b/source/locale/pt_BR/LC_MESSAGES/copyright-and-license.po
@@ -5,7 +5,7 @@
 #
 msgid ""
 msgstr ""
-"Project-Id-Version: dojot v0.6.0\n"
+"Project-Id-Version: dojot v0.7.0\n"
 "Report-Msgid-Bugs-To: \n"
 "POT-Creation-Date: 2021-02-05 15:36-0300\n"
 "PO-Revision-Date: 2021-02-05 15:42-0300\n"

diff --git a/source/locale/pt_BR/LC_MESSAGES/faq.po b/source/locale/pt_BR/LC_MESSAGES/faq.po
@@ -747,13 +747,12 @@ msgid "How can I add a new node type to its menu?"
 msgstr "Como eu posso adicionar um novo tipo de nó no menu?"
 
 #: ../../source/faq/faq.rst:415
-#, fuzzy
 msgid ""
 "There is a tutorial on how to add new nodes and two examples of node too, check "
 "the `flowbroker library`_ for more details."
 msgstr ""
 "Há um tutorial sobre como adicionar novos nós e dois exemplos de nós também, "
-"verifique o repositório GitHub flowbroker para mais detalhes."
+"verifique `flowbroker library`_ para mais detalhes."
 
 #: ../../source/faq/faq.rst:420
 msgid "Applications"