Skip to content

Commit

Permalink
Add using mqtts with vernemq, others refs to vernemq and some reviews (
Browse files Browse the repository at this point in the history
  • Loading branch information
Mariane Previde committed Sep 16, 2020
1 parent c177a2f commit c41c647
Show file tree
Hide file tree
Showing 26 changed files with 2,309 additions and 2,490 deletions.
6 changes: 2 additions & 4 deletions source/architecture.rst
Original file line number Diff line number Diff line change
Expand Up @@ -80,8 +80,8 @@ different users and applications data, enabling a multi-tenant infrastructure.

The DataBroker service makes use of an in-memory database for efficiency. It
adds context to Apache Kafka, making it possible that internal or even external
services are able to consume real-time data based on context. DataBroker is
also a distributed service to avoid it being a single point of failure or even
services are able to consume real-time data based on context. DataBroker can also be
a distributed service to avoid it being a single point of failure or even
a bottleneck for the architecture.

DeviceManager
Expand Down Expand Up @@ -250,8 +250,6 @@ All components communicate with each other in two ways:
need to know which component is sending data through a particular topic.


.. _iotagent-mosca: https://github.com/dojot/iotagent-mosca
.. _Mosca: https://github.com/mcollina/mosca
.. _x.509: https://en.wikipedia.org/wiki/X.509
.. _CA: https://en.wikipedia.org/wiki/Certificate_authority
.. _CSR: https://en.wikipedia.org/wiki/Certificate_signing_request
53 changes: 39 additions & 14 deletions source/components-and-apis.rst
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,14 @@ Components
- `Kafka site`_
- `Kafka doc.`_
-
* - VerneMQ
- `VerneMQ site`_
- `VerneMQ doc.`_
-
* - Leshan
- `Leshan site`_
- `Leshan doc.`_
-
* - Auth
- `GitHub - auth`_
- `Auth doc.`_
Expand Down Expand Up @@ -67,11 +75,21 @@ Components
- `GitHub - data-broker`_
-
- `API - data-broker`_
* - | Iotagent Mosca
| (MQTT)
* - | IotAgent VerneMQ
| (MQTT) - **Default**
- `GitHub - iotagent-vernemq`_
-
-
* - | IotAgent Mosca
| (MQTT) - **Legacy**
- `GitHub - iotagent-mosca`_
-
-
* - | IotAgent Leshan
| (LWM2M)
- `GitHub - iotagent-leshan`_
-
-
* - Data Manager
- `GitHub - Data Manager`_
-
Expand All @@ -93,19 +111,18 @@ Components
Exposed APIs (API Gateway)
--------------------------


The API gateway used in dojot reroutes some of endpoints from component.
The following table shows which **endpoint exposed
The following table shows which **Exposed endpoint
by the API gateway** is mapped to which **component endpoint**,
its **component endpoint Documentation** and
whether the endpoint **needs authentication** when used via API Gateway.
See more about how using API in :ref:`Using API interface`.
See more about how using APIs in :doc:`./using-api-interface`.

.. list-table:: Exposed endpoints
:header-rows: 1

* - | Component
- | Endpoint exposed
- | Exposed endpoint
| by the API gateway
- | Component
| Endpoint
Expand Down Expand Up @@ -142,7 +159,7 @@ See more about how using API in :ref:`Using API interface`.
* - Auth
- **/auth**/revoke
- /revoke
-
- `API - auth`_
- No
* - Auth
- **/auth**/user
Expand Down Expand Up @@ -186,30 +203,30 @@ See more about how using API in :ref:`Using API interface`.
- | /device/
| {deviceID}
| /latest
-
- `API - data-broker`_
- Yes
* - Data Broker
- /subscription
- /subscription
-
- `API - data-broker`_
- Yes
* - Data Broker
- /stream
- /stream
-
- `API - data-broker`_
- Yes
* - Data Broker
- /socket.io
- /socket.io
- `API - data-broker`_
- No
* - X.509 Identity Management
- /x509/v1
- /api/v1
- **/x509/v1**
- **/api/v1**
- `API - x509-identity-mgmt`_
- Yes

**NOTE: Some of the endpoints from component aren't exposed, but are used internally.**
**NOTE: Some of the components' endpoints aren't exposed, but are used internally.**


In addition, the API gateway reroutes the endpoints with their ports from component, so that they
Expand Down Expand Up @@ -313,7 +330,10 @@ dojot.
.. _Zookeeper doc.: https://zookeeper.apache.org/documentation.html
.. _Kafka site: https://kafka.apache.org/
.. _Kafka doc.: http://kafka.apache.org/documentation/

.. _VerneMQ site: https://vernemq.com/
.. _VerneMQ doc.: https://docs.vernemq.com/
.. _Leshan site: https://www.eclipse.org/leshan/
.. _Leshan doc.: https://github.com/eclipse/leshan/wiki

.. _GitHub - auth: https://github.com/dojot/auth/tree/v0.5.0
.. _API - auth: https://dojot.github.io/auth/apiary_v0.5.0.html
Expand Down Expand Up @@ -345,6 +365,11 @@ dojot.
.. _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.5.0

.. _GitHub - iotagent-vernemq: https://github.com/dojot/dojot/tree/v0.5.0/connector/mqtt/vernemq

.. _GitHub - iotagent-leshan: https://github.com/dojot/iotagent-leshan/tree/v0.5.0


.. _GitHub - Data Manager: https://github.com/dojot/data-manager/tree/v0.5.0
.. _API - Data Manager: https://dojot.github.io/data-manager/apiary_v0.5.0.html

Expand Down
2 changes: 1 addition & 1 deletion source/faq/faq.rst
Original file line number Diff line number Diff line change
Expand Up @@ -450,7 +450,7 @@ You can check all available APIs in the `API Listing page <../components-and-api
How can I use them?
^^^^^^^^^^^^^^^^^^^

There is a very quick and useful tutorial in the :ref:`Using API interface`.
There is a very quick and useful tutorial in the :doc:`./../using-api-interface`.

I'm interested in integrating my application with dojot. How can I do it?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Expand Down
16 changes: 8 additions & 8 deletions source/flow.rst
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,7 @@ Multi device out
:align: left
:alt: deviceout_node

Device out will determine wich device (or devices) will have its attributes
Device out will determine which device (or devices) will have its attributes
updated on *dojot* according to the result of the flow. Bear in mind that this
node doesn't send messages to your device, it will only update the attributes
on the platform. Normally, the chosen device out is a *virtual device*, which
Expand All @@ -138,11 +138,11 @@ is a device that exists only on *dojot*.
Fields:

* **Name** *(optional)*: Name of the node.
* **Action** *(required)*: Which node will receive the update. Options are:
* **Action** *(required)*: Which device will receive the update. Options are:
- `The device that triggered the flow`: this will update the same device
that sent the message which triggered this flow.
- `Specific device(s)`: which nodes that will receive the update.
- `Device(s) defined during the flow`: which nodes that will receive the
- `Specific device(s)`: which device(s) that will receive the update.
- `Device(s) defined during the flow`: which device(s) that will receive the
update. This is referenced by a list of values, just as with output
values (msg.list_of_devices).
* **Device** *(required)*: Select "The device that triggered the flow" will
Expand Down Expand Up @@ -180,8 +180,8 @@ Fields:
* **Action** *(required)*: which device a message will be sent to. Options are:
- `The device that triggered the flow`: this will send a message to
the same device that sent the message which triggered this flow.
- `Specific device(s)`: which node the message will be sent to.
- `Device(s) defined during the flow`: which nodes the message will be
- `Specific device(s)`: which device(s) the message will be sent to.
- `Device(s) defined during the flow`: which device(s) the message will be
sent to. This is referenced by a list of values, just as with output
values (msg.list_of_devices).
* **Device** *(required)*: Select "The device that triggered the flow" will
Expand Down Expand Up @@ -494,7 +494,7 @@ Geofence
:align: left
:alt: geofence_node

Select an interest area to determine wich devices will activate the flow
Select an interest area to determine which devices will activate the flow

.. _geofence_node_cfg:
.. figure:: images/nodes/geofence_node_cfg.png
Expand Down Expand Up @@ -740,7 +740,7 @@ Device out
:align: left
:alt: deviceout_node

Device out will determine wich device will have its attributes updated on
Device out will determine which device will have its attributes updated on
*dojot* according to the result of the flow. Bear in mind that this node
doesn't send messages to your device, it will only update the attributes on the
platform. Normally, the chosen device out is a *virtual device*, which is a
Expand Down
2 changes: 1 addition & 1 deletion source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ and efficient infrastructure.
using-web-interface
using-api-interface
flow
mosca-tls
mqtt-tls
load-testing-dojot-platform

.. Indices and tables
Expand Down
3 changes: 2 additions & 1 deletion source/installation-guide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -158,7 +158,7 @@ Usage

The web interface is available at ``http://localhost:8000``. The user is
``admin`` and the password is ``admin``. You also can interact with platform
using the :ref:`Components and APIs`.
using the :doc:`./components-and-apis`.

Read the :doc:`using-api-interface` and :doc:`using-web-interface` for more
information about how to interact with the platform.
Expand All @@ -171,6 +171,7 @@ Kubernetes
<iframe id="ytplayer" type="text/html" width="720" height="405"
src="https://www.youtube.com/embed/qGUlBCmmIao?rel=0" frameborder="0"
allowfullscreen></iframe>

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.4.3


Expand Down
2 changes: 1 addition & 1 deletion source/integrating-physical-devices.rst
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ messages to the platform. There are two ways to do that:
internal mechanisms and messages - check its documentation to know more.


See more about :doc:`mosca-tls`.
See more about :doc:`mqtt-tls`.

.. _iotagent-mosca: https://github.com/dojot/iotagent-mosca
.. _iotagent-nodejs: https://github.com/dojot/iotagent-nodejs

0 comments on commit c41c647

Please sign in to comment.