Neutron Northbound

Owned by Casey Cain
Last updated: Sept 30, 2020 by Achuth Maniyedath
2 min read

Welcome to Neutron Northbound

Project Facts

Project Creation Date: Feb 12, 2015 
Primary Contact: @Achuth Maniyedath
Project Lead:  @Achuth Maniyedath
Committers:  

  • @Achuth Maniyedath

Mailing List:  
Meetings: See Community Meetings 

IRC: #opendaylight-neutron on freenode (Northbound meeting)

Repository: https://git.opendaylight.org/gerrit/admin/repos/neutron
Jenkins: https://jenkins.opendaylight.org/releng/view/neutron/
OpenBugs: https://jira.opendaylight.org/browse/NEUTRON-207?jql=project%20%3D%20neutron%20AND%20resolution%20%3D%20Unresolved%20



Introduction

The neutron northbound project is focused on the communication from the ODL drivers in OpenStack to the ODL neutron service and saves the neutron models into ODL data store for other providers to use. It does not include direct manipulation of low-level network/overlay elements - these are left to the providers that receive information from this project

The goals of this project are

  1. To allow the ODL neutron service to evolve in tandem with the evolution of Neutron APIs in OpenStack.

  2. Maintain the transparency of the current communication between OpenStack and OpenDaylight.

  3. Improve on the current method of passing neutron information to multiple providers.

  4. Attract more developer involvement.

Documentation

Getting Started for Developers

The project comprises of the following packages

  • odl-neutron-service  : This is a top level feature to load Neutron northbound functionality.

  • odl-neutron-northbound-spi : Provides REST API for OpenStack Neutron

  • odl-neutron-spi : Provides the SPI Neutron Northbound feature

  • odl--neutron-transcriber : data converter from/to REST API to/from MD_SAL  YANG model

  • odl-neutron-hostconfig-ovs : Helper library to support hostconfig for OpenStack service provider with Open vSwitch

  • odl-neutron-hostconfig-vpp : Helper library to support hostconfig for OpenStack service provider with VPP

  • odl-neutron-logger :  Logger on activity on Neutron YANG models

Architecture

https://docs.opendaylight.org/en/latest/developer-guide/neutron-service-developer-guide.html

Adding new neutron API support

https://docs.opendaylight.org/en/latest/developer-guide/neutron-northbound.html

Requirements

Related OpenStack resources

Release Planning

Release Notes

Previous release reference