.. Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. Convention for heading levels in Neutron devref: ======= Heading 0 (reserved for the title in a document) ------- Heading 1 ~~~~~~~ Heading 2 +++++++ Heading 3 ''''''' Heading 4 (Avoid deeper levels because they do not render well.) 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 exist under the Neutron project is: http://governance.openstack.org/reference/projects/neutron.html 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. This list may contain projects that are already listed in the governance repo but are summarized here to describe the functionality they provide. +-------------------------------+-----------------------+ | Name | Functionality | +===============================+=======================+ | dragonflow_ | l3 | +-------------------------------+-----------------------+ | group-based-policy_ | intent | +-------------------------------+-----------------------+ | kuryr_ | docker | +-------------------------------+-----------------------+ | networking-ale-omniswitch_ | ml2 | +-------------------------------+-----------------------+ | networking-arista_ | ml2,l3 | +-------------------------------+-----------------------+ | networking-bagpipe-l2_ | ml2 | +-------------------------------+-----------------------+ | networking-bgpvpn_ | vpn | +-------------------------------+-----------------------+ | networking-bigswitch_ | ml2,core,l3 | +-------------------------------+-----------------------+ | networking-brocade_ | ml2,l3 | +-------------------------------+-----------------------+ | networking-calico_ | ml2 | +-------------------------------+-----------------------+ | networking-cisco_ | core,ml2,l3,fw,vpn | +-------------------------------+-----------------------+ | networking-edge-vpn_ | vpn | +-------------------------------+-----------------------+ | networking-fujitsu_ | ml2 | +-------------------------------+-----------------------+ | networking-hyperv_ | ml2 | +-------------------------------+-----------------------+ | networking-ibm_ | ml2,l3 | +-------------------------------+-----------------------+ | networking-l2gw_ | l2 | +-------------------------------+-----------------------+ | networking-midonet_ | core,lb | +-------------------------------+-----------------------+ | networking-mlnx_ | ml2 | +-------------------------------+-----------------------+ | networking-nec_ | core | +-------------------------------+-----------------------+ | nuage-openstack-neutron_ | core | +-------------------------------+-----------------------+ | networking-odl_ | ml2,l3,lb,fw | +-------------------------------+-----------------------+ | networking-ofagent_ | ml2 | +-------------------------------+-----------------------+ | networking-onos_ | ml2 | +-------------------------------+-----------------------+ | networking-ovn_ | ml2 | +-------------------------------+-----------------------+ | networking-ovs-dpdk_ | ml2 | +-------------------------------+-----------------------+ | networking-plumgrid_ | core | +-------------------------------+-----------------------+ | networking-portforwarding_ | l3 | +-------------------------------+-----------------------+ | neutron-powervm_ | ml2 | +-------------------------------+-----------------------+ | networking-sfc_ | service composition | +-------------------------------+-----------------------+ | networking-vsphere_ | ml2 | +-------------------------------+-----------------------+ | vmware-nsx_ | core | +-------------------------------+-----------------------+ | octavia_ | lb | +-------------------------------+-----------------------+ Functionality legend ++++++++++++++++++++ - l2: a Layer 2 service; - ml2: an ML2 mechanism driver; - core: a monolithic plugin that can implement API at multiple layers L3-L7; - l3: a Layer 3 service plugin; - fw: a Firewall service plugin; - vpn: a VPN service plugin; - lb: a Load Balancer service plugin; - intent: a service plugin that provides a declarative API to realize networking; - docker: a Docker network plugin that uses Neutron to provide networking services to Docker containers; .. _networking-ale-omniswitch: ALE Omniswitch ++++++++++++++ * Git: https://git.openstack.org/cgit/openstack/networking-ale-omniswitch * Launchpad: https://launchpad.net/networking-ale-omniswitch * Pypi: https://pypi.python.org/pypi/networking-ale-omniswitch .. _networking-arista: Arista ++++++ * Git: https://git.openstack.org/cgit/openstack/networking-arista * Launchpad: https://launchpad.net/networking-arista * Pypi: https://pypi.python.org/pypi/networking-arista .. _networking-bagpipe-l2: BaGPipe +++++++ * Git: https://git.openstack.org/cgit/stackforge/networking-bagpipe-l2 * Launchpad: https://launchpad.net/bagpipe-l2 * Pypi: https://pypi.python.org/pypi/bagpipe-l2 .. _networking-bgpvpn: BGPVPN ++++++ * Git: https://git.openstack.org/cgit/openstack/networking-bgpvpn .. _networking-bigswitch: Big Switch Networks +++++++++++++++++++ * Git: https://git.openstack.org/cgit/stackforge/networking-bigswitch * Pypi: https://pypi.python.org/pypi/bsnstacklib .. _networking-brocade: Brocade +++++++ * Git: https://git.openstack.org/cgit/stackforge/networking-brocade * Launchpad: https://launchpad.net/networking-brocade * PyPI: https://pypi.python.org/pypi/networking-brocade .. _networking-calico: Calico ++++++ * Git: https://git.openstack.org/cgit/openstack/networking-calico * Launchpad: https://launchpad.net/networking-calico .. _networking-cisco: Cisco +++++ * Git: https://git.openstack.org/cgit/openstack/networking-cisco * Launchpad: https://launchpad.net/networking-cisco * PyPI: https://pypi.python.org/pypi/networking-cisco .. _dragonflow: DragonFlow ++++++++++ * Git: https://git.openstack.org/cgit/openstack/dragonflow * Launchpad: https://launchpad.net/dragonflow * PyPi: https://pypi.python.org/pypi/DragonFlow .. _networking-edge-vpn: Edge VPN ++++++++ * Git: https://git.openstack.org/cgit/stackforge/networking-edge-vpn * Launchpad: https://launchpad.net/edge-vpn .. _networking-fujitsu: FUJITSU +++++++ * Git: https://git.openstack.org/cgit/openstack/networking-fujitsu * Launchpad: https://launchpad.net/networking-fujitsu * PyPI: https://pypi.python.org/pypi/networking-fujitsu .. _networking-hyperv: Hyper-V +++++++ * Git: https://git.openstack.org/cgit/stackforge/networking-hyperv * Launchpad: https://launchpad.net/networking-hyperv * PyPi: https://pypi.python.org/pypi/networking-hyperv .. _group-based-policy: Group Based Policy ++++++++++++++++++ * Git: https://git.openstack.org/cgit/stackforge/group-based-policy * Launchpad: https://launchpad.net/group-based-policy * PyPi: https://pypi.python.org/pypi/group-based-policy .. _networking-ibm: IBM SDNVE +++++++++ * Git: https://git.openstack.org/cgit/stackforge/networking-ibm * Launchpad: https://launchpad.net/networking-ibm .. _kuryr: Kuryr +++++ * Git: https://git.openstack.org/cgit/openstack/kuryr/ * Launchpad: https://launchpad.net/kuryr * PyPI: https://pypi.python.org/pypi/kuryr/ .. _networking-l2gw: L2 Gateway ++++++++++ * Git: https://git.openstack.org/cgit/openstack/networking-l2gw * Launchpad: https://launchpad.net/networking-l2gw .. _networking-midonet: MidoNet +++++++ * Git: https://git.openstack.org/cgit/openstack/networking-midonet * Launchpad: https://launchpad.net/networking-midonet * PyPI: https://pypi.python.org/pypi/networking-midonet .. _networking-mlnx: Mellanox ++++++++ * Git: https://git.openstack.org/cgit/stackforge/networking-mlnx * Launchpad: https://launchpad.net/networking-mlnx .. _networking-nec: NEC +++ * Git: https://git.openstack.org/cgit/stackforge/networking-nec * Launchpad: https://launchpad.net/networking-nec * PyPI: https://pypi.python.org/pypi/networking-nec .. _nuage-openstack-neutron: Nuage +++++ * Git: https://github.com/nuage-networks/nuage-openstack-neutron .. _networking-odl: OpenDayLight ++++++++++++ * Git: https://git.openstack.org/cgit/openstack/networking-odl * Launchpad: https://launchpad.net/networking-odl .. _networking-ofagent: OpenFlow Agent (ofagent) ++++++++++++++++++++++++ * Git: https://git.openstack.org/cgit/openstack/networking-ofagent * Launchpad: https://launchpad.net/networking-ofagent * PyPI: https://pypi.python.org/pypi/networking-ofagent .. _networking-onos: Open Network Operating System (onos) ++++++++++++++++++++++++++++++++++++ * Git: https://git.openstack.org/cgit/openstack/networking-onos * Launchpad: https://launchpad.net/networking-onos * PyPI: https://pypi.python.org/pypi/networking-onos .. _networking-ovn: Open Virtual Network ++++++++++++++++++++ * Git: https://git.openstack.org/cgit/openstack/networking-ovn * Launchpad: https://launchpad.net/networking-ovn * PyPI: https://pypi.python.org/pypi/networking-ovn .. _networking-ovs-dpdk: Open DPDK +++++++++ * Git: https://git.openstack.org/cgit/stackforge/networking-ovs-dpdk * Launchpad: https://launchpad.net/networking-ovs-dpdk .. _networking-plumgrid: PLUMgrid ++++++++ * Git: https://git.openstack.org/cgit/openstack/networking-plumgrid * Launchpad: https://launchpad.net/networking-plumgrid * PyPI: https://pypi.python.org/pypi/networking-plumgrid .. _neutron-powervm: PowerVM +++++++ * Git: https://git.openstack.org/cgit/stackforge/neutron-powervm * Launchpad: https://launchpad.net/neutron-powervm * PyPI: https://pypi.python.org/pypi/neutron-powervm .. _networking-portforwarding: PortForwarding ++++++++++++++ * Git: https://git.openstack.org/cgit/stackforge/networking-portforwarding * Launchpad: https://launchpad.net/networking-portforwarding .. _networking-sfc: SFC +++ * Git: https://git.openstack.org/cgit/openstack/networking-sfc .. _networking-vsphere: vSphere +++++++ * Git: https://git.openstack.org/cgit/openstack/networking-vsphere * Launchpad: https://launchpad.net/networking-vsphere .. _vmware-nsx: VMware NSX ++++++++++ * Git: https://git.openstack.org/cgit/openstack/vmware-nsx * Launchpad: https://launchpad.net/vmware-nsx * PyPI: https://pypi.python.org/pypi/vmware-nsx .. _octavia: Octavia +++++++ * Git: https://git.openstack.org/cgit/openstack/octavia * Launchpad: https://launchpad.net/octavia