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.
...
| Deliverable Name | Deliverable Description |
|---|---|
| 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.
...
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
...
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
...
| 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.
...
Each project must edit its project table available at Project FOSS.|
Charter Compliance
The project team comply with the ONAP Charter.
...