...

Longer term roadmap

Indicate at a high level the longer term roadmap. This is to put things into the big perspectiveThe External API Framework project describes and defines the APIs between ONAP and External Systems, including ONAP interfaces targeted on BSS/OSS, peering, B2B, etc. Proposed initial focus may be on the Common APIs between ONAP and BSS/OSS. Common APIs between ONAP and BSS/OSS allow Service Providers to utilize the capabilities of ONAP using their existing BSS/OSS environment with minimal customization.

Scope:

• Deliver points of interoperability between ONAP and External Systems
• Initial focus on ONAP APIs to BSS/OSS
• May support the following capabilities:
  
  • Service feasibility; 
  • Service provisioning configuration & activation; 
  • Usage events & metrics; 
  • License accounting; 
  • Service performance & quality; 
  • Service Trouble management;
  • Service policy; 
  • Capacity engineering;
  • Address allocation management

• initial focus is likely to be: “Service provisioning configuration & activation”, "License management", and “Address allocation management”

• Definition of Use Cases, Interactions, and Information Model engaging service providers and BSS/OSS vendors

• API development (in conjunction with specific ONAP component projects)
  • Well defined specifications for the NB APIs (e.g., JSON Swagger). 
  • ONAP implementation of these APIs
• Work with Modeling project to explore a Model Driven approach: a cohesive way to have a shared view of information across ONAP external interfaces that can be used for or be input into a model driven process whereby the cost of delivering platform functionality is drastically reduced and the time to delivery is dramatically decreased.
• Explore use of Model Driven Tool Chain to automatically generate APIs based on models
• Main deliverables of this project may include: User Stories; Use Cases and Interactions (e.g., UML); Information Models (e.g., UML); Data Models (e.g., JSON); Interface Profiles and Functional Definition; ONAP Component Mapping and Functional Analysis.

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

List the other ONAP projects your depends on.

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.

• Modeling Project & Sub-Committee
  • Identify overall modeling guidelines and approaches, determine modeling tools and tool chaining, and identification of industry standard models (e.g., TMF SID, ONF TAPI, etc.) that may be applied to the APIs
• Service Orchestrator Project
  • Gather information about the relevant Service Orchestrator APIs (particularly the Service Instantiation API). Will collaborate with Service Orchestrator team to ensure that APIs remain consistent for R1.
• SDC (service model)
• DMaaP
  • Data Filtering, data transport, and data processing
• Micro-Service Bus (API Transport and Authentication / Authorization)
• Standards Coordinator
  • Related activities in the TM Forum, MEF, etc.
• This project will also analyze the functionality of the implemented set of APIs in ONAP components that are relevant to providing the described external interface functionality. Mapping and alignment between this project and the ONAP components implementing the supporting APIs is essential since functional API gaps and potential enhancements will be identified based on the functional analysis. This project also allows the pertinent ONAP component specific external API artifacts (e.g., JSON/Swagger) to be collected and referenced. 

Architecture

High level architecture diagram

Image Added

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

...

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, ...).

...

Third Party Products Dependencies

Only modeling tools, e.g., Eclipse Papyrus.

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 activitiesOnly models and API definition. No implementation as part of this project.

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.

...

...

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
  • ...

...

Each project must edit its project table available at Project FOSS.

Charter Compliance

The project team comply with the ONAP Charter.