DRAFT PROPOSAL FOR COMMENTS

The content of this template is expected to be fill out for M1 Release Planning Milestone.

Overview

Scope

What is this release trying to address?

• to address the S3P requirements, especially security vulnerabilities
• to fix the issues reported by other projects and users
• to support all the use cases (as a common service)

Use Cases

The existing use cases and new use cases in the Istanbul release.

Minimum Viable Product

• Internal API Gateway:  Service API gateway which serve as a transparent inter-service communication proxy to provide service discovery/routing/load balancing inside ONAP system.

• External API Gateway:  Service API Gateway which serve as an entrance to allow external system access to ONAP services.

• Service Discovery:  Provides service registration and discovery for ONAP microservices, which leverage Consul and builds an abstract layer on top of it to make it agnostic to the registration provider.

• JAVA SDK: Provides a JAVA SDK for rapid microservices development, including service registration, service discovery, request routing, load balancing, retry, etc.

• Swagger SD: Swagger SDK could be used to generate the server stub and client part in different languages.

Functionalities

List the functionalities that this release is committing to deliver by providing a link to JIRA Epics and Stories. In the JIRA Priority field, specify the priority (either High, Medium, Low). The priority will be used in case de-scoping is required. Don't assign High priority to all functionalities.

Epics

Stories

Longer term roadmap

MSB is already in a fairly stable stage.

Release Deliverables

Indicate the outcome (Executable, Source Code, Library, API description, Tool, Documentation, Release Note...) of this release.

Sub-Components

Please see the INFO.yaml files associated with each repo as the authoritative sources of information. https://gerrit.onap.org/r/admin/repos/q/filter:msb

Architecture

High level architecture diagram

MSB is part of the underlying platform to support onap microservice communication. MSB consists of these sub-components:

• Registry Service information storage, MSB uses Consul as the service registry.
• MSB Discovery Provides REST APIs for service discovery and registration.
• API Gateway Provide service request routing, load balancing and service governance. It can be deployed as external Gateway or Internal Gateway.
• MSB SDK A Java SDK for point to point communication.

MSB works with OOM (Kube2msb Registrator) to provide transparent service registration for onap microservices.

• OOM deploy/start/stop ONAP components. 
• Registrator watches the kubernetes event.
• Registrator reads the service definition from kubernetes deployment specs.
• Registrator sends service endpoints to MSB discovery when ONAP apps are deployed by OOM.
• Registrator registers service endpoint info to MSB. It also updates the service info to MSB when ONAP components are stopped/restarted/scaled by OOM

Platform Maturity

Istanbul Release Platform Maturity

API Incoming Dependencies

List the API this project is expecting from other projects.
Prior to Release Planning review, Team Leads must agreed on the date by which the API will be fully defined. The API Delivery date must not be later than the release API Freeze date.

Prior to the delivery date, it is a good practice to organize an API review with the API consumers.

Note:  MSB project has no incoming dependency.

API Outgoing Dependencies

API this project is delivering to other projects.

We don't expect mass API changes in Dublin, MSB APIs are already stable, however, plain HTTP APIs may be deprecated after enforcing AAF certificate.

Third Party Products Dependencies

Third Party Products mean products that are mandatory to provide services for your components. Development of new functionality in third party product may or not be expected.
List the Third Party Products (OpenStack, ODL, RabbitMQ, ElasticSearch,Crystal Reports, ...).

In case there are specific dependencies  (Centos 7 vs Ubuntu 16. Etc.) list them as well.

Testing and Integration Plans

Provide a description of the testing activities (unit test, functional test, automation,...) that will be performed by the team within the scope of this release.

Describe the plan to integrate and test the release deliverables within the overall ONAP system.
Confirm that resources have been allocated to perform such activities.

• Unit test: the goal is keeping up with Casablanca as 50% coverage or above for Dublin Release.
• Functional test: Leverage the robot framework infrastructure to provide the functional test.
• Integration test: Support integration team to provide the end to end integration test.
• All the above should be automation tests run on the LF Jenkins Infrastructure.

Gaps

This section is used to document a limitation on a functionality or platform support. We are currently aware of this limitation and it will be delivered in a future Release.
List identified release gaps (if any), and its impact.

Known Defects and Issues

Provide a link toward the list of all known project bugs.

Risks

List the risks identified for this release along with the plan to prevent the risk to occur (mitigation) and the plan of action in the case the risk would materialized (contingency).

Resources

Please see the INFO.yaml files associated with each repo as the authoritative sources of information. https://gerrit.onap.org/r/admin/repos/q/filter:msb

Release Milestone

The milestones are defined at the Release Planning: Istanbuland all the supporting project agreed to comply with these dates.

Team Internal Milestone

This section is optional and may be used to document internal milestones within a project team or multiple project teams. For instance, in the case the team has made agreement with other team to deliver some artifacts on a certain date that are not in the release milestone, it is erecommended to provide these agreements and dates in this section.

It is not expected to have a detailed project plan.

Documentation, Training

• Highlight the team contributions to the specific document related to he project (Config guide, installation guide...).
• Highlight the team contributions to the overall Release Documentation and training asset
• High level list of documentation, training and tutorials necessary to understand the release capabilities, configuration and operation.
• Documentation includes items such as:
  • Installation instructions
  • Configuration instructions
  • Developer guide
  • End User guide
  • Admin guide
  • ...

Please refer to : Istanbul Documentation

Other Information

• Vendor Neutral

If this project is coming from an existing proprietary codebase, ensure that all proprietary trademarks, logos, product names, etc. have been removed. All ONAP deliverables must comply with this rule and be agnostic of any proprietary symbols.

All the found proprietary trademarks, logos, product name have been removed from MSB codebase, and we promise removing such content if finding any in the future.

• Free and Open Source Software

FOSS activities are critical to the delivery of the whole ONAP initiative. The information may not be fully available at Release Planning, however to avoid late refactoring, it is critical to accomplish this task as early as possible.
List all third party Free and Open Source Software used within the release and provide License type (BSD, MIT, Apache, GNU GPL,... ).
In the case non Apache License are found inform immediately the TSC and the Release Manager and document your reasoning on why you believe we can use a non Apache version 2 license.

Each project must edit its project table available at Project FOSS.

Microservices Bus Project FOSS wiki page.

Charter Compliance

The project team comply with the ONAP Charter.