Skip to content

Commit

Permalink
Docs updates
Browse files Browse the repository at this point in the history
  • Loading branch information
kcech committed May 9, 2019
1 parent 34469a1 commit 1f56d22
Show file tree
Hide file tree
Showing 9 changed files with 18 additions and 15 deletions.
File renamed without changes
6 changes: 3 additions & 3 deletions docs/architecture.rst
Original file line number Diff line number Diff line change
Expand Up @@ -70,14 +70,14 @@ Services offered by the API can be classified into five main groups:
By default, the information is transmitted using JSON format. Please,
check this out fore more `info <./api_docs/web_home.html>`__.

Agent
^^^^^
Agents
^^^^^^

Agents are Java processes that expand the core functionality of the
platform through a Plug & Play system using the Redis publish and
subscribe mechanism.

Sentilo currently provides several `agents <./extensions.html>`__:
Sentilo currently provides several `agents <./integrations.html#agents>`__:

- **Relational database agent**: used to export historical data to a
relational database.
Expand Down
2 changes: 1 addition & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Contents:
quickstart
api_docs
architecture
extensions
integrations
monitorization
catalog_and_maps
multitenant
Expand Down
14 changes: 7 additions & 7 deletions docs/extensions.rst → docs/integrations.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Extensions
==========
Integrations
============

Agents
------
Expand All @@ -17,7 +17,7 @@ database, process alarms, generate statistics, …)

The following diagram shows the design that every agent should follow:

.. image:: _static/images/extensions/arch6.jpg
.. image:: _static/images/integrations/arch6.jpg

1. When agent is started, it subscribes as client to Redis for the event
that wants to receive notifications.
Expand Down Expand Up @@ -299,7 +299,7 @@ The federation agent is a module that permits to share events between two indepe
The sharing is unilateral - one Sentilo instance is emitting events and the other is receiving.
The agent is installed at the side of the receiving instance:

.. image:: _static/images/extensions/sentilo_federation.png
.. image:: _static/images/integrations/sentilo_federation.png

The administrator of the emmitting Sentilo instance only needs to create a new application and provide the token the
administrator of the receiving instance.
Expand Down Expand Up @@ -356,7 +356,7 @@ The menu is available when running Tomcat with the option:

The "Client application token" input is the token created in the emitting Sentilo instance:

.. image:: _static/images/extensions/catalog-federation-config.png
.. image:: _static/images/integrations/catalog-federation-config.png



Expand Down Expand Up @@ -436,8 +436,8 @@ NodeJS node_modules.

Then, following nodes should appear in the nodes palette:

.. image:: _static/images/extensions/sentilo-nodered.png
.. image:: _static/images/integrations/sentilo-nodered.png

Now, you should be able to use Sentilo from Node-RED:

.. image:: _static/images/extensions/sentilo-nodered2.png
.. image:: _static/images/integrations/sentilo-nodered2.png
11 changes: 7 additions & 4 deletions docs/setup.rst
Original file line number Diff line number Diff line change
Expand Up @@ -281,7 +281,7 @@ MySQL settings

**This software is mandatory only if you want to export the published
events to a relational database using the specific agent. Otherwise, you
can skip this step.** Please, check `this <./extensions.html>`__ out for
can skip this step.** Please, check `this <./integrations.html#relational-database-agent>`__ out for
more info.

Sentilo default settings consider MySQL server will be listening on
Expand Down Expand Up @@ -380,7 +380,7 @@ openTSDB settings

**It is only necessary if you want to store into openTSDB all the
published events using the specific agent. Otherwise, you can skip this
step.** Please, check `this <./historian_agent.html>`__ out for more
step.** Please, check `this <./integrations.html#historian-agent>`__ out for more
info.

Sentilo default settings consider openTSDB server will be listening on
Expand Down Expand Up @@ -489,10 +489,10 @@ As have been mentioned previously, all agents are optional and you are
free to choose which of them will be deployed, depending on your
specific needs. Agents are internal modules oriented to expand the
platform functionality without having to alter its core. You will find
more information about them in the `Extensions <./extensions.html>`__
more information about them in the `Integrations <./integrations.html#agents>`__
section of our documentation.

We have currently *five core* agents:
We have currently *seven core* agents:

- **Alarms agent** is responsible for processing each internal alert
defined in the catalog and publish a notification (a.k.a. *alarm*)
Expand All @@ -514,6 +514,9 @@ We have currently *five core* agents:
received from the PubSub server into a search engine server. You need
this agent if you want to store data published in Sentilo into
Elasticsearch too.
- **Kafka agent** Publishes events to Kafka.
- **Federation agent** Synchronizes two independent Sentilo instances,
publishing selected observations from a set of providers to another Sentilo.

**Remember:** As mentioned before, Sentilo always store all published
events into Redis.
Expand Down

0 comments on commit 1f56d22

Please sign in to comment.