X-Git-Url: https://gerrit.onap.org/r/gitweb?p=oom.git;a=blobdiff_plain;f=docs%2Frelease-notes.rst;h=80575c02a4ae9f808b9be79987bb2616b02820d0;hp=c87eee0114237bdb41843a74ac740ec193a23d44;hb=0fc975b6fc41d9b8b5d15c543ea4d1a0083d992d;hpb=eaa96057dd72822bdefeee20fd655c12681648b2 diff --git a/docs/release-notes.rst b/docs/release-notes.rst index c87eee0114..80575c02a4 100644 --- a/docs/release-notes.rst +++ b/docs/release-notes.rst @@ -1,12 +1,267 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. This work is licensed under a Creative Commons Attribution 4.0 International +.. License. .. http://creativecommons.org/licenses/by/4.0 -.. Copyright 2017 Bell Canada & Amdocs Intellectual Property. All rights reserved. +.. Copyright 2017 Bell Canada & Amdocs Intellectual Property. All rights +.. reserved. .. Links .. _release-notes-label: -Release Notes -============= +ONAP Operations Manager Release Notes +===================================== + +Version 5.0.2 (El Alto Maintenance Release 1) +--------------------------------------------- + +:Release Date: 2020-09-01 + +Summary +------- + +The focus of this release is to make El Alto to continue to work. No new +features are delivered but only bug fixes. + +**New Features** + +**Bug Fixes** + + +* [`OOM-2156 `_] - Fixing missing apiVersion in etcd chart +* [`OOM-2203 `_] - docs: Replace include directives for non existent file +* [`OOM-1612 `_] - docs: Ensure literalinclude directive rendering +* [`OOM-2336 `_] - Update CDS image version for elalto to 0.6.5 +* [`OOM-2364 `_] - [GENERIC] follow elalto branches for submodules +* [`OOM-2364 `_] - [AAI|ROBOT] track latest commits on submodules +* [`OOM-2412 `_] - Fix: make all - returns multiple warnings +* [`OOM-2407 `_] - deploy.sh does not work on Mac os x because untar directory is create… +* [`OOM-2412 `_] - [COMMON] Align Makefile with last changes + +**Known Issues** + +The following known issues will be addressed in a future release: + +* [`OOM-1480 `_] - postgres chart does not set root password when installing on an existing database instances +* [`OOM-1966 `_] - ONAP on HA Kubernetes Cluster - Documentation update +* [`OOM-1995 `_] - Mariadb Galera cluster pods keep failing +* [`OOM-2061 `_] - Details Missing for installing the kubectl section +* [`OOM-2075 `_] - Invalid MTU for Canal CNI interfaces +* [`OOM-2080 `_] - Need for "ReadWriteMany" access on storage when deploying on Kubernetes? +* [`OOM-2091 `_] - incorrect release deployed +* [`OOM-2132 `_] - Common Galera server.cnf does not contain Camunda required settings + +**Security Notes** + +*Fixed Security Issues* + +*Known Security Issues* + +* In default deployment OOM (consul-server-ui) exposes HTTP port 30270 outside of cluster. [`OJSI-134 `_] +* Hard coded password used for all oom deployments [`OJSI-188 `_] +* CVE-2019-12127 - OOM exposes unprotected API/UI on port 30270 [`OJSI-202 `_] + +*Known Vulnerabilities in Used Modules* + +OOM code has been formally scanned during build time using NexusIQ and no +Critical vulnerability was found. + +Quick Links: + + - `OOM project page `_ + + - `Passing Badge information for OOM `_ + + + + +Version 5.0.1 (El Alto Release) +---------------------------------- + +:Release Date: 2019-10-10 + +Summary +------- + +The focus of this release was on maintanence and as such no new features were delivered. +A list of issues resolved in this release can be found here: https://jira.onap.org/projects/OOM/versions/10726 + +**New Features** + +**Bug Fixes** + +* 25 defects addressed (see link above) + +**Known Issues** + +The following known issues will be addressed in a future release: + +* [`OOM-1480 `_] - postgres chart does not set root password when installing on an existing database instances +* [`OOM-1966 `_] - ONAP on HA Kubernetes Cluster - Documentation update +* [`OOM-1995 `_] - Mariadb Galera cluster pods keep failing +* [`OOM-2061 `_] - Details Missing for installing the kubectl section +* [`OOM-2075 `_] - Invalid MTU for Canal CNI interfaces +* [`OOM-2080 `_] - Need for "ReadWriteMany" access on storage when deploying on Kubernetes? +* [`OOM-2091 `_] - incorrect release deployed +* [`OOM-2132 `_] - Common Galera server.cnf does not contain Camunda required settings + +**Security Notes** + +*Fixed Security Issues* + +*Known Security Issues* + +* In default deployment OOM (consul-server-ui) exposes HTTP port 30270 outside of cluster. [`OJSI-134 `_] +* Hard coded password used for all oom deployments [`OJSI-188 `_] +* CVE-2019-12127 - OOM exposes unprotected API/UI on port 30270 [`OJSI-202 `_] + +*Known Vulnerabilities in Used Modules* + +OOM code has been formally scanned during build time using NexusIQ and no +Critical vulnerability was found. + +Quick Links: + + - `OOM project page `_ + + - `Passing Badge information for OOM `_ + + + +Version 5.0.0 (El Alto Early Drop) +---------------------------------- + +:Release Date: 2019-08-19 + +Summary +------- + +**Software Requirements** + +* Upgraded to Kubernetes 1.15.x and Helm 1.14.x + + +Version 4.0.0 (Dublin Release) +------------------------------ + +:Release Date: 2019-06-26 + +Summary +------- + +**Platform Resiliency** + +* Documenation of a Highly-Available Kubernetes Cluster Deployment +* Availability of a Default Storage Class Provisioner for improved Persistent Storage resiliency +* Availability of a CNI reference integration for Multi-site support + + * applications can take advantage of multi-site by using POD and/or Node (anti)affinity, taints/tolerations, labels per application + +**Footprint Optimization** + +* Shared MariaDB-Galera Cluster - current clients in Dublin: SO, SDNC +* Shared Cassandra Cluster - current clients in Dublin: AAI, SDC +* Optional deployment of independent clusters (backward compatibility) + +**Platform Upgradability** + +* Introduction of an Upgrade Framework supporting: + + * Automated rolling upgrades for applications + * In-place schema and data migrations + * Blue-Green deployment environment migration (e.g. Pre-prod to Prod) + * Upgrades from embedded database instance into shared database instance + +* Release-to-release upgrade support delivered for the following projects + + * A&AI + * SDNC + * SO + +**Security Notes** + +*Fixed Security Issues* + +*Known Security Issues* + +* In default deployment OOM (consul-server-ui) exposes HTTP port 30270 outside of cluster. [`OJSI-134 `_] +* Hard coded password used for all oom deployments [`OJSI-188 `_] +* CVE-2019-12127 - OOM exposes unprotected API/UI on port 30270 [`OJSI-202 `_] + +*Known Vulnerabilities in Used Modules* + +OOM code has been formally scanned during build time using NexusIQ and no +Critical vulnerability was found. + +Quick Links: + + - `OOM project page `_ + + - `Passing Badge information for OOM `_ + + +**Known Issues** + + + +Version 3.0.0 Casablanca Release +-------------------------------- + +:Release Date: 2018-11-30 + +Summary +------- + +The focus of this release was on incremental improvements in the following +areas: + +* Pluggable persistent storage with support for GlusterFS as the first storage + class provisioner + +* CPU and Memory limits in Helm Charts to improve Pod placement based on + resource availablity in Kubernetes Cluster + +* Support of Node Selectors for Pod placement + +* Common "shared" Helm Charts referencing common images + + - mariadb-galera + - postgres + - cassandra + - mysql + - mongo + +* Integration of ARK Backup and Restore solution + +* Introduction of Helm deploy and undeploy plugins to better manage ONAP + deployments + + +**Security Notes** + +OOM code has been formally scanned during build time using NexusIQ and no +Critical vulnerability was found. + +Quick Links: + + - `OOM project page `_ + + - `Passing Badge information for OOM `_ + + +**Known Issues** + + * **Problem**: kubectl connections to pods (kubectl exec|logs) will + fail after a while due to a known bug in Kubernetes (1.11.2) + + **Workaround**: Restart of the kubelet daemons on the k8s hosts + + **Fix**: Will be delivered in the next release via a new + Kubernetes version (1.12) + + - `K8S Bug Report `_ + - `OOM-1532 `_ + - `OOM-1516 `_ + - `OOM-1520 `_ + Version 2.0.0 Beijing Release ----------------------------- @@ -407,12 +662,13 @@ Sub-task **Security Notes** -OOM code has been formally scanned during build time using NexusIQ and no Critical vulnerability was found. +OOM code has been formally scanned during build time using NexusIQ and no +Critical vulnerability was found. Quick Links: - - `OOM project page `_ + - `OOM project page `_ - - `Passing Badge information for OOM `_ + - `Passing Badge information for OOM `_ Version: 1.1.0 -------------- @@ -421,34 +677,43 @@ Version: 1.1.0 **New Features** -The Amsterdam release is the first release of the ONAP Operations Manager (OOM). +The Amsterdam release is the first release of the ONAP Operations Manager +(OOM). The main goal of the Amsterdam release was to: - - Support Flexible Platform Deployment via Kubernetes of fully containerized ONAP components - on any type of environment. + - Support Flexible Platform Deployment via Kubernetes of fully + containerized ONAP components - on any type of environment. - Support State Management of ONAP platform components. - - Support full production ONAP deployment and any variation of component level deployment for development. + - Support full production ONAP deployment and any variation of component + level deployment for development. - Platform Operations Orchestration / Control Loop Actions. - Platform centralized logging with ELK stack. **Bug Fixes** - The full list of implemented user stories and epics is available on `JIRA `_ - This is the first release of OOM, the defects fixed in this release were raised during the course of the release. - Anything not closed is captured below under Known Issues. If you want to review the defects fixed in the Amsterdam release, refer to Jira link above. + The full list of implemented user stories and epics is available on + `JIRA `_ + This is the first release of OOM, the defects fixed in this release were + raised during the course of the release. + Anything not closed is captured below under Known Issues. If you want to + review the defects fixed in the Amsterdam release, refer to Jira link + above. **Known Issues** - `OOM-6 `_ Automated platform deployment on Docker/Kubernetes VFC, AAF, MSB minor issues. - Workaround: Manual configuration changes - however the reference vFirewall use case does not currently require these components. + Workaround: Manual configuration changes - however the reference + vFirewall use case does not currently require these components. - `OOM-10 `_ Platform configuration management. OOM ONAP Configuration Management - Handling of Secrets. - Workaround: Automated workaround to be able to pull from protected docker repositories. + Workaround: Automated workaround to be able to pull from protected + docker repositories. **Security Issues**