NeutronNorthbound: Boron Release Plan

Owned by Achuth Maniyedath
Jul 28, 2020

Introduction

Release Deliverables

NameDescription
org.opendaylight.neutron.neutron-spiInternal bundle implementing neutron data objects
org.opendaylight.neutron.transcriberInternal bundle implementing copying data from northbound to subscribers
org.opendaylight.neutron.northbound-apiBundle implementing Northbound API
org.opendaylight.neutron.modelBundle holding the Neutron yang models
org.opendaylight.neutron.neutron-loggerBundle that logs datatree-changes on Neutron yang models
org.opendaylight.neutron.utils (this name is tentative. TBD)Bundle that implementing common utilities
org.opendaylight.neutron.hostconfig.ovsedb (this name is tentative. TBD)Bundle implementing hostconfig with ovsdb
org.opendaylight.neutron.hostconfig.vpp (this name is tentative. TBD)Bundle implementing hostconfig with vpp

Featurewise list:

NameDescription
resource status reportODL reports status update of resource to neutron, nteworking-odl
QoS API updateupdate yang models for QoS API
TRUNK APITRUNK API(aka vlan-aware-vm api)
yang model: project-idadd project-id for tenant-id. add compatiblility logic for future deprecation of tenant-id.
yang mode update for Neutron changevarious minor yang model update to catch up to Neutron change
utility libraries for hostconfigvarious helper libraries to support hostconfig that will be utilized by openstack service provider.

Release Milestones

  • Offset: 1
MilestoneOffset 1 DateDeliverables
M110/27/2016
NameStatusDescription
Intent to participateDoneIntent to participate in Boron Simultaneous Release
Project Lead elected and project contactDoneProject/Test Lead election
documentation/test contactDoneselect document/test contact
Release PlanDoneCandidate Release Plan
M212/1/2016
NameStatusDescription
Release PlanDoneFinal Release Plan
System Test Waiveron-going
M31/19/2017
NameStatusDescription
Feature FreezeDone
Candidate Stable Distribution

Extension Distribution

M42/16/2017
NameDescription
API FreezeDone
Candidate Stable DistributionA running candidate of what is attempting to be the stable distribution to be blessed by the TSC.
Extension DistributionA running candidate of what is attempting to be the extension distribution.
M53/16/2017
NameDescription
Code FreezeDone
Candidate Stable DistributionA running candidate of what is attempting to be the stable distribution to be blessed by the TSC.
Extension DistributionA running candidate of what is attempting to be the extension distribution.
RC04/13/2017
NameDescription
Candidate Stable DistributionA running candidate of what is attempting to be the stable distribution to be blessed by the TSC.
Extension DistributionA running candidate of what is attempting to be the extension distribution.
RC14/20/2017
NameDescription
Candidate Stable DistributionA running candidate of what is attempting to be the stable distribution to be blessed by the TSC.
Extension DistributionA running candidate of what is attempting to be the extension distribution.
RC24/27/2017
NameDescription
Release ReviewRelease Review Description
Candidate Stable DistributionA running candidate of what is attempting to be the stable distribution to be blessed by the TSC.
Extension DistributionA running candidate of what is attempting to be the extension distribution.
RC35/4/2017
NameDescription
Release ReviewRelease Review Description
Candidate Stable DistributionA running candidate of what is attempting to be the stable distribution to be blessed by the TSC.
Extension DistributionA running candidate of what is attempting to be the extension distribution.
Formal Release5/11/2016
NameDescription
Deliverable NameDeliverable Description

Externally Consumable APIs

Short NameDescriptionType (at M2)Type (at M3)Type (release)ContractSupporting Code
TBDNorthboundInterface to OpenStack networking-odl

Openstack Networking Ref v2 Openstack Networking API v2.0 extensionsorg.opendaylight.neutron.northbound-api
MD-SAL yang models: To be updated





MD-SAL Networks ModelYANG model for Neutron NetworksProvisionalProvisionalProvisionalneutron-networks.yangorg.opendaylight.neutron.model
MD-SAL Subnet ModelYANG model for Neutron SubnetsProvisionalProvisionalProvisionalneutron-subnets.yangorg.opendaylight.neutron.model
MD-SAL Ports ModelYANG model for Neutron PortsProvisionalProvisionalProvisionalneutron-ports.yangorg.opendaylight.neutron.model
MD-SAL L3 ModelYANG model for Neutron Routers and Floating IPsProvisionalProvisionalProvisionalneutron-l3.yangorg.opendaylight.neutron.model
MD-SAL FWaaS ModelYANG model for Neutron Firewalls, Firewall Policies, Firewall RulesProvisionalProvisionalProvisionalneutron-fwaas.yangorg.opendaylight.neutron.model
MD-SAL LBaaS ModelYANG model for Neutron Load Balancer, Load Balancer Health Monitor, Load Balancer Listener, Load Balancer Pool, and Load Balancer Pool MemberProvisionalProvisionalProvisionalneutron-lbaas.yangorg.opendaylight.neutron.model
MD-SAL Metering ModelYANG model for Neutron Metering Label and Metering Label RuleProvisionalProvisionalProvisionalneutron-metering.yangorg.opendaylight.neutron.model
MD-SAL Security Group/Rule ModelYANG model for Neutron Security Group and Security RuleProvisionalProvisionalProvisionalneutron-secgroups.yangorg.opendaylight.neutron.model
MD-SAL VPNaaS ModelYANG model for Neutron VPN IKE Policy, VPN IPSEC Policy, VPN IPSEC Site Connection, VPN ServiceProvisionalProvisionalProvisionalneutron-vpnaas.yangorg.opendaylight.neutron.model
MD-SAL L2-gateway ModelYANG model for Neutron L2 Gateway, L2 Gateway ConnectionProvisionalProvisionalProvisionalneutron-l2gateways.yangorg.opendaylight.neutron.model
MD-SAL BGPVPN ModelYANG model for Neutron BGPVPNProvisionalProvisionalProvisionalneutron-bgpvpn.yangorg.opendaylight.neutron.model
Neutron HostConfig ModelYANG model for Neutron HostconfigProvisionalProvisionalProvisionalneutron-hostconfig.yangorg.opendaylight.neutron.model
Neutron QoS ModelYANG model for Neutron QoS APIProvisionalProvisionalProvisionalneutron-qos.yangorg.opendaylight.neutron.model
Neutron SFC ModelYANG model for Neutron SFC API (networking-sfc)ProvisionalProvisionalProvisionalneutron-sfc.yangorg.opendaylight.neutron.model
Neutron extension discovery ModelYANG model for Neutron extension discoveryProvisionalProvisionalProvisionalneutron-extension.yangorg.opendaylight.neutron.model
Neutron TRUNK API ModelYANG model for Neutron TRUNK APIN/AN/AProvisional(planned)neutron-trunk.yang(planned)org.opendaylight.neutron.model
Neutron yangmodel updatevarious update of neutron yang modelN/AN/AProvisional(planned)neutron-*.yang(planned)org.opendaylight.neutron.model
Neutron utilshelper functionsN/AN/Atentative(planned)
org.opendaylight.neutron.utils(planned)
Neutron hostconfig ovsdbhelper functions for hostconfig with ovsdbN/AN/Atentative(planned)
org.opendaylight.neutron.hostconfig.ovsdb(planned)
Neutron hostconfig vpphelper functions for hostconfig with vppN/AN/Atentative(planned)
org.opendaylight.neutron.hostconfig.vpp(planned)

Expected Dependencies on Other Projects

  • Depends on all other projects in Boron

Neutorn northbound project depends on the projects, odlparent, controller, md-sal, yangtools. But there is no new dependencies in Carbon.

Providing ProjectDescription
controllerbasic controller features
mdsalmdsal features
odlparentodlparent values
yangtoolsyangtools for compiling yang
ovsdb(and netvirt?)ovsdb network topology
netconfodl-netconf-clustered-topology

Expected Incompatibilities with Other Projects

new member as project id for tenant id. In Carbon cycle, tenant-id will be kept for compatibility. In Nitrogen cycle or later, project-id may be deprecated.

https://wiki.opendaylight.org/view/Weather#Neutron_Northbound:_rename_tenant-id_to_project-id

Top-level or User-facing Karaf Features

  • odl-neutron-service (Top Level, User Facing)
    • This feature provides the complete neutron northbound service

Planned Documentation

  • User/Operator Guide for odl-neutron-service feature
  • Developer Guides for odl-neutron-service features

Compatibility with Previous Releases

  • None intrinsic to distribution, projects delivered may have their own.

Themes and Priorities

  • carry over from Boron cycles
    • neutron HA support
    • support port binding well(hostconfig)
  • status report from ODL to networking-odl
  • TRUNK API
  • FWaaS v2 API
  • QoS API update
  • various model update to catch up neutron change

Requests from Other Projects

The following projects requested dependency on Neutorn Northbound

  • NetVirt

The followings are copied from Boron cycles.

  • GBP
  • Netvirt
  • VPNService
  • VTN

Test Tools Requirements

  • NN will be requesting a System Test exemption
  • NN system test cases are already included in the integration/test project tests that run as part of all jenkins jobs.

Other