dcae doc updates

Change-Id: Ia63b7669d55c929d729663418747ab7e52ae89d4
Signed-off-by: VENKATESH KUMAR <vv770d@att.com>
Issue-ID: DCAEGEN2-772

diff --git a/docs/sections/configuration.rst b/docs/sections/configuration.rst
index 80541b9..0e6fade 100644 (file)
--- a/docs/sections/configuration.rst
+++ b/docs/sections/configuration.rst
@@ -5,18 +5,13 @@ Configuration
 =============
 
 DACEGEN2 platform deploys its components via Cloudify Blueprints. Below is the list of Blueprints included in ONAP DCAEGEN2
-and details for how to configure them.  For how to configure the deployemnt of the DCAE platform and service components, please see teh Installation document: ./installation.rst.
+and details for how to configure them.  For how to configure the deployment of the DCAE platform and service components, please see the Installation document: ./installation.rst.
 
 .. toctree::
    :maxdepth: 1
    :titlesonly:
 
-   ./blueprints/centos_vm.rst
-   ./blueprints/consul.rst
-   ./blueprints/DockerHost.rst
-   ./blueprints/cdap.rst
    ./blueprints/cbs.rst
-   ./blueprints/cdapbroker.rst
    ./blueprints/deploymenthandler.rst
    ./blueprints/servicechangehandler.rst
    ./blueprints/inventoryapi.rst
@@ -24,6 +19,4 @@ and details for how to configure them.  For how to configure the deployemnt of t
    ./blueprints/PGaaS.rst
    ./blueprints/ves.rst
    ./blueprints/tca.rst
-   ./blueprints/holmes.rst
-
-
+   ./blueprints/holmes.rst
\ No newline at end of file

diff --git a/docs/sections/installation_heat.rst b/docs/sections/installation_heat.rst
index 82f9394..20242c0 100644 (file)
--- a/docs/sections/installation_heat.rst
+++ b/docs/sections/installation_heat.rst
@@ -88,6 +88,7 @@ In DCAE R3, the configuration for DCAE deployment in Heat is greatly simplified.
         * Missing Heartbeat Detection analytics,
         * Universal Mapper
 
+Note: Missing Heartbeat and Universal Mapper are not part of official Casablanca release
 
 Tips for Manual Interventions
 -----------------------------

diff --git a/docs/sections/installation_oom.rst b/docs/sections/installation_oom.rst
index d071f83..b8926d5 100644 (file)
--- a/docs/sections/installation_oom.rst
+++ b/docs/sections/installation_oom.rst
@@ -126,6 +126,7 @@ Below is a table of default hostnames and ports for DCAE component service endpo
     VES                  dcae-ves-collector:8080             xdcae-ves-collector.onap:30235
     HV-VES               dcae-hv-ves-collector:6061          xdcae-hv-ves-collector.onap:30222
     TCA                  dcae-tca-analytics:11011            xdcae-tca-analytics.onap:32010
+    PRH                  dcae-prh:8100                       NA
     DataFileCollector    dcae-datafile-collector:8443/8100   xdcae-datafile-collector:8433:30224/TCP,8100:30223/TCP
     SNMPTrap             dcae-snmptrap-collector:6162/udp    NA
     Policy Handler       policy-handler:25577                NA

diff --git a/docs/sections/release-notes.rst b/docs/sections/release-notes.rst
index cda7e97..a9b476b 100644 (file)
--- a/docs/sections/release-notes.rst
+++ b/docs/sections/release-notes.rst
@@ -89,15 +89,31 @@ Quick Links:
         - `Project Vulnerability Review Table for DCAE <https://wiki.onap.org/pages/viewpage.action?pageId=28377647>`_
 
 
+**New component Notes**
+The following components are introduced in R3
+
+    - DataFile Collector
+       - Docker container tag: onap/org.onap.dcaegen2.collectors.datafile.datafile-app-server:1.0.3
+       - Description : Bulk data file collector to fetch non-realtime PM data
+    - PNF Registrator handler
+       - Docker container tag: onap/org.onap.dcaegen2.services.prh.prh-app-server:1.1.1
+       - Description : Recieves VES registration event and updates AAI and SO 
+    - HV-VES Collector
+       - Docker container tag: onap/org.onap.dcaegen2.collectors.hv-ves.hv-collector-main:1.0.0
+       - Description : High Volume VES Collector for fetching real-time PM measurement data
+    - SNMP Trap Collector
+       - Docker container tag: onap/org.onap.dcaegen2.collectors.snmptrap:1.4.0
+       - Description : Receives SNMP traps and publishes them to a  message router (DMAAP/MR) in json structure 
+
 
 **Upgrade Notes**
 
 The following components are upgraded from R2:
     - Cloudify Manager:
        - Docker container tag: onap/org.onap.dcaegen2.deployments.cm-container:1.4.2
-       - Description: R3 DCAE's Cloudify Manager container is based on Cloudify Manager Community Version 18.2.28, which is based on Cloudify Manager 4.3.
+       - Description: R3 DCAE's Cloudify Manager container is based on Cloudify Manager Community Version 18.7.23, which is based on Cloudify Manager 4.3.
     - Bootstrap container: 
-       - Docker container tag: onap/org.onap.dcaegen2.deployments.k8s-bootstrap-container:1.4.4
+       - Docker container tag: onap/org.onap.dcaegen2.deployments.k8s-bootstrap-container:1.4.5
        - Description: R3 DCAE no longer uses bootstrap container for Heat based deployment, -- deployment is done through cloud-init scripts and docker-compose specifications.  The bootstrap is for OOM (Kubernetes) based deployment.
     - Configuration Binding Service: 
        - Docker container tag: onap/org.onap.dcaegen2.platform.configbinding.app-app:2.2.3
