Project Name:
- Proposed name for the project:
External API Framework
- Proposed name for the repository:
externalapi
Project description:
- This project will describe and define the APIs between ONAP and External Systems.
- Proposed initial focus may be on the Common Northbound APIs between ONAP and BSS/OSS.
Common Northbound 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 Northbound APIs to BSS/OSS
- May support the following capabilities:
- Service feasibility;
- Service provisioning configuration & activation;
- Usage events & metrics;
- License accounting;
- Service performance & quality;
- Service policy;
- Capacity engineering;
- Address allocation management
Definition of Use Cases, Interactions, and Information Model engaging service providers and BSS/OSS vendors
- API development
- Well defined specifications for the NB APIs (e.g., JSON Swagger).
- ONAP implementation of these APIs
- Explore use of Tool Chain to automatically generate APIs based on models
Architecture Alignment:
- How does this project fit into the rest of the ONAP Architecture?
- What other ONAP projects does this project depend on?
- Service Orchestrator
- A&AI
- DCAE
- SD&C
- Controllers
- Reference VNFs (related Use Cases)
- What other ONAP projects does this project depend on?
- How does this align with external standards/specifications?
- Base service abstraction Information Model on best in breed standard models (e.g., TM Forum SID, MEF 7.3 Service Info Model, etc.)
- MEF LSO Legato (MEF 7.3 Service Info Model)
- TM Forum SID
- TM Forum Zoom effort and related TM Forum APIs where applicable.
- Are there dependencies with other open source projects?
- ??
Resources:
- Primary Contact Person:
- Andy Mayer, AT&T, am803u@att.com
- Names, gerrit IDs, and company affiliations of the committers
- Alex Vul, Intel, alex.vul@intel.com
- Al Hua, Huawei,
- Chen Yan, China Telecom, chenyan.bri@chinatelecom.cn
- Jack Pugaczewski, Century Link, Jack.Pugaczewski@CenturyLink.com
- Laurent Leboucher, Orange, laurent.leboucher@orange.com
- Mahesh Jethanandani, Cisco, mahesh@cisco.com
- Mehmet Toy, Verizon, mehmet.toy@verizon.com
- Nigel Davis, Ciena, ndavis@ciena.com
- Raghu Ranganathan, Ciena, rraghu@ciena.com
- Raluca Sirbu, AT&T, rs2184@att.com
- Shahar Steiff, PCCW Global, ssteiff@pccwglobal.com
- Xiaojun Xie, China Telecom, xiexj.gd@chinatelecom.cn
- Names and affiliations of any other contributors
- Project Roles (include RACI chart, if applicable)
Other Information:
- link to seed code (if applicable)
- Vendor Neutral
- This project is vendor neutral and open-sourced under the Apache license from the OPEN-O project
- Meets Board policy (including IPR)
Use the above information to create a key project facts section on your project page
Key Project Facts
Project Name:
- JIRA project name: externalapi
- JIRA project prefix: externalapi
Repo name:
- org.onap.externalapi/nbi
Lifecycle State: incubation
Primary Contact: Andy Mayer, AT&T, am803u@att.com
Project Lead: Andy Mayer, AT&T, am803u@att.com
mailing list tag [externalapi]
Committers:
- Alex Vul, Intel, alex.vul@intel.com
- Al Hua, Huawei,
- Chen Yan, China Telecom, chenyan.bri@chinatelecom.cn
- Jack Pugaczewski, Century Link, Jack.Pugaczewski@CenturyLink.com
- Laurent Leboucher, Orange, laurent.leboucher@orange.com
- Mahesh Jethanandani, Cisco, mahesh@cisco.com
- Mehmet Toy, Verizon, mehmet.toy@verizon.com
- Nigel Davis, Ciena, ndavis@ciena.com
- Raghu Ranganathan, Ciena, rraghu@ciena.com
- Raluca Sirbu, AT&T, rs2184@att.com
- Shahar Steiff, PCCW Global, ssteiff@pccwglobal.com
- Xiaojun Xie, China Telecom, xiexj.gd@chinatelecom.cn
*Link to TSC approval:
Link to approval of additional submitters:
1) Well defined specifications for the NB APIs (e.g., JSON Swagger). These define what the BSS/OSSs would need to build to.
2) An ONAP implementation of these APIs