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