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: 2.0.0
   7 --------------
   8
   9 :Release Date: 2018-06-07
  10
  11 **New Features**
  12
  13 DCAE R2 improves upon previous release with the following new features:
  14
  15 - All DCAE R2 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 R2.
  37
  38 - DCAE R2 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 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.
  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.deployments
  58     - dcaegen2.platform
  59     - dcaegen2.platform.blueprints
  60     - dcaegen2.platform.cli
  61     - dcaegen2.platform.configbinding
  62     - dcaegen2.platform.deployment-handler
  63     - dcaegen2.platform.inventory-api
  64     - dcaegen2.platform.plugins
  65     - dcaegen2.platform.policy-handler
  66     - dcaegen2.platform.servicechange-handler
  67     - dcaegen2.services.heartbeat
  68     - dcaegen2.services.mapper
  69     - dcaegen2.services.prh
  70     - dcaegen2.utils
  71
  72 **Bug Fixes**
  73
  74 **Known Issues**
  75
  76 - 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.
  77
  78 **Security Notes**
  79
  80 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>`_.
  81
  82 Quick Links:
  83         - `DCAE project page <https://wiki.onap.org/display/DW/Data+Collection+Analytics+and+Events+Project>`_
  84
  85         - `Passing Badge information for DCAE <https://bestpractices.coreinfrastructure.org/en/projects/1718>`_
  86
  87         - `Project Vulnerability Review Table for DCAE <https://wiki.onap.org/pages/viewpage.action?pageId=28377647>`_
  88
  89
  90
  91 **Upgrade Notes**
  92
  93 The following components are upgraded from R1:
  94     - Cloudify Manager:
  95        - Docker container tag: onap/org.onap.dcaegen2.deployments.cm-container:1.3.0
  96        - 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.
  97     - Bootstrap container:
  98        - Docker container tag: onap/org.onap.dcaegen2.deployments.k8s-bootstrap-container:1.1.11
  99        - 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.
 100     - Configuration Binding Service:
 101        - Docker container tag: onap/org.onap.dcaegen2.platform.configbinding:2.1.5
 102        - Description: Configuration Binding Sevice now supports the new configuration policy format.
 103     - Deployment Handler
 104        - Docker container image tag: onap/org.onap.dcaegen2.platform.deployment-handler:2.1.5
 105     - Policy Handler
 106        - Docker container image tag: onap/org.onap.dcaegen2.platform.policy-handler:2.4.5
 107        - Description: Policy Handler now supports the new configuration policy format.
 108     - Service Change Handler
 109        - Docker container image tag: onap/org.onap.dcaegen2.platform.servicechange-handler:1.1.4
 110        - Description: Refactoring.
 111     - Inventory API
 112        - Docker container image tag: onap/org.onap.dcaegen2.platform.inventory-api:3.0.1
 113        - Description: Refactoring.
 114     - VES Collector
 115        - Docker container image tag: onap/org.onap.dcaegen2.collectors.ves.vescollector:1.2.0
 116     - Threshold Crossing Analytics
 117        - Docker container image tag: onap/org.onap.dcaegen2.deployments.tca-cdap-container:1.1.0
 118        - 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.
 119
 120
 121
 122 Version: 1.0.0
 123 --------------
 124
 125 :Release Date: 2017-11-16
 126
 127
 128 **New Features**
 129
 130 DCAE is the data collection and analytics sub-system of ONAP.  Under ONAP Release 1 the DCAE
 131 sub-system includes both platform components and DCAE service components.  Collectively the ONAP R1
 132 DCAE components support the data collection and analytics functions for the R1 use cases, i.e. vFW,
 133 vDNS, vCPU, and vVoLTE.
 134
 135 Specifically, DCAE R1 includes the following components:
 136
 137 - Core platform
 138     - Cloudify manager
 139     - Consul cluster
 140 - Extended platform
 141     - Platform component docker host
 142     - Service component docker host
 143     - CDAP cluster
 144     - PostgreSQL database (*)
 145 - Platform docker container components
 146     - Configuration binding service
 147     - Deployment handler
 148     - Service change handler
 149     - Inventory
 150     - Policy handler
 151     - CDAP broker
 152 - Service components
 153     - Docker container components
 154         - VNF Event Streaming (VES) collector
 155         - Holmes (engine and rule management) **
 156     - CDAP analytics component
 157         - Threshold Crossing Analytics (TCA)
 158
 159 (*) Note: This component is delivered under the CCSDK project, deployed by DCAE under a single
 160 VM configuration as a shared PostgreSQL database for the R1 demos.  (CCSDK PostgreSQL supports
 161 other deployment configurations not used in the R1 demos.)
 162 (**) Note: This component is delivered under the Holmes project and used as a DCAE analytics component
 163 in R1.
 164
 165 Source codes of DCAE are released under the following repositories on gerrit.onap.org:
 166
 167 - dcaegen2
 168 - dcaegen2/analytics
 169 - dcaegen2/analytics/tca
 170 - dcaegen2/collectors
 171 - dcaegen2/collectors/snmptrap
 172 - dcaegen2/collectors/ves
 173 - dcaegen2/deployments
 174 - dcaegen2/platform
 175 - dcaegen2/platform/blueprints
 176 - dcaegen2/platform/cdapbroker
 177 - dcaegen2/platform/cli
 178 - dcaegen2/platform/configbinding
 179 - dcaegen2/platform/deployment-handler
 180 - dcaegen2/platform/inventory-api
 181 - dcaegen2/platform/plugins
 182 - dcaegen2/platform/policy-handler
 183 - dcaegen2/platform/servicechange-handler
 184 - dcaegen2/utils
 185
 186
 187 **Bug Fixes**
 188
 189 This is the initial release.
 190
 191
 192 **Known Issues**
 193
 194 - Need to test/integrate into an OpenStack environment other than Intel/Windriver Pod25.
 195 - Need to provide a dev configuration DCAE.
 196
 197
 198 **Security Issues**
 199
 200 - 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.
 201 - 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.
 202
 203
 204 **Upgrade Notes**
 205
 206 This is the initial release.
 207
 208
 209 **Deprecation Notes**
 210
 211 There is a GEN1 DCAE sub-system implementation existing in the pre-R1 ONAP Gerrit system.  The GEN1
 212 DCAE is deprecated by the R1 release.  The DCAE included in ONAP R1 is also known as DCAE GEN2.  The
 213 following Gerrit repos are voided and already locked as read-only.
 214
 215 - dcae
 216 - dcae/apod
 217 - dcae/apod/analytics
 218 - dcae/apod/buildtools
 219 - dcae/apod/cdap
 220 - dcae/collectors
 221 - dcae/collectors/ves
 222 - dcae/controller
 223 - dcae/controller/analytics
 224 - dcae/dcae-inventory
 225 - dcae/demo
 226 - dcae/demo/startup
 227 - dcae/demo/startup/aaf
 228 - dcae/demo/startup/controller
 229 - dcae/demo/startup/message-router
 230 - dcae/dmaapbc
 231 - dcae/operation
 232 - dcae/operation/utils
 233 - dcae/orch-dispatcher
 234 - dcae/pgaas
 235 - dcae/utils
 236 - dcae/utils/buildtools
 237 - ncomp
 238 - ncomp/cdap
 239 - ncomp/core
 240 - ncomp/docker
 241 - ncomp/maven
 242 - ncomp/openstack
 243 - ncomp/sirius
 244 - ncomp/sirius/manager
 245 - ncomp/utils
 246
 247
 248 **Other**
 249
 250 SNMP trap collector is seed code delivery only.