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 d593e69 commit 351e168
Show file tree
Hide file tree
Showing 4 changed files with 35 additions and 26 deletions.
8 changes: 5 additions & 3 deletions docs/api_docs/services/alert/create_alerts.rst
Original file line number Diff line number Diff line change
Expand Up @@ -114,9 +114,11 @@ This request will register a new external alert with ID REC_ALERT_001
and associated to rec entity (i.e. rec entity is who will publish alarms
associated to this alert).

Remember, the external alerts are defined by third party
entities(providers or applications), which will be the responsibles of
calculating their logic and throw the related alarms when applies.
.. note::

External alerts are defined by third party
entities(providers or applications), which will be the responsibles of
calculating their logic and throw the related alarms when applies.

Adding one internal alert
~~~~~~~~~~~~~~~~~~~~~~~~~
Expand Down
4 changes: 3 additions & 1 deletion docs/api_docs/services/alert/delete_alerts.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,9 @@ entity’s owner token.

http://<your_api_server.com>/catalog/alert/<entity_id>

Remember, the entity_id can be also an Application or a Provider too.
.. note::

entity_id can be also an Application or a Provider too.

+----------------+----------------+
| **Format** | json |
Expand Down
9 changes: 6 additions & 3 deletions docs/api_docs/services/alert/update_alerts.rst
Original file line number Diff line number Diff line change
Expand Up @@ -94,9 +94,12 @@ and in the body message:
This request will update the external alert with REC_ALERT_001
identifier updating its name to REC_EXTERNAL_ALERT_001.

Remember, the external alerts are defined by third party
entities(providers or applications), which will be the responsibles of
calculating their logic and throw the related alarms when applies.
.. note::

External alerts are defined by third party
entities(providers or applications), which will be the responsibles of
calculating their logic and throw the related alarms when applies.


Update one internal alert
~~~~~~~~~~~~~~~~~~~~~~~~~
Expand Down
40 changes: 21 additions & 19 deletions docs/setup.rst
Original file line number Diff line number Diff line change
Expand Up @@ -233,9 +233,9 @@ command from the directory where the file is located:

Please keep in mind that data defined in the previous file contains
default passwords and tokens (which are recommended for run Sentilo in a
test environment). In order to avoid compromissing your platform, **we
test environment). In order to avoid compromissing your platform, we
recommend to change them before installing Sentilo in a production
environment**.
environment.

After change their values in the *init_data.js* and load them on
MongoDB, and before compiling and building Sentilo, you will have to
Expand Down Expand Up @@ -277,12 +277,12 @@ it:
MySQL settings
~~~~~~~~~~~~~~

**Remember**:
.. note::

**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 <./integrations.html#relational-database-agent>`__ out for
more info.
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 <./integrations.html#relational-database-agent>`__ out for
more info.

Sentilo default settings consider MySQL server will be listening on
127.0.0.1:3306, and requires an existing database named *sentilo*,
Expand Down Expand Up @@ -352,12 +352,12 @@ code:
Elastisearch settings
~~~~~~~~~~~~~~~~~~~~~

**Remember**:
.. note::

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

Sentilo default settings consider Elasticsearch server will be listening
on localhost:9200. If you change this behaviour, you need to modify the
Expand All @@ -376,12 +376,12 @@ configured in the following file:
openTSDB settings
~~~~~~~~~~~~~~~~~

**Remember**:
.. note::

**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 <./integrations.html#historian-agent>`__ out for more
info.
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 <./integrations.html#historian-agent>`__ out for more
info.

Sentilo default settings consider openTSDB server will be listening on
127.0.0.1:4242. If you change this behaviour, you need to modify the
Expand Down Expand Up @@ -518,8 +518,10 @@ We have currently *seven core* agents:
- **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.
.. note::

As mentioned before, Sentilo always store all published events into Redis.


All the agents are installed in a similar manner to the PubSub server,
as described below.
Expand Down

0 comments on commit 351e168

Please sign in to comment.