docs/sections/version_4.0.0.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   2 .. http://creativecommons.org/licenses/by/4.0
   3
   4 Version: 4.0.0
   5 ==============
   6
   7 :Release Date: 2019-06-06
   8
   9 **New Features**
  10
  11 DCAE R4 improves upon previous release with the following new features:
  12
  13 - DCAE Platform Enhancement
  14     - Multisite K8S cluster deployment support for DCAE services (via K8S plugin)
  15     - Support helm chart deployment in DCAE using new Helm cloudify plugin
  16     - DCAE Healthcheck enhancement to cover static and dynamic deployments
  17     - Dynamic AAF based topic provisioning support through Dmaap cloudify plugin
  18     - Dashboard Integration (UI for deployment/verification)
  19     - PolicyHandler Enhancement to support new Policy Lifecycle API's
  20     - Blueprint generator tool to simplify deployment artifact creation
  21     - Cloudify Manager resiliency
  22
  23 - Following new services are delivered with Dublin
  24     - Collectors
  25         - RESTConf collector
  26     - Event Processors
  27         - VES Mapper
  28         - 3gpp PM-Mapper
  29         - BBS Event processor
  30     - Analytics/RCA
  31         - SON-Handler
  32         - Heartbeat MS
  33
  34 Most platform components has been migrated to helm charts. Following is complete list of DCAE components available part of default ONAP/dcae installation.
  35     - Platform components
  36         - Cloudify Manager (helm chart)
  37         - Bootstrap container (helm chart)
  38         - Configuration Binding Service (helm chart)
  39         - Deployment Handler (helm chart)
  40         - Policy Handler (helm chart
  41         - Service Change Handler (helm chart)
  42         - Inventory API (helm chart)
  43         - Dashboard (Cloudify Blueprint)
  44     - Service components
  45         - VES Collector
  46         - SNMP Collector
  47         - Threshold Crossing Analytics
  48         - HV-VES Collector
  49         - PNF-Registration Handler
  50         - Holmes Rule Management *
  51         - Holmes Engine Management *
  52     - Additional resources that DCAE utilizes:
  53         - Postgres Database
  54         - Redis Cluster Database
  55         - Consul Cluster *
  56
  57     Notes:
  58         \*  These components are delivered by the Holmes project.
  59
  60
  61 Under OOM (Kubernetes) deployment all DCAE component containers are deployed as Kubernetes Pods/Deployments/Services into Kubernetes cluster. DCAE R3 includes enhancement to Cloudify Manager plugin (k8splugin) that is capable of expanding a Blueprint node specification written for Docker container to a full Kubernetes specification, with additional enhancements such as replica scaling, sidecar for logging to ONAP ELK stack, registering services to MSB, etc.
  62
  63 - All DCAE components are designed to support platform maturity requirements.
  64
  65
  66 **Source Code**
  67
  68 Source code of DCAE components are released under the following repositories on gerrit.onap.org:
  69     - dcaegen2
  70     - dcaegen2.analytics.tca
  71     - dcaegen2.collectors.snmptrap
  72     - dcaegen2.collectors.ves
  73     - dcaegen2.collectors.hv-ves
  74     - dcaegen2.collectors.datafile
  75     - dcaegen2.collectors.restconf
  76     - dcaegen2.deployments
  77     - dcaegen2.platform.blueprints
  78     - dcaegen2.platform.cli
  79     - dcaegen2.platform.configbinding
  80     - dcaegen2.platform.deployment-handler
  81     - dcaegen2.platform.inventory-api
  82     - dcaegen2.platform.plugins
  83     - dcaegen2.platform.policy-handler
  84     - dcaegen2.platform.servicechange-handler
  85     - dcaegen2.services.heartbeat
  86     - dcaegen2.services.mapper
  87     - dcaegen2.services.pm-mapper
  88     - dcaegen2.services.prh
  89     - dcaegen2.services.son-handler
  90     - dcaegen2.services
  91     - dcaegen2.services.sdk
  92     - dcaegen2.utils
  93     - ccsdk.platform.plugins
  94     - ccsdk.dashboard
  95
  96 **Bug Fixes**
  97
  98 **Known Issues**
  99     * Healthcheck/Readiness probe VES Collector when authentication is enabled (DCAEGEN2-1594)
 100
 101
 102 **Security Notes**
 103
 104 *Fixed Security Issues*
 105
 106 *Known Security Issues*
 107
 108     * Unsecured Swagger UI Interface in xdcae-datafile-collector. [`OJSI-28 <https://jira.onap.org/browse/OJSI-28>`_]
 109     * Unsecured Swagger UI Interface in xdcae-ves-collector. [`OJSI-30 <https://jira.onap.org/browse/OJSI-30>`_]
 110     * In default deployment DCAEGEN2 (xdcae-datafile-collector) exposes HTTP port 30223 outside of cluster. [`OJSI-109 <https://jira.onap.org/browse/OJSI-109>`_]
 111     * In default deployment DCAEGEN2 (xdcae-ves-collector) exposes HTTP port 30235 outside of cluster. [`OJSI-116 <https://jira.onap.org/browse/OJSI-116>`_]
 112     * In default deployment DCAEGEN2 (dcae-datafile-collector) exposes HTTP port 30262 outside of cluster. [`OJSI-131 <https://jira.onap.org/browse/OJSI-131>`_]
 113     * In default deployment DCAEGEN2 (xdcae-dashboard) exposes HTTP port 30418 outside of cluster. [`OJSI-159 <https://jira.onap.org/browse/OJSI-159>`_]
 114     * In default deployment DCAEGEN2 (xdcae-tca-analytics) exposes HTTP port 32010 outside of cluster. [`OJSI-161 <https://jira.onap.org/browse/OJSI-161>`_]
 115     * In default deployment DCAEGEN2 (dcae-redis) exposes redis port 30286 outside of cluster. [`OJSI-187 <https://jira.onap.org/browse/OJSI-187>`_]
 116     * In default deployment DCAEGEN2 (config-binding-service) exposes HTTP port 30415 outside of cluster. [`OJSI-195 <https://jira.onap.org/browse/OJSI-195>`_]
 117     * CVE-2019-12126 - DCAE TCA exposes unprotected APIs/UIs on port 32010. [`OJSI-201 <https://jira.onap.org/browse/OJSI-201>`_]
 118
 119 *Known Vulnerabilities in Used Modules*
 120
 121 DCAE code has been formally scanned during build time using NexusIQ and all Critical vulnerabilities have been addressed, items that remain open have been assessed for risk and determined to be false positive. The DCAE open Critical security vulnerabilities and their risk assessment have been documented as part of the `project <https://wiki.onap.org/pages/viewpage.action?pageId=51282478>`_.
 122
 123 Quick Links:
 124         - `DCAE project page <https://wiki.onap.org/display/DW/Data+Collection+Analytics+and+Events+Project>`_
 125
 126         - `Passing Badge information for DCAE <https://bestpractices.coreinfrastructure.org/en/projects/1718>`_
 127
 128         - `Project Vulnerability Review Table for DCAE (Dublin) <https://wiki.onap.org/pages/viewpage.action?pageId=51282478>`_
 129
 130
 131 **New component Notes**
 132 The following components are introduced in R4
 133
 134     - Dashboard
 135        - Docker container tag: onap/org.onap.ccsdk.dashboard.ccsdk-app-os:1.1.0
 136        - Description: Dashboard provides an UI interface for users/operation to deploy and manage service components in DCAE
 137     - Blueprint generator
 138        - Java artifact : /org/onap/dcaegen2/platform/cli/blueprint-generator/1.0.0/blueprint-generator-1.0.0.jar
 139        - Description: Tool to generate the deployment artifact (cloudify blueprints) based on component spec
 140     - RESTConf collector
 141        - Docker container tag: onap/org.onap.dcaegen2.collectors.restconfcollector:1.1.1
 142        - Description: Provides RESTConf interfaces to events from external domain controllers
 143     - VES/Universal Mapper
 144        - Docker container tag: onap/org.onap.dcaegen2.services.mapper.vesadapter.universalvesadaptor:1.0.0
 145        - Description: Standardizes events recieved from SNMP and RESTConf collector into VES for further processing with DCAE analytics services
 146     - 3gpp PM-Mapper
 147        - Docker container tag: onap/org.onap.dcaegen2.services.pm-mapper:1.0.1
 148        - Description: Transforms 3gpp data feed recieved from DMAAP-DR into VES events
 149     - BBS Event processor
 150        - Docker container tag: onap/org.onap.dcaegen2.services.components.bbs-event-processor:1.0.0
 151        - Description: Handles PNF-Reregistration and CPE authentication events and generate CL events
 152     - SON-Handler
 153        - Docker container tag: onap/org.onap.dcaegen2.services.son-handler:1.0.3
 154        - Description: Supports PC-ANR optimization analysis and generating CL events output
 155     - Heartbeat MS
 156        - Docker container tag: onap/org.onap.dcaegen2.services.heartbeat:2.1.0
 157        - Description: Generates missing heartbeat CL events based on configured threshold for VES heartbeats/VNF type.
 158
 159
 160 **Upgrade Notes**
 161
 162 The following components are upgraded from R3
 163     - Cloudify Manager:
 164        - Docker container tag: onap/org.onap.dcaegen2.deployments.cm-container:1.6.2
 165        - Description: DCAE's Cloudify Manager container is based on Cloudify Manager Community Version 19.01.24, which is based on Cloudify Manager 4.5.
 166     - K8S Bootstrap container:
 167        - Docker container tag: onap/org.onap.dcaegen2.deployments.k8s-bootstrap-container:1.4.18
 168        - Description: K8s bootstrap container updated to include new plugin and remove DCAE Controller components which have been migrated to Helm chart.
 169     - Configuration Binding Service:
 170        - Docker container tag: onap/org.onap.dcaegen2.platform.configbinding.app-app:2.3.0
 171        - Description: Code optimization and bug fixes
 172     - Deployment Handler
 173        - Docker container image tag: onap/org.onap.dcaegen2.platform.deployment-handler:4.0.1
 174        - Include updates for health and service endpoint check and bug fixes
 175     - Policy Handler
 176        - Docker container image tag: onap/org.onap.dcaegen2.platform.policy-handler:5.0.0
 177        - Description: Policy Handler supports the new lifecycle API's from Policy framework
 178     - Service Change Handler
 179        - Docker container image tag: onap/org.onap.dcaegen2.platform.servicechange-handler:1.1.5
 180        - Description: No update from R3
 181     - Inventory API
 182        - Docker container image tag: onap/org.onap.dcaegen2.platform.inventory-api:3.2.0
 183        - Description: Refactoring and updates for health and service endpoint check
 184     - VES Collector
 185        - Docker container image tag: onap/org.onap.dcaegen2.collectors.ves.vescollector:1.4.5
 186        - Description : Authentication enhancement, refactoring and bug-fixes
 187     - Threshold Crossing Analytics
 188        - Docker container image tag: onap/org.onap.dcaegen2.deployments.tca-cdap-container:1.1.2
 189        - Description: Config updates. Replaced Hadoop VM Cluster based file system with regular host file system; repackaged full TCA-CDAP stack into Docker container; transactional state separation from TCA in-memory to off-node Redis cluster for supporting horizontal scaling.
 190     - DataFile Collector
 191        - Docker container tag: onap/org.onap.dcaegen2.collectors.datafile.datafile-app-server:1.1.3
 192        - Description : Code optimization, bug fixes, logging and performance improvement
 193     - PNF Registrator handler
 194        - Docker container tag: onap/org.onap.dcaegen2.services.prh.prh-app-server:1.2.4
 195        - Description : Code optimization, SDK integration, PNF-UPDATE flow support
 196     - HV-VES Collector
 197        - Docker container tag: onap/org.onap.dcaegen2.collectors.hv-ves.hv-collector-main:1.1.0
 198        - Description : Code optimization, bug fixes, and enables SASL for kafka interface
 199     - SNMP Trap Collector
 200        - Docker container tag: onap/org.onap.dcaegen2.collectors.snmptrap:1.4.0
 201        - Description : Code coverage improvements