External API Framework M1 Release Planning (Amsterdam Release)
DRAFT PROPOSAL FOR COMMENTS
The content of this template is expected to be fill out for M1 Release Planning Milestone.
- 1 Overview
- 2 Scope
- 3 Release Deliverables
- 4 Sub-Components
- 5 ONAP Dependencies
- 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 | Amsterdam |
Project Lifecycle State | Incubation |
Participating Company | Amdocs, AT&T, Bell Canada, Century Link, China Mobile, China Telecom, Ciena, Cisco, Ericsson, Huawei, IBM, Intel, Netcracker, Orange, PCCW Global, Verizon |
Scope
What is this release trying to address?
Common APIs between ONAP and BSS/OSS allow Service Providers to utilize the capabilities of ONAP while using their existing BSS/OSS environment minimizing customization.
Service Providers need a clear and unambiguous ONAP service abstraction so that the BSS/OSS can exchange service requirements and service capabilities in a common and consistent fashion.
Service Providers want to rapidly integrate new Services and Service Components into ONAP so that they can quickly introduce capabilities for their customers and within their infrastructure.
Service Providers want to manage the entire lifecycle of Services within ONAP in a common way so that they can ensure orchestration, manageability and control of each Service in an easily integrateable and low cost way.
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.
Focus: Service Instantiation; License Management; Network Address Space Management
Use Cases
In Amsterdam, we will target packaging of the vCPE and VoLTE VNFs
Will address any BSS/OSS interactions described in these use cases
Minimum Viable Product
The MVP allows for the definition of BSS/OSS - ONAP APIs that:
Support simple Service Instantiation Requests;
Provide Licence usage information to the BSS/OSS;
Allow Network Address Spaces to be provided to the ONAP instance.
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
The 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.
Deliverable Name | Deliverable Description |
---|---|
Functional Reference Architecture and Target Capabilities | Functional reference architecture (MEF LSO mapping, Interface Reference Point definition, etc.) Note that the BSS/OSS to ONAP APIs are relevant to the MEF LSO Legato Interface Reference Point. Include deployment scenarios. Functional description of target ONAP capabilities for interactions with BSS/OSS |
Use Cases | Identify BSS/OSS – ONAP Use Cases and interactions |
UML Models | UML Information Models for: Service Instantiation; Licence Management; and Address Space Management |
API Definitions | API Definitions for: Service Instantiation; Licence Management; and Address Space Management |
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
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
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 Name | API Description | API Definition Date | API Delivery date | API Definition link (i.e.swagger) |
---|---|---|---|---|
Service Instantiation | SO Service Instantiation API | Date | Date | Link toward the detailed API description |
Catalog | SDC Catalog API | Date | Date |
API Outgoing Dependencies
API this release is delivering to other releases.
API Name | API Description | API Definition Date | API Delivery date | API Definition link (i.e.swagger) |
---|---|---|---|---|
Service Instantiation API Definition | Revised SO Service Instantiation API. Jointly with SO team. | 24 Aug 2017 | Date | Link toward the detailed API description |
License Management API Definition | License Management API | 24 Aug 2017 | ||
Address Space Management API Definition | Address Space Management API | 24 Aug 2017 |
Third Party Products Dependencies
Only modeling tools, e.g., Eclipse Papyrus.
Testing and Integration Plans
Only 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.
Gaps identified | Impact |
---|---|
To fill out | To fill out |
Known Defects and Issues
Provide a link toward the list of all known project bugs.
key | summary | type | created | updated | due | assignee |
---|