NeutronNorthbound: Lithium Release Plan

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

Release Milestones

  • Offset: 1
MilestoneOffset X DateDeliverables
M112/18/2014 (3/2/2015)
NameStatus
Intent to participateDone
Project Lead electedDone
Test Contact specifiedDone
Candidate Release PlanDone
M21/29/2015 (3/2/2015)
NameStatusDescription
Release PlanDoneFinal Release Plan
Project ChecklistDoneProject Checklist completed
OpenDaylight CIDoneOpenDaylight CI infrastructure usage for system test
M33/05/2015
NameStatusDescription
Functionality FreezeDoneFinal list of externally consumable APIs defined and documented
Karaf Features definedDoneKaraf feature defined
Documentation StartedDoneIdentified the kinds of documentation to be provided, created AsciiDoc files for them with outlines, and committed those files in an appropriate location

(patch)

Integration & System TestDone
  • Project must have completed User Facing Features wiki page (done, see below)
  • Start system test integration: Automate controller deployment, devices provisioning and system test run. (Done - CI will be handled by in project jenkins job)
M44/02/2015
NameStatusDescription
API Freeze
Final defined API
Documentation
Documentation: Project readouts MUST include a word count of each relevant .adoc file with a goal of draft documentation done.
Maven Central Requirements
Accomplished/Not Accomplished
Integration & System Test
Participating projects must run a simple system test on a karaf distribution with the project's recommended features installed on Code Merge
M54/30/2015
NameStatusDescription
Code Freeze

Stability branch
Stability branch stable/lithium, must be cut and local project versions bumped on master to avoid overwriting lithium SNAPSHOTS
String Freeze
All externally visible strings frozen to allow for translation & documentation
Documentation Complete
Only editing and and enhancing should take place after this point
Integration & System Test
The system test for each user-facing feature must be complete and should run on Code Merge
RC0N/A
NameStatus
Bug fixes
Release Candidate 0
RC1N/A
NameStatus
Bug fixes
Release Candidate 1
RC2N/A
NameStatus
Bug fixes
Release Candidate 2
RC3N/A
NameStatusDescription
Release Review
Participating Projects must hold their Release Reviews, including User Facing Documentation
Release Candidate 3

Formal Lithium ReleaseN/A
NameStatusDescription
Formal Lithium Release

Release Patch
Release patch to the stable/lithium branch and bump versions
SR1N/A
NameStatusDescription
First Service Release for Lithium

Release Patch
Release patch to the stable/lithium branch and bump versions
SR2N/A
NameStatusDescription
Second Service Release for Lithium

Release Patch
Release patch to the stable/lithium branch and bump versions

Externally Consumable APIs

  • OpenStack Neutron interface provided by northbound-api bundle for openstack ODL ML2 agent/plug-in (Stable)
     Openstack Networking Ref v2
  • I*Aware Interfaces provided by neutron-spi bundle for southbound providers (Stable)
  • Neutron data element yang model provided by neutron-model for southbound providers (Provisional)

Expected Incompatibilities with Other Projects

None

Compatibility with Previous Releases

Removed APIs and/or Functionality

No changes

Deprecated APIs and/or Functionality

All FWaaS related interfaces and classes are being marked as deprecated in Lithium.

Changed APIs and/or Functionality

Adding Neutron data element yang model


Neutron APIs provided in Helium are unchanged in Lithium, but have been moved to the Neutron repo created in Lithium's timeframe. All projects are expected to stop using the deprecated Neutron API in controller and begin using org.opendaylight.neutron. More info in this work is provided here.

User Facing Karaf Features List

https://git.opendaylight.org/gerrit/gitweb?p=neutron.git;a=blob;f=features/src/main/features/features.xml;h=e54a8068d41e81e9075512e980682c1b39be55fc;hb=HEAD

https://git.opendaylight.org/gerrit/16144

NeutronNorthbound:Lithium_Lithium_User_Facing_Features

Expected Dependencies on Other Projects

Neutron Northbound will depend on

  • odlparent for configuration and property handling
  • yangtools and controller for holding Neutron Yang Model

Test Tools Requirements

  • OpenStack CI testing breaks into two parts:
    1. stable ODL/unstable OpenStack testing is the responsibility of downstream implementing projects.
    2. stable OpenStack/unstable ODL testing will be handled by ODL integration team
  • Other testing will intend to be using OpenDaylight Test System