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 API Gateway Release Notes
   6 =============================
   7
   8 .. note::
   9         * This Release Notes must be updated each time the team decides to Release new artifacts.
  10         * The scope of this Release Notes is for this particular component. In other words, each ONAP component has its Release Notes.
  11         * This Release Notes is cumulative, the most recently Released artifact is made visible in the top of this Release Notes.
  12         * Except the date and the version number, all the other sections are optional but there must be at least one section describing the purpose of this new release.
  13         * This note must be removed after content has been added.
  14
  15 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.
  16
  17
  18
  19 Version: 1.0.0
  20 --------------
  21
  22
  23 :Release Date: 2017-11-04
  24
  25
  26
  27 **New Features**
  28 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.
  29
  30 The current release of MSB is mianly compose of the following components：
  31
  32 **msb/apigateway**
  33
  34 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.
  35
  36 **msb/discovery**
  37
  38 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.
  39
  40 **msb/java-sdk**
  41
  42 Provides a JAVA SDK for rapid microservices development, including service registration, service discovery, request routing, load balancing, retry, etc.
  43
  44 **msb/swagger-sdk**
  45
  46 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.
  47
  48 In the future release, MSB plans to provide service mesh for ONAP.
  49
  50 **Bug Fixes**
  51
  52 `MSB-94 <https://jira.onap.org/browse/MSB-94>`_
  53 Vendor name(ZTE) on the MSB Portal tiltle
  54
  55 `MSB-91 <https://jira.onap.org/browse/MSB-91>`_
  56 Duplicate class variable in service sub-classes
  57
  58 `MSB-88 <https://jira.onap.org/browse/MSB-88>`_
  59 The path parameter has been lost when register services in demo project
  60
  61 `MSB-87 <https://jira.onap.org/browse/MSB-87>`_
  62 MSB JAVA SDK dosen't release stage binary
  63
  64 `MSB-85 <https://jira.onap.org/browse/MSB-85>`_
  65 API Gateway UT coverage doesn't show up in Sonar
  66
  67 `MSB-74 <https://jira.onap.org/browse/MSB-74>`_
  68 Jenkins Integration Test job failed
  69
  70 `MSB-73 <https://jira.onap.org/browse/MSB-73>`_
  71 Can't register service by using MSB Api gateway 80 port
  72
  73 `MSB-72 <https://jira.onap.org/browse/MSB-72>`_
  74 Unit test coverage data is incorrect
  75
  76 `MSB-71 <https://jira.onap.org/browse/MSB-71>`_
  77 API Gateway service Registration and discovery api causes confusion
  78
  79 `MSB-70 <https://jira.onap.org/browse/MSB-70>`_
  80 Swagger SDK site job build failed
  81
  82 `MSB-69 <https://jira.onap.org/browse/MSB-69>`_
  83 Discovery checkstyle issue
  84
  85 `MSB-68 <https://jira.onap.org/browse/MSB-68>`_
  86 Discovery daily build jenkins job failed
  87
  88 `MSB-67 <https://jira.onap.org/browse/MSB-67>`_
  89 API Gateway check style warnning
  90
  91 `MSB-66 <https://jira.onap.org/browse/MSB-66>`_
  92 API Gateway daily build failed
  93
  94 `MSB-60 <https://jira.onap.org/browse/MSB-60>`_
  95 Api gateway test coverage data not in snoar
  96
  97 `MSB-59 <https://jira.onap.org/browse/MSB-59>`_
  98 Swagger SDK build failed
  99
 100 `MSB-58 <https://jira.onap.org/browse/MSB-58>`_
 101 MSB Java SDK Jenkins merge job failed
 102
 103 `MSB-57 <https://jira.onap.org/browse/MSB-57>`_
 104 Discovery site jenkins job failed
 105
 106 `MSB-55 <https://jira.onap.org/browse/MSB-55>`_
 107 Discovery site jenkins job failed
 108
 109 `MSB-54 <https://jira.onap.org/browse/MSB-54>`_
 110 API Gateway site jenkins job failed
 111
 112 `MSB-21 <https://jira.onap.org/browse/MSB-21>`_
 113 Merge and daily jenkins job failed
 114
 115 `MSB-17 <https://jira.onap.org/browse/MSB-17>`_
 116 release version java daily job failed
 117
 118 **Known Issues**
 119
 120 `MSB-92 <https://jira.onap.org/browse/MSB-92>`_
 121 microservice delete is reporting 500, though it deleted the service
 122
 123 **Security Issues**
 124 None
 125
 126 **Upgrade Notes**
 127 This is an initial release
 128
 129 **Deprecation Notes**
 130
 131 **Other**
 132 N/A
 133 ===========
 134
 135 End of Release Notes