@@ -105,7 +121,7 @@ The following components are upgraded from R2:
     - Deployment Handler
        - Docker container image tag: onap/org.onap.dcaegen2.platform.deployment-handler:3.0.3
     - Policy Handler
-       - Docker container image tag: onap/org.onap.dcaegen2.platform.policy-handler:4.3.1
+       - Docker container image tag: onap/org.onap.dcaegen2.platform.policy-handler:4.4.0
        - Description: Policy Handler now supports the new configuration policy format and support for TLS
     - Service Change Handler
        - Docker container image tag: onap/org.onap.dcaegen2.platform.servicechange-handler:1.1.5

diff --git a/docs/sections/services/serviceindex.rst b/docs/sections/services/serviceindex.rst
index 4a86760..b221602 100644 (file)
--- a/docs/sections/services/serviceindex.rst
+++ b/docs/sections/services/serviceindex.rst
@@ -13,4 +13,3 @@ Service components under DCAE
    ./snmptrap/index.rst
    ./ves-http/index.rst
    ./ves-hv/index.rst
-

diff --git a/docs/sections/services/ves-http/VES-processingFlow.png b/docs/sections/services/ves-http/VES-processingFlow.png
index 6d9e28b..4c53a2e 100644 (file)
Binary files a/docs/sections/services/ves-http/VES-processingFlow.png and b/docs/sections/services/ves-http/VES-processingFlow.png differ

diff --git a/docs/sections/services/ves-http/architecture.rst b/docs/sections/services/ves-http/architecture.rst
index d7815d3..5994255 100644 (file)
--- a/docs/sections/services/ves-http/architecture.rst
+++ b/docs/sections/services/ves-http/architecture.rst
@@ -17,14 +17,14 @@ VES Schema Validation
 
 VES Collector is configured to support below VES Version; the corresponding API uses VES schema definition for event validation.
 
-==============     ==========================    =================================
-VES Version        API version                   Schema Definition
-==============     ==========================    =================================
-VES 1.2            eventListener/v1              CommonEventFormat_Vendors_v25.json   
-VES 4.1            eventListener/v4              CommonEventFormat_27.2.json
-VES 5.4            eventListener/v5              CommonEventFormat_28.4.1.json
-VES 7.0            eventListener/v7              CommonEventFormat_30.0.1.json
-==============     ==========================    ==================================
+===========     ================    ==================================
+VES Version     API version         Schema Definition
+===========     ================    ==================================
+VES 1.2         eventListener/v1    CommonEventFormat_Vendors_v25.json   
+VES 4.1         eventListener/v4    CommonEventFormat_27.2.json
+VES 5.4         eventListener/v5    CommonEventFormat_28.4.1.json
+VES 7.0         eventListener/v7    CommonEventFormat_30.0.1.json
+===========     ================    ==================================
 
 Schema definition files are contained within VES collector gerrit repo - https://git.onap.org/dcaegen2/collectors/ves/tree/etc
 

diff --git a/docs/sections/services/ves-http/index.rst b/docs/sections/services/ves-http/index.rst
index 286e765..ea43b1f 100644 (file)
--- a/docs/sections/services/ves-http/index.rst
+++ b/docs/sections/services/ves-http/index.rst
@@ -13,7 +13,7 @@ The collector verifies the source (when authentication is enabled) and validates
 
 
 VES Collector (HTTP) overview and functions
-===========================================
+-------------------------------------------
 
 
 .. toctree::
@@ -22,5 +22,6 @@ VES Collector (HTTP) overview and functions
    ./configuration.rst
    ./delivery.rst
    ./installation.rst
-   `API`_
-.. _API: ../../apis/swagger_vescollector.yaml
\ No newline at end of file
+
+   
+.. _`Offered APIs`: ../../apis/ves.rst
\ No newline at end of file

diff --git a/docs/sections/services/ves-http/ves-deployarch.png b/docs/sections/services/ves-http/ves-deployarch.png
index fd4db1b..0048b5b 100644 (file)
Binary files a/docs/sections/services/ves-http/ves-deployarch.png and b/docs/sections/services/ves-http/ves-deployarch.png differ

diff --git a/docs/sections/tls_enablement.rst b/docs/sections/tls_enablement.rst
index 577dc8e..2d7b007 100644 (file)
--- a/docs/sections/tls_enablement.rst
+++ b/docs/sections/tls_enablement.rst
@@ -17,6 +17,16 @@ Solution overview
         * A boolean (``use_tls``) that indicates whether the component uses TLS. 
         * A string (``cert_directory``) that indicates where the component expects to find certificate artifacts.
     
+        Example
+.. code-block:: yaml
+
+        tls_info:
+           cert_directory: '/opt/app/dh/etc/cert/'
+           use_tls: true
+
+For this example the certificates are mounted into /opt/app/dh/etc/cert directory within the conainer.
+        
+    
     During deployment Kubernetes plugin (referenced in blueprint) will check if the ``tls_info`` property is set and ``use_tls`` is set to true, then the plugin will add some elements to the Kubernetes Deployment for the component:
           * A Kubernetes volume (``tls-info``) that will hold the certificate artifacts
           * A Kubernetes initContainer (``tls-init``)