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: 3.0.1
   8 --------------
   9
  10 :Release Date: 2019-01-31
  11
  12 DCAE R3 Maintenance release includes following fixes
  13
  14 **Bug Fixes**
  15
  16 - DataFileCollector
  17      - DCAEGEN2-940
  18        Larger files of size 100Kb publish to DR
  19      - DCAEGEN2-941
  20        DFC error after running over 12 hours
  21      - DCAEGEN2-1001
  22        Multiple Fileready notification not handled
  23
  24 - HighVolume VES Collector (protobuf/tcp)
  25      - DCAEGEN2-976
  26        HV-VES not fully complaint to RTPM protocol (issue with CommonEventHeader.sequence)
  27
  28 - VESCollector (http)
  29      - DCAEGEN2-1035
  30        Issue with VES batch event publish
  31
  32 - Heat deployment
  33      - DCAEGEN2-1007
  34        Removing obsolete services configuration
  35
  36
  37 The following containers are updated in R3.0.1
  38
  39     - DataFile Collector
  40        - Docker container tag: onap/org.onap.dcaegen2.collectors.datafile.datafile-app-server:1.0.5
  41     - HV-VES Collector
  42        - Docker container tag: onap/org.onap.dcaegen2.collectors.hv-ves.hv-collector-main:1.0.2
  43     - VES Collector
  44        - Docker container tag: onap/org.onap.dcaegen2.collectors.ves.vescollector:1.3.2
  45
  46
  47 Version: 3.0.0
  48 --------------
  49
  50 :Release Date: 2018-11-30
  51
  52 **New Features**
  53
  54 DCAE R3 improves upon previous release with the following new features:
  55
  56 - All DCAE R3 components are delivered as Docker container images.  The list of components is as follows.
  57     - Platform components
  58         - Cloudify Manager
  59         - Bootstrap container
  60         - Configuration Binding Service
  61         - Deployment Handler
  62         - Policy Handler
  63         - Service Change Handler
  64         - Inventory API
  65     - Service components
  66         - VES Collector
  67         - SNMP Collector
  68         - Threshold Crossing Analytics
  69         - Holmes Rule Management *
  70         - Holmes Engine Management *
  71     - Additional resources that DCAE utilizes:
  72         - Postgres Database
  73         - Redis Cluster Database
  74         - Consul Cluster
  75
  76     Notes:
  77         \*  These components are delivered by the Holmes project.
  78
  79 - DCAE R3 supports both OpenStack Heat Orchestration Template based deployment and OOM (Kubernetes) based deployment.
  80
  81     - 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".
  82     - Under OOM (Kubernetes) deployment all DCAE component containers are deployed as Kubernetes Pods/Deployments/Services into Kubernetes cluster.
  83
  84 - 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.
  85
  86 - All DCAE components are designed to support platform maturity requirements.
  87
  88
  89 **Source Code**
  90
  91 Source code of DCAE components are released under the following repositories on gerrit.onap.org:
  92     - dcaegen2
  93     - dcaegen2.analytics
  94     - dcaegen2.analytics.tca
  95     - dcaegen2.collectors
  96     - dcaegen2.collectors.snmptrap
  97     - dcaegen2.collectors.ves
  98     - dcaegen2.collectors.hv-ves
  99     - dcaegen2.collectors.datafile
 100     - dcaegen2.deployments
 101     - dcaegen2.platform
 102     - dcaegen2.platform.blueprints
 103     - dcaegen2.platform.cli
 104     - dcaegen2.platform.configbinding
 105     - dcaegen2.platform.deployment-handler
 106     - dcaegen2.platform.inventory-api
 107     - dcaegen2.platform.plugins
 108     - dcaegen2.platform.policy-handler
 109     - dcaegen2.platform.servicechange-handler
 110     - dcaegen2.services.heartbeat
 111     - dcaegen2.services.mapper
 112     - dcaegen2.services.prh
 113     - dcaegen2.utils
 114
 115 **Bug Fixes**
 116
 117 **Known Issues**
 118
 119 - 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.
 120
 121 **Security Notes**
 122
 123 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>`_.
 124
 125 Quick Links:
 126         - `DCAE project page <https://wiki.onap.org/display/DW/Data+Collection+Analytics+and+Events+Project>`_
 127
 128         - `Passing Badge information for DCAE <https://bestpractices.coreinfrastructure.org/en/projects/1718>`_
 129
 130         - `Project Vulnerability Review Table for DCAE <https://wiki.onap.org/pages/viewpage.action?pageId=41421168>`_
 131
 132
 133 **New component Notes**
 134 The following components are introduced in R3
 135
 136     - DataFile Collector
 137        - Docker container tag: onap/org.onap.dcaegen2.collectors.datafile.datafile-app-server:1.0.4
 138        - Description : Bulk data file collector to fetch non-realtime PM data
 139     - PNF Registrator handler
 140        - Docker container tag: onap/org.onap.dcaegen2.services.prh.prh-app-server:1.1.1
 141        - Description : Recieves VES registration event and updates AAI and SO
 142     - HV-VES Collector
 143        - Docker container tag: onap/org.onap.dcaegen2.collectors.hv-ves.hv-collector-main:1.0.0
 144        - Description : High Volume VES Collector for fetching real-time PM measurement data
 145     - SNMP Trap Collector
 146        - Docker container tag: onap/org.onap.dcaegen2.collectors.snmptrap:1.4.0
 147        - Description : Receives SNMP traps and publishes them to a  message router (DMAAP/MR) in json structure
 148
 149
 150 **Upgrade Notes**
 151
 152 The following components are upgraded from R2:
 153     - Cloudify Manager:
 154        - Docker container tag: onap/org.onap.dcaegen2.deployments.cm-container:1.4.2
 155        - 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.
 156     - Bootstrap container:
 157        - Docker container tag: onap/org.onap.dcaegen2.deployments.k8s-bootstrap-container:1.4.5
 158        - 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.
 159     - Configuration Binding Service:
 160        - Docker container tag: onap/org.onap.dcaegen2.platform.configbinding.app-app:2.2.3
 161        - Description: Configuration Binding Sevice now supports the new configuration policy format and support for TLS
 162     - Deployment Handler
 163        - Docker container image tag: onap/org.onap.dcaegen2.platform.deployment-handler:3.0.3
 164     - Policy Handler
 165        - Docker container image tag: onap/org.onap.dcaegen2.platform.policy-handler:4.4.0
 166        - Description: Policy Handler now supports the new configuration policy format and support for TLS
 167     - Service Change Handler
 168        - Docker container image tag: onap/org.onap.dcaegen2.platform.servicechange-handler:1.1.5
 169        - Description: Refactoring.
 170     - Inventory API
 171        - Docker container image tag: onap/org.onap.dcaegen2.platform.inventory-api:3.0.4
 172        - Description: Refactoring.
 173     - VES Collector
 174        - Docker container image tag: onap/org.onap.dcaegen2.collectors.ves.vescollector:1.3.1
 175        - Description : Refactoring
 176     - Threshold Crossing Analytics
 177        - Docker container image tag: onap/org.onap.dcaegen2.deployments.tca-cdap-container:1.1.0
 178        - 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.
 179
 180
 181
 182
 183 Version: 2.0.0
 184 --------------
 185
 186 :Release Date: 2018-06-07
 187
 188 **New Features**
 189
 190 DCAE R2 improves upon previous release with the following new features:
 191
 192 - All DCAE R2 components are delivered as Docker container images.  The list of components is as follows.
 193     - Platform components
 194         - Cloudify Manager
 195         - Bootstrap container
 196         - Configuration Binding Service
 197         - Deployment Handler
 198         - Policy Handler
 199         - Service Change Handler
 200         - Inventory API
 201     - Service components
 202         - VES Collector
 203         - SNMP Collector
 204         - Threshold Crossing Analytics
 205         - Holmes Rule Management *
 206         - Holmes Engine Management *
 207     - Additional resources that DCAE utilizes:
 208         - Postgres Database
 209         - Redis Cluster Database
 210         - Consul Cluster
 211
 212     Notes:
 213         \*  These components are delivered by the Holmes project and used as a DCAE analytics component in R2.
 214
 215 - DCAE R2 supports both OpenStack Heat Orchestration Template based deployment and OOM (Kubernetes) based deployment.
 216
 217     - 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".
 218     - Under OOM (Kubernetes) deployment all DCAE component containers are deployed as Kubernetes Pods/Deployments/Services into Kubernetes cluster.
 219
 220 - 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.
 221
 222 - All DCAE components are designed to support platform maturity requirements.
 223
 224
 225 **Source Code**
 226
 227 Source code of DCAE components are released under the following repositories on gerrit.onap.org:
 228     - dcaegen2
 229     - dcaegen2.analytics
 230     - dcaegen2.analytics.tca
 231     - dcaegen2.collectors
 232     - dcaegen2.collectors.snmptrap
 233     - dcaegen2.collectors.ves
 234     - dcaegen2.deployments
 235     - dcaegen2.platform
 236     - dcaegen2.platform.blueprints
 237     - dcaegen2.platform.cli
 238     - dcaegen2.platform.configbinding
 239     - dcaegen2.platform.deployment-handler
 240     - dcaegen2.platform.inventory-api
 241     - dcaegen2.platform.plugins
 242     - dcaegen2.platform.policy-handler
 243     - dcaegen2.platform.servicechange-handler
 244     - dcaegen2.services.heartbeat
 245     - dcaegen2.services.mapper
 246     - dcaegen2.services.prh
 247     - dcaegen2.utils
 248
 249 **Bug Fixes**
 250
 251 **Known Issues**
 252
 253 - 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.
 254
 255 **Security Notes**
 256
 257 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>`_.
 258
 259 Quick Links:
 260         - `DCAE project page <https://wiki.onap.org/display/DW/Data+Collection+Analytics+and+Events+Project>`_
 261
 262         - `Passing Badge information for DCAE <https://bestpractices.coreinfrastructure.org/en/projects/1718>`_
 263
 264         - `Project Vulnerability Review Table for DCAE <https://wiki.onap.org/pages/viewpage.action?pageId=28377647>`_
 265
 266
 267
 268 **Upgrade Notes**
 269
 270 The following components are upgraded from R1:
 271     - Cloudify Manager:
 272        - Docker container tag: onap/org.onap.dcaegen2.deployments.cm-container:1.3.0
 273        - 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.
 274     - Bootstrap container:
 275        - Docker container tag: onap/org.onap.dcaegen2.deployments.k8s-bootstrap-container:1.1.11
 276        - 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.
 277     - Configuration Binding Service:
 278        - Docker container tag: onap/org.onap.dcaegen2.platform.configbinding:2.1.5
 279        - Description: Configuration Binding Sevice now supports the new configuration policy format.
 280     - Deployment Handler
 281        - Docker container image tag: onap/org.onap.dcaegen2.platform.deployment-handler:2.1.5
 282     - Policy Handler
 283        - Docker container image tag: onap/org.onap.dcaegen2.platform.policy-handler:2.4.5
 284        - Description: Policy Handler now supports the new configuration policy format.
 285     - Service Change Handler
 286        - Docker container image tag: onap/org.onap.dcaegen2.platform.servicechange-handler:1.1.4
 287        - Description: Refactoring.
 288     - Inventory API
 289        - Docker container image tag: onap/org.onap.dcaegen2.platform.inventory-api:3.0.1
 290        - Description: Refactoring.
 291     - VES Collector
 292        - Docker container image tag: onap/org.onap.dcaegen2.collectors.ves.vescollector:1.2.0
 293     - Threshold Crossing Analytics
 294        - Docker container image tag: onap/org.onap.dcaegen2.deployments.tca-cdap-container:1.1.0
 295        - 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.
 296
 297
 298
 299 Version: 1.0.0
 300 --------------
 301
 302 :Release Date: 2017-11-16
 303
 304
 305 **New Features**
 306
 307 DCAE is the data collection and analytics sub-system of ONAP.  Under ONAP Release 1 the DCAE
 308 sub-system includes both platform components and DCAE service components.  Collectively the ONAP R1
 309 DCAE components support the data collection and analytics functions for the R1 use cases, i.e. vFW,
 310 vDNS, vCPU, and vVoLTE.
 311
 312 Specifically, DCAE R1 includes the following components:
 313
 314 - Core platform
 315     - Cloudify manager
 316     - Consul cluster
 317 - Extended platform
 318     - Platform component docker host
 319     - Service component docker host
 320     - CDAP cluster
 321     - PostgreSQL database (*)
 322 - Platform docker container components
 323     - Configuration binding service
 324     - Deployment handler
 325     - Service change handler
 326     - Inventory
 327     - Policy handler
 328     - CDAP broker
 329 - Service components
 330     - Docker container components
 331         - VNF Event Streaming (VES) collector
 332         - Holmes (engine and rule management) **
 333     - CDAP analytics component
 334         - Threshold Crossing Analytics (TCA)
 335
 336 (*) Note: This component is delivered under the CCSDK project, deployed by DCAE under a single
 337 VM configuration as a shared PostgreSQL database for the R1 demos.  (CCSDK PostgreSQL supports
 338 other deployment configurations not used in the R1 demos.)
 339 (**) Note: This component is delivered under the Holmes project and used as a DCAE analytics component
 340 in R1.
 341
 342 Source codes of DCAE are released under the following repositories on gerrit.onap.org:
 343
 344 - dcaegen2
 345 - dcaegen2/analytics
 346 - dcaegen2/analytics/tca
 347 - dcaegen2/collectors
 348 - dcaegen2/collectors/snmptrap
 349 - dcaegen2/collectors/ves
 350 - dcaegen2/deployments
 351 - dcaegen2/platform
 352 - dcaegen2/platform/blueprints
 353 - dcaegen2/platform/cdapbroker
 354 - dcaegen2/platform/cli
 355 - dcaegen2/platform/configbinding
 356 - dcaegen2/platform/deployment-handler
 357 - dcaegen2/platform/inventory-api
 358 - dcaegen2/platform/plugins
 359 - dcaegen2/platform/policy-handler
 360 - dcaegen2/platform/servicechange-handler
 361 - dcaegen2/utils
 362
 363
 364 **Bug Fixes**
 365
 366 This is the initial release.
 367
 368
 369 **Known Issues**
 370
 371 - Need to test/integrate into an OpenStack environment other than Intel/Windriver Pod25.
 372 - Need to provide a dev configuration DCAE.
 373
 374
 375 **Security Issues**
 376
 377 - 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>`_.>`_.
 378 - 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.
 379
 380
 381 **Upgrade Notes**
 382
 383 This is the initial release.
 384
 385
 386 **Deprecation Notes**
 387
 388 There is a GEN1 DCAE sub-system implementation existing in the pre-R1 ONAP Gerrit system.  The GEN1
 389 DCAE is deprecated by the R1 release.  The DCAE included in ONAP R1 is also known as DCAE GEN2.  The
 390 following Gerrit repos are voided and already locked as read-only.
 391
 392 - dcae
 393 - dcae/apod
 394 - dcae/apod/analytics
 395 - dcae/apod/buildtools
 396 - dcae/apod/cdap
 397 - dcae/collectors
 398 - dcae/collectors/ves
 399 - dcae/controller
 400 - dcae/controller/analytics
 401 - dcae/dcae-inventory
 402 - dcae/demo
 403 - dcae/demo/startup
 404 - dcae/demo/startup/aaf
 405 - dcae/demo/startup/controller
 406 - dcae/demo/startup/message-router
 407 - dcae/dmaapbc
 408 - dcae/operation
 409 - dcae/operation/utils
 410 - dcae/orch-dispatcher
 411 - dcae/pgaas
 412 - dcae/utils
 413 - dcae/utils/buildtools
 414 - ncomp
 415 - ncomp/cdap
 416 - ncomp/core
 417 - ncomp/docker
 418 - ncomp/maven
 419 - ncomp/openstack
 420 - ncomp/sirius
 421 - ncomp/sirius/manager
 422 - ncomp/utils
 423
 424
 425 **Other**
 426
 427 SNMP trap collector is seed code delivery only.