diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/sections/installation_oom.rst | 13 | ||||
| -rw-r--r-- | docs/sections/release-notes.rst | 173 |
2 files changed, 125 insertions, 61 deletions
diff --git a/docs/sections/installation_oom.rst b/docs/sections/installation_oom.rst index fccefa0b..1af68aa3 100644 --- a/docs/sections/installation_oom.rst +++ b/docs/sections/installation_oom.rst @@ -4,17 +4,16 @@ DCAE Deployment (using Helm and Cloudify) ========================================= -This document describes the details of the Helm chart based deployment process for R4 ONAP and how DCAE is deployed through this process. +This document describes the details of the Helm chart based deployment process for ONAP and how DCAE is deployed through this process. Deployment Overview ------------------- -ONAP R4 extends the Kubernetes deployment method introduced in R2 and continued in R3. -Kubernetes is a container orchestration technology that organizes containers into composites of various patterns for easy deployment, management, and scaling. +ONAP deployments are done on kubernetes through OOM/Helm charts. Kubernetes is a container orchestration technology that organizes containers into composites of various patterns for easy deployment, management, and scaling. ONAP uses Kubernetes as the foundation for fulfilling its platform maturity promises. -ONAP manages Kubernetes specifications using Helm charts, under which all Kubernetes yaml-formatted resource specifications and additional files +ONAP manages Kubernetes specifications using Helm charts (in OOM project), under which all Kubernetes yaml-formatted resource specifications and additional files are organized into a hierarchy of charts, sub-charts, and resources. These yaml files are further augmented with Helm's templating, which makes dependencies and cross-references of parameters and parameter derivatives among resources manageable for a large and complex Kubernetes system such as ONAP. @@ -91,6 +90,7 @@ directory, not as part of the DCAE chart hierarchy. The dcae-bootstrap service has a number of prerequisites because the subsequently deployed DCAE components depends on a number of resources having entered their normal operation state. DCAE bootstrap job will not start before these resources are ready. They are: + * dcae-cloudify-manager * consul-server * msb-discovery @@ -98,6 +98,10 @@ The dcae-bootstrap service has a number of prerequisites because the subsequentl * dcae-config-binding-service * dcae-db * dcae-mongodb + * dcae-inventory-api + +Additionaly tls-init-container invoked during component deployment relies on AAF to generate the required certificate hence AAF +must be enabled under OOM deployment configuration. Once started, the DCAE bootstrap service will call Cloudify Manager to deploy a series of blueprints which specify the additional DCAE microservice components. @@ -111,6 +115,7 @@ The DCAE bootstrap service creates the following Kubernetes deployments: * deploy/dep-dcae-hv-ves-collector * deploy/dep-dcae-prh * deploy/dep-dcae-tca-analytics +* deploy/dep-dcae-tcagen2 * deploy/dep-dcae-ves-collector * deploy/dep-holmes-engine-mgmt * deploy/dep-holmes-rule-mgmt diff --git a/docs/sections/release-notes.rst b/docs/sections/release-notes.rst index e58c6543..98279453 100644 --- a/docs/sections/release-notes.rst +++ b/docs/sections/release-notes.rst @@ -13,46 +13,24 @@ DCAE Release Notes :depth: 2 .. +.. =========================== +.. * * * FRANKFURT * * * +.. =========================== + Version: 6.0.0 ============== + Abstract -------- -This document provides the release notes for the Frankfurt release (6.0.0) - +This document provides the release notes for the Frankfurt release. Summary ------- -**New Features** - -DCAE improves upon previous release with the following new features - -- DCAE Platform Enhancement - - - Introduction of Microservice and Onboarding Design (MOD) platform - - Policy Notification support for DCAE components - - Dynamic AAF certificate creation during component instantiation - - Helm chart optimization to control each platform component separate - - Dashboard Optimization - - Blueprint generator tool to simplify deployment artifact creation - - -- Following new services are delivered this release - - - Event Processors - - - PM Subscription Handler - - DataLake Handlers - - Analytics/RCA - - - TCA-GEN2 - - - Acumos Adapter (PoC) - -Below is complete list of DCAE components available part of default ONAP/DCAE installation. +Following DCAE components are available with default ONAP/DCAE installation. - Platform components @@ -82,7 +60,7 @@ Below is complete list of DCAE components available part of default ONAP/DCAE in - Redis Cluster Database - Consul Cluster -Following service components (mS) can be deployed on-demand +Below service components (mS) are available to be deployed on-demand. - SNMPTrap Collector - RESTConf Collector @@ -103,42 +81,55 @@ Following service components (mS) can be deployed on-demand Under OOM (Kubernetes) deployment all DCAE component containers are deployed as Kubernetes Pods/Deployments/Services into Kubernetes cluster. DCAE platform components are deployed using Helm charts. DCAE service components are deployed using Cloudify blueprints. DCAE provides a Cloudify Manager plugin (k8splugin) that is capable of expanding a Cloudify blueprint node specification for a service component to a full Kubernetes specification, with additional enhancements such as replica scaling, sidecar for logging to ONAP ELK stack, registering services to MSB, etc. -- All DCAE components are designed to support platform maturity requirements. +Release Data +------------ ++--------------------------------------+--------------------------------------------------------+ +| **DCAE Project** | | +| | | ++--------------------------------------+--------------------------------------------------------+ +| **Docker images** |Refer :any:`Deliverable <frankfurt_deliverable>` | +| | | ++--------------------------------------+--------------------------------------------------------+ +| **Release designation** | 6.0.0 frankfurt | +| | | ++--------------------------------------+--------------------------------------------------------+ +| **Release date** | 2020-06-04 | +| | | ++--------------------------------------+--------------------------------------------------------+ -**Bug Fixes** -**Known Issues** +New features +------------ - * Blueprint generator escape char issue (DCAEGEN2-2140) - * TCAgen2 Policy configuration support (DCAEGEN2-2198) - * TCA/CDAP config refresh causes duplicate events (DCAEGEN2-2241) - - -**Security Notes** +- DCAE Platform Enhancement -*Fixed Security Issues* + - Introduction of Microservice and Onboarding Design (MOD) platform + - Policy Notification support for DCAE components + - Dynamic AAF certificate creation during component instantiation + - Helm chart optimization to control each platform component separate + - Dashboard Optimization + - Blueprint generator tool to simplify deployment artifact creation + - * Unsecured Swagger UI Interface in xdcae-ves-collector. [`OJSI-30 <https://jira.onap.org/browse/OJSI-30>`_] - * In default deployment DCAEGEN2 (xdcae-ves-collector) exposes HTTP port 30235 outside of cluster. [`OJSI-116 <https://jira.onap.org/browse/OJSI-116>`_] - * In default deployment DCAEGEN2 (xdcae-dashboard) exposes HTTP port 30418 outside of cluster. [`OJSI-159 <https://jira.onap.org/browse/OJSI-159>`_] - * In default deployment DCAEGEN2 (dcae-redis) exposes redis port 30286 outside of cluster. [`OJSI-187 <https://jira.onap.org/browse/OJSI-187>`_] - * In default deployment DCAEGEN2 (config-binding-service) exposes HTTP port 30415 outside of cluster. [`OJSI-195 <https://jira.onap.org/browse/OJSI-195>`_] +- Following new services are delivered this release + - Event Processors -*Known Security Issues* - - None - + - PM Subscription Handler + - DataLake Handlers + - Analytics/RCA + + - TCA-GEN2 -*Known Vulnerabilities in Used Modules* + - Acumos Adapter (PoC) - None - -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=51282478>`_. +.. _frankfurt_deliverable: +Deliverables +------------ -Artifacts released: +Software Deliverables .. csv-table:: :header: "Repository", "SubModules", "Version & Docker Image (if applicable)" @@ -184,18 +175,86 @@ Artifacts released: "dcaegen2/platform", "mod/bpgenerator", "Blueprint Generator 1.3.1 (jar)" "dcaegen2/services/sdk", "", "DCAE SDK 1.3.5 (jar)" "ccsdk/dashboard", "", "onap/org.onap.ccsdk.dashboard.ccsdk-app-os:1.3.2" - -**Test Results** + + +Known Limitations, Issues and Workarounds +----------------------------------------- + + * Blueprint generator escape char issue (DCAEGEN2-2140) + * TCAgen2 Policy configuration support (DCAEGEN2-2198) + * TCA/CDAP config refresh causes duplicate events (DCAEGEN2-2241) + + + +*System Limitations* + +None + +*Known Vulnerabilities* + +None + +*Workarounds* + +Documented under corresponding jira if applicable. + +Security Notes +-------------- + +*Fixed Security Issues* + + * Unsecured Swagger UI Interface in xdcae-ves-collector. [`OJSI-30 <https://jira.onap.org/browse/OJSI-30>`_] + * In default deployment DCAEGEN2 (xdcae-ves-collector) exposes HTTP port 30235 outside of cluster. [`OJSI-116 <https://jira.onap.org/browse/OJSI-116>`_] + * In default deployment DCAEGEN2 (xdcae-dashboard) exposes HTTP port 30418 outside of cluster. [`OJSI-159 <https://jira.onap.org/browse/OJSI-159>`_] + * In default deployment DCAEGEN2 (dcae-redis) exposes redis port 30286 outside of cluster. [`OJSI-187 <https://jira.onap.org/browse/OJSI-187>`_] + * In default deployment DCAEGEN2 (config-binding-service) exposes HTTP port 30415 outside of cluster. [`OJSI-195 <https://jira.onap.org/browse/OJSI-195>`_] + + +*Known Security Issues* + + None + + +*Known Vulnerabilities in Used Modules* + + None + +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=51282478>`_. + +Test Results +------------ - `DCAE Pairwise Test <https://wiki.onap.org/display/DW/DCAE+Pair+Wise+Testing+for+Frankfurt+Release>`_ - `DCAE MOD Test <https://wiki.onap.org/display/DW/DCAE+MOD+Test+Plan>`_ -**References** +References +---------- + +For more information on the ONAP Frankfurt release, please see: + +#. `ONAP Home Page`_ +#. `ONAP Documentation`_ +#. `ONAP Release Downloads`_ +#. `ONAP Wiki Page`_ + + +.. _`ONAP Home Page`: https://www.onap.org +.. _`ONAP Wiki Page`: https://wiki.onap.org +.. _`ONAP Documentation`: https://docs.onap.org +.. _`ONAP Release Downloads`: https://git.onap.org + +Quick Links: - `DCAE project page <https://wiki.onap.org/display/DW/Data+Collection+Analytics+and+Events+Project>`_ - `Passing Badge information for DCAE <https://bestpractices.coreinfrastructure.org/en/projects/1718>`_ + +.. ========================= +.. * * * EL-ALTO * * * +.. ========================= + + Version: 5.0.1 ============== |