Update Release notes and documentation

[msb/apigateway.git] / docs / release-notes.rst

diff --git a/docs/release-notes.rst b/docs/release-notes.rst
index 245c022..fd92900 100644 (file)
--- a/docs/release-notes.rst
+++ b/docs/release-notes.rst
@@ -2,9 +2,6 @@
 .. http://creativecommons.org/licenses/by/4.0
 
 
-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 +9,51 @@ MSB is platform independent, while it is integrated with Kubernetes(OOM) to prov
 Release Notes
 =============
 
+Version: 1.2.5 EI-Alto Release
+------------------------------
+
+:Release Date: 2019-09-05
+
+**New Features**
+
+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`_
+
+**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`_
+
+**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=64003723>`_
+
+**Upgrade Notes**
+
+N/A
+
+**Deprecation Notes**
+
+N/A
+
+**Other**
+
+N/A
+
 Version: 1.2.4 Dublin Release
 -----------------------------
 
@@ -22,21 +64,22 @@ Version: 1.2.4 Dublin Release
 This release only contains some security improvements and a few fixes.
 
 **Security improvements**
-* MSB-295 Nexus IQ Issue: bootstrap
-* MSB-320 Run API Gateway as a non-root user
-* MSB-321 Run Discovery as a non-root user
-* MSB-322 Run Kube2msb as a non-root user
-* MSB-328 Security issue reported by Nexus-iq : jetty-http
-* MSB-329 Security issue reported by Nexus-iq : spring-core
-* MSB-330 Security issue reported by Nexus-iq : commons-beanutils
-* 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**