docs/release-notes.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   2 .. http://creativecommons.org/licenses/by/4.0
   3
   4
   5 MSB Release Notes
   6 =================
   7
   8 Microservices Bus provide key infrastructure functionalities to support ONAP microservice architecture including service registration/discovery, service gateway, service load balancer and service governance. It's a pluggable architecture so it can be extended with plugins to provide value added services such as centralized authentication for APIs. Microservices Platform also provides a GUI portal for service management.
   9
  10 Version: 1.1.0
  11 --------------
  12
  13 :Release Date: 2018-06-07
  14
  15
  16 **New Features**
  17
  18
  19 **Bug Fixes**
  20
  21 N/A
  22
  23 **Known Issues**
  24
  25 N/A
  26
  27 **Security Notes**
  28
  29 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>`_.
  30
  31 Quick Links:
  32         - `MSB project page <https://wiki.onap.org/display/DW/Microservices+Bus+Project>`_
  33
  34         - `Passing Badge information for MSB <https://bestpractices.coreinfrastructure.org/en/projects/1601>`_
  35
  36         - `Project Vulnerability Review Table for MSB <https://wiki.onap.org/pages/viewpage.action?pageId=25439016>`_
  37
  38 **Upgrade Notes**
  39
  40 N/A
  41
  42 **Deprecation Notes**
  43
  44 N/A
  45
  46 **Other**
  47
  48 N/A
  49
  50
  51 Version: 1.0.0
  52 --------------
  53
  54 :Release Date: 2017-11-16
  55
  56
  57 **New Features**
  58 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.
  59
  60 The current release of MSB is mainly composed of the following components：
  61
  62 **msb/apigateway**
  63
  64 Provides client request routing, client request load balancing, transformation, such as https to http, authentication & authorization for service request with plugin of auth service provider, service request logging, service request rate-limiting, service monitoring, request result cache, solve cross-domain issue for web application and other functionalities with the pluggable architecture capability.
  65
  66 **msb/discovery**
  67
  68 Provides service registration and discovery for ONAP microservices, which leverage Consul and build an abstract layer on top of it to make it agnostic to the registration provider and add needed extension.
  69
  70 **msb/java-sdk**
  71
  72 Provides a JAVA SDK for rapid microservices development, including service registration, service discovery, request routing, load balancing, retry, etc.
  73
  74 **msb/swagger-sdk**
  75
  76 Swagger sdk helps to generate swagger.json and java client sdk during the build time, it also helps to provide the swagger.json at the given URI in the run time.
  77
  78 In the future release, MSB plans to provide service mesh for ONAP.
  79
  80 **Bug Fixes**
  81
  82 - `MSB-94 <https://jira.onap.org/browse/MSB-94>`_ Vendor name(ZTE) on the MSB Portal tiltle
  83 - `MSB-91 <https://jira.onap.org/browse/MSB-91>`_ Duplicate class variable in service sub-classes
  84 - `MSB-88 <https://jira.onap.org/browse/MSB-88>`_ The path parameter has been lost when register services in demo project
  85 - `MSB-87 <https://jira.onap.org/browse/MSB-87>`_ MSB JAVA SDK dosen't release stage binary
  86 - `MSB-85 <https://jira.onap.org/browse/MSB-85>`_ API Gateway UT coverage doesn't show up in Sonar
  87 - `MSB-74 <https://jira.onap.org/browse/MSB-74>`_ Jenkins Integration Test job failed
  88 - `MSB-73 <https://jira.onap.org/browse/MSB-73>`_ Can't register service by using MSB Api gateway 80 port
  89 - `MSB-72 <https://jira.onap.org/browse/MSB-72>`_ Unit test coverage data is incorrect
  90 - `MSB-71 <https://jira.onap.org/browse/MSB-71>`_ API Gateway service Registration and discovery api causes confusion
  91 - `MSB-70 <https://jira.onap.org/browse/MSB-70>`_ Swagger SDK site job build failed
  92 - `MSB-69 <https://jira.onap.org/browse/MSB-69>`_ Discovery checkstyle issue
  93 - `MSB-68 <https://jira.onap.org/browse/MSB-68>`_ Discovery daily build jenkins job failed
  94 - `MSB-67 <https://jira.onap.org/browse/MSB-67>`_ API Gateway check style warnning
  95 - `MSB-66 <https://jira.onap.org/browse/MSB-66>`_ API Gateway daily build failed
  96 - `MSB-60 <https://jira.onap.org/browse/MSB-60>`_ API gateway test coverage data not in snoar
  97 - `MSB-59 <https://jira.onap.org/browse/MSB-59>`_ Swagger SDK build failed
  98 - `MSB-58 <https://jira.onap.org/browse/MSB-58>`_ MSB Java SDK Jenkins merge job failed
  99 - `MSB-57 <https://jira.onap.org/browse/MSB-57>`_ Discovery site jenkins job failed
 100 - `MSB-55 <https://jira.onap.org/browse/MSB-55>`_ Discovery site jenkins job failed
 101 - `MSB-54 <https://jira.onap.org/browse/MSB-54>`_ API Gateway site jenkins job failed
 102 - `MSB-21 <https://jira.onap.org/browse/MSB-21>`_ Merge and daily jenkins job failed
 103 - `MSB-17 <https://jira.onap.org/browse/MSB-17>`_ Release version java daily job failed
 104
 105 **Known Issues**
 106
 107 - `MSB-92 <https://jira.onap.org/browse/MSB-92>`_ Microservice delete is reporting 500, though it deleted the service
 108
 109 **Security Issues**
 110
 111 None
 112
 113 **Upgrade Notes**
 114
 115 This is an initial release
 116
 117 **Deprecation Notes**
 118
 119 N/A
 120
 121 **Other**
 122
 123 N/A
 124
 125 ===========
 126
 127 End of Release Notes