docs/sections/release-notes.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   2 .. http://creativecommons.org/licenses/by/4.0
   3 .. Copyright (c) 2017-2020 AT&T Intellectual Property. All rights reserved.
   4 .. _release_notes:
   5
   6
   7
   8 ==================
   9 DCAE Release Notes
  10 ==================
  11
  12 .. contents::
  13     :depth: 2
  14 ..
  15
  16
  17 Version: 6.0.0
  18 ==============
  19
  20 Abstract
  21 --------
  22
  23 This document provides the release notes for the Frankfurt release (6.0.0)
  24
  25
  26 Summary
  27 -------
  28
  29 **New Features**
  30
  31 DCAE improves upon previous release with the following new features
  32
  33 - DCAE Platform Enhancement
  34
  35     - Introduction of Microservice and Onboarding Design (MOD) platform
  36     - Policy Notification support for DCAE components
  37     - Dynamic AAF certificate creation during component instantiation
  38     - Helm chart optimization to control each platform component separate
  39     - Dashboard Optimization
  40     - Blueprint generator tool to simplify deployment artifact creation
  41
  42
  43 - Following new services are delivered this release
  44
  45     - Event Processors
  46
  47         - PM Subscription Handler
  48         - DataLake Handlers
  49     - Analytics/RCA
  50
  51         - TCA-GEN2
  52
  53         - Acumos Adapter (PoC)
  54
  55 Below is complete list of DCAE components available part of default ONAP/DCAE installation.
  56
  57     - Platform components
  58
  59         - Cloudify Manager (helm chart)
  60         - Bootstrap container (helm chart)
  61         - Configuration Binding Service (helm chart)
  62         - Deployment Handler (helm chart)
  63         - Policy Handler (helm chart
  64         - Service Change Handler (helm chart)
  65         - Inventory API (helm chart)
  66         - Dashboard (helm chart)
  67
  68     - Service components
  69
  70         - VES Collector
  71         - Threshold Crossing Analytics (TCA/CDAP)
  72         - HV-VES Collector
  73         - PNF-Registration Handler
  74         - Docker based Threshold Crossing Analytics (TCA-Gen2)
  75         - Holmes Rule Management *
  76         - Holmes Engine Management *
  77
  78     - Additional resources that DCAE utilizes deployed using ONAP common charts:
  79
  80         - Postgres Database
  81         - Mongo Database
  82         - Redis Cluster Database
  83         - Consul Cluster
  84
  85 Following service components (mS) can be deployed on-demand
  86
  87         - SNMPTrap Collector
  88         - RESTConf Collector
  89         - DataFile Collector
  90         - PM-Mapper
  91         - BBS-EventProcessor
  92         - VES Mapper
  93         - Heartbeat mS
  94         - SON-Handler
  95         - PM-Subscription Handler
  96
  97     Notes:
  98
  99         \*  These components are delivered by the Holmes project.
 100
 101
 102
 103 Under OOM (Kubernetes) deployment all DCAE component containers are deployed as Kubernetes Pods/Deployments/Services into Kubernetes cluster. DCAE platform components are deployed using Helm charts. DCAE service components are deployed using Cloudify blueprints. DCAE provides a Cloudify Manager plugin (k8splugin) that is capable of expanding a Cloudify blueprint node specification for a service component to a full Kubernetes specification, with additional enhancements such as replica scaling, sidecar for logging to ONAP ELK stack, registering services to MSB, etc.
 104
 105
 106 - All DCAE components are designed to support platform maturity requirements.
 107
 108
 109 **Bug Fixes**
 110
 111 **Known Issues**
 112
 113     * Blueprint generator escape char issue (DCAEGEN2-2140)
 114     * TCAgen2 Policy configuration support (DCAEGEN2-2198)
 115     * TCA/CDAP config refresh causes duplicate events (DCAEGEN2-2241)
 116
 117
 118 **Security Notes**
 119
 120 *Fixed Security Issues*
 121
 122     * Unsecured Swagger UI Interface in xdcae-ves-collector. [`OJSI-30 <https://jira.onap.org/browse/OJSI-30>`_]
 123     * In default deployment DCAEGEN2 (xdcae-ves-collector) exposes HTTP port 30235 outside of cluster. [`OJSI-116 <https://jira.onap.org/browse/OJSI-116>`_]
 124     * In default deployment DCAEGEN2 (xdcae-dashboard) exposes HTTP port 30418 outside of cluster. [`OJSI-159 <https://jira.onap.org/browse/OJSI-159>`_]
 125     * In default deployment DCAEGEN2 (dcae-redis) exposes redis port 30286 outside of cluster. [`OJSI-187 <https://jira.onap.org/browse/OJSI-187>`_]
 126     * In default deployment DCAEGEN2 (config-binding-service) exposes HTTP port 30415 outside of cluster. [`OJSI-195 <https://jira.onap.org/browse/OJSI-195>`_]
 127
 128
 129 *Known Security Issues*
 130
 131         None
 132
 133
 134 *Known Vulnerabilities in Used Modules*
 135
 136         None
 137
 138 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>`_.
 139
 140
 141 Artifacts released:
 142
 143 .. csv-table::
 144    :header: "Repository", "SubModules", "Version & Docker Image (if applicable)"
 145    :widths: auto
 146
 147    "dcaegen2/analytics/tca-gen2", "", "onap/org.onap.dcaegen2.analytics.tca-gen2.dcae-analytics-tca-web:1.0.1"
 148    "dcaegen2/collectors/datafile", "", "onap/org.onap.dcaegen2.collectors.datafile.datafile-app-server:1.3.0"
 149    "dcaegen2/collectors/hv-ves", "", "onap/org.onap.dcaegen2.collectors.hv-ves.hv-collector-main:1.4.0"
 150    "dcaegen2/collectors/restconf", "", "onap/org.onap.dcaegen2.collectors.restconfcollector:1.1.1"
 151    "dcaegen2/collectors/snmptrap", "", "onap/org.onap.dcaegen2.collectors.snmptrap:2.0.3"
 152    "dcaegen2/collectors/ves", "", "onap/org.onap.dcaegen2.collectors.ves.vescollector:1.5.4"
 153    "dcaegen2/deployments", "cm-container", "onap/org.onap.dcaegen2.deployments.cm-container:2.1.0"
 154    "dcaegen2/deployments", "consul-loader-container", "onap/org.onap.dcaegen2.deployments.consul-loader-container:1.0.0"
 155    "dcaegen2/deployments", "dcae-k8s-cleanup-container", "onap/org.onap.dcaegen2.deployments.dcae-k8s-cleanup-container:1.0.0"
 156    "dcaegen2/deployments", "healthcheck-container", "onap/org.onap.dcaegen2.deployments.healthcheck-container:1.3.1"
 157    "dcaegen2/deployments", "multisite-init-container", "onap/org.onap.dcaegen2.deployments.multisite-init-container:1.0.0"
 158    "dcaegen2/deployments", "redis-cluster-container", "onap/org.onap.dcaegen2.deployments.redis-cluster-container:1.0.0"
 159    "dcaegen2/deployments", "tca-cdap-container", "onap/org.onap.dcaegen2.deployments.tca-cdap-container:1.2.2"
 160    "dcaegen2/deployments", "tls-init-container", "onap/org.onap.dcaegen2.deployments.tls-init-container:2.1.0"
 161    "dcaegen2/platform", "mod/onboardingapi", "onap/org.onap.dcaegen2.platform.mod.onboardingapi:2.12.1"
 162    "dcaegen2/platform", "mod/distributorapi", "onap/org.onap.dcaegen2.platform.mod.distributorapi:1.0.1"
 163    "dcaegen2/platform", "mod/designtool", "onap/org.onap.dcaegen2.platform.mod.designtool-web:1.0.2"
 164    "dcaegen2/platform", "mod/genprocessor", "onap/org.onap.dcaegen2.platform.mod.genprocessor-http:1.0.1"
 165    "dcaegen2/platform", "mod/genprocessor", "onap/org.onap.dcaegen2.platform.mod.genprocessor-job:1.0.1"
 166    "dcaegen2/platform", "mod/designtool/mod-registry", "onap/org.onap.dcaegen2.platform.mod.mod-registry:1.0.0"
 167    "dcaegen2/platform", "mod/runtimeapi", "onap/org.onap.dcaegen2.platform.mod.runtime-web:1.0.3"
 168    "dcaegen2/platform/blueprints", "", "onap/org.onap.dcaegen2.deployments.k8s-bootstrap-container:1.12.6"
 169    "dcaegen2/platform/configbinding", "", "onap/org.onap.dcaegen2.platform.configbinding:2.5.2"
 170    "dcaegen2/platform/deployment-handler", "", "onap/org.onap.dcaegen2.platform.deployment-handler:4.3.0"
 171    "dcaegen2/platform/inventory-api", "", "onap/org.onap.dcaegen2.platform.inventory-api:3.4.1"
 172    "dcaegen2/platform/policy-handler", "", "onap/org.onap.dcaegen2.platform.policy-handler:5.1.0"
 173    "dcaegen2/platform/servicechange-handler", "", "onap/org.onap.dcaegen2.platform.servicechange-handler:1.3.2"
 174    "dcaegen2/services", "components/datalake-handler", "onap/org.onap.dcaegen2.services.datalakefeeder:1.0.2"
 175    "dcaegen2/services", "components/datalake-handler", "onap/org.onap.dcaegen2.services.datalakeadminui:1.0.2"
 176    "dcaegen2/services", "components/pm-subscription-handler", "onap/org.onap.dcaegen2.services.pmsh:1.0.3"
 177    "dcaegen2/services", "components/bbs-event-processor", "onap/org.onap.dcaegen2.services.components.bbs-event-processor:2.0.0"
 178    "dcaegen2/services/heartbeat", "", "onap/org.onap.dcaegen2.services.heartbeat:2.1.0"
 179    "dcaegen2/services/mapper", "", "onap/org.onap.dcaegen2.services.mapper.vesadapter.universalvesadaptor:1.0.1"
 180    "dcaegen2/services/pm-mapper", "", "onap/org.onap.dcaegen2.services.pm-mapper:1.3.1"
 181    "dcaegen2/services/prh", "", "onap/org.onap.dcaegen2.services.prh.prh-app-server:1.5.2"
 182    "dcaegen2/services/son-handler", "", "onap/org.onap.dcaegen2.services.son-handler:2.0.2"
 183    "dcaegen2/platform", "adapter/acumos", "onap/org.onap.dcaegen2.platform.adapter.acumos:1.0.2"
 184    "dcaegen2/platform", "mod/bpgenerator", "Blueprint Generator 1.3.1 (jar)"
 185    "dcaegen2/services/sdk", "", "DCAE SDK 1.3.5 (jar)"
 186    "ccsdk/dashboard", "", "onap/org.onap.ccsdk.dashboard.ccsdk-app-os:1.3.2"
 187
 188 **Test Results**
 189
 190  - `DCAE Pairwise Test <https://wiki.onap.org/display/DW/DCAE+Pair+Wise+Testing+for+Frankfurt+Release>`_
 191  - `DCAE MOD Test <https://wiki.onap.org/display/DW/DCAE+MOD+Test+Plan>`_
 192
 193
 194 **References**
 195
 196         - `DCAE project page <https://wiki.onap.org/display/DW/Data+Collection+Analytics+and+Events+Project>`_
 197         - `Passing Badge information for DCAE <https://bestpractices.coreinfrastructure.org/en/projects/1718>`_
 198
 199 Version: 5.0.1
 200 ==============
 201
 202 The offical El-Alto release (rolls up all 5.0.0 early drop deliverables) focused on technical debts and SECCOM priority work-items.
 203
 204 Following is summary of updates done for DCAEGEN2
 205
 206 **Security**
 207
 208 Following platform components were enabled for HTTPS
 209     - ConfigBindingService (CBS)
 210       -   CBS is used by all DCAE MS to fetch DCAE MS configuration from Consul. To mitigate impact for DCAE MS, CBS deployment through OOM/Helm was modified to support CBS on both HTTP and HTTPS. `Design for CBS TLS migration <https://wiki.onap.org/display/DW/TLS+support+for+CBS+-+Migration+Plan>`_
 211     - Cloudify Manager
 212     - InventoryAPI
 213     - Non-root container process (ConfigBindingService, InventoryAPI, ServiceChangeHandler, HV-VES, PRH, Son-handler)
 214
 215 All components interfacing with platform components were modified to support TLS interface
 216
 217 **Miscellaneous**
 218     - DCAE Dashboard deployment migration from cloudify blueprint to OOM/Chart
 219     - Dynamic Topic support via Dmaap plugin integration for DataFileCollector MS
 220     - Dynamic Topic support via Dmaap plugin integration for PM-Mapper service
 221     - CBS client libraries updated to remove consul service lookup
 222     - Image Optimization (ConfigBindingService, InventoryAPI, ServiceChangeHandler, HV-VES, PRH, Son-handler)
 223
 224
 225
 226 With this release, all DCAE platform components has been migrated to helm charts. Following is complete list of DCAE components available part of default ONAP/DCAE installation.
 227     - Platform components
 228         - Cloudify Manager (helm chart)
 229         - Bootstrap container (helm chart)
 230         - Configuration Binding Service (helm chart)
 231         - Deployment Handler (helm chart)
 232         - Policy Handler (helm chart
 233         - Service Change Handler (helm chart)
 234         - Inventory API (helm chart)
 235         - Dashboard (helm charts)
 236     - Service components
 237         - VES Collector
 238         - SNMP Collector
 239         - Threshold Crossing Analytics
 240         - HV-VES Collector
 241         - PNF-Registration Handler
 242         - Holmes Rule Management *
 243         - Holmes Engine Management *
 244     - Additional resources that DCAE utilizes:
 245         - Postgres Database
 246         - Redis Cluster Database
 247         - Consul Cluster *
 248
 249     Notes:
 250         \*  These components are delivered by external ONAP project.
 251
 252 DCAE also includes below MS which can be deployed on-demand (via Dashboard or Cloudify CLI or CLAMP)
 253
 254     - Collectors
 255         - RESTConf collector
 256         - DataFile collector
 257     - Event Processors
 258         - VES Mapper
 259         - 3gpp PM-Mapper
 260         - BBS Event processor
 261     - Analytics/RCA
 262         - SON-Handler
 263         - Missing Heartbeat Ms
 264
 265 - All DCAE components are designed to support platform maturity requirements.
 266
 267
 268 **Source Code**
 269
 270 Source code of DCAE components are released under the following repositories on gerrit.onap.org; there is no new component introduced for El-Alto Early-drop.
 271     - dcaegen2
 272     - dcaegen2.analytics.tca
 273     - dcaegen2.collectors.snmptrap
 274     - dcaegen2.collectors.ves
 275     - dcaegen2.collectors.hv-ves
 276     - dcaegen2.collectors.datafile
 277     - dcaegen2.collectors.restconf
 278     - dcaegen2.deployments
 279     - dcaegen2.platform.blueprints
 280     - dcaegen2.platform.cli
 281     - dcaegen2.platform.configbinding
 282     - dcaegen2.platform.deployment-handler
 283     - dcaegen2.platform.inventory-api
 284     - dcaegen2.platform.plugins
 285     - dcaegen2.platform.policy-handler
 286     - dcaegen2.platform.servicechange-handler
 287     - dcaegen2.services.heartbeat
 288     - dcaegen2.services.mapper
 289     - dcaegen2.services.pm-mapper
 290     - dcaegen2.services.prh
 291     - dcaegen2.services.son-handler
 292     - dcaegen2.services
 293     - dcaegen2.services.sdk
 294     - dcaegen2.utils
 295     - ccsdk.platform.plugins
 296     - ccsdk.dashboard
 297
 298 **Bug Fixes**
 299     * k8splugin can generate deployment name > 63 chars (DCAEGEN2-1667)
 300     * CM container loading invalid Cloudify types file (DCAEGEN2-1685)
 301
 302
 303 **Known Issues**
 304     * Healthcheck/Readiness probe VES Collector when authentication is enabled (DCAEGEN2-1594)
 305
 306 **Security Notes**
 307
 308 *Fixed Security Issues*
 309     * Unsecured Swagger UI Interface in xdcae-datafile-collector. [`OJSI-28 <https://jira.onap.org/browse/OJSI-28>`_]
 310     * In default deployment DCAEGEN2 (xdcae-datafile-collector) exposes HTTP port 30223 outside of cluster. [`OJSI-109 <https://jira.onap.org/browse/OJSI-109>`_]
 311     * In default deployment DCAEGEN2 (xdcae-tca-analytics) exposes HTTP port 32010 outside of cluster. [`OJSI-161 <https://jira.onap.org/browse/OJSI-161>`_]
 312     * In default deployment DCAEGEN2 (dcae-datafile-collector) exposes HTTP port 30262 outside of cluster. [`OJSI-131 <https://jira.onap.org/browse/OJSI-131>`_]
 313     * CVE-2019-12126 - DCAE TCA exposes unprotected APIs/UIs on port 32010. [`OJSI-201 <https://jira.onap.org/browse/OJSI-201>`_]
 314
 315 *Known Security Issues*
 316     * Unsecured Swagger UI Interface in xdcae-ves-collector. [`OJSI-30 <https://jira.onap.org/browse/OJSI-30>`_]
 317     * In default deployment DCAEGEN2 (xdcae-ves-collector) exposes HTTP port 30235 outside of cluster. [`OJSI-116 <https://jira.onap.org/browse/OJSI-116>`_]
 318     * In default deployment DCAEGEN2 (xdcae-dashboard) exposes HTTP port 30418 outside of cluster. [`OJSI-159 <https://jira.onap.org/browse/OJSI-159>`_]
 319     * In default deployment DCAEGEN2 (dcae-redis) exposes redis port 30286 outside of cluster. [`OJSI-187 <https://jira.onap.org/browse/OJSI-187>`_]
 320     * In default deployment DCAEGEN2 (config-binding-service) exposes HTTP port 30415 outside of cluster. [`OJSI-195 <https://jira.onap.org/browse/OJSI-195>`_]
 321
 322 *Known Vulnerabilities in Used Modules*
 323
 324 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>`_.
 325
 326 Quick Links:
 327         - `DCAE project page <https://wiki.onap.org/display/DW/Data+Collection+Analytics+and+Events+Project>`_
 328
 329         - `Passing Badge information for DCAE <https://bestpractices.coreinfrastructure.org/en/projects/1718>`_
 330
 331         - `Project Vulnerability Review Table for DCAE <https://wiki.onap.org/pages/viewpage.action?pageId=68540441>`_
 332
 333
 334 **Upgrade Notes**
 335
 336 The following components are upgraded from Dublin/R4 and El-Alto EarlyDrop deliverables.
 337     - K8S Bootstrap container:
 338        - Docker container tag: onap/org.onap.dcaegen2.deployments.k8s-bootstrap-container:1.6.4
 339        - Description: K8s bootstrap container updated to interface with Cloudify using HTTPS; new k8s and Dmaap plugin version included; Dashboard deployment was removed.
 340     - Configuration Binding Service:
 341        - Docker container tag: onap/org.onap.dcaegen2.platform.configbinding.app-app:2.5.2
 342        - Description: HTTPS support, Image optimization and non-root user
 343     - Inventory API
 344        - Docker container image tag: onap/org.onap.dcaegen2.platform.inventory-api:3.4.0
 345        - Description: HTTPS support, container optmization and non-root user
 346     - DataFile Collector
 347        - Docker container tag: onap/org.onap.dcaegen2.collectors.datafile.datafile-app-server:1.2.3
 348        - Description : Code optimization, bug fixes, dmaap plugin integration
 349     - SON Handler MS
 350        - Docker container tag: onap/org.onap.dcaegen2.services.son-handler:1.1.1
 351        - Description : Image optimization, bug fixes, CBS integration
 352     - VES Adapter/Mapper MS
 353        - Docker container tag: onap/org.onap.dcaegen2.services.mapper.vesadapter.universalvesadaptor:1.0.1
 354        - Description : Image optimization & CBS periodic polling
 355     - PRH MS
 356        - Docker container tag: onap/org.onap.dcaegen2.services.prh.prh-app-server:1.3.1
 357        - Description : Code optimization, bug fixes and SDK alignment
 358     - HV-VES MS
 359        - Docker container tag: onap/org.onap.dcaegen2.collectors.hv-ves.hv-collector-main:1.3.0
 360        - Description : Code optimization, bug fixes and SDK alignment
 361
 362 Version: 5.0.0
 363 ==============
 364
 365 El-Alto Early-drop focused on technical debts and SECCOM priority work-items.
 366
 367 Following is summary of updates done for DCAEGEN2
 368
 369 **Security**
 370
 371 Following platform components were enabled for HTTPS
 372     - ConfigBindingService (CBS)
 373       -   CBS is used by all DCAE MS to fetch DCAE MS configuration from Consul. To mitigate impact for DCAE MS, CBS deployment through OOM/Helm was modified to support CBS on both HTTP and HTTPS. `Design for CBS TLS migration <https://wiki.onap.org/display/DW/TLS+support+for+CBS+-+Migration+Plan>`_
 374     - Cloudify Manager
 375     - InventoryAPI
 376
 377 All components interfacing with platform components were modified to support TLS interface
 378
 379 **Miscellaneous**
 380     - DCAE Dashboard deployment migration from cloudify blueprint to OOM/Chart
 381     - Dynamic Topic support via Dmaap plugin integration for DataFileCollector MS
 382     - Dynamic Topic support via Dmaap plugin integration for PM-Mapper service
 383     - CBS client libraries updated to remove consul service lookup
 384
 385
 386
 387 **Bug Fixes**
 388     * k8splugin can generate deployment name > 63 chars (DCAEGEN2-1667)
 389     * CM container loading invalid Cloudify types file (DCAEGEN2-1685)
 390
 391
 392 **Known Issues**
 393     * Healthcheck/Readiness probe VES Collector when authentication is enabled (DCAEGEN2-1594)
 394
 395
 396 **Security Notes**
 397
 398 *Fixed Security Issues*
 399
 400 *Known Security Issues*
 401
 402     * Unsecured Swagger UI Interface in xdcae-datafile-collector. [`OJSI-28 <https://jira.onap.org/browse/OJSI-28>`_]
 403     * Unsecured Swagger UI Interface in xdcae-ves-collector. [`OJSI-30 <https://jira.onap.org/browse/OJSI-30>`_]
 404     * In default deployment DCAEGEN2 (xdcae-datafile-collector) exposes HTTP port 30223 outside of cluster. [`OJSI-109 <https://jira.onap.org/browse/OJSI-109>`_]
 405     * In default deployment DCAEGEN2 (xdcae-ves-collector) exposes HTTP port 30235 outside of cluster. [`OJSI-116 <https://jira.onap.org/browse/OJSI-116>`_]
 406     * In default deployment DCAEGEN2 (dcae-datafile-collector) exposes HTTP port 30262 outside of cluster. [`OJSI-131 <https://jira.onap.org/browse/OJSI-131>`_]
 407     * In default deployment DCAEGEN2 (xdcae-dashboard) exposes HTTP port 30418 outside of cluster. [`OJSI-159 <https://jira.onap.org/browse/OJSI-159>`_]
 408     * In default deployment DCAEGEN2 (xdcae-tca-analytics) exposes HTTP port 32010 outside of cluster. [`OJSI-161 <https://jira.onap.org/browse/OJSI-161>`_]
 409     * In default deployment DCAEGEN2 (dcae-redis) exposes redis port 30286 outside of cluster. [`OJSI-187 <https://jira.onap.org/browse/OJSI-187>`_]
 410     * In default deployment DCAEGEN2 (config-binding-service) exposes HTTP port 30415 outside of cluster. [`OJSI-195 <https://jira.onap.org/browse/OJSI-195>`_]
 411     * CVE-2019-12126 - DCAE TCA exposes unprotected APIs/UIs on port 32010. [`OJSI-201 <https://jira.onap.org/browse/OJSI-201>`_]
 412
 413 *Known Vulnerabilities in Used Modules*
 414
 415 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>`_.
 416
 417 Quick Links:
 418         - `DCAE project page <https://wiki.onap.org/display/DW/Data+Collection+Analytics+and+Events+Project>`_
 419
 420         - `Passing Badge information for DCAE <https://bestpractices.coreinfrastructure.org/en/projects/1718>`_
 421
 422         - `Project Vulnerability Review Table for DCAE <https://wiki.onap.org/pages/viewpage.action?pageId=68540441>`_
 423
 424
 425 **Upgrade Notes**
 426
 427 The following components are upgraded from Dublin/R4.
 428     - Cloudify Manager:
 429        - Docker container tag: onap/org.onap.dcaegen2.deployments.cm-container:2.0.2
 430        - Description: DCAE's Cloudify Manager container is based on Cloudify Manager Community Version 19.01.24, which is based on Cloudify Manager 4.5. The container was updated to support TLS.
 431     - K8S Bootstrap container:
 432        - Docker container tag: onap/org.onap.dcaegen2.deployments.k8s-bootstrap-container:1.6.2
 433        - Description: K8s bootstrap container updated to interface with Cloudify using HTTPS; new k8s and Dmaap plugin version included; Dashboard deployment was removed.
 434     - Configuration Binding Service:
 435        - Docker container tag: onap/org.onap.dcaegen2.platform.configbinding.app-app:2.5.1
 436        - Description: HTTPS support, Image optimization and non-root user
 437     - Deployment Handler
 438        - Docker container image tag: onap/org.onap.dcaegen2.platform.deployment-handler:4.2.0
 439        - Description: Update to node10, uninstall workflow updates
 440     - Service Change Handler
 441        - Docker container image tag: onap/org.onap.dcaegen2.platform.servicechange-handler:1.3.2
 442        - Description: HTTPS inventoryAPI support, container optmization and non-root user
 443     - Inventory API
 444        - Docker container image tag: onap/org.onap.dcaegen2.platform.inventory-api:3.4.0
 445        - Description: HTTPS support, container optmization and non-root user
 446     - DataFile Collector
 447        - Docker container tag: onap/org.onap.dcaegen2.collectors.datafile.datafile-app-server:1.2.2
 448        - Description : Code optimization, bug fixes, dmaap plugin integration
 449     - 3gpp PM-Mapper
 450        - Docker container tag: onap/org.onap.dcaegen2.services.pm-mapper:1.1.3
 451        - Description: Code optimization, bug fixes, dmaap plugin integration
 452
 453
 454
 455 Version: 4.0.0
 456 ==============
 457
 458 :Release Date: 2019-06-06
 459
 460 **New Features**
 461
 462 DCAE R4 improves upon previous release with the following new features:
 463
 464 - DCAE Platform Enhancement
 465     - Multisite K8S cluster deployment support for DCAE services (via K8S plugin)
 466     - Support helm chart deployment in DCAE using new Helm cloudify plugin
 467     - DCAE Healthcheck enhancement to cover static and dynamic deployments
 468     - Dynamic AAF based topic provisioning support through Dmaap cloudify plugin
 469     - Dashboard Integration (UI for deployment/verification)
 470     - PolicyHandler Enhancement to support new Policy Lifecycle API’s
 471     - Blueprint generator tool to simplify deployment artifact creation
 472     - Cloudify Manager resiliency
 473
 474 - Following new services are delivered with Dublin
 475     - Collectors
 476         - RESTConf collector
 477     - Event Processors
 478         - VES Mapper
 479         - 3gpp PM-Mapper
 480         - BBS Event processor
 481     - Analytics/RCA
 482         - SON-Handler
 483         - Heartbeat MS
 484
 485 Most platform components has been migrated to helm charts. Following is complete list of DCAE components available part of default ONAP/dcae installation.
 486     - Platform components
 487         - Cloudify Manager (helm chart)
 488         - Bootstrap container (helm chart)
 489         - Configuration Binding Service (helm chart)
 490         - Deployment Handler (helm chart)
 491         - Policy Handler (helm chart
 492         - Service Change Handler (helm chart)
 493         - Inventory API (helm chart)
 494         - Dashboard (Cloudify Blueprint)
 495     - Service components
 496         - VES Collector
 497         - SNMP Collector
 498         - Threshold Crossing Analytics
 499         - HV-VES Collector
 500         - PNF-Registration Handler
 501         - Holmes Rule Management *
 502         - Holmes Engine Management *
 503     - Additional resources that DCAE utilizes:
 504         - Postgres Database
 505         - Redis Cluster Database
 506         - Consul Cluster *
 507
 508     Notes:
 509         \*  These components are delivered by the Holmes project.
 510
 511
 512 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.
 513
 514 - All DCAE components are designed to support platform maturity requirements.
 515
 516
 517 **Source Code**
 518
 519 Source code of DCAE components are released under the following repositories on gerrit.onap.org:
 520     - dcaegen2
 521     - dcaegen2.analytics.tca
 522     - dcaegen2.collectors.snmptrap
 523     - dcaegen2.collectors.ves
 524     - dcaegen2.collectors.hv-ves
 525     - dcaegen2.collectors.datafile
 526     - dcaegen2.collectors.restconf
 527     - dcaegen2.deployments
 528     - dcaegen2.platform.blueprints
 529     - dcaegen2.platform.cli
 530     - dcaegen2.platform.configbinding
 531     - dcaegen2.platform.deployment-handler
 532     - dcaegen2.platform.inventory-api
 533     - dcaegen2.platform.plugins
 534     - dcaegen2.platform.policy-handler
 535     - dcaegen2.platform.servicechange-handler
 536     - dcaegen2.services.heartbeat
 537     - dcaegen2.services.mapper
 538     - dcaegen2.services.pm-mapper
 539     - dcaegen2.services.prh
 540     - dcaegen2.services.son-handler
 541     - dcaegen2.services
 542     - dcaegen2.services.sdk
 543     - dcaegen2.utils
 544     - ccsdk.platform.plugins
 545     - ccsdk.dashboard
 546
 547 **Bug Fixes**
 548
 549 **Known Issues**
 550     * Healthcheck/Readiness probe VES Collector when authentication is enabled (DCAEGEN2-1594)
 551
 552
 553 **Security Notes**
 554
 555 *Fixed Security Issues*
 556
 557 *Known Security Issues*
 558
 559     * Unsecured Swagger UI Interface in xdcae-datafile-collector. [`OJSI-28 <https://jira.onap.org/browse/OJSI-28>`_]
 560     * Unsecured Swagger UI Interface in xdcae-ves-collector. [`OJSI-30 <https://jira.onap.org/browse/OJSI-30>`_]
 561     * In default deployment DCAEGEN2 (xdcae-datafile-collector) exposes HTTP port 30223 outside of cluster. [`OJSI-109 <https://jira.onap.org/browse/OJSI-109>`_]
 562     * In default deployment DCAEGEN2 (xdcae-ves-collector) exposes HTTP port 30235 outside of cluster. [`OJSI-116 <https://jira.onap.org/browse/OJSI-116>`_]
 563     * In default deployment DCAEGEN2 (dcae-datafile-collector) exposes HTTP port 30262 outside of cluster. [`OJSI-131 <https://jira.onap.org/browse/OJSI-131>`_]
 564     * In default deployment DCAEGEN2 (xdcae-dashboard) exposes HTTP port 30418 outside of cluster. [`OJSI-159 <https://jira.onap.org/browse/OJSI-159>`_]
 565     * In default deployment DCAEGEN2 (xdcae-tca-analytics) exposes HTTP port 32010 outside of cluster. [`OJSI-161 <https://jira.onap.org/browse/OJSI-161>`_]
 566     * In default deployment DCAEGEN2 (dcae-redis) exposes redis port 30286 outside of cluster. [`OJSI-187 <https://jira.onap.org/browse/OJSI-187>`_]
 567     * In default deployment DCAEGEN2 (config-binding-service) exposes HTTP port 30415 outside of cluster. [`OJSI-195 <https://jira.onap.org/browse/OJSI-195>`_]
 568     * CVE-2019-12126 - DCAE TCA exposes unprotected APIs/UIs on port 32010. [`OJSI-201 <https://jira.onap.org/browse/OJSI-201>`_]
 569
 570 *Known Vulnerabilities in Used Modules*
 571
 572 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>`_.
 573
 574 Quick Links:
 575         - `DCAE project page <https://wiki.onap.org/display/DW/Data+Collection+Analytics+and+Events+Project>`_
 576
 577         - `Passing Badge information for DCAE <https://bestpractices.coreinfrastructure.org/en/projects/1718>`_
 578
 579         - `Project Vulnerability Review Table for DCAE <https://wiki.onap.org/pages/viewpage.action?pageId=51282478>`_
 580
 581
 582 **New component Notes**
 583 The following components are introduced in R4
 584
 585     - Dashboard
 586        - Docker container tag: onap/org.onap.ccsdk.dashboard.ccsdk-app-os:1.1.0
 587        - Description: Dashboard provides an UI interface for users/operation to deploy and manage service components in DCAE
 588     - Blueprint generator
 589        - Java artifact : /org/onap/dcaegen2/platform/cli/blueprint-generator/1.0.0/blueprint-generator-1.0.0.jar
 590        - Description: Tool to generate the deployment artifact (cloudify blueprints) based on component spec
 591     - RESTConf collector
 592        - Docker container tag: onap/org.onap.dcaegen2.collectors.restconfcollector:1.1.1
 593        - Description: Provides RESTConf interfaces to events from external domain controllers
 594     - VES/Universal Mapper
 595        - Docker container tag: onap/org.onap.dcaegen2.services.mapper.vesadapter.universalvesadaptor:1.0.0
 596        - Description: Standardizes events recieved from SNMP and RESTConf collector into VES for further processing with DCAE analytics services
 597     - 3gpp PM-Mapper
 598        - Docker container tag: onap/org.onap.dcaegen2.services.pm-mapper:1.0.1
 599        - Description: Transforms 3gpp data feed recieved from DMAAP-DR into VES events
 600     - BBS Event processor
 601        - Docker container tag: onap/org.onap.dcaegen2.services.components.bbs-event-processor:1.0.0
 602        - Description: Handles PNF-Reregistration and CPE authentication events and generate CL events
 603     - SON-Handler
 604        - Docker container tag: onap/org.onap.dcaegen2.services.son-handler:1.0.3
 605        - Description: Supports PC-ANR optimization analysis and generating CL events output
 606     - Heartbeat MS
 607        - Docker container tag: onap/org.onap.dcaegen2.services.heartbeat:2.1.0
 608        - Description: Generates missing heartbeat CL events based on configured threshold for VES heartbeats/VNF type.
 609
 610
 611 **Upgrade Notes**
 612
 613 The following components are upgraded from R3
 614     - Cloudify Manager:
 615        - Docker container tag: onap/org.onap.dcaegen2.deployments.cm-container:1.6.2
 616        - Description: DCAE's Cloudify Manager container is based on Cloudify Manager Community Version 19.01.24, which is based on Cloudify Manager 4.5.
 617     - K8S Bootstrap container:
 618        - Docker container tag: onap/org.onap.dcaegen2.deployments.k8s-bootstrap-container:1.4.18
 619        - Description: K8s bootstrap container updated to include new plugin and remove DCAE Controller components which have been migrated to Helm chart.
 620     - Configuration Binding Service:
 621        - Docker container tag: onap/org.onap.dcaegen2.platform.configbinding.app-app:2.3.0
 622        - Description: Code optimization and bug fixes
 623     - Deployment Handler
 624        - Docker container image tag: onap/org.onap.dcaegen2.platform.deployment-handler:4.0.1
 625        - Include updates for health and service endpoint check and bug fixes
 626     - Policy Handler
 627        - Docker container image tag: onap/org.onap.dcaegen2.platform.policy-handler:5.0.0
 628        - Description: Policy Handler supports the new lifecycle API's from Policy framework
 629     - Service Change Handler
 630        - Docker container image tag: onap/org.onap.dcaegen2.platform.servicechange-handler:1.1.5
 631        - Description: No update from R3
 632     - Inventory API
 633        - Docker container image tag: onap/org.onap.dcaegen2.platform.inventory-api:3.2.0
 634        - Description: Refactoring and updates for health and service endpoint check
 635     - VES Collector
 636        - Docker container image tag: onap/org.onap.dcaegen2.collectors.ves.vescollector:1.4.5
 637        - Description : Authentication enhancement, refactoring and bug-fixes
 638     - Threshold Crossing Analytics
 639        - Docker container image tag: onap/org.onap.dcaegen2.deployments.tca-cdap-container:1.1.2
 640        - 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.
 641     - DataFile Collector
 642        - Docker container tag: onap/org.onap.dcaegen2.collectors.datafile.datafile-app-server:1.1.3
 643        - Description : Code optimization, bug fixes, logging and performance improvement
 644     - PNF Registrator handler
 645        - Docker container tag: onap/org.onap.dcaegen2.services.prh.prh-app-server:1.2.4
 646        - Description : Code optimization, SDK integration, PNF-UPDATE flow support
 647     - HV-VES Collector
 648        - Docker container tag: onap/org.onap.dcaegen2.collectors.hv-ves.hv-collector-main:1.1.0
 649        - Description : Code optimization, bug fixes, and enables SASL for kafka interface
 650     - SNMP Trap Collector
 651        - Docker container tag: onap/org.onap.dcaegen2.collectors.snmptrap:1.4.0
 652        - Description : Code coverage improvements
 653
 654
 655
 656
 657 Version: 3.0.1
 658 ==============
 659
 660 :Release Date: 2019-01-31
 661
 662 DCAE R3 Maintenance release includes following fixes
 663
 664 **Bug Fixes**
 665
 666 - DataFileCollector
 667      - DCAEGEN2-940
 668        Larger files of size 100Kb publish to DR
 669      - DCAEGEN2-941
 670        DFC error after running over 12 hours
 671      - DCAEGEN2-1001
 672        Multiple Fileready notification not handled
 673
 674 - HighVolume VES Collector (protobuf/tcp)
 675      - DCAEGEN2-976
 676        HV-VES not fully complaint to RTPM protocol (issue with CommonEventHeader.sequence)
 677
 678 - VESCollector (http)
 679      - DCAEGEN2-1035
 680        Issue with VES batch event publish
 681
 682 - Heat deployment
 683      - DCAEGEN2-1007
 684        Removing obsolete services configuration
 685
 686
 687 The following containers are updated in R3.0.1
 688
 689     - DataFile Collector
 690        - Docker container tag: onap/org.onap.dcaegen2.collectors.datafile.datafile-app-server:1.0.5
 691     - HV-VES Collector
 692        - Docker container tag: onap/org.onap.dcaegen2.collectors.hv-ves.hv-collector-main:1.0.2
 693     - VES Collector
 694        - Docker container tag: onap/org.onap.dcaegen2.collectors.ves.vescollector:1.3.2
 695
 696 **Known Issues**
 697
 698 - An issue related to VESCollector basic authentication was noted and tracked under DCAEGEN2-1130. This configuration is not enabled by default for R3.0.1; and fix will be handled in Dublin
 699
 700 - Certificates under onap/org.onap.dcaegen2.deployments.tls-init-container:1.0.0 has expired March'2019 and impacting CL deployment from CLAMP. Follow below workaround to update the certificate
 701     kubectl get deployments -n onap | grep deployment-handler
 702     kubectl edit deployment -n onap dev-dcaegen2-dcae-deployment-handler
 703     Search and change tag onap/org.onap.dcaegen2.deployments.tls-init-container:1.0.0 to onap/org.onap.dcaegen2.deployments.tls-init-container:1.0.3
 704
 705
 706
 707
 708 Version: 3.0.0
 709 --------------
 710
 711 :Release Date: 2018-11-30
 712
 713 **New Features**
 714
 715 DCAE R3 improves upon previous release with the following new features:
 716
 717 - All DCAE R3 components are delivered as Docker container images.  The list of components is as follows.
 718     - Platform components
 719         - Cloudify Manager
 720         - Bootstrap container
 721         - Configuration Binding Service
 722         - Deployment Handler
 723         - Policy Handler
 724         - Service Change Handler
 725         - Inventory API
 726     - Service components
 727         - VES Collector
 728         - SNMP Collector
 729         - Threshold Crossing Analytics
 730         - Holmes Rule Management *
 731         - Holmes Engine Management *
 732     - Additional resources that DCAE utilizes:
 733         - Postgres Database
 734         - Redis Cluster Database
 735         - Consul Cluster
 736
 737     Notes:
 738         \*  These components are delivered by the Holmes project.
 739
 740 - DCAE R3 supports both OpenStack Heat Orchestration Template based deployment and OOM (Kubernetes) based deployment.
 741
 742     - Under Heat based deployment all DCAE component containers are deployed onto a single Docker host VM that is launched from an OpenStack Heat Orchestration Template as part of "stack creation".
 743     - Under OOM (Kubernetes) deployment all DCAE component containers are deployed as Kubernetes Pods/Deployments/Services into Kubernetes cluster.
 744
 745 - DCAE R3 includes a new 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.
 746
 747 - All DCAE components are designed to support platform maturity requirements.
 748
 749
 750 **Source Code**
 751
 752 Source code of DCAE components are released under the following repositories on gerrit.onap.org:
 753     - dcaegen2
 754     - dcaegen2.analytics
 755     - dcaegen2.analytics.tca
 756     - dcaegen2.collectors
 757     - dcaegen2.collectors.snmptrap
 758     - dcaegen2.collectors.ves
 759     - dcaegen2.collectors.hv-ves
 760     - dcaegen2.collectors.datafile
 761     - dcaegen2.deployments
 762     - dcaegen2.platform
 763     - dcaegen2.platform.blueprints
 764     - dcaegen2.platform.cli
 765     - dcaegen2.platform.configbinding
 766     - dcaegen2.platform.deployment-handler
 767     - dcaegen2.platform.inventory-api
 768     - dcaegen2.platform.plugins
 769     - dcaegen2.platform.policy-handler
 770     - dcaegen2.platform.servicechange-handler
 771     - dcaegen2.services.heartbeat
 772     - dcaegen2.services.mapper
 773     - dcaegen2.services.prh
 774     - dcaegen2.utils
 775
 776 **Bug Fixes**
 777
 778 **Known Issues**
 779
 780 - DCAE utilizes Cloudify Manager as its declarative model based resource deployment engine.  Cloudify Manager is an open source upstream technology provided by Cloudify Inc. as a Docker image.  DCAE R2 does not provide additional enhancements towards Cloudify Manager's platform maturity.
 781
 782 **Security Notes**
 783
 784 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=28377647>`_.
 785
 786 Quick Links:
 787         - `DCAE project page <https://wiki.onap.org/display/DW/Data+Collection+Analytics+and+Events+Project>`_
 788
 789         - `Passing Badge information for DCAE <https://bestpractices.coreinfrastructure.org/en/projects/1718>`_
 790
 791         - `Project Vulnerability Review Table for DCAE <https://wiki.onap.org/pages/viewpage.action?pageId=41421168>`_
 792
 793
 794 **New component Notes**
 795 The following components are introduced in R3
 796
 797     - DataFile Collector
 798        - Docker container tag: onap/org.onap.dcaegen2.collectors.datafile.datafile-app-server:1.0.4
 799        - Description : Bulk data file collector to fetch non-realtime PM data
 800     - PNF Registrator handler
 801        - Docker container tag: onap/org.onap.dcaegen2.services.prh.prh-app-server:1.1.1
 802        - Description : Recieves VES registration event and updates AAI and SO
 803     - HV-VES Collector
 804        - Docker container tag: onap/org.onap.dcaegen2.collectors.hv-ves.hv-collector-main:1.0.0
 805        - Description : High Volume VES Collector for fetching real-time PM measurement data
 806     - SNMP Trap Collector
 807        - Docker container tag: onap/org.onap.dcaegen2.collectors.snmptrap:1.4.0
 808        - Description : Receives SNMP traps and publishes them to a  message router (DMAAP/MR) in json structure
 809
 810
 811 **Upgrade Notes**
 812
 813 The following components are upgraded from R2:
 814     - Cloudify Manager:
 815        - Docker container tag: onap/org.onap.dcaegen2.deployments.cm-container:1.4.2
 816        - 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.
 817     - Bootstrap container:
 818        - Docker container tag: onap/org.onap.dcaegen2.deployments.k8s-bootstrap-container:1.4.5
 819        - 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.
 820     - Configuration Binding Service:
 821        - Docker container tag: onap/org.onap.dcaegen2.platform.configbinding.app-app:2.2.3
 822        - Description: Configuration Binding Sevice now supports the new configuration policy format and support for TLS
 823     - Deployment Handler
 824        - Docker container image tag: onap/org.onap.dcaegen2.platform.deployment-handler:3.0.3
 825     - Policy Handler
 826        - Docker container image tag: onap/org.onap.dcaegen2.platform.policy-handler:4.4.0
 827        - Description: Policy Handler now supports the new configuration policy format and support for TLS
 828     - Service Change Handler
 829        - Docker container image tag: onap/org.onap.dcaegen2.platform.servicechange-handler:1.1.5
 830        - Description: Refactoring.
 831     - Inventory API
 832        - Docker container image tag: onap/org.onap.dcaegen2.platform.inventory-api:3.0.4
 833        - Description: Refactoring.
 834     - VES Collector
 835        - Docker container image tag: onap/org.onap.dcaegen2.collectors.ves.vescollector:1.3.1
 836        - Description : Refactoring
 837     - Threshold Crossing Analytics
 838        - Docker container image tag: onap/org.onap.dcaegen2.deployments.tca-cdap-container:1.1.0
 839        - Description: 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.
 840
 841
 842
 843
 844 Version: 2.0.0
 845 ==============
 846
 847 :Release Date: 2018-06-07
 848
 849 **New Features**
 850
 851 DCAE R2 improves upon previous release with the following new features:
 852
 853 - All DCAE R2 components are delivered as Docker container images.  The list of components is as follows.
 854     - Platform components
 855         - Cloudify Manager
 856         - Bootstrap container
 857         - Configuration Binding Service
 858         - Deployment Handler
 859         - Policy Handler
 860         - Service Change Handler
 861         - Inventory API
 862     - Service components
 863         - VES Collector
 864         - SNMP Collector
 865         - Threshold Crossing Analytics
 866         - Holmes Rule Management *
 867         - Holmes Engine Management *
 868     - Additional resources that DCAE utilizes:
 869         - Postgres Database
 870         - Redis Cluster Database
 871         - Consul Cluster
 872
 873     Notes:
 874         \*  These components are delivered by the Holmes project and used as a DCAE analytics component in R2.
 875
 876 - DCAE R2 supports both OpenStack Heat Orchestration Template based deployment and OOM (Kubernetes) based deployment.
 877
 878     - Under Heat based deployment all DCAE component containers are deployed onto a single Docker host VM that is launched from an OpenStack Heat Orchestration Template as part of "stack creation".
 879     - Under OOM (Kubernetes) deployment all DCAE component containers are deployed as Kubernetes Pods/Deployments/Services into Kubernetes cluster.
 880
 881 - DCAE R2 includes a new 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.
 882
 883 - All DCAE components are designed to support platform maturity requirements.
 884
 885
 886 **Source Code**
 887
 888 Source code of DCAE components are released under the following repositories on gerrit.onap.org:
 889     - dcaegen2
 890     - dcaegen2.analytics
 891     - dcaegen2.analytics.tca
 892     - dcaegen2.collectors
 893     - dcaegen2.collectors.snmptrap
 894     - dcaegen2.collectors.ves
 895     - dcaegen2.deployments
 896     - dcaegen2.platform
 897     - dcaegen2.platform.blueprints
 898     - dcaegen2.platform.cli
 899     - dcaegen2.platform.configbinding
 900     - dcaegen2.platform.deployment-handler
 901     - dcaegen2.platform.inventory-api
 902     - dcaegen2.platform.plugins
 903     - dcaegen2.platform.policy-handler
 904     - dcaegen2.platform.servicechange-handler
 905     - dcaegen2.services.heartbeat
 906     - dcaegen2.services.mapper
 907     - dcaegen2.services.prh
 908     - dcaegen2.utils
 909
 910 **Bug Fixes**
 911
 912 **Known Issues**
 913
 914 - DCAE utilizes Cloudify Manager as its declarative model based resource deployment engine.  Cloudify Manager is an open source upstream technology provided by Cloudify Inc. as a Docker image.  DCAE R2 does not provide additional enhancements towards Cloudify Manager's platform maturity.
 915
 916 **Security Notes**
 917
 918 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=28377647>`_.
 919
 920 Quick Links:
 921         - `DCAE project page <https://wiki.onap.org/display/DW/Data+Collection+Analytics+and+Events+Project>`_
 922
 923         - `Passing Badge information for DCAE <https://bestpractices.coreinfrastructure.org/en/projects/1718>`_
 924
 925         - `Project Vulnerability Review Table for DCAE <https://wiki.onap.org/pages/viewpage.action?pageId=28377647>`_
 926
 927
 928
 929 **Upgrade Notes**
 930
 931 The following components are upgraded from R1:
 932     - Cloudify Manager:
 933        - Docker container tag: onap/org.onap.dcaegen2.deployments.cm-container:1.3.0
 934        - Description: R2 DCAE's Cloudify Manager container is based on Cloudify Manager Community Version 18.2.28, which is based on Cloudify Manager 4.3.
 935     - Bootstrap container:
 936        - Docker container tag: onap/org.onap.dcaegen2.deployments.k8s-bootstrap-container:1.1.11
 937        - Description: R2 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.
 938     - Configuration Binding Service:
 939        - Docker container tag: onap/org.onap.dcaegen2.platform.configbinding:2.1.5
 940        - Description: Configuration Binding Sevice now supports the new configuration policy format.
 941     - Deployment Handler
 942        - Docker container image tag: onap/org.onap.dcaegen2.platform.deployment-handler:2.1.5
 943     - Policy Handler
 944        - Docker container image tag: onap/org.onap.dcaegen2.platform.policy-handler:2.4.5
 945        - Description: Policy Handler now supports the new configuration policy format.
 946     - Service Change Handler
 947        - Docker container image tag: onap/org.onap.dcaegen2.platform.servicechange-handler:1.1.4
 948        - Description: Refactoring.
 949     - Inventory API
 950        - Docker container image tag: onap/org.onap.dcaegen2.platform.inventory-api:3.0.1
 951        - Description: Refactoring.
 952     - VES Collector
 953        - Docker container image tag: onap/org.onap.dcaegen2.collectors.ves.vescollector:1.2.0
 954     - Threshold Crossing Analytics
 955        - Docker container image tag: onap/org.onap.dcaegen2.deployments.tca-cdap-container:1.1.0
 956        - Description: 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.
 957
 958
 959
 960 Version: 1.0.0
 961 ==============
 962
 963 :Release Date: 2017-11-16
 964
 965
 966 **New Features**
 967
 968 DCAE is the data collection and analytics sub-system of ONAP.  Under ONAP Release 1 the DCAE
 969 sub-system includes both platform components and DCAE service components.  Collectively the ONAP R1
 970 DCAE components support the data collection and analytics functions for the R1 use cases, i.e. vFW,
 971 vDNS, vCPU, and vVoLTE.
 972
 973 Specifically, DCAE R1 includes the following components:
 974
 975 - Core platform
 976     - Cloudify manager
 977     - Consul cluster
 978 - Extended platform
 979     - Platform component docker host
 980     - Service component docker host
 981     - CDAP cluster
 982     - PostgreSQL database (*)
 983 - Platform docker container components
 984     - Configuration binding service
 985     - Deployment handler
 986     - Service change handler
 987     - Inventory
 988     - Policy handler
 989     - CDAP broker
 990 - Service components
 991     - Docker container components
 992         - VNF Event Streaming (VES) collector
 993         - Holmes (engine and rule management) **
 994     - CDAP analytics component
 995         - Threshold Crossing Analytics (TCA)
 996
 997 (*) Note: This component is delivered under the CCSDK project, deployed by DCAE under a single
 998 VM configuration as a shared PostgreSQL database for the R1 demos.  (CCSDK PostgreSQL supports
 999 other deployment configurations not used in the R1 demos.)
1000 (**) Note: This component is delivered under the Holmes project and used as a DCAE analytics component
1001 in R1.
1002
1003 Source codes of DCAE are released under the following repositories on gerrit.onap.org:
1004
1005 - dcaegen2
1006 - dcaegen2/analytics
1007 - dcaegen2/analytics/tca
1008 - dcaegen2/collectors
1009 - dcaegen2/collectors/snmptrap
1010 - dcaegen2/collectors/ves
1011 - dcaegen2/deployments
1012 - dcaegen2/platform
1013 - dcaegen2/platform/blueprints
1014 - dcaegen2/platform/cdapbroker
1015 - dcaegen2/platform/cli
1016 - dcaegen2/platform/configbinding
1017 - dcaegen2/platform/deployment-handler
1018 - dcaegen2/platform/inventory-api
1019 - dcaegen2/platform/plugins
1020 - dcaegen2/platform/policy-handler
1021 - dcaegen2/platform/servicechange-handler
1022 - dcaegen2/utils
1023
1024
1025 **Bug Fixes**
1026
1027 This is the initial release.
1028
1029
1030 **Known Issues**
1031
1032 - Need to test/integrate into an OpenStack environment other than Intel/Windriver Pod25.
1033 - Need to provide a dev configuration DCAE.
1034
1035
1036 **Security Issues**
1037
1038 - The DCAE Bootstrap container needs to have a secret key for accessing VMs that it launches.  This key is currently passed in as a Heat template parameter.  Tracked by JIRA `DCAEGEN2-178 <https://jira.onap.org/browse/DCAEGEN2-178>`_.>`_.
1039 - The RESTful API calls are generally not secure.  That is, they are either over http, or https without certificate verification.  Once there is an ONAP wide solution for handling certificates, DCAE will switch to https.
1040
1041
1042 **Upgrade Notes**
1043
1044 This is the initial release.
1045
1046
1047 **Deprecation Notes**
1048
1049 There is a GEN1 DCAE sub-system implementation existing in the pre-R1 ONAP Gerrit system.  The GEN1
1050 DCAE is deprecated by the R1 release.  The DCAE included in ONAP R1 is also known as DCAE GEN2.  The
1051 following Gerrit repos are voided and already locked as read-only.
1052
1053 - dcae
1054 - dcae/apod
1055 - dcae/apod/analytics
1056 - dcae/apod/buildtools
1057 - dcae/apod/cdap
1058 - dcae/collectors
1059 - dcae/collectors/ves
1060 - dcae/controller
1061 - dcae/controller/analytics
1062 - dcae/dcae-inventory
1063 - dcae/demo
1064 - dcae/demo/startup
1065 - dcae/demo/startup/aaf
1066 - dcae/demo/startup/controller
1067 - dcae/demo/startup/message-router
1068 - dcae/dmaapbc
1069 - dcae/operation
1070 - dcae/operation/utils
1071 - dcae/orch-dispatcher
1072 - dcae/pgaas
1073 - dcae/utils
1074 - dcae/utils/buildtools
1075 - ncomp
1076 - ncomp/cdap
1077 - ncomp/core
1078 - ncomp/docker
1079 - ncomp/maven
1080 - ncomp/openstack
1081 - ncomp/sirius
1082 - ncomp/sirius/manager
1083 - ncomp/utils
1084
1085
1086 **Other**
1087
1088 SNMP trap collector is seed code delivery only.