External System Register (5/14/17)

Project Name:

• Proposed name for the project: External System Register
• Proposed name for the repository: esr

Project description:

• ONAP components need to talk with external systems such as VIM/VNFM/vendor SDNC/EMS to orchestrate a network service, for example, VF-C need to talk with VNFM to deploy a VNF. So they should get the information of available external systems from a registry before call the Interfaces of these external systems.  ESR provides a service to centralized management of the information (name, vendor, version, acess end point, etc.) of external systems. So the ONAP components can get the system information with unified API from a logical single point. 

  Note: This project is proposed to be a sub-project of A&AI.

Scope:

• This project provides a service to centralized management of external systems. 
  • Register/query/update/delete function of external system, such as VIM/VNFM/EMS/vendor SDN Controller. Users can register/update/delete external systems to ESR with API. And Multi-Vim/VF-C, for example, can query and talk to external systems with the query API. 
  • Provide a portal to manage the external systems.

• This project will also check whether the external systems are reachable, and store the health status. So that other components can determine whether the systems are available based on the status.

  Merge with A&AI

  Original ESR Scope (proposed at 5/14/17)	Merge Plan with A&AI (decided at 7/10/2017)
  Provide the API to register/query/update/delete external system, A&AI is the data storage back-end	contribute these function to A&AI
  Provide the Portal for user to register/query/update/delete external system	a function of ESR which would be a sub-project of A&AI
  check whether the external systems are reachable, and store the health status to A&AI	a function of ESR which would be a sub-project of A&AI

Architecture Alignment:

• How does this project fit into the rest of the ONAP Architecture?
  

• What other ONAP projects does this project depend on?
  
  • A&AI (store the external system data and status to A&AI)
  • MSB
• What other ONAP projects will call the API from ESR?
  • Multi-Vim
  • VF-C  
  • ONAP SDN-C ?
• Are there dependencies with other open source projects?
  
  

Resources:

• Primary Contact Person: Zi Li
• Names, gerrit IDs, and company affiliations of the committers
• Contributors
  Zi Li li.zi30@zte.com.cn 
  Qi Sun sun.qi310@zte.com.cn
  Liang Qin qin.liang13@zte.com.cn

• Project Roles (include RACI chart, if applicable)

  Role	First Name Last Name	Linux Foundation ID	Email Address	Location
  Primary Contact
  	Zi Li	nancylizi	li.zi30@zte.com.cn
  Committers
  	Zi Li	nancylizi	li.zi30@zte.com.cn
  	Qi Sun	sunqi310	sun.qi310@zte.com.cn
  Contributors
  	Zi Li		li.zi30@zte.com.cn
  	Qi Sun		sun.qi310@zte.com.cn
  	Liang Qin		qin.liang13@zte.com.cn

Other Information:

• link to seed code (if applicable)
  https://gerrit.open-o.org/r/#/admin/projects/common-services-external-system-registration (seed code for service end)
  https://gerrit.open-o.org/r/#/admin/projects/client-gui  (seed code for portal)
• Vendor Neutral
  • if the proposal is coming from an existing proprietary codebase, have you ensured that all proprietary trademarks, logos, product names, etc., have been removed?
• 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: esr
• JIRA project prefix: esr

Repo name:
Lifecycle State:
Primary Contact: li.zi30@zte.com.cn
Project Lead:
mailing list tag [Should match Jira Project Prefix] 
Committers:

Zi Li li.zi30@zte.com.cn 
Qi Sun sun.qi310@zte.com.cn

*Link to TSC approval: 
Link to approval of additional submitters: