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