From c762eb18c16f5cf05ac79312bd24a7a8ab1aa664 Mon Sep 17 00:00:00 2001 From: maximesson Date: Thu, 4 Apr 2019 14:43:43 +0000 Subject: Update documentation Change-Id: I2df7480401fe0371b7458962ac3535a00f287919 Issue-ID: DCAEGEN2-1389 Signed-off-by: maximesson --- docs/sections/services/dfc/architecture.rst | 13 +++++++++- docs/sections/services/dfc/configuration.rst | 37 +++++++++++++++++++++------- docs/sections/services/dfc/delivery.rst | 12 +++++++-- docs/sections/services/dfc/installation.rst | 3 ++- docs/sections/services/dfc/logging.rst | 2 +- docs/sections/services/dfc/release-notes.rst | 16 +++++++++++- 6 files changed, 68 insertions(+), 15 deletions(-) diff --git a/docs/sections/services/dfc/architecture.rst b/docs/sections/services/dfc/architecture.rst index 1ee922af..73597541 100644 --- a/docs/sections/services/dfc/architecture.rst +++ b/docs/sections/services/dfc/architecture.rst @@ -6,7 +6,8 @@ Architecture Introduction """""""""""" -DataFile Collector (DFC) is a part of DCAEGEN2. Some information about DFC and the reasons of its implementation can be found here: `5G bulk PM wiki page`_. +DataFile Collector (DFC) is a part of DCAEGEN2. Some information about DFC and the reasons of its implementation can be +found here: `5G bulk PM wiki page`_. .. _5G bulk PM wiki page: https://wiki.onap.org/display/DW/5G+-+Bulk+PM @@ -29,3 +30,13 @@ Interaction """"""""""" DFC will interact with the DMaaP Message Router and with the Data Router via secured protocol, using json files. So far, the implemented protocols are sftp and ftp(e)s. + +Retry mechanism +""""""""""""""" +DFC is designed to retry downloading and publishing of files in order to recover from temporary faults. +Each time an event is received, DFC will try to download and and publish each previously unpublished file in the event. +The event is received from the Message Router (MR), the files are fetched from a PNF and are published to Data Router +(DR). +Both fetching of a file and publishing is retried a number of times with an increasing delay between each attempt. +After a number of attempts, the DFC will log an error message and give up. Failing of processing of one file does not +affect the handling of others. \ No newline at end of file diff --git a/docs/sections/services/dfc/configuration.rst b/docs/sections/services/dfc/configuration.rst index d57a85f1..22f50eeb 100644 --- a/docs/sections/services/dfc/configuration.rst +++ b/docs/sections/services/dfc/configuration.rst @@ -48,9 +48,21 @@ ftpesConfiguration .. code-block:: json "keyCert": - "keyPassword": - "trustedCA": - "trustedCAPassword": + "keyPassword": + "trustedCa": + "trustedCaPassword": + +securityConfiguration +""""""""""""""""""""" + +.. code-block:: json + + "trustStorePath": + "trustStorePasswordPath": + "keyStorePath": + "keyStorePasswordPath": + "enableDmaapCertAuth": . If false, all information above are ignored. + Sample JSON configuration @@ -87,12 +99,19 @@ The format of the JSON configuration that drives all behavior of DFC is probably } }, "ftp": { - "ftpesConfiguration": { - "keyCert": "config/ftpKey.jks", - "keyPassword": "secret", - "trustedCA": "config/cacerts", - "trustedCAPassword": "secret" + "ftpesConfiguration": { + "keyCert": "config/dfc.jks", + "keyPassword": "secret", + "trustedCa": "config/ftp.jks", + "trustedCaPassword": "secret" + } + }, + "security": { + "trustStorePath" : "change it", + "trustStorePasswordPath" : "change it", + "keyStorePath" : "change it", + "keyStorePasswordPath" : "change it", + "enableDmaapCertAuth" : "false" } - } } } diff --git a/docs/sections/services/dfc/delivery.rst b/docs/sections/services/dfc/delivery.rst index 233e2543..b2d9425b 100644 --- a/docs/sections/services/dfc/delivery.rst +++ b/docs/sections/services/dfc/delivery.rst @@ -7,6 +7,14 @@ Delivery Docker Container ---------------- -**datafile** is delivered as a docker container that can be downloaded from onap: +**datafile** is delivered as a docker container. The latest onap automatically built version can be downloaded from nexus: - ``docker run -d -p 8100:8100 -p 8433:8433 nexus3.onap.org:10001/onap/org.onap.dcaegen2.collectors.datafile`` + ``docker run -d -p 8100:8100 -p 8433:8433 + nexus3.onap.org:10001/onap/org.onap.dcaegen2.collectors.datafile.datafile-app-server:latest`` + + +Another option is to pull the container first, and then run it with the image ID: + + ``docker pull nexus3.onap.org:10001/onap/org.onap.dcaegen2.collectors.datafile.datafile-app-server:latest`` + ``docker images | grep 'datafile'`` + ``docker run -d -p 8100:8100 -p 8433:8433 `` \ No newline at end of file diff --git a/docs/sections/services/dfc/installation.rst b/docs/sections/services/dfc/installation.rst index ffaa580e..a0fe4429 100644 --- a/docs/sections/services/dfc/installation.rst +++ b/docs/sections/services/dfc/installation.rst @@ -22,4 +22,5 @@ Installation The following command will download the latest datafile container from nexus and launch it in the container named "datafile": - ``docker run -d -p 8100:8100 -p 8433:8433 nexus3.onap.org:10001/onap/org.onap.dcaegen2.collectors.datafile`` + ``docker run -d -p 8100:8100 -p 8433:8433 + nexus3.onap.org:10001/onap/org.onap.dcaegen2.collectors.datafile.datafile-app-server:latest`` diff --git a/docs/sections/services/dfc/logging.rst b/docs/sections/services/dfc/logging.rst index b6ac7930..480f53bb 100644 --- a/docs/sections/services/dfc/logging.rst +++ b/docs/sections/services/dfc/logging.rst @@ -10,4 +10,4 @@ file located in datafile-app-server/config folder. **Where is the log file?** -The log file is located under /opt/log and called application.log. +The log file is located under /var/log/ONAP/ and called application.log. \ No newline at end of file diff --git a/docs/sections/services/dfc/release-notes.rst b/docs/sections/services/dfc/release-notes.rst index 18ee1061..e9db0aff 100644 --- a/docs/sections/services/dfc/release-notes.rst +++ b/docs/sections/services/dfc/release-notes.rst @@ -4,7 +4,19 @@ Release Notes ============= -Version: 1.0.5 +Version 1.2.0 +------------- + +:Release Date: 2019-04-11 (Dublin, M4) + +Messages are now handled in parallel + +Retry mechanism implemented + +Adapting to ONAP logging standard + + +Version: 1.1.1 -------------- :Release Date: 2019-01-30 (Casablanca Maintenance fixes) @@ -13,7 +25,9 @@ Version: 1.0.5 **Bug Fixes** DCAEGEN2-940 - Larger files of size 100Kb publish to DR + DCAEGEN2-941 - DFC error after running over 12 hours + DCAEGEN2-1001 - Multiple Fileready notification not handled -- cgit 1.2.3-korg