neutron/doc/source/stadium/sub_projects.rst
Russell Bryant e9e773ca81 stadium: Update list of Neutron sub-projects.
Update the list of Neutron sub-projects to make it clear which ones are
currently under the Neutron team under OpenStack governance.  No changes are
made here.  It only updates this document to reflect projects.yaml in the
governance repository.

Change-Id: I4a96a9d66689a1eca0e202f1f1365236f47b9da1
Signed-off-by: Russell Bryant <rbryant@redhat.com>
2016-02-04 16:38:49 -05:00

16 KiB

Official Sub-Projects

Neutron has a set of official sub-projects. These projects are recognized as a part of the overall Neutron project.

Inclusion Process

The process for proposing a repo into openstack/ and under the Neutron project is to propose a patch to the openstack/governance repository. For example, to propose networking-foo, one would add the following entry under Neutron in reference/projects.yaml:

- repo: openstack/networking-foo
  tags:
    - name: release:independent

For more information about the release:independent tag (and other currently defined tags) see:

http://governance.openstack.org/reference/tags/

The Neutron PTL must approve the change. The TC clarified that once a project has been approved (Neutron in this case), the project can add additional repos without needing TC approval as long as the added repositories are within the existing approved scope of the project.

http://git.openstack.org/cgit/openstack/governance/commit/?id=321a020cbcaada01976478ea9f677ebb4df7bd6d

In order to create a project, in case it does not exist, follow steps as explained in:

http://docs.openstack.org/infra/manual/creators.html

Responsibilities

All affected repositories already have their own review teams. The sub-team working on the sub-project is entirely responsible for day-to-day development. That includes reviews, bug tracking, and working on testing.

By being included, the project accepts oversight by the TC as a part of being in OpenStack, and also accepts oversight by the Neutron PTL.

It is also assumed the respective review teams will make sure their projects stay in line with current best practices.

Inclusion Criteria

As mentioned before, the Neutron PTL must approve the inclusion of each additional repository under the Neutron project. That evaluation will be primarily based on the new project requirements used for all new OpenStack projects for the criteria that is applicable:

http://governance.openstack.org/reference/new-projects-requirements.html

Official Sub-Project List

The official source of all repositories that are a part of Neutron or another official OpenStack project team is here:

http://governance.openstack.org/reference/projects/neutron.html

We list the Neutron repositories, as well as other Neutron affiliated projects here to provide references and note the functionality they provide.

Functionality legend

  • base: the base Neutron platform
  • client: API client implementation
  • core: a monolithic plugin that can implement API at multiple layers L3-L7;
  • dashboard: Horizon dashboard integration
  • docker: a Docker network plugin that uses Neutron to provide networking services to Docker containers;
  • fw: a Firewall service plugin;
  • intent: a service plugin that provides a declarative API to realize networking;
  • ipam: an IP address management driver;
  • l2: a Layer 2 service;
  • l3: a Layer 3 service plugin;
  • lb: a Load Balancer service plugin;
  • ml2: an ML2 mechanism driver;
  • sfc; traffic steering based on traffic classification
  • vpn: a VPN service plugin;

Neutron projects

This table shows the list of official Neutron repositories and their functionality.

Name Functionality
dragonflow core
kuryr docker
networking-ale-omniswitch ml2
networking-arista ml2,l3
networking-bagpipe ml2
networking-bgpvpn vpn
networking-calico ml2
networking-cisco core,ml2,l3,fw,vpn
networking-fujitsu ml2
networking-hyperv ml2
networking-infoblox ipam
networking-l2gw l2
networking-midonet core,ml2,l3,lb,fw
networking-odl ml2,l3,lb,fw
networking-ofagent ml2
networking-onos ml2,l3
networking-ovn core
networking-plumgrid core
networking-powervm ml2
networking-sfc sfc
networking-vsphere ml2
neutron base,l2,ml2,core,l3
neutron-lbaas lb
neutron-lbaas-dashboard dashboard
neutron-fwaas fw
neutron-lib base
neutron-vpnaas vpn
octavia lb
python-neutronclient client
vmware-nsx core

Affiliated projects

This table shows the affiliated projects that integrate with Neutron, in one form or another. These projects typically leverage the pluggable capabilities of Neutron, the Neutron API, or a combination of both.

Name Functionality
networking-bigswitch ml2,core,l3
networking-brocade ml2,l3
networking-edge-vpn vpn
networking-mlnx ml2
networking-nec core
nuage-openstack-neutron core
networking-ovs-dpdk ml2

ALE Omniswitch

Arista

BaGPipe

BGPVPN

Big Switch Networks

Brocade

Calico

Cisco

DragonFlow

Edge VPN

FUJITSU

Hyper-V

Infoblox

Kuryr

L2 Gateway

MidoNet

Mellanox

NEC

Neutron

Neutron Client

Neutron FWaaS

Neutron LBaaS

Neutron LBaaS Dashboard

Neutron Library

Neutron VPNaaS

Nuage

OpenDayLight

OpenFlow Agent (ofagent)

Open Network Operating System (onos)

Open Virtual Network

Open DPDK

PLUMgrid

PowerVM

SFC

vSphere

VMware NSX

Octavia