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