update doc - part 1

README.md

@@ -71,7 +71,7 @@ Event structure, and forward them to the Tornado Engine.
 collector that knows how to manipulate the datasource's Events and generate Tornado Events.
 
 Out of the box, Tornado provides a number of Collectors for handling inputs from snmptrapd,
-rsyslog and generic Webhooks.
+rsyslog, JSON from Nats channels and generic Webhooks.
 
 Because all Collectors are defined with a simple format, Collectors for new event types
 can easily be added or extended from existing types for:
@@ -136,9 +136,10 @@ user-friendly installable packages such as .rpm's.
 ### Prerequisites
 
 The following prerequisites must be met in order to compile and run Tornado:
-- You must have Rust version 1.32 or later installed.
+- You must have Rust version 1.44 or later installed.
 - To build the Tornado executables, the *openssl-dev* library should be present in your build
   environment.
+- Some tests require Docker to be installed on the localhost.
 
 
 
@@ -175,6 +176,7 @@ The repository structure is shown here:
       |     |-- engine # The Tornado Engine executable with embedded Tornado Executors
       |     |-- email_collector # A Tornado Collector to handle MIME emails
       |     |-- icinga2_collector # A Tornado Collector to subscribe to the Icinga2 API event streams
+      |     |-- nats_json_collector # A Tornado Collector to handle generic JSON message from Nats channels
       |     |-- rsyslog_collector # A Tornado Collector to handle rsyslog events
       |     |-- snmptrapd_collector # A Tornado Collector written in Perl to handle snmptrapd events
       |     |-- webhook_collector # A Tornado Collector to handle generic Webhook events
@@ -216,8 +218,11 @@ The elements of the Tornado build process can be grouped into three categories:
 To run Tornado, follow the configuration instructions of the Tornado executables provided by
 their respective documentation pages:
 * [tornado_engine documentation](tornado/engine/README.md)
+* [tornado_email_collector documentation](tornado/email_collector/README.md)
+* [tornado_icinga2_collector documentation](tornado/icinga2_collector/README.md)
 * [tornado_rsyslog_collector documentation](tornado/rsyslog_collector/README.md)
-* [tornado_web_collector documentation](tornado/webhook_collector/README.md)
+* [tornado_nats_json_collector documentation](tornado/nats_json_collector/README.md)
+* [tornado_webhook_collector documentation](tornado/webhook_collector/README.md)
 
 
 
@@ -354,6 +359,9 @@ An executable that processes incoming emails and generates Tornado Events.
 An executable that subscribes to Icinga2 Event Streams API and generates Tornado Events.
 - [tornado_icinga2_collector](tornado/icinga2_collector/README.md)
 
+An executable that subscribes to Nats channels and generates Tornado Events.
+- [tornado_nats_json_collector](tornado/nats_json_collector/README.md)
+
 The description of a binary executable that generates Tornado Events from _rsyslog_ inputs.
 - [tornado_rsyslog_collector](tornado/rsyslog_collector/README.md)
 

RUN_WITH_CARGO_MAKE.md

@@ -35,7 +35,7 @@ cargo make run-engine
 ```
 
 This builds and starts a Tornado Engine on the local machine configured to receive events
-on the UDS path _/tmp/tornado_.
+on the TCP port 4747.
 
 
 ## Start Tornado Icinga2 Collector
@@ -48,7 +48,22 @@ cargo make run-icinga2-collector
 
 This builds and starts the Tornado Icinga2 collector that, by default, connects to an Icinga2 server
 on the localhost at port 5665.
-For each incoming Icinga2 Event, it will send a Tornado Event on the UDS path _/tmp/tornado_.
+Produced events are sent to tornado to the TCP port 4747.
+
+
+## Start Tornado Nats JSON Collector
+Requirements: 
+- A Nats server running on the localhost on port 4222
+
+To start the [tornado_nats_json_collector](tornado/nats_json_collector/README.md),
+enter the _src_ folder and run:
+
+```bash
+cargo make run-nats-json-collector
+```
+
+This builds and starts the Tornado Nats JSON collector. 
+Produced events are sent to tornado to the TCP port 4747. 
 
 
 ## Start Tornado Webhook Collector
@@ -60,7 +75,7 @@ cargo make run-webhook-collector
 ```
 
 This builds and starts the Tornado Webhook collector Web Servet at port 8080.
-For each incoming webhook message, it will send a Tornado Event on the UDS path _/tmp/tornado_.
+Produced events are sent to tornado to the TCP port 4747.
 
 
 ## Start Tornado Rsyslog Collector
@@ -80,14 +95,14 @@ cargo make run-rsyslog-collector
 ```
 
 This builds and starts both the spike and the rsyslog-collector.
-The collector will send Tornado Events on the UDS path _/tmp/tornado_.
+The collector will send Tornado Events on the TCP port 4747.
 
 
 ## Start fake snmptrapd
 A spike that produces fake snmptrapd events is available for local testing
 (see ./spike/snmptrapd_collector_writer). This fake snmptrapd
 generates fake events and forwards them directly to the Engine
-on the UDS path _/tmp/tornado_snmptrapd_.
+on the TCP port 4747.
 
 To start the fake snmptrapd, enter the _src_ folder and run:
 
@@ -98,7 +113,7 @@ cargo make run-snmptrapd-writer
 
 ## Start Tornado Events Generator
 A spike that reads Tornado events from json files
-and forwards them to the Engine on the UDS path _/tmp/tornado_.
+and forwards them to the Engine on the TCP port 4747.
 
 To start the Tornado Events Generator, enter the _src_ folder and run: