MSB Release Planning for Dublin
- Huabing Zhao
DRAFT PROPOSAL FOR COMMENTS
The content of this template is expected to be fill out for M1 Release Planning Milestone.
Info
Use the "Copy" and "Move" options (available under the ..., top right of this page) to duplicate this template into your project wiki.
Use the Wiki to document the release plan. Don't provide PowerPoint.
Use as much diagrams and flow charts as you need, directly in the wiki, to convey your message.
- 1.1 Info
- 2 Overview
- 3 Scope
- 4 Release Deliverables
- 5 Sub-Components
- 6 Architecture
- 7 Testing and Integration Plans
- 8 Gaps
- 9 Known Defects and Issues
- 10 Risks
- 11 Resources
- 12 Release Milestone
- 13 Team Internal Milestone
- 14 Documentation, Training
- 14.1 Note
- 15 Other Information
Overview
Project Name | Enter the name of the project |
|---|---|
Target Release Name | Dublin |
Project Lifecycle State | Incubation |
Participating Company | AT&T, CMCC, IBM, Tech Mahindra, ZTE |
Scope
What is this release trying to address?
to support all the use cases (as a common service)
to provide access to new version of ONAP APIs via MSB
to implement the S3P requirements
to fix the issues reported by other projects and users
to support service mesh efforts (limited resources)
Use Cases
Describe the use case this release is targeted for (better if reference to customer use case).
As a common service project, MSB is the upstream of other projects to provide inter-service communication infrastructure, so it will be involved in the use cases indirectly.
Just list the use cases of VF-C and MultiCloud project which depends on MSB here , other use case will also be supported if msb involvement is needed.
Residential Broadband vCPE (Approved)
vFW/vDNS
vCPE
Functional Requirements:
Hardware Platform Enablement In ONAP
Centralized Representation and Consistent Identification of Cloud Regions In ONAP
Auto Scaling - stretch goal
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 language.
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
Integration with Istio service mesh
at a high level the longer term roadmap. This is to put things into the big perspective.
Release Deliverables
Indicate the outcome (Executable, Source Code, Library, API description, Tool, Documentation, Release Note...) of this release.
Deliverable Name | Deliverable Description |
|---|---|
Executable | Binaries, Docker Images and Helm charts. |
API description | Introduction of MSB APIs and how to set up a MSB development environment. |
Documentation | Installation manual, user guide, etc. |
Release Note | Release note of the release |
Source Code | The source code of the sub-components listed below. |
Sub-Components
Please refer to the Resources and Repositories page.
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
Refering to CII Badging Security Program and Platform Maturity Requirements, fill out the table below by indicating the actual level , the targeted level for the current release and the evidences on how you plan to achieve the targeted level.
Area | Actual Level | Targeted Level for current Release | How, Evidences | Comments |
|---|---|---|---|---|
Performance | 1 | 2 | Capture the baseline performance of API Gateway, such as QPS Latency Transfer/sec. |
|
Stability | 1 | 2 | 72 hours soak test with random transactions from ONAP microservices via Internal API Gateway. |
|
Resiliency | 2 | 2 | MSB integrates with OOM and leverage kubernetes to provide automated detection and recovery |
|
Security | 1 | 1 | Reach the 50% Test Coverage, get CII Passing badge(now 98%). |
|
Scalability | 1 | 1 | Provide cluster deployment for MSB components to achieve single site horizontal scaling. |
|
Manageability | 1 | 1 | MSB provide access logging at API gateway. |
|
Usability | 1 | 2 | Provide all the required documentation. |
|
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 Name | API Description | API Definition Date | API Delivery date | API Definition link (i.e.swagger) |
|---|---|---|---|---|
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.
API Name | API Description | API Definition Date | API Delivery date | API Definition link (i.e.swagger) |
|---|---|---|---|---|
Service Registration | RESTFul API for service registration with MSB. | 2019/01/24 | ||
Service Discovery | RESTFul API for service discovery with MSB. | 2019/01/24 | ||
JAVA SDK | JAVA SDK for service registration, discovery and inter-services communication. | 2019/01/24 |
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, ...).
Name | Description | Version |
|---|---|---|
Consul | Consul is a distributed, highly-available, and multi-datacenter aware tool for service discovery, configuration, and orchestration. | 0.9.3 |
OpenResty | OpenResty® is a full-fledged web platform that integrates the standard Nginx core, LuaJIT, many carefully written Lua libraries, lots of high quality 3rd-party Nginx modules, and most of their external dependencies. It is designed to help developers easily build scalable web applications, web services, and dynamic web gateways. | 1.11.2.3 |
Redis | Redis is an in-memory data structure store, used as a database, cache and message broker. | 3.2.8 |
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.
Gaps identified | 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).
Risk identified | Mitigation Plan | Contingency Plan |
|---|---|---|
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
...
Note
The Documentation project will provide the Documentation Tool Chain to edit, configure, store and publish all Documentation asset.
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.