update release note
[msb/apigateway.git] / docs / release-notes.rst
index e459abe..d05b37f 100644 (file)
@@ -1,10 +1,8 @@
 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
 .. http://creativecommons.org/licenses/by/4.0
+.. _release_notes:
 
 
-MSB
-===
-
 Microservices Bus(MSB) provides a reliable, resilient and scalable communication and governance infrastructure to support ONAP Microservice Architecture including service registration/discovery, external API gateway, internal API gateway, client SDK, Swagger SDK, etc. It's a pluggable architecture, plugins can be added to MSB to provide whatever functionalities you need, such as an auth plugin can be used to provide centralized authentication & authorization. MSB also provides a service portal to manage the REST APIs.
 
 MSB is platform independent, while it is integrated with Kubernetes(OOM) to provide transparent service registration for ONAP microservices, MSB also supports OpenStack(Heat) and bare metal deployment.
@@ -12,6 +10,60 @@ MSB is platform independent, while it is integrated with Kubernetes(OOM) to prov
 Release Notes
 =============
 
+Version: 1.2.6 Frankfurt Release
+------------------------------
+
+:Release Date: 2020-May-07
+
+**New Features**
+
+**Bug Fixes**
+
+- MSB-470 Pairwise testing fails from Portal to MSB
+- MSB-468 MSB verification job is unstable
+- MSB-467 Certificate in MSB is set to use *.zte.com.cn
+- MSB-451 Code coverage data can't show at sonarcloud
+
+**Fixed Security Issues**
+
+- MSB-465 Update alpine to the latest version
+- MSB-462 Pods still run as root
+- MSB-418 Solve MSB vulnerability onap-msb-discovery-jackson-databind
+- MSB-417 Solve MSB vulnerability onap-msb-apigateway-jackson-databind
+- MSB-410 Solve MSB vulnerability onap-msb-java-sdk-jackson-databind
+- MSB-408 Solve MSB vulnerability onap-msb-java-sdk-commons-codec
+- MSB-407 Solve MSB vulnerability onap-msb-java-sdk-okhttp 
+- MSB-398 Remove plain HTTP Rest APIs
+- MSB-386 General sonar fixes
+
+**Known Issues**
+
+**Security Notes**
+
+MSB code has been formally scanned during build time using NexusIQ and all Critical vulnerabilities have been addressed.
+The remaining issues are identified as false positive and their risk assessment have been documented as part of the `project <https://wiki.onap.org/pages/viewpage.action?pageId=64003723>`_.
+
+Quick Links:
+        - `MSB project page <https://wiki.onap.org/display/DW/Microservices+Bus+Project>`_
+
+        - `Passing Badge information for MSB <https://bestpractices.coreinfrastructure.org/en/projects/1601>`_
+
+        - `Project Vulnerability Review Table for MSB <https://wiki.onap.org/pages/viewpage.action?pageId=68541445>`_
+
+**Upgrade Notes**
+
+N/A
+
+**Deprecation Notes**
+
+Plain HTTP APIs have been removed from Frankfurt release, please use HTTPS instead.
+
+N/A
+
+**Other**
+
+N/A
+
 Version: 1.2.5 EI-Alto Release
 ------------------------------
 
@@ -22,14 +74,14 @@ Version: 1.2.5 EI-Alto Release
 This release only contains a few bug fixes and small features.
 
 **New Features**
-- `MSB-332 Delete custom services via the MSB management UI`_
-- `MSB-151 Support registering HTTPS service on the MSB management UI`_
+
+- MSB-332 Delete custom services via the MSB management UI
+- MSB-151 Support registering HTTPS service on the MSB management UI
 
 **Bug Fixes**
 
-- `MSB-372 Empty pages that looks like they should be deleted`_
-- `MSB-374 MSB stripe of the headers with underscore and it blocks SDC API functionality`_
+- MSB-372 Empty pages that looks like they should be deleted
+- MSB-374 MSB stripe of the headers with underscore and it blocks SDC API functionality
 
 **Known Issues**
 
@@ -68,21 +120,21 @@ This release only contains some security improvements and a few fixes.
 
 **Security improvements**
 
-- `MSB MSB-295 Nexus IQ Issue: bootstrap`_
-- `MSB MSB-320 Run API Gateway as a non-root user`_
-- `MSBMSB-321 Run Discovery as a non-root user`_
-- `MSB MSB-322 Run Kube2msb as a non-root user`_
-- `MSB MSB-328 Security issue reported by Nexus-iq : jetty-http`_
-- `MSB MSB-329 Security issue reported by Nexus-iq : spring-core`_
-- `MSB MSB-330 Security issue reported by Nexus-iq : commons-beanutils`_
-- `MSB MSB-331 Jackson datatype security issue
+- MSB MSB-295 Nexus IQ Issue: bootstrap
+- MSB MSB-320 Run API Gateway as a non-root user
+- MSBMSB-321 Run Discovery as a non-root user
+- MSB MSB-322 Run Kube2msb as a non-root user
+- MSB MSB-328 Security issue reported by Nexus-iq : jetty-http
+- MSB MSB-329 Security issue reported by Nexus-iq : spring-core
+- MSB MSB-330 Security issue reported by Nexus-iq : commons-beanutils
+- MSB MSB-331 Jackson datatype security issue
 
 **Bug Fixes**
 
-- `MSB-98  No information is available to select proper node IP from registered services`_
-- `MSB-281 improve CLM for swagger sdk`_
-- `MSB-325 consul container is outdated`_
-- `MSB-326 non STAGING version on master`_
+- MSB-98  No information is available to select proper node IP from registered services
+- MSB-281 improve CLM for swagger sdk
+- MSB-325 consul container is outdated
+- MSB-326 non STAGING version on master
 
 **Known Issues**
 
@@ -227,9 +279,9 @@ Version: 1.0.0
 
 
 **New Features**
-Initial release of Microservices Bus (MSB) for Open Network Automation Platform (ONAP). MSB provides core functionalities to support ONAP microservices architecture, including SDK for rapid microservie development, infrastructure for service communication and tools for service governance.
+Initial release of Microservices Bus (MSB) for Open Network Automation Platform (ONAP). MSB provides core functionalities to support ONAP microservices architecture, including SDK for rapid microservie development, infrastructure for service communication and tools for service governance.
 
-The current release of MSB is mainly composed of the following components
+The current release of MSB is mainly composed of the following components:
 
 **msb/apigateway**