summaryrefslogtreecommitdiff
path: root/doc/source
diff options
context:
space:
mode:
authorRichard Theis <rtheis@us.ibm.com>2016-03-30 08:31:12 -0500
committerRichard Theis <rtheis@us.ibm.com>2016-04-07 10:16:08 -0500
commit3faf02f6ca119ddbbecb2e4917384764ff229448 (patch)
tree65af8ddef7832043f18689491061fd5ff02d3af7 /doc/source
parent939981891df75841ab632635861b01d3e9a9f086 (diff)
downloadpython-neutronclient-3faf02f6ca119ddbbecb2e4917384764ff229448.tar.gz
Devref: Newton updates for transition to OSC
Update the "Transition to OpenStack Client" devref with the plan for handling network resources in Newton. In particular, this update clarifies the OpenStack project where the commands will reside. This update attempts to capture some of the information in [1] and to address packaging concerns. [1] https://etherpad.openstack.org/p/osc-neutron-support Change-Id: I95e579ab23377a6cf36fc7a50356ab406d350053 Related-Bug: #1521291
Diffstat (limited to 'doc/source')
-rw-r--r--doc/source/devref/transition_to_osc.rst35
1 files changed, 14 insertions, 21 deletions
diff --git a/doc/source/devref/transition_to_osc.rst b/doc/source/devref/transition_to_osc.rst
index 0ac2c90..5dcf67e 100644
--- a/doc/source/devref/transition_to_osc.rst
+++ b/doc/source/devref/transition_to_osc.rst
@@ -154,16 +154,16 @@ only with feature requests only being made to the ``openstack`` CLI.
+---------------------------+-------------------+-------------------------------------------------+
| Networking Commands | OSC Plugin | OpenStack Project for ``openstack`` Commands |
+===========================+===================+=================================================+
-| Core (Stable) | No | python-openstackclient |
+| Core | No | python-openstackclient |
+---------------------------+-------------------+-------------------------------------------------+
-| Core (New/Experimental) | Yes | python-neutronclient |
-| | | (with possible move to python-openstackclient) |
+| LBaaS v2 | Yes | python-neutronclient |
+| | | (under ``neutronclient/osc/v2/lbaas``) |
+---------------------------+-------------------+-------------------------------------------------+
-| LBaaS v2 | Yes | neutron-lbaas |
+| VPNaaS v2 | Yes | python-neutronclient |
+| | | (under ``neutronclient/osc/v2/vpnaas``) |
+---------------------------+-------------------+-------------------------------------------------+
-| VPNaaS v2 | Yes | neutron-vpnaas |
-+---------------------------+-------------------+-------------------------------------------------+
-| FWaaS v2 | Yes | neutron-fwaas |
+| FWaaS v2 | Yes | python-neutronclient |
+| | | (under ``neutronclient/osc/v2/fwaas``) |
+---------------------------+-------------------+-------------------------------------------------+
| LBaaS v1 | N/A | None (deprecated) |
+---------------------------+-------------------+-------------------------------------------------+
@@ -173,21 +173,14 @@ only with feature requests only being made to the ``openstack`` CLI.
+---------------------------+-------------------+-------------------------------------------------+
-The following network resources are part of the "Core (Stable)" group:
-
-- availability zone
-- extension
-- floating ip
-- network
-- port
-- quota
-- rbac
-- router
-- security group
-- security group rule
-- subnet
-- subnet pool
+**Important:** The actual name of the command object and/or action in OSC may differ
+from those used by neutron in order to follow the OSC command structure and to avoid
+name conflicts. Developers should get new command objects and actions approved by
+the OSC team before proceeding with the implementation.
+The "Core" group includes network resources that provide ``neutron`` project features
+(i.e. not advanced service or other features). Examples in the "Core" group include:
+network, subnet, port, etc.
When adding or updating an ``openstack`` networking command to
python-openstackclient, changes may first be required to the