docs/sections/release-notes.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   2
   3 Release Notes
   4 =============
   5
   6
   7 Version: 5.0.0
   8 --------------
   9
  10 El-Alto Early-drop focused on technical debts and SECCOM priority work-items.
  11
  12 Following is summary of updates done for DCAEGEN2
  13
  14 **Security**
  15
  16 Following platform components were enabled for HTTPS
  17     - ConfigBindingService (CBS)
  18       -   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>`_
  19     - Cloudify Manager
  20     - InventoryAPI
  21
  22 All components interfacing with platform components were modified to support TLS interface
  23
  24 **Miscellaneous**
  25     - DCAE Dashboard deployment migration from cloudify blueprint to OOM/Chart
  26     - Dynamic Topic support via Dmaap plugin integration for DataFileCollector MS
  27     - Dynamic Topic support via Dmaap plugin integration for PM-Mapper service
  28     - CBS client libraries updated to remove consul service lookup
  29
  30
  31 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.
  32     - Platform components
  33         - Cloudify Manager (helm chart)
  34         - Bootstrap container (helm chart)
  35         - Configuration Binding Service (helm chart)
  36         - Deployment Handler (helm chart)
  37         - Policy Handler (helm chart
  38         - Service Change Handler (helm chart)
  39         - Inventory API (helm chart)
  40         - Dashboard (helm charts)
  41     - Service components
  42         - VES Collector
  43         - SNMP Collector
  44         - Threshold Crossing Analytics
  45         - HV-VES Collector
  46         - PNF-Registration Handler
  47         - Holmes Rule Management *
  48         - Holmes Engine Management *
  49     - Additional resources that DCAE utilizes:
  50         - Postgres Database
  51         - Redis Cluster Database
  52         - Consul Cluster *
  53
  54     Notes:
  55         \*  These components are delivered by external ONAP project.
  56
  57 DCAE also includes below MS which can be deployed on-demand (via Dashboard or Cloudify CLI or CLAMP)
  58
  59     - Collectors
  60         - RESTConf collector
  61         - DataFile collector
  62     - Event Processors
  63         - VES Mapper
  64         - 3gpp PM-Mapper
  65         - BBS Event processor
  66     - Analytics/RCA
  67         - SON-Handler
  68         - Missing Heartbeat Ms
  69
  70 - All DCAE components are designed to support platform maturity requirements.
  71
  72
  73 **Source Code**
  74
  75 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.
  76     - dcaegen2
  77     - dcaegen2.analytics.tca
  78     - dcaegen2.collectors.snmptrap
  79     - dcaegen2.collectors.ves
  80     - dcaegen2.collectors.hv-ves
  81     - dcaegen2.collectors.datafile
  82     - dcaegen2.collectors.restconf
  83     - dcaegen2.deployments
  84     - dcaegen2.platform.blueprints
  85     - dcaegen2.platform.cli
  86     - dcaegen2.platform.configbinding
  87     - dcaegen2.platform.deployment-handler
  88     - dcaegen2.platform.inventory-api
  89     - dcaegen2.platform.plugins
  90     - dcaegen2.platform.policy-handler
  91     - dcaegen2.platform.servicechange-handler
  92     - dcaegen2.services.heartbeat
  93     - dcaegen2.services.mapper
  94     - dcaegen2.services.pm-mapper
  95     - dcaegen2.services.prh
  96     - dcaegen2.services.son-handler
  97     - dcaegen2.services
  98     - dcaegen2.services.sdk
  99     - dcaegen2.utils
 100     - ccsdk.platform.plugins
 101     - ccsdk.dashboard
 102
 103 **Bug Fixes**
 104     * k8splugin can generate deployment name > 63 chars (DCAEGEN2-1667)
 105     * CM container loading invalid Cloudify types file (DCAEGEN2-1685)
 106
 107
 108 **Known Issues**
 109     * Healthcheck/Readiness probe VES Collector when authentication is enabled (DCAEGEN2-1594)
 110
 111
 112 **Security Notes**
 113
 114 *Fixed Security Issues*
 115
 116 *Known Security Issues*
 117
 118     * Unsecured Swagger UI Interface in xdcae-datafile-collector. [`OJSI-28 <https://jira.onap.org/browse/OJSI-28>`_]
 119     * Unsecured Swagger UI Interface in xdcae-ves-collector. [`OJSI-30 <https://jira.onap.org/browse/OJSI-30>`_]
 120     * In default deployment DCAEGEN2 (xdcae-datafile-collector) exposes HTTP port 30223 outside of cluster. [`OJSI-109 <https://jira.onap.org/browse/OJSI-109>`_]
 121     * In default deployment DCAEGEN2 (xdcae-ves-collector) exposes HTTP port 30235 outside of cluster. [`OJSI-116 <https://jira.onap.org/browse/OJSI-116>`_]
 122     * In default deployment DCAEGEN2 (dcae-datafile-collector) exposes HTTP port 30262 outside of cluster. [`OJSI-131 <https://jira.onap.org/browse/OJSI-131>`_]
 123     * In default deployment DCAEGEN2 (xdcae-dashboard) exposes HTTP port 30418 outside of cluster. [`OJSI-159 <https://jira.onap.org/browse/OJSI-159>`_]
 124     * In default deployment DCAEGEN2 (xdcae-tca-analytics) exposes HTTP port 32010 outside of cluster. [`OJSI-161 <https://jira.onap.org/browse/OJSI-161>`_]
 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     * CVE-2019-12126 - DCAE TCA exposes unprotected APIs/UIs on port 32010. [`OJSI-201 <https://jira.onap.org/browse/OJSI-201>`_]
 128
 129 *Known Vulnerabilities in Used Modules*
 130
 131 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>`_.
 132
 133 Quick Links:
 134         - `DCAE project page <https://wiki.onap.org/display/DW/Data+Collection+Analytics+and+Events+Project>`_
 135
 136         - `Passing Badge information for DCAE <https://bestpractices.coreinfrastructure.org/en/projects/1718>`_
 137
 138         - `Project Vulnerability Review Table for DCAE <https://wiki.onap.org/pages/viewpage.action?pageId=68540441>`_
 139
 140
 141 **Upgrade Notes**
 142
 143 The following components are upgraded from Dublin/R4.
 144     - Cloudify Manager:
 145        - Docker container tag: onap/org.onap.dcaegen2.deployments.cm-container:2.0.2
 146        - 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.
 147     - K8S Bootstrap container:
 148        - Docker container tag: onap/org.onap.dcaegen2.deployments.k8s-bootstrap-container:1.6.2
 149        - Description: K8s bootstrap container updated to interface with Cloudify using HTTPS; new k8s and Dmaap plugin version included; Dashboard deployment was removed.
 150     - Configuration Binding Service:
 151        - Docker container tag: onap/org.onap.dcaegen2.platform.configbinding.app-app:2.5.1
 152        - Description: HTTPS support, Image optimization and non-root user
 153     - Deployment Handler
 154        - Docker container image tag: onap/org.onap.dcaegen2.platform.deployment-handler:4.2.0
 155        - Description: Update to node10, uninstall workflow updates
 156     - Service Change Handler
 157        - Docker container image tag: onap/org.onap.dcaegen2.platform.servicechange-handler:1.3.2
 158        - Description: HTTPS inventoryAPI support, container optmization and non-root user
 159     - Inventory API
 160        - Docker container image tag: onap/org.onap.dcaegen2.platform.inventory-api:3.4.0
 161        - Description: HTTPS support, container optmization and non-root user
 162     - DataFile Collector
 163        - Docker container tag: onap/org.onap.dcaegen2.collectors.datafile.datafile-app-server:1.2.2
 164        - Description : Code optimization, bug fixes, dmaap plugin integration
 165     - 3gpp PM-Mapper
 166        - Docker container tag: onap/org.onap.dcaegen2.services.pm-mapper:1.1.3
 167        - Description: Code optimization, bug fixes, dmaap plugin integration
 168
 169
 170
 171 Version: 4.0.0
 172 --------------
 173
 174 :Release Date: 2019-06-06
 175
 176 **New Features**
 177
 178 DCAE R4 improves upon previous release with the following new features:
 179
 180 - DCAE Platform Enhancement
 181     - Multisite K8S cluster deployment support for DCAE services (via K8S plugin)
 182     - Support helm chart deployment in DCAE using new Helm cloudify plugin
 183     - DCAE Healthcheck enhancement to cover static and dynamic deployments
 184     - Dynamic AAF based topic provisioning support through Dmaap cloudify plugin
 185     - Dashboard Integration (UI for deployment/verification)
 186     - PolicyHandler Enhancement to support new Policy Lifecycle API’s
 187     - Blueprint generator tool to simplify deployment artifact creation
 188     - Cloudify Manager resiliency
 189
 190 - Following new services are delivered with Dublin
 191     - Collectors
 192         - RESTConf collector
 193     - Event Processors
 194         - VES Mapper
 195         - 3gpp PM-Mapper
 196         - BBS Event processor
 197     - Analytics/RCA
 198         - SON-Handler
 199         - Heartbeat MS
 200
 201 Most platform components has been migrated to helm charts. Following is complete list of DCAE components available part of default ONAP/dcae installation.
 202     - Platform components
 203         - Cloudify Manager (helm chart)
 204         - Bootstrap container (helm chart)
 205         - Configuration Binding Service (helm chart)
 206         - Deployment Handler (helm chart)
 207         - Policy Handler (helm chart
 208         - Service Change Handler (helm chart)
 209         - Inventory API (helm chart)
 210         - Dashboard (Cloudify Blueprint)
 211     - Service components
 212         - VES Collector
 213         - SNMP Collector
 214         - Threshold Crossing Analytics
 215         - HV-VES Collector
 216         - PNF-Registration Handler
 217         - Holmes Rule Management *
 218         - Holmes Engine Management *
 219     - Additional resources that DCAE utilizes:
 220         - Postgres Database
 221         - Redis Cluster Database
 222         - Consul Cluster *
 223
 224     Notes:
 225         \*  These components are delivered by the Holmes project.
 226
 227
 228 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.
 229
 230 - All DCAE components are designed to support platform maturity requirements.
 231
 232
 233 **Source Code**
 234
 235 Source code of DCAE components are released under the following repositories on gerrit.onap.org:
 236     - dcaegen2
 237     - dcaegen2.analytics.tca
 238     - dcaegen2.collectors.snmptrap
 239     - dcaegen2.collectors.ves
 240     - dcaegen2.collectors.hv-ves
 241     - dcaegen2.collectors.datafile
 242     - dcaegen2.collectors.restconf
 243     - dcaegen2.deployments
 244     - dcaegen2.platform.blueprints
 245     - dcaegen2.platform.cli
 246     - dcaegen2.platform.configbinding
 247     - dcaegen2.platform.deployment-handler
 248     - dcaegen2.platform.inventory-api
 249     - dcaegen2.platform.plugins
 250     - dcaegen2.platform.policy-handler
 251     - dcaegen2.platform.servicechange-handler
 252     - dcaegen2.services.heartbeat
 253     - dcaegen2.services.mapper
 254     - dcaegen2.services.pm-mapper
 255     - dcaegen2.services.prh
 256     - dcaegen2.services.son-handler
 257     - dcaegen2.services
 258     - dcaegen2.services.sdk
 259     - dcaegen2.utils
 260     - ccsdk.platform.plugins
 261     - ccsdk.dashboard
 262
 263 **Bug Fixes**
 264
 265 **Known Issues**
 266     * Healthcheck/Readiness probe VES Collector when authentication is enabled (DCAEGEN2-1594)
 267
 268
 269 **Security Notes**
 270
 271 *Fixed Security Issues*
 272
 273 *Known Security Issues*
 274
 275     * Unsecured Swagger UI Interface in xdcae-datafile-collector. [`OJSI-28 <https://jira.onap.org/browse/OJSI-28>`_]
 276     * Unsecured Swagger UI Interface in xdcae-ves-collector. [`OJSI-30 <https://jira.onap.org/browse/OJSI-30>`_]
 277     * In default deployment DCAEGEN2 (xdcae-datafile-collector) exposes HTTP port 30223 outside of cluster. [`OJSI-109 <https://jira.onap.org/browse/OJSI-109>`_]
 278     * In default deployment DCAEGEN2 (xdcae-ves-collector) exposes HTTP port 30235 outside of cluster. [`OJSI-116 <https://jira.onap.org/browse/OJSI-116>`_]
 279     * In default deployment DCAEGEN2 (dcae-datafile-collector) exposes HTTP port 30262 outside of cluster. [`OJSI-131 <https://jira.onap.org/browse/OJSI-131>`_]
 280     * In default deployment DCAEGEN2 (xdcae-dashboard) exposes HTTP port 30418 outside of cluster. [`OJSI-159 <https://jira.onap.org/browse/OJSI-159>`_]
 281     * In default deployment DCAEGEN2 (xdcae-tca-analytics) exposes HTTP port 32010 outside of cluster. [`OJSI-161 <https://jira.onap.org/browse/OJSI-161>`_]
 282     * In default deployment DCAEGEN2 (dcae-redis) exposes redis port 30286 outside of cluster. [`OJSI-187 <https://jira.onap.org/browse/OJSI-187>`_]
 283     * In default deployment DCAEGEN2 (config-binding-service) exposes HTTP port 30415 outside of cluster. [`OJSI-195 <https://jira.onap.org/browse/OJSI-195>`_]
 284     * CVE-2019-12126 - DCAE TCA exposes unprotected APIs/UIs on port 32010. [`OJSI-201 <https://jira.onap.org/browse/OJSI-201>`_]
 285
 286 *Known Vulnerabilities in Used Modules*
 287
 288 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>`_.
 289
 290 Quick Links:
 291         - `DCAE project page <https://wiki.onap.org/display/DW/Data+Collection+Analytics+and+Events+Project>`_
 292
 293         - `Passing Badge information for DCAE <https://bestpractices.coreinfrastructure.org/en/projects/1718>`_
 294
 295         - `Project Vulnerability Review Table for DCAE <https://wiki.onap.org/pages/viewpage.action?pageId=51282478>`_
 296
 297
 298 **New component Notes**
 299 The following components are introduced in R4
 300
 301     - Dashboard
 302        - Docker container tag: onap/org.onap.ccsdk.dashboard.ccsdk-app-os:1.1.0
 303        - Description: Dashboard provides an UI interface for users/operation to deploy and manage service components in DCAE
 304     - Blueprint generator
 305        - Java artifact : /org/onap/dcaegen2/platform/cli/blueprint-generator/1.0.0/blueprint-generator-1.0.0.jar
 306        - Description: Tool to generate the deployment artifact (cloudify blueprints) based on component spec
 307     - RESTConf collector
 308        - Docker container tag: onap/org.onap.dcaegen2.collectors.restconfcollector:1.1.1
 309        - Description: Provides RESTConf interfaces to events from external domain controllers
 310     - VES/Universal Mapper
 311        - Docker container tag: onap/org.onap.dcaegen2.services.mapper.vesadapter.universalvesadaptor:1.0.0
 312        - Description: Standardizes events recieved from SNMP and RESTConf collector into VES for further processing with DCAE analytics services
 313     - 3gpp PM-Mapper
 314        - Docker container tag: onap/org.onap.dcaegen2.services.pm-mapper:1.0.1
 315        - Description: Transforms 3gpp data feed recieved from DMAAP-DR into VES events
 316     - BBS Event processor
 317        - Docker container tag: onap/org.onap.dcaegen2.services.components.bbs-event-processor:1.0.0
 318        - Description: Handles PNF-Reregistration and CPE authentication events and generate CL events
 319     - SON-Handler
 320        - Docker container tag: onap/org.onap.dcaegen2.services.son-handler:1.0.3
 321        - Description: Supports PC-ANR optimization analysis and generating CL events output
 322     - Heartbeat MS
 323        - Docker container tag: onap/org.onap.dcaegen2.services.heartbeat:2.1.0
 324        - Description: Generates missing heartbeat CL events based on configured threshold for VES heartbeats/VNF type.
 325
 326
 327 **Upgrade Notes**
 328
 329 The following components are upgraded from R3
 330     - Cloudify Manager:
 331        - Docker container tag: onap/org.onap.dcaegen2.deployments.cm-container:1.6.2
 332        - Description: DCAE's Cloudify Manager container is based on Cloudify Manager Community Version 19.01.24, which is based on Cloudify Manager 4.5.
 333     - K8S Bootstrap container:
 334        - Docker container tag: onap/org.onap.dcaegen2.deployments.k8s-bootstrap-container:1.4.18
 335        - Description: K8s bootstrap container updated to include new plugin and remove DCAE Controller components which have been migrated to Helm chart.
 336     - Configuration Binding Service:
 337        - Docker container tag: onap/org.onap.dcaegen2.platform.configbinding.app-app:2.3.0
 338        - Description: Code optimization and bug fixes
 339     - Deployment Handler
 340        - Docker container image tag: onap/org.onap.dcaegen2.platform.deployment-handler:4.0.1
 341        - Include updates for health and service endpoint check and bug fixes
 342     - Policy Handler
 343        - Docker container image tag: onap/org.onap.dcaegen2.platform.policy-handler:5.0.0
 344        - Description: Policy Handler supports the new lifecycle API's from Policy framework
 345     - Service Change Handler
 346        - Docker container image tag: onap/org.onap.dcaegen2.platform.servicechange-handler:1.1.5
 347        - Description: No update from R3
 348     - Inventory API
 349        - Docker container image tag: onap/org.onap.dcaegen2.platform.inventory-api:3.2.0
 350        - Description: Refactoring and updates for health and service endpoint check
 351     - VES Collector
 352        - Docker container image tag: onap/org.onap.dcaegen2.collectors.ves.vescollector:1.4.5
 353        - Description : Authentication enhancement, refactoring and bug-fixes
 354     - Threshold Crossing Analytics
 355        - Docker container image tag: onap/org.onap.dcaegen2.deployments.tca-cdap-container:1.1.2
 356        - 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.
 357     - DataFile Collector
 358        - Docker container tag: onap/org.onap.dcaegen2.collectors.datafile.datafile-app-server:1.1.3
 359        - Description : Code optimization, bug fixes, logging and performance improvement
 360     - PNF Registrator handler
 361        - Docker container tag: onap/org.onap.dcaegen2.services.prh.prh-app-server:1.2.4
 362        - Description : Code optimization, SDK integration, PNF-UPDATE flow support
 363     - HV-VES Collector
 364        - Docker container tag: onap/org.onap.dcaegen2.collectors.hv-ves.hv-collector-main:1.1.0
 365        - Description : Code optimization, bug fixes, and enables SASL for kafka interface
 366     - SNMP Trap Collector
 367        - Docker container tag: onap/org.onap.dcaegen2.collectors.snmptrap:1.4.0
 368        - Description : Code coverage improvements
 369
 370
 371
 372
 373 Version: 3.0.1
 374 --------------
 375
 376 :Release Date: 2019-01-31
 377
 378 DCAE R3 Maintenance release includes following fixes
 379
 380 **Bug Fixes**
 381
 382 - DataFileCollector
 383      - DCAEGEN2-940
 384        Larger files of size 100Kb publish to DR
 385      - DCAEGEN2-941
 386        DFC error after running over 12 hours
 387      - DCAEGEN2-1001
 388        Multiple Fileready notification not handled
 389
 390 - HighVolume VES Collector (protobuf/tcp)
 391      - DCAEGEN2-976
 392        HV-VES not fully complaint to RTPM protocol (issue with CommonEventHeader.sequence)
 393
 394 - VESCollector (http)
 395      - DCAEGEN2-1035
 396        Issue with VES batch event publish
 397
 398 - Heat deployment
 399      - DCAEGEN2-1007
 400        Removing obsolete services configuration
 401
 402
 403 The following containers are updated in R3.0.1
 404
 405     - DataFile Collector
 406        - Docker container tag: onap/org.onap.dcaegen2.collectors.datafile.datafile-app-server:1.0.5
 407     - HV-VES Collector
 408        - Docker container tag: onap/org.onap.dcaegen2.collectors.hv-ves.hv-collector-main:1.0.2
 409     - VES Collector
 410        - Docker container tag: onap/org.onap.dcaegen2.collectors.ves.vescollector:1.3.2
 411
 412 **Known Issues**
 413
 414 - 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
 415
 416 - 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
 417     kubectl get deployments -n onap | grep deployment-handler
 418     kubectl edit deployment -n onap dev-dcaegen2-dcae-deployment-handler
 419     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
 420
 421
 422
 423
 424 Version: 3.0.0
 425 --------------
 426
 427 :Release Date: 2018-11-30
 428
 429 **New Features**
 430
 431 DCAE R3 improves upon previous release with the following new features:
 432
 433 - All DCAE R3 components are delivered as Docker container images.  The list of components is as follows.
 434     - Platform components
 435         - Cloudify Manager
 436         - Bootstrap container
 437         - Configuration Binding Service
 438         - Deployment Handler
 439         - Policy Handler
 440         - Service Change Handler
 441         - Inventory API
 442     - Service components
 443         - VES Collector
 444         - SNMP Collector
 445         - Threshold Crossing Analytics
 446         - Holmes Rule Management *
 447         - Holmes Engine Management *
 448     - Additional resources that DCAE utilizes:
 449         - Postgres Database
 450         - Redis Cluster Database
 451         - Consul Cluster
 452
 453     Notes:
 454         \*  These components are delivered by the Holmes project.
 455
 456 - DCAE R3 supports both OpenStack Heat Orchestration Template based deployment and OOM (Kubernetes) based deployment.
 457
 458     - 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".
 459     - Under OOM (Kubernetes) deployment all DCAE component containers are deployed as Kubernetes Pods/Deployments/Services into Kubernetes cluster.
 460
 461 - 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.
 462
 463 - All DCAE components are designed to support platform maturity requirements.
 464
 465
 466 **Source Code**
 467
 468 Source code of DCAE components are released under the following repositories on gerrit.onap.org:
 469     - dcaegen2
 470     - dcaegen2.analytics
 471     - dcaegen2.analytics.tca
 472     - dcaegen2.collectors
 473     - dcaegen2.collectors.snmptrap
 474     - dcaegen2.collectors.ves
 475     - dcaegen2.collectors.hv-ves
 476     - dcaegen2.collectors.datafile
 477     - dcaegen2.deployments
 478     - dcaegen2.platform
 479     - dcaegen2.platform.blueprints
 480     - dcaegen2.platform.cli
 481     - dcaegen2.platform.configbinding
 482     - dcaegen2.platform.deployment-handler
 483     - dcaegen2.platform.inventory-api
 484     - dcaegen2.platform.plugins
 485     - dcaegen2.platform.policy-handler
 486     - dcaegen2.platform.servicechange-handler
 487     - dcaegen2.services.heartbeat
 488     - dcaegen2.services.mapper
 489     - dcaegen2.services.prh
 490     - dcaegen2.utils
 491
 492 **Bug Fixes**
 493
 494 **Known Issues**
 495
 496 - 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.
 497
 498 **Security Notes**
 499
 500 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>`_.
 501
 502 Quick Links:
 503         - `DCAE project page <https://wiki.onap.org/display/DW/Data+Collection+Analytics+and+Events+Project>`_
 504
 505         - `Passing Badge information for DCAE <https://bestpractices.coreinfrastructure.org/en/projects/1718>`_
 506
 507         - `Project Vulnerability Review Table for DCAE <https://wiki.onap.org/pages/viewpage.action?pageId=41421168>`_
 508
 509
 510 **New component Notes**
 511 The following components are introduced in R3
 512
 513     - DataFile Collector
 514        - Docker container tag: onap/org.onap.dcaegen2.collectors.datafile.datafile-app-server:1.0.4
 515        - Description : Bulk data file collector to fetch non-realtime PM data
 516     - PNF Registrator handler
 517        - Docker container tag: onap/org.onap.dcaegen2.services.prh.prh-app-server:1.1.1
 518        - Description : Recieves VES registration event and updates AAI and SO
 519     - HV-VES Collector
 520        - Docker container tag: onap/org.onap.dcaegen2.collectors.hv-ves.hv-collector-main:1.0.0
 521        - Description : High Volume VES Collector for fetching real-time PM measurement data
 522     - SNMP Trap Collector
 523        - Docker container tag: onap/org.onap.dcaegen2.collectors.snmptrap:1.4.0
 524        - Description : Receives SNMP traps and publishes them to a  message router (DMAAP/MR) in json structure
 525
 526
 527 **Upgrade Notes**
 528
 529 The following components are upgraded from R2:
 530     - Cloudify Manager:
 531        - Docker container tag: onap/org.onap.dcaegen2.deployments.cm-container:1.4.2
 532        - 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.
 533     - Bootstrap container:
 534        - Docker container tag: onap/org.onap.dcaegen2.deployments.k8s-bootstrap-container:1.4.5
 535        - 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.
 536     - Configuration Binding Service:
 537        - Docker container tag: onap/org.onap.dcaegen2.platform.configbinding.app-app:2.2.3
 538        - Description: Configuration Binding Sevice now supports the new configuration policy format and support for TLS
 539     - Deployment Handler
 540        - Docker container image tag: onap/org.onap.dcaegen2.platform.deployment-handler:3.0.3
 541     - Policy Handler
 542        - Docker container image tag: onap/org.onap.dcaegen2.platform.policy-handler:4.4.0
 543        - Description: Policy Handler now supports the new configuration policy format and support for TLS
 544     - Service Change Handler
 545        - Docker container image tag: onap/org.onap.dcaegen2.platform.servicechange-handler:1.1.5
 546        - Description: Refactoring.
 547     - Inventory API
 548        - Docker container image tag: onap/org.onap.dcaegen2.platform.inventory-api:3.0.4
 549        - Description: Refactoring.
 550     - VES Collector
 551        - Docker container image tag: onap/org.onap.dcaegen2.collectors.ves.vescollector:1.3.1
 552        - Description : Refactoring
 553     - Threshold Crossing Analytics
 554        - Docker container image tag: onap/org.onap.dcaegen2.deployments.tca-cdap-container:1.1.0
 555        - 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.
 556
 557
 558
 559
 560 Version: 2.0.0
 561 --------------
 562
 563 :Release Date: 2018-06-07
 564
 565 **New Features**
 566
 567 DCAE R2 improves upon previous release with the following new features:
 568
 569 - All DCAE R2 components are delivered as Docker container images.  The list of components is as follows.
 570     - Platform components
 571         - Cloudify Manager
 572         - Bootstrap container
 573         - Configuration Binding Service
 574         - Deployment Handler
 575         - Policy Handler
 576         - Service Change Handler
 577         - Inventory API
 578     - Service components
 579         - VES Collector
 580         - SNMP Collector
 581         - Threshold Crossing Analytics
 582         - Holmes Rule Management *
 583         - Holmes Engine Management *
 584     - Additional resources that DCAE utilizes:
 585         - Postgres Database
 586         - Redis Cluster Database
 587         - Consul Cluster
 588
 589     Notes:
 590         \*  These components are delivered by the Holmes project and used as a DCAE analytics component in R2.
 591
 592 - DCAE R2 supports both OpenStack Heat Orchestration Template based deployment and OOM (Kubernetes) based deployment.
 593
 594     - 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".
 595     - Under OOM (Kubernetes) deployment all DCAE component containers are deployed as Kubernetes Pods/Deployments/Services into Kubernetes cluster.
 596
 597 - 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.
 598
 599 - All DCAE components are designed to support platform maturity requirements.
 600
 601
 602 **Source Code**
 603
 604 Source code of DCAE components are released under the following repositories on gerrit.onap.org:
 605     - dcaegen2
 606     - dcaegen2.analytics
 607     - dcaegen2.analytics.tca
 608     - dcaegen2.collectors
 609     - dcaegen2.collectors.snmptrap
 610     - dcaegen2.collectors.ves
 611     - dcaegen2.deployments
 612     - dcaegen2.platform
 613     - dcaegen2.platform.blueprints
 614     - dcaegen2.platform.cli
 615     - dcaegen2.platform.configbinding
 616     - dcaegen2.platform.deployment-handler
 617     - dcaegen2.platform.inventory-api
 618     - dcaegen2.platform.plugins
 619     - dcaegen2.platform.policy-handler
 620     - dcaegen2.platform.servicechange-handler
 621     - dcaegen2.services.heartbeat
 622     - dcaegen2.services.mapper
 623     - dcaegen2.services.prh
 624     - dcaegen2.utils
 625
 626 **Bug Fixes**
 627
 628 **Known Issues**
 629
 630 - 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.
 631
 632 **Security Notes**
 633
 634 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>`_.
 635
 636 Quick Links:
 637         - `DCAE project page <https://wiki.onap.org/display/DW/Data+Collection+Analytics+and+Events+Project>`_
 638
 639         - `Passing Badge information for DCAE <https://bestpractices.coreinfrastructure.org/en/projects/1718>`_
 640
 641         - `Project Vulnerability Review Table for DCAE <https://wiki.onap.org/pages/viewpage.action?pageId=28377647>`_
 642
 643
 644
 645 **Upgrade Notes**
 646
 647 The following components are upgraded from R1:
 648     - Cloudify Manager:
 649        - Docker container tag: onap/org.onap.dcaegen2.deployments.cm-container:1.3.0
 650        - 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.
 651     - Bootstrap container:
 652        - Docker container tag: onap/org.onap.dcaegen2.deployments.k8s-bootstrap-container:1.1.11
 653        - 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.
 654     - Configuration Binding Service:
 655        - Docker container tag: onap/org.onap.dcaegen2.platform.configbinding:2.1.5
 656        - Description: Configuration Binding Sevice now supports the new configuration policy format.
 657     - Deployment Handler
 658        - Docker container image tag: onap/org.onap.dcaegen2.platform.deployment-handler:2.1.5
 659     - Policy Handler
 660        - Docker container image tag: onap/org.onap.dcaegen2.platform.policy-handler:2.4.5
 661        - Description: Policy Handler now supports the new configuration policy format.
 662     - Service Change Handler
 663        - Docker container image tag: onap/org.onap.dcaegen2.platform.servicechange-handler:1.1.4
 664        - Description: Refactoring.
 665     - Inventory API
 666        - Docker container image tag: onap/org.onap.dcaegen2.platform.inventory-api:3.0.1
 667        - Description: Refactoring.
 668     - VES Collector
 669        - Docker container image tag: onap/org.onap.dcaegen2.collectors.ves.vescollector:1.2.0
 670     - Threshold Crossing Analytics
 671        - Docker container image tag: onap/org.onap.dcaegen2.deployments.tca-cdap-container:1.1.0
 672        - 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.
 673
 674
 675
 676 Version: 1.0.0
 677 --------------
 678
 679 :Release Date: 2017-11-16
 680
 681
 682 **New Features**
 683
 684 DCAE is the data collection and analytics sub-system of ONAP.  Under ONAP Release 1 the DCAE
 685 sub-system includes both platform components and DCAE service components.  Collectively the ONAP R1
 686 DCAE components support the data collection and analytics functions for the R1 use cases, i.e. vFW,
 687 vDNS, vCPU, and vVoLTE.
 688
 689 Specifically, DCAE R1 includes the following components:
 690
 691 - Core platform
 692     - Cloudify manager
 693     - Consul cluster
 694 - Extended platform
 695     - Platform component docker host
 696     - Service component docker host
 697     - CDAP cluster
 698     - PostgreSQL database (*)
 699 - Platform docker container components
 700     - Configuration binding service
 701     - Deployment handler
 702     - Service change handler
 703     - Inventory
 704     - Policy handler
 705     - CDAP broker
 706 - Service components
 707     - Docker container components
 708         - VNF Event Streaming (VES) collector
 709         - Holmes (engine and rule management) **
 710     - CDAP analytics component
 711         - Threshold Crossing Analytics (TCA)
 712
 713 (*) Note: This component is delivered under the CCSDK project, deployed by DCAE under a single
 714 VM configuration as a shared PostgreSQL database for the R1 demos.  (CCSDK PostgreSQL supports
 715 other deployment configurations not used in the R1 demos.)
 716 (**) Note: This component is delivered under the Holmes project and used as a DCAE analytics component
 717 in R1.
 718
 719 Source codes of DCAE are released under the following repositories on gerrit.onap.org:
 720
 721 - dcaegen2
 722 - dcaegen2/analytics
 723 - dcaegen2/analytics/tca
 724 - dcaegen2/collectors
 725 - dcaegen2/collectors/snmptrap
 726 - dcaegen2/collectors/ves
 727 - dcaegen2/deployments
 728 - dcaegen2/platform
 729 - dcaegen2/platform/blueprints
 730 - dcaegen2/platform/cdapbroker
 731 - dcaegen2/platform/cli
 732 - dcaegen2/platform/configbinding
 733 - dcaegen2/platform/deployment-handler
 734 - dcaegen2/platform/inventory-api
 735 - dcaegen2/platform/plugins
 736 - dcaegen2/platform/policy-handler
 737 - dcaegen2/platform/servicechange-handler
 738 - dcaegen2/utils
 739
 740
 741 **Bug Fixes**
 742
 743 This is the initial release.
 744
 745
 746 **Known Issues**
 747
 748 - Need to test/integrate into an OpenStack environment other than Intel/Windriver Pod25.
 749 - Need to provide a dev configuration DCAE.
 750
 751
 752 **Security Issues**
 753
 754 - 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>`_.>`_.
 755 - 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.
 756
 757
 758 **Upgrade Notes**
 759
 760 This is the initial release.
 761
 762
 763 **Deprecation Notes**
 764
 765 There is a GEN1 DCAE sub-system implementation existing in the pre-R1 ONAP Gerrit system.  The GEN1
 766 DCAE is deprecated by the R1 release.  The DCAE included in ONAP R1 is also known as DCAE GEN2.  The
 767 following Gerrit repos are voided and already locked as read-only.
 768
 769 - dcae
 770 - dcae/apod
 771 - dcae/apod/analytics
 772 - dcae/apod/buildtools
 773 - dcae/apod/cdap
 774 - dcae/collectors
 775 - dcae/collectors/ves
 776 - dcae/controller
 777 - dcae/controller/analytics
 778 - dcae/dcae-inventory
 779 - dcae/demo
 780 - dcae/demo/startup
 781 - dcae/demo/startup/aaf
 782 - dcae/demo/startup/controller
 783 - dcae/demo/startup/message-router
 784 - dcae/dmaapbc
 785 - dcae/operation
 786 - dcae/operation/utils
 787 - dcae/orch-dispatcher
 788 - dcae/pgaas
 789 - dcae/utils
 790 - dcae/utils/buildtools
 791 - ncomp
 792 - ncomp/cdap
 793 - ncomp/core
 794 - ncomp/docker
 795 - ncomp/maven
 796 - ncomp/openstack
 797 - ncomp/sirius
 798 - ncomp/sirius/manager
 799 - ncomp/utils
 800
 801
 802 **Other**
 803
 804 SNMP trap collector is seed code delivery only.