openstack/nova-specs
Code Issues Proposed changes

Clarify the process for moving the v2 code

Browse Source 
The previous spec proposed using a directory for the deprecated v2 code
named 'legacy-v2', but module names cannot include hyphens, so this
changes the proposed name to 'legacy_v2'. There is also some additional
comments added about the need to preserve the current APIRouter* class
names until they can be changed in api-paste.ini so that upgrades won't
break existing deployments.

Change-Id: I4f770f3ec74bd136abc3ab5d1c60ef0de670e694
This commit is contained in:
EdLeafe
2015-06-19 10:02:38 -05:00
parent 0602ec5538
commit 5b7790b669
1 changed files with 8 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
specs/liberty/approved/nova-api-remove-v3.rst
View File

@@ -50,7 +50,7 @@ is an example with some key data, not the entire set of moves):
::
nova/api/openstack/
compute/ - all the os compute api
legacy-v2/ - the entry point for all the v2 code. This will
legacy_v2/ - the entry point for all the v2 code. This will
make it easier to remove in the future
servers.py - the v2.1 servers implementation
@@ -82,7 +82,7 @@ where things fit in the REST strucuture.
* Move the V2 API code which is currently under
``nova/api/openstack/compute`` and
``nova/api/openstack/compute/contrib`` into
``nova/api/openstack/compute/legacy-v2``. The 'V2' API will be
``nova/api/openstack/compute/legacy_v2``. The 'V2' API will be
deprecated in the future.
* The Nova V2.1 REST API refers to the new Nova REST API with
Microversion. The evolution of v2.1 will be done by Microversion in
@@ -98,6 +98,9 @@ where things fit in the REST strucuture.
* Restructure the code on disk for the v2.1 code to more accurately
reflect the REST uri structure of the resources those components
represent.
* Note that existing api-paste.ini files refer to the `APIRouter` and
`APIRouterV21` classes. We will have to maintain these names so that when
people upgrade we don't break things.
Alternatives
------------
@@ -160,7 +163,9 @@ Primary assignee:
Work Items
----------
* Move all V2 code under 'v2' directory.
* Move all V2 code under 'legacy_v2' directory.
* Update all existing references to 'nova.api.openstack.compute' to point to
'nova.api.openstack.compute.legacy_v2' instead.
* Move all V2.1 code to the toplevel directory.
* Move V2.1's json-schema out of v3 directory.
* Remove v3 endpoint from api-paste.ini.