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-16
  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
  93 **Upgrade Notes**
  94
  95 The following components are upgraded from R2:
  96     - Cloudify Manager:
  97        - Docker container tag: onap/org.onap.dcaegen2.deployments.cm-container:1.4.1
  98        - Description: R3 DCAE's Cloudify Manager container is based on Cloudify Manager Community Version 18.2.28, which is based on Cloudify Manager 4.3.
  99     - Bootstrap container:
 100        - Docker container tag: onap/org.onap.dcaegen2.deployments.k8s-bootstrap-container:1.4.2
 101        - 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.
 102     - Configuration Binding Service:
 103        - Docker container tag: onap/org.onap.dcaegen2.platform.configbinding.app-app:2.2.3
 104        - Description: Configuration Binding Sevice now supports the new configuration policy format and support for TLS
 105     - Deployment Handler
 106        - Docker container image tag: onap/org.onap.dcaegen2.platform.deployment-handler:3.0.2
 107     - Policy Handler
 108        - Docker container image tag: onap/org.onap.dcaegen2.platform.policy-handler:4.3.1
 109        - Description: Policy Handler now supports the new configuration policy format and support for TLS
 110     - Service Change Handler
 111        - Docker container image tag: onap/org.onap.dcaegen2.platform.servicechange-handler:1.1.5
 112        - Description: Refactoring.
 113     - Inventory API
 114        - Docker container image tag: onap/org.onap.dcaegen2.platform.inventory-api:3.0.4
 115        - Description: Refactoring.
 116     - VES Collector
 117        - Docker container image tag: onap/org.onap.dcaegen2.collectors.ves.vescollector:1.3.1
 118     - Threshold Crossing Analytics
 119        - Docker container image tag: onap/org.onap.dcaegen2.deployments.tca-cdap-container:1.1.0
 120        - 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.
 121
 122
 123
 124
 125 Version: 2.0.0
 126 --------------
 127
 128 :Release Date: 2018-06-07
 129
 130 **New Features**
 131
 132 DCAE R2 improves upon previous release with the following new features:
 133
 134 - All DCAE R2 components are delivered as Docker container images.  The list of components is as follows.
 135     - Platform components
 136         - Cloudify Manager
 137         - Bootstrap container
 138         - Configuration Binding Service
 139         - Deployment Handler
 140         - Policy Handler
 141         - Service Change Handler
 142         - Inventory API
 143     - Service components
 144         - VES Collector
 145         - SNMP Collector
 146         - Threshold Crossing Analytics
 147         - Holmes Rule Management *
 148         - Holmes Engine Management *
 149     - Additional resources that DCAE utilizes:
 150         - Postgres Database
 151         - Redis Cluster Database
 152         - Consul Cluster
 153
 154     Notes:
 155         \*  These components are delivered by the Holmes project and used as a DCAE analytics component in R2.
 156
 157 - DCAE R2 supports both OpenStack Heat Orchestration Template based deployment and OOM (Kubernetes) based deployment.
 158
 159     - 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".
 160     - Under OOM (Kubernetes) deployment all DCAE component containers are deployed as Kubernetes Pods/Deployments/Services into Kubernetes cluster.
 161
 162 - 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.
 163
 164 - All DCAE components are designed to support platform maturity requirements.
 165
 166
 167 **Source Code**
 168
 169 Source code of DCAE components are released under the following repositories on gerrit.onap.org:
 170     - dcaegen2
 171     - dcaegen2.analytics
 172     - dcaegen2.analytics.tca
 173     - dcaegen2.collectors
 174     - dcaegen2.collectors.snmptrap
 175     - dcaegen2.collectors.ves
 176     - dcaegen2.deployments
 177     - dcaegen2.platform
 178     - dcaegen2.platform.blueprints
 179     - dcaegen2.platform.cli
 180     - dcaegen2.platform.configbinding
 181     - dcaegen2.platform.deployment-handler
 182     - dcaegen2.platform.inventory-api
 183     - dcaegen2.platform.plugins
 184     - dcaegen2.platform.policy-handler
 185     - dcaegen2.platform.servicechange-handler
 186     - dcaegen2.services.heartbeat
 187     - dcaegen2.services.mapper
 188     - dcaegen2.services.prh
 189     - dcaegen2.utils
 190
 191 **Bug Fixes**
 192
 193 **Known Issues**
 194
 195 - 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.
 196
 197 **Security Notes**
 198
 199 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>`_.
 200
 201 Quick Links:
 202         - `DCAE project page <https://wiki.onap.org/display/DW/Data+Collection+Analytics+and+Events+Project>`_
 203
 204         - `Passing Badge information for DCAE <https://bestpractices.coreinfrastructure.org/en/projects/1718>`_
 205
 206         - `Project Vulnerability Review Table for DCAE <https://wiki.onap.org/pages/viewpage.action?pageId=28377647>`_
 207
 208
 209
 210 **Upgrade Notes**
 211
 212 The following components are upgraded from R1:
 213     - Cloudify Manager:
 214        - Docker container tag: onap/org.onap.dcaegen2.deployments.cm-container:1.3.0
 215        - 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.
 216     - Bootstrap container:
 217        - Docker container tag: onap/org.onap.dcaegen2.deployments.k8s-bootstrap-container:1.1.11
 218        - 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.
 219     - Configuration Binding Service:
 220        - Docker container tag: onap/org.onap.dcaegen2.platform.configbinding:2.1.5
 221        - Description: Configuration Binding Sevice now supports the new configuration policy format.
 222     - Deployment Handler
 223        - Docker container image tag: onap/org.onap.dcaegen2.platform.deployment-handler:2.1.5
 224     - Policy Handler
 225        - Docker container image tag: onap/org.onap.dcaegen2.platform.policy-handler:2.4.5
 226        - Description: Policy Handler now supports the new configuration policy format.
 227     - Service Change Handler
 228        - Docker container image tag: onap/org.onap.dcaegen2.platform.servicechange-handler:1.1.4
 229        - Description: Refactoring.
 230     - Inventory API
 231        - Docker container image tag: onap/org.onap.dcaegen2.platform.inventory-api:3.0.1
 232        - Description: Refactoring.
 233     - VES Collector
 234        - Docker container image tag: onap/org.onap.dcaegen2.collectors.ves.vescollector:1.2.0
 235     - Threshold Crossing Analytics
 236        - Docker container image tag: onap/org.onap.dcaegen2.deployments.tca-cdap-container:1.1.0
 237        - 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.
 238
 239
 240
 241 Version: 1.0.0
 242 --------------
 243
 244 :Release Date: 2017-11-16
 245
 246
 247 **New Features**
 248
 249 DCAE is the data collection and analytics sub-system of ONAP.  Under ONAP Release 1 the DCAE
 250 sub-system includes both platform components and DCAE service components.  Collectively the ONAP R1
 251 DCAE components support the data collection and analytics functions for the R1 use cases, i.e. vFW,
 252 vDNS, vCPU, and vVoLTE.
 253
 254 Specifically, DCAE R1 includes the following components:
 255
 256 - Core platform
 257     - Cloudify manager
 258     - Consul cluster
 259 - Extended platform
 260     - Platform component docker host
 261     - Service component docker host
 262     - CDAP cluster
 263     - PostgreSQL database (*)
 264 - Platform docker container components
 265     - Configuration binding service
 266     - Deployment handler
 267     - Service change handler
 268     - Inventory
 269     - Policy handler
 270     - CDAP broker
 271 - Service components
 272     - Docker container components
 273         - VNF Event Streaming (VES) collector
 274         - Holmes (engine and rule management) **
 275     - CDAP analytics component
 276         - Threshold Crossing Analytics (TCA)
 277
 278 (*) Note: This component is delivered under the CCSDK project, deployed by DCAE under a single
 279 VM configuration as a shared PostgreSQL database for the R1 demos.  (CCSDK PostgreSQL supports
 280 other deployment configurations not used in the R1 demos.)
 281 (**) Note: This component is delivered under the Holmes project and used as a DCAE analytics component
 282 in R1.
 283
 284 Source codes of DCAE are released under the following repositories on gerrit.onap.org:
 285
 286 - dcaegen2
 287 - dcaegen2/analytics
 288 - dcaegen2/analytics/tca
 289 - dcaegen2/collectors
 290 - dcaegen2/collectors/snmptrap
 291 - dcaegen2/collectors/ves
 292 - dcaegen2/deployments
 293 - dcaegen2/platform
 294 - dcaegen2/platform/blueprints
 295 - dcaegen2/platform/cdapbroker
 296 - dcaegen2/platform/cli
 297 - dcaegen2/platform/configbinding
 298 - dcaegen2/platform/deployment-handler
 299 - dcaegen2/platform/inventory-api
 300 - dcaegen2/platform/plugins
 301 - dcaegen2/platform/policy-handler
 302 - dcaegen2/platform/servicechange-handler
 303 - dcaegen2/utils
 304
 305
 306 **Bug Fixes**
 307
 308 This is the initial release.
 309
 310
 311 **Known Issues**
 312
 313 - Need to test/integrate into an OpenStack environment other than Intel/Windriver Pod25.
 314 - Need to provide a dev configuration DCAE.
 315
 316
 317 **Security Issues**
 318
 319 - 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>`_.>`_.
 320 - 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.
 321
 322
 323 **Upgrade Notes**
 324
 325 This is the initial release.
 326
 327
 328 **Deprecation Notes**
 329
 330 There is a GEN1 DCAE sub-system implementation existing in the pre-R1 ONAP Gerrit system.  The GEN1
 331 DCAE is deprecated by the R1 release.  The DCAE included in ONAP R1 is also known as DCAE GEN2.  The
 332 following Gerrit repos are voided and already locked as read-only.
 333
 334 - dcae
 335 - dcae/apod
 336 - dcae/apod/analytics
 337 - dcae/apod/buildtools
 338 - dcae/apod/cdap
 339 - dcae/collectors
 340 - dcae/collectors/ves
 341 - dcae/controller
 342 - dcae/controller/analytics
 343 - dcae/dcae-inventory
 344 - dcae/demo
 345 - dcae/demo/startup
 346 - dcae/demo/startup/aaf
 347 - dcae/demo/startup/controller
 348 - dcae/demo/startup/message-router
 349 - dcae/dmaapbc
 350 - dcae/operation
 351 - dcae/operation/utils
 352 - dcae/orch-dispatcher
 353 - dcae/pgaas
 354 - dcae/utils
 355 - dcae/utils/buildtools
 356 - ncomp
 357 - ncomp/cdap
 358 - ncomp/core
 359 - ncomp/docker
 360 - ncomp/maven
 361 - ncomp/openstack
 362 - ncomp/sirius
 363 - ncomp/sirius/manager
 364 - ncomp/utils
 365
 366
 367 **Other**
 368
 369 SNMP trap collector is seed code delivery only.