Difference between revisions of "Neutron/LibraryAPIBreakage"

Revision as of 16:17, 10 March 2015

This page is expected to capture all the relevant information about potential and real neutron library API breakages that go merged in the tree.

History

Neutron started to spin out both advanced services (LBaaS, VPNaaS, FWaaS) and vendor plugins and ml2 drivers into separate git repositories in Kilo. Code that was already split out still uses lots of symbols from neutron.* namespace, assuming neutron is a library with stable API. It's not really the case, and so there may be changes in the tree that will break external code (*aas, vendor libraries) that use those symbols.

The idea is to eventually stabilize some parts of neutron tree and convert them into a public library with some kind of API stability guarantees. That said, it's not going to happen immediately, so breakages are expected in the short term.

Breakages

Date	Patch that causes breakage	Brief description of the change	Possible solutions	Severity
TBD	In review	switches to oslo.log, removes neutron.openstack.common.log	a) switch to oslo.log; b) copy log module into your tree and use it (may not work due to conflicts between the module and oslo.log configuration options)	High (most CI systems are affected)

@@ Line 10: / Line 10: @@
 {| class="wikitable"
 |-
-! Date !! Patch !! Brief description of the change !! Possible solutions || Severity
+! Date !! Patch that causes breakage !! Brief description of the change !! Possible solutions || Severity
 |-
 | TBD || [https://review.openstack.org/159638 In review] || switches to oslo.log, removes neutron.openstack.common.log || a) switch to oslo.log; b) copy log module into your tree and use it (may not work due to conflicts between the module and oslo.log configuration options) || High (most CI systems are affected)