...
- Provides RESTFul API for service registration/discovery
- Provides JAVA SDK for service registration and access, discovery and inter-services communication
- Provides a transparent service registration proxy with OOM-Kube2MSB
- Provides a transparent service communication proxy which handles service discovery, load balancing, routing, failure handling, and visibility by Internal API Gateway(Current implementation) and Mesh sidecar(WIP)
- Provides an External API Gateway to expose ONAP services to the outside world
...
MSB is an infrastructure project, it means that MSB supports every ONAP use case with no difference.
Minimum Viable Product
- Meet the platform maturityMeet the planned Beijing platform maturity(S3P) requirements
- Help other projects integrate with MSB Reach out to help other projects integrate with MSB
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.
...
Jira server ONAP JIRA columns key,summary,type,created,updated,due,assignee,reporter,priority,status,resolution maximumIssues 20 jqlQuery project=sanbox msb and issuetype in (epic) and fixVersion = "Beijing Release" serverId 425b2b0a-557c-3c0c-b515-579789cceedb
...
Jira server ONAP JIRA columns key,summary,type,created,updated,due,assignee,reporter,priority,status,resolution maximumIssues 20 jqlQuery project=sanbox msb and issuetype in (story) and fixVersion = "Beijing Release" serverId 425b2b0a-557c-3c0c-b515-579789cceedb
...
Sub-components are repositories and are consolidated in a single centralized place. Edit the Release Components name for your project in the centralized page.
...
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 | 0 | 1 | Capture the baseline performance of API Gateway, such as QPS Latency Transfer/sec. |
|
| Stability | 0 | 1 | 72 hours soak test with random transactions from ONAP microservices via Internal API Gateway. |
|
| Resiliency | 1 | 2 | MSB integrates with OOM and leverage kubernetes to provide automated detection and recovery |
|
| Security | 0 | 1 | Reach the 50% Test Coverage. It's unclear how to get CII Passing badge, will Investgate and figure out. |
|
| Scalability | 1 | 1 | Provide cluster deployment for MSB components to achieve ingle site horizontal scaling. |
|
| Manageability | 1 | 1 | MSB provide access logging at API gateway. |
|
| Usability | 1 | 1 | Provide all the required documentation. |
|
API Incoming Dependencies
...
| 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. | 1/1/2018 | release API Freeze date | Microservice Bus API Documentation |
| Service Discovery | RESTFul API for service discovery with MSB. | 1/1/2018 | release API Freeze date | Microservice Bus API Documentation |
| JAVA SDK | JAVA SDK for service registration, discovery and inter-services communication. | 1/1/2018 | release API Freeze date | Microservice Bus API Documentation |
...
| Jira | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
|
...
| Risk identified | Mitigation Plan | Contingency Plan |
|---|---|---|
| To fill out | To fill out | To fill out |
Resources
Fill out the Resources Committed to the Release centralized page.
Release 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 recommended to provide these agreements and dates in this section.
It is not expected to have a detailed project plan.
| Date | Project | Deliverable | To fill out | To fill outTo fill out | |
|---|---|---|---|---|---|
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.
- Reach out to each project to help them to integrate with MSB, including tutorial, demonstration and code example.
- Provide introduction, guideline and API documentation in ONAP wiki.
- Populate release documentation content to http://onap.readthedocs.io includes Documentation includes items such as:
- Installation instructions
- Configuration instructions
- Developer guide
- End User guide
- Admin guide
- ...
...
Other Information
Vendor Neutral
If this project is coming from an existing proprietary codebase, ensure that all proprietary All proprietary trademarks, logos, product names, etc. have been removed. All ONAP deliverables must removed to comply with this rule and be agnostic of any proprietary symbols. If there is any new findings, the team promises to remove them ASAP.
Free and Open Source Software
...