DRAFT PROPOSAL FOR COMMENTS
The content of this template is expected to be fill out for M1 Release Planning Milestone.
...
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.
...
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) 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) serverId 425b2b0a-557c-3c0c-b515-579789cceedb
...
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.
| Deliverable Name | Deliverable Description | To fill out | To fill out|
|---|---|---|---|
| Service Discovery | Service Registry,Registration & Discovery | ||
| API Gateway | Can be deployed as external API gateway or router(Internal API gateway) | ||
| API documentation | |||
| RESTful API Design Specification | Guideline for ONAP Restful API design |
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)
...
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
...
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.
...
| Jira | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
|
...
| Risk identified | Mitigation Plan | Contingency Plan |
|---|---|---|
| MSB needs to work with OOM to register services to MSB service registry, given that OOM is a newly created project, there may be a risk that the cooperation job between MSB and OOM can't be done in the release 1. | Work with OOM team closely and try to put this job in the priority task list of OOM team. | MSB provide Restful APIs and UI Portal so ONAP services can be manually registered. |
Resources
Fill out the Resources Committed to the Release centralized page.
Release Milestone
...
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 for ONAP
MSB team promise to provide other necessary materials as input according to documentation project's request.
...