User Tools

Site Tools


This page is outdated.

Please go to the following link for the project proposal

Project Name:

  • Proposed name for the project: VIM Northbound Model and Interface
  • Proposed name for the repository: vim_nbi
  • Project Categories: (Requirements)

Project description:

While OpenStack is a competitive candidate for VIM, existing interfaces provided by OpenStack include three major parts: compute, storage, and network. However, OpenStack as a general cloud platform is not customized for NFV scenario, leaving a lot of detailed work for the NFV orchestrator.

The proposed project is to provide a consistent and intuitive northbound interface for VIM to better fitting the orchestrator, and make it easy for resource access, connection generation, flow identification, policy operation, etc. This higher level interface gives the upper layer application (e.g. orchestrator) another option in addition to openstack native interfaces.

There will be a shim layer to encapsulate higher order operations appropriately in the NFV problem domain, and convert them into collections of calls to cloud platforms. This project will use existing projects, like promise, copper, VNFFG, and so on, to implement the NBI and find gaps when the NBI cannot be implemented by existing projects.

To achieve the NBI consistency, we can use the Model Driven Architecture (MDA) approach and define system functionality using platform-independent models. Interfaces can be generated automatically with well defined models.


Describe the problem being solved by project

This project is to provide a consistent and intuitive northbound interface for VIM to better fitting the orchestrator. With a set of information models and interfaces, we can address most use-cases in a systematical way. The proposed project is intended to (tentatively scheduled):

  • document typical NFV use-cases for high-level functional abstraction, and find gaps between OpenStack API and high level applicaitons;
  • abstract the service oriented VIM NB models and interfaces, refine existing information models and develop new models;
  • work together with other entities to achieve collaboration and synergy;
  • provide open source implementation for a shim layer.
  • and coordinate integrated testing and release testing results.

Specify any interface/API specification proposed

Vi-Vnfm, Or-Vi


Identify similar projects is underway or being proposed in OPNFV or upstream project

  • The "Promise" project in OPNFV
  • The "Copper" project in OPNFV
  • The "VNFFG" project in OPNFV
  • The "Doctor" project in OPNFV
  • The "Nova" project in OpenStack
  • The "Neutron" project in OpenStack
  • the use cases and messages specified in the individual projects
  • new shim layer will consider the interface specifications currently being made by ETSI NFV IFA

Committers and Contributors:

Names and affiliations of the committers:

  Tianran Zhou (
  Lei Zhu (
  Zhipeng Huang (
  Linghui Zeng (
  Qiao Fu (
  Susan Hares (
  Zhiying Wang (
  Gerald Kunzmann ( 
  Peter Lee (
  David Lenrow (

Any other contributors:

  Julien Zhang (
  Rajeev Seth (
  Guofeng Shao (
  Yinben Xia (
  Wei Cao (

Planned deliverables

  • Described the project release package as OPNFV or open source upstream projects.
  1. Document on typical NFV use-cases for high-level functional abstraction
  2. Gap Analysis for OpenStack API and high level applicaitons
  3. Blueprint sent to OpenStack, e.g. "Congress" and more.
  • If project deliverables have multiple dependencies across other project categories, described linkage of the deliverables.

Proposed Release Schedule:

  • When is the first release planned? Q2 2015
  • Will this align with the current release cadence? Yes
requirements_projects/nemo.txt · Last modified: 2015/07/02 07:43 by Tianran Zhou