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?

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 plugin service provider options like AAF to provide Authentication & Authorization for APIs. Microservices Platform also provides a service portal and service requests logging, tracing and monitoring mechanism, etc.

Use Cases

1. Service registration per service provider instances

   • Registration
     Service instances are registered to the registry by proxy or themselves. The visible scope should be indicated as a parameter when register. If a service is only internal visible, the service information is only pulled by the internal gateway (aka router & load balancer) and used by other components inside the system, the interal services can't be accessed by external systems or front end(web client). If a service is visible to external system, the service information is pulled by the external gateway and can be accessed by external systems and front end (web client) with auth.
              
       

     Open

     

   • Discovery & Service Consuming

     • For internal service consumers(Components inside ONAP system, such as A&AI, SO, Controller, etc.)

       • Client side discovery and load balancing
         
         

         Open

         

       • Server side discovery and load balancing
         
         

     • For external service clients(OSS, BSS, Web client, etc.), access the service via external gateway
       
       

       
       
       
       

2. Service registration per service
   The service may have its own load balancer built inside, for example, Kubernetes can create a load balancer for a service. In such case, only need to register the service LB node to MSB, and the service request from the consumer is routed to the service LB node.
   
   

   • Registration
     
     
     

   • Discovery  & Service Consuming
     
     Note: Only show the client side discovery in this diagram for simplicity, it's also possible to use server side discovery by the internal gateway.
     
     
     

    

3. Centralized Authentication&Authorization via MSB plugin
   MSB is a pluggable architecture, so it can provide centralized authentication & authorization for service request with plugin of auth service provider like AAF.
   
   

Minimum Viable Product

Service Registration & Discovery

Service API Gateway(External API Gateway)

Service Router(Internal API Gateway)

Stretch Goal: Integrate with OOM so OOM can register service endpoints to MSB after deploying and starting an ONAP component/service.

Stretch Goal: Integrate with AAF so MSB API Gateway can work with AAF to provide centralized authentication and authorization for ONAP platform.

Stretch Goal: Integrate with for discovery of Dmaap topics in addition to RESTful API’s.

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

Indicate at a high level the longer term roadmap. This is to put things into the big perspective.

Provide a high performance, high availability microservice infrastructure layer for ONAP platform, including service registration&discovery, service API gateway and service governance.

Release Deliverables

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

Sub-Components

List all sub-components part of this release.
Activities related to sub-component must be in sync with the overall release.

Sub-components are repositories are consolidate in a single centralized place. Edit the Release Components name for your project in the centralized page.

ONAP Dependencies

• OOM: work with OOM team to register services to MSB after ONAP components are deployed and started by OOM

• AAF:work with AAF team to provide centralized authentication an authorization fro ONAP components. (It's just a proposed solution which is under discussion now)

Architecture

High level architecture diagram

At that stage within the Release, the team is expected to provide more Architecture details describing how the functional modules are interacting.

Block and sequence diagrams showing relation within the project as well as relation with external components are expected.

Anyone reading this section should have a good understanding of all the interacting modules.

Sequence diagram

Service Registration & Discovery

User login flow with Auth service provider

(Note: API token may be used for the external systems such as OSS/BSS, however, the generation of API token is not considered to be relevant to MSB(External API Gateway))

External service request flow

(Assumption: the external system(OSS/BSS) or user agent(Browser)  already get authenticated and allocated a token, it can be either a user token for ONAP user or an API token for OSS/BSS)

Internal service request flow

Option 1: Service consumer and service provider communicate with each other via Internal API Gateway

Option 2: Service consumer uses MSB client SDK to communicate with service provider directly

API Incoming Dependencies

List the API this release is expecting from other releases.
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.

API Outgoing Dependencies

API this release is delivering to other releases.

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 50% coverage for Amsterdam Release.

• Functional test: Leverage the robot framework infrastructure to provide 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

Fill out the Resources Committed to the Release centralized page.

Release Milestone

The milestones are defined at the Release Level and 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

  • ...

MSB team provides the API documentation for the use of ONAP projects. Microservice Bus API Documentation

MSB team provides a draft guideline for RESTful API design for the use of ONP projects, which will be discussed in the community/ arc subcommittee and to be approved by TSC if needed. RESTful API Design Specification

MSB team promise to provide other necessary materials as input according to documentation project's request.

Other Information

Vendor Neutral

All proprietary trademarks, logos, product names, etc. from the seed codes have been removed. If anything new which doesn't comply with this rule is found in the future, the team promise to response and remove it immediately.

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.

Charter Compliance

The project team comply with the ONAP Charter.