[MSB] trigger doc build
[msb/apigateway.git] / docs / release-notes.rst
index e459abe..6a03cb9 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,191 @@ MSB is platform independent, while it is integrated with Kubernetes(OOM) to prov
 Release Notes
 =============
 
+Version: 1.4.0 Jakarta Release
+-------------------------------
+
+:Release Date: 2022-3-24
+
+**New Features**
+
+- MSB-661 MSB should support TLSv1.3
+
+**Bug Fixes**
+
+- MSB-663 NGINX requests is too small on one keepalive connection
+- MSB-645 remove obsolete docs from msb/java-sdk repo
+- MSB-646 remove obsolete docs from msb/discovery repo
+- MSB-633 remove duplicated docs in msb/apigateway repo and update sphinx config files
+
+**Fixed Security Issues**
+
+- MSB-662 NGINX should user server ciphers for security
+- MSB-644 PACKAGES UPGRADES IN DIRECT DEPENDENCIES FOR JAKARTA
+
+**Known Issues**
+
+**Security Notes**
+
+Quick Links:
+        - `MSB project page for Jakarta Release <https://wiki.onap.org/display/DW/Microservices+Bus+Project>`_
+
+        - `Passing Badge information for MSB <https://bestpractices.coreinfrastructure.org/en/projects/1601>`_
+
+**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.3.1 Istanbul Release
+-------------------------------
+
+:Release Date: 2021-9-22
+
+**New Features**
+
+**Bug Fixes**
+
+**Fixed Security Issues**
+
+- MSB-593 PACKAGES UPGRADES IN DIRECT DEPENDENCIES FOR ISTANBUL
+- MSB-519 MSB has python 2.7 pods
+- MSB-520 MSB has java 8 pods
+- MSB-521 MSB certificates are too long and have bad owner
+
+**Known Issues**
+
+- MSB-534 kube2msb fails to register SO services including braces in url
+
+**Security Notes**
+
+The remaining issues are supposed to be fixed in the next release.
+
+Quick Links:
+        - `MSB project page for Istanbul Release <https://wiki.onap.org/display/DW/Microservices+Bus+Project>`_
+
+        - `Passing Badge information for MSB <https://bestpractices.coreinfrastructure.org/en/projects/1601>`_
+
+**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.7 Guilin Release
+------------------------------
+
+:Release Date: 2020-11-19
+
+**New Features**
+
+**Bug Fixes**
+
+- MSB-539 Fix nginx say 10000 worker_connections are not enough
+- MSB-540 nginx in discovery deletes useless log printing
+- MSB-541 Discovery supports blocking monitoring time exceeding 10min
+
+**Fixed Security Issues**
+
+**Known Issues**
+
+- MSB-519 MSB has python 2.7 pods
+- MSB-520 MSB has java 8 pods
+- MSB-521 MSB certificates are too long and have bad owner
+- MSB-529 MSB dockers contain GPLv3
+
+**Security Notes**
+
+The remaining issues are supposed to be fixed in the next release.
+
+Quick Links:
+        - `MSB project page for Guilin Release <https://wiki.onap.org/display/DW/Microservices+Bus+Project>`_
+
+        - `Passing Badge information for MSB <https://bestpractices.coreinfrastructure.org/en/projects/1601>`_
+
+
+**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.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.
+
+Quick Links:
+        - `MSB project page for Frankfurt Release <https://wiki.onap.org/display/DW/Microservices+Bus+Project>`_
+
+        - `Passing Badge information for MSB <https://bestpractices.coreinfrastructure.org/en/projects/1601>`_
+
+**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,28 +205,28 @@ 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**
 
 **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>`_.
+The remaining issues are identified as false positive and their risk assessment have been documented.
 
 Quick Links:
-       - `MSB project page <https://wiki.onap.org/display/DW/Microservices+Bus+Project>`_
+       - `MSB project page for EI-Alto Release <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=64003723>`_
+       - `Project Vulnerability Review Table for MSB EI-Alto Release <https://wiki.onap.org/pages/viewpage.action?pageId=68541445>`_
 
 **Upgrade Notes**
 
@@ -68,35 +251,35 @@ 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**
 
 **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>`_.
+The remaining issues are identified as false positive and their risk assessment have been documented.
 
 Quick Links:
-       - `MSB project page <https://wiki.onap.org/display/DW/Microservices+Bus+Project>`_
+       - `MSB project page for Dublin Release <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=64003723>`_
+       - `Project Vulnerability Review Table for MSB Dublin Release <https://wiki.onap.org/pages/viewpage.action?pageId=64003723>`_
 
 **Upgrade Notes**
 
@@ -145,14 +328,14 @@ How to manage ONAP microservices with Istio service mesh:
 **Security Notes**
 
 MSB 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 actions to be taken in future release.
-The MSB open Critical security vulnerabilities and their risk assessment have been documented as part of the `project <https://wiki.onap.org/pages/viewpage.action?pageId=45305668>`_.
+The MSB open Critical security vulnerabilities and their risk assessment have been documented.
 
 Quick Links:
-       - `MSB project page <https://wiki.onap.org/display/DW/Microservices+Bus+Project>`_
+       - `MSB project page for Casablanca Release <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=45305668>`_
+       - `Project Vulnerability Review Table for MSB Casablanca Release <https://wiki.onap.org/pages/viewpage.action?pageId=45305668>`_
 
 **Upgrade Notes**
 
@@ -199,13 +382,13 @@ N/A
 
 **Security Notes**
 
-MSB 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 MSB open Critical security vulnerabilities and their risk assessment have been documented as part of the `project <https://wiki.onap.org/pages/viewpage.action?pageId=25439016>`_.
+MSB 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 MSB open Critical security vulnerabilities and their risk assessment have been documented.
 
 Quick Links:
 
-- `MSB project page <https://wiki.onap.org/display/DW/Microservices+Bus+Project>`_
+- `MSB project page for  Beijing Release <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=25439016>`_
+- `Project Vulnerability Review Table for MSB Beijing Release <https://wiki.onap.org/pages/viewpage.action?pageId=40927271>`_
 
 **Upgrade Notes**
 
@@ -227,9 +410,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**