Merge pull request #1988 from ging/master

Update documentation for cygnus-ngsi-ld agent

cygnus-ngsi-ld/README.md

@@ -84,7 +84,7 @@ cygnusagent.channels.test-channel.capacity = 1000
 cygnusagent.channels.test-channel.transactionCapacity = 100
 ```
 
-Check the [Installation and Administration Guide](../doc/installation_and_administration_guide/introduction.md) for configurations involving real data storages.
+Check the [Installation and Administration Guide](../doc/cygnus-ngsi-ld/installation_and_administration_guide/introduction.md) for configurations involving real data storages.
 
 In addition, a `/usr/cygnus/conf/cygnus_instance_1.conf` file must be created if we want to run Cygnus NGSI-LD as a service (see next section):
 
@@ -201,6 +201,31 @@ $ curl -X GET "http://localhost:8081/v1/stats" | python -m json.tool
 ```
 
 
+[Top](#top)
+
+## <a name="section3"></a>Advanced topics and further reading
+Detailed information regarding cygus-ngsi can be found in the [Installation and Administration Guide](../doc/cygnus-ngsi-ld/installation_and_administration_guide/introduction.md), the [User and Programmer Guide](../doc/cygnus-ngsi-ld/user_and_programmer_guide/introduction.md) and the [Flume extensions catalogue](../doc/cygnus-ngsi-ld/flume_extensions_catalogue/introduction.md). The following is just a list of shortcuts regarding the most popular topics:
+
+* [Installation with docker](../doc/cygnus-ngsi-ld/installation_and_administration_guide/install_with_docker.md). An alternative to RPM installation, docker is one of the main options when installing FIWARE components.
+* [Installation from sources](../doc/cygnus-ngsi-ld/installation_and_administration_guide/install_from_sources.md). Sometimes you will need to install from sources, particularly when some of the dependencies must be modified.
+
+[Top](#top)
+
+## <a name="section4"></a>Features summary
+<table>
+  <tr><th>Component</th><th>Feature</th><th>From version</th></tr>
+  <tr><td>NGSIPostgreSQLSink</td><td>First implementation</td><td>2.3.0</td></tr>
+  <tr><td>NGSIPostgisLSink</td><td>First implementation</td><td>2.3.0</td></tr>
+  <tr><td>NGSICKANSink</td><td>First implementation</td><td>2.3.0</td></tr>
+  <tr><td rowspan="9">All sinks</td><td>Events TTL</td><td>2.3.0</td></tr>
+  <tr><td>Infinite events TTL</td><td>2.3.0</td></tr>
+  <tr><td>Data model configuration</td><td>2.3.0</td></tr>
+  <tr><td>enable/disable forced lower case</td><td>2.3.0</td></tr>
+  <tr><td>New encoding</td><td>2.3.0</td></tr>
+  <tr><td>Agents and instances</td><td>2.3.0</td></tr>
+  <tr><td>Logs</td><td>2.3.0</td></tr>
+</table>
+
 [Top](#top)
 
 ## <a name="section5"></a>Reporting issues and contact information

doc/cygnus-ngsi-ld/installation_and_administration_guide/README.md

@@ -5,15 +5,14 @@
     * [Installation via docker](./install_with_docker.md)
     * [Installation from sources](./install_from_sources.md)
 * Configuration:
-    * [NGSI agent configuration](./ngsi_agent_conf.md)
-    * [log4j configuration](../../installation_and_administration_guide/log4j_conf.md)
+    * [NGSI-LD agent configuration](./ngsi_agent_conf.md)
     * [Configuration examples](./configuration_examples.md)
+    * log4j configuration (FIXME: we don't have yet and specific configuration for log4j but it will be done in the future)
 * Running:
     * [Running as a process](./running_as_process.md)
     * [Running as a service](./running_as_service.md)
 * Advanced topics:
     * [Testing](./testing.md)
-    * [Backends as short-term historics](./backends_as_sth.md)
 * [Sanity checks](./sanity_checks.md)
 * [Diagnosis procedures](./diagnosis_procedures.md)
 * [Reporting issues and contact information](./issues_and_contact.md)

doc/cygnus-ngsi-ld/installation_and_administration_guide/introduction.md

@@ -9,13 +9,9 @@ Internally, cygnus-ngsi-ld is based on [Apache Flume](http://flume.apache.org/),
 
 Current stable release is able to persist Orion context data in:
 
-* [HDFS](http://hadoop.apache.org/docs/current/hadoop-project-dist/hadoop-hdfs/HdfsUserGuide.html), the [Hadoop](http://hadoop.apache.org/) distributed file system.
-* [MySQL](https://www.mysql.com/), the well-know relational database manager.
-* [CKAN](http://ckan.org/), an Open Data platform.
-* [MongoDB](https://www.mongodb.org/), the NoSQL document-oriented database.
-* [STH Comet](https://github.com/telefonicaid/IoT-STH), a Short-Term Historic database built on top of MongoDB.
-* [Kafka](http://kafka.apache.org/), the publish-subscribe messaging broker.
-* [DynamoDB](https://aws.amazon.com/dynamodb/), a cloud-based NoSQL database by [Amazon Web Services](https://aws.amazon.com/).
+* [PostgreSQL](http://www.postgresql.org/), the well-know relational database manager.
+* [PostGIS](http://postgis.net/), a spatial database extender for PostgreSQL object-relational database.
+* [CKAN](http://ckan.org/), an Open Data platform. 
 
 [Top](#top)
 
@@ -29,13 +25,20 @@ If your aim is to create a new sink for cygnus-ngsi-ld, or expand it in some way
 ## Structure of the document
 Apart from this introduction, this Installation and Administration Guide mainly contains sections about installing, configuring, running and testing cygnus-ngsi-ld. The FIWARE user will also find useful information regarding multitenancy or performance tips. In addition, sanity check procedures (useful to know wether the installation was successful or not) and diagnosis procedures (a set of tips aiming to help when an issue arises) are provided as well.
 
-It is very important to note that, for those topics not covered by this documentation, the related section in cygnus-common applies. Specifically:
+* Installation:
+    * [Installation via docker](./install_with_docker.md)
+    * [Installation from sources](./install_from_sources.md)
+* Configuration:
+    * [NGSI-LD agent configuration](./ngsi_agent_conf.md)
+    * [Configuration examples](./configuration_examples.md)
+* Running:
+    * [Running as a process](./running_as_process.md)
+    * [Running as a service](./running_as_service.md)
+* Advanced topics:
+    * [Testing](./testing.md)
+* [Sanity checks](./sanity_checks.md)
+* [Diagnosis procedures](./diagnosis_procedures.md)
+* [Reporting issues and contact information](./issues_and_contact.md)
 
-* Hardware requirements.
-* Flume environment configuration.
-* log4j configuration.
-* Running as a process.
-* Management interface.
-* Logs and alarms.
 
 [Top](#top)

doc/cygnus-ngsi-ld/installation_and_administration_guide/ngsi_agent_conf.md

@@ -1,5 +1,5 @@
-# <a name="top"></a>cygnus-ngsi agent configuration
-cygnus-ngsi, as any other Cygnus agent, follows the multi-instance configuration of cygnus-common.
+# <a name="top"></a>cygnus-ngsi-ld agent configuration
+cygnus-ngsi-ld, as any other Cygnus agent, follows the multi-instance configuration of cygnus-common.
 
 The file `agent_<id>.conf` can be instantiated from a template given in the Cygnus repository, `conf/agent_ngsi.conf.template`.
 
@@ -16,8 +16,8 @@ The file `agent_<id>.conf` can be instantiated from a template given in the Cygn
 # one of them (this example shows how to configure 3 sink types at the same time). Even, you can define more than one
 # sink of the same type and sharing the channel in order to improve the performance (this is like having
 # multi-threading).
-cygnus-ngsi.sources = http-source
-cygnus-ngsi.sinks = postgresql-sink 
+cygnus-ngsi-ld.sources = http-source
+cygnus-ngsi-ld.sinks = postgresql-sink 
 cygnus-ngsi-ld.channels = postgresql-channel 
 
 #=============================================

doc/cygnus-ngsi-ld/user_and_programmer_guide/introduction.md

@@ -1,8 +1,13 @@
-# <name="top"></a>User and programmer guide
+# User and programmer guide
 This document describes how to use Cygnus once it has been [installed](../installation_and_administration_guide/introduction.md). It describes how to program extensions for it as well.
 
 ## Intended audience
-This documenttion is intended to be used by developers, if you want to only use this cygnus-ngsi-ld pleasego
-to the [Asdministration section](../installation_and_administration_guide/introduction.md). It describes how to program extensions for it as well.
-
+This documenttion is intended to be used by developers, if you want to only use this cygnus-ngsi-ld please go
+to the [Administration section](../installation_and_administration_guide/introduction.md). It describes how to program extensions for it as well.
+## Structure of the document
 
+* User guide:
+    * [Connecting Orion LD Context Broker and Cygnus](./connecting_orion.md)
+* Programmer guide:
+    * [Adding a new sink](./adding_new_sink.md)
+* [Reporting issues and contact information](./issues_and_contact.md)