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