You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@libcloud.apache.org by to...@apache.org on 2013/10/15 10:49:27 UTC

[2/2] git commit: docs: Update upgrade notes.

docs: Update upgrade notes.


Project: http://git-wip-us.apache.org/repos/asf/libcloud/repo
Commit: http://git-wip-us.apache.org/repos/asf/libcloud/commit/200d2361
Tree: http://git-wip-us.apache.org/repos/asf/libcloud/tree/200d2361
Diff: http://git-wip-us.apache.org/repos/asf/libcloud/diff/200d2361

Branch: refs/heads/trunk
Commit: 200d2361d2ad1b15489496694101441bfdc64a23
Parents: 9e9024c
Author: Tomaz Muraus <to...@apache.org>
Authored: Tue Oct 15 10:36:32 2013 +0200
Committer: Tomaz Muraus <to...@apache.org>
Committed: Tue Oct 15 10:48:06 2013 +0200

----------------------------------------------------------------------
 docs/upgrade_notes.rst | 165 ++++++++++++++++++++++++++++++++++----------
 1 file changed, 130 insertions(+), 35 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/libcloud/blob/200d2361/docs/upgrade_notes.rst
----------------------------------------------------------------------
diff --git a/docs/upgrade_notes.rst b/docs/upgrade_notes.rst
index 924d7c8..249b358 100644
--- a/docs/upgrade_notes.rst
+++ b/docs/upgrade_notes.rst
@@ -22,17 +22,18 @@ Amazon EC2 compute driver has moved to single class plus ``region`` argument
 model. As such, the following provider constants have been deprecated:
 
 * ``EC2_US_EAST``
+* ``EC2_US_WEST_OREGON``
 * ``EC2_EU``
 * ``EC2_EU_WEST``
 * ``EC2_AP_SOUTHEAST``
+* ``EC2_AP_SOUTHEAST2``
 * ``EC2_AP_NORTHEAST``
-* ``EC2_US_WEST_OREGON``
 * ``EC2_SA_EAST``
-* ``EC2_AP_SOUTHEAST2``
 
 And replaced with a single constants:
 
-* ``EC2`` - supported values for the ``region`` argument are: ``us-east-1``,
+* ``EC2`` - Default value for region argument is ``us-east-1``. Supported
+  values for the ``region`` argument are: ``us-east-1``,
   ``us-west-1``, ``us-west-2``, ``eu-west-1``, ``ap-southeast-1``,
   ``ap-northeast-1``, ``sa-east-1``, ``ap-southeast-2``.
 
@@ -55,8 +56,11 @@ Old code:
     from libcloud.compute.types import Provider
     from libcloud.compute.providers import get_driver
 
-    cls = get_driver(Provider.EC2_EU_WEST)
-    driver = cls('username', 'api_key')
+    cls1 = get_driver(Provider.EC2)
+    cls2 = get_driver(Provider.EC2_EU_WEST)
+
+    driver1 = cls('username', 'api_key')
+    driver2 = cls('username', 'api_key')
 
 New code:
 
@@ -66,7 +70,9 @@ New code:
     from libcloud.compute.providers import get_driver
 
     cls = get_driver(Provider.EC2)
-    driver = cls('username', 'api_key', region='eu-west-1')
+
+    driver1 = cls('username', 'api_key', region='us-east-1')
+    driver2 = cls('username', 'api_key', region='eu-west-1')
 
 Rackspace compute driver changes
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -77,10 +83,10 @@ model. As such, the following provider constants have been removed:
 * ``RACKSPACE``
 * ``RACKSPACE_UK``
 * ``RACKSPACE_AU``
-* ``RACKSPACE_NOVA_BETA``
+* ``RACKSPACE_NOVA_ORD``
 * ``RACKSPACE_NOVA_DFW``
 * ``RACKSPACE_NOVA_LON``
-* ``RACKSPACE_NOVA_ORD``
+* ``RACKSPACE_NOVA_BETA``
 
 And replaced with two new constants:
 
@@ -96,40 +102,41 @@ servers.
 If you want to preserve old behavior and use first-gen drivers you need to use
 ``RACKSPACE_FIRST_GEN`` provider constant.
 
-More examples which show how to update your code to work with a new version can
-be found bellow.
-
-Old code (connecting to a first-gen provider in the US):
-
-.. sourcecode:: python
+Because of the nature of this first-gen to next-gen change, old constants have
+been fully removed and unlike region changes in other driver, this change is not
+backward compatible.
 
-    from libcloud.compute.types import Provider
-    from libcloud.compute.providers import get_driver
+List which shows how old, first-gen classes map to a new ``region`` argument
+value:
 
-    cls = get_driver(Provider.RACKSPACE)
-    driver = cls('username', 'api_key')
+* ``RACKSPACE`` -> ``us``
+* ``RACKSPACE_UK`` -> ``uk``
 
-New code (connecting to a first-gen provider in the US):
+List which shows how old, next-gen classes map to a new ``region`` argument
+value:
 
-.. sourcecode:: python
+* ``RACKSPACE_NOVA_ORD`` -> ``ord``
+* ``RACKSPACE_NOVA_DFW`` -> ``dfw``
+* ``RACKSPACE_NOVA_LON`` -> ``lon``
+* ``RACKSPACE_AU`` -> ``syd``
 
-    from libcloud.compute.types import Provider
-    from libcloud.compute.providers import get_driver
-
-    cls = get_driver(Provider.RACKSPACE_FIRST_GEN)
-    driver = cls('username', 'api_key', region='us')
+More examples which show how to update your code to work with a new version can
+be found bellow.
 
-Old code (connecting to a first gen provider in the UK):
+Old code (connecting to a first-gen provider):
 
 .. sourcecode:: python
 
     from libcloud.compute.types import Provider
     from libcloud.compute.providers import get_driver
 
-    cls = get_driver(Provider.RACKSPACE_UK)
-    driver = cls('username', 'api_key')
+    cls1 = get_driver(Provider.RACKSPACE) # US regon
+    cls2 = get_driver(Provider.RACKSPACE_UK) # UK regon
 
-New code (connecting to a first-gen provider in the UK):
+    driver1 = cls('username', 'api_key')
+    driver2 = cls('username', 'api_key')
+
+New code (connecting to a first-gen provider):
 
 .. sourcecode:: python
 
@@ -137,19 +144,26 @@ New code (connecting to a first-gen provider in the UK):
     from libcloud.compute.providers import get_driver
 
     cls = get_driver(Provider.RACKSPACE_FIRST_GEN)
-    driver = cls('username', 'api_key', region='uk')
 
-Old code (connection to a next-gen provider using ``ORD`` region)
+    driver1 = cls('username', 'api_key', region='us')
+    driver2 = cls('username', 'api_key', region='uk')
+
+Old code (connecting to a next-gen provider)
 
 .. sourcecode:: python
 
     from libcloud.compute.types import Provider
     from libcloud.compute.providers import get_driver
 
-    cls = get_driver(Provider.RACKSPACE_NOVA_ORD)
-    driver = cls('username', 'api_key')
+    cls1 = get_driver(Provider.RACKSPACE_NOVA_ORD)
+    cls2 = get_driver(Provider.RACKSPACE_NOVA_DFW)
+    cls3 = get_driver(Provider.RACKSPACE_NOVA_LON)
+
+    driver1 = cls('username', 'api_key')
+    driver2 = cls('username', 'api_key')
+    driver3 = cls('username', 'api_key')
 
-New code (connection to a next-gen provider using ``ORD`` region)
+New code (connecting to a next-gen provider)
 
 .. sourcecode:: python
 
@@ -157,7 +171,10 @@ New code (connection to a next-gen provider using ``ORD`` region)
     from libcloud.compute.providers import get_driver
 
     cls = get_driver(Provider.RACKSPACE)
-    driver = cls('username', 'api_key', region='ord')
+
+    driver1 = cls('username', 'api_key', region='ord')
+    driver2 = cls('username', 'api_key', region='dfw')
+    driver3 = cls('username', 'api_key', region='lon')
 
 CloudStack Compute driver changes
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -202,6 +219,84 @@ New code:
     driver1 = cls1('username', 'api_key', region='dfw')
     driver2 = cls1('username', 'api_key', region='lon')
 
+Rackspace DNS driver changes
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Rackspace DNS driver has moved to one class plus ``region`` argument model. As
+such, the following provider constants have been deprecated:
+
+* ``RACKSPACE_US``
+* ``RACKSPACE_UK``
+
+And replaced with a single constant:
+
+* ``RACKSPACE`` - Default region is ``us``. Supported values for ``region``
+  arguments are ``us``, ``uk``.
+
+Old code:
+
+.. sourcecode:: python
+
+    from libcloud.dns.types import Provider
+    from libcloud.dns.providers import get_driver
+
+    cls1 = get_driver(Provider.RACKSPACE_US)
+    cls2 = get_driver(Provider.RACKSPACE_UK)
+
+    driver1 = cls1('username', 'api_key')
+    driver2 = cls1('username', 'api_key')
+
+New code:
+
+.. sourcecode:: python
+
+    from libcloud.dns.types import Provider
+    from libcloud.dns.providers import get_driver
+
+    cls = get_driver(Provider.RACKSPACE)
+
+    driver1 = cls1('username', 'api_key', region='us')
+    driver2 = cls1('username', 'api_key', region='uk')
+
+Rackspace LoadBalancer driver changes
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Rackspace loadbalancer driver has moved to one class plus ``region`` argument
+model. As such, the following provider constants have been deprecated:
+
+* ``RACKSPACE_US``
+* ``RACKSPACE_UK``
+
+And replaced with a single constant:
+
+* ``RACKSPACE`` - Default region is ``ord``. Supported values for ``region``
+  arguments are ``dfw``, ``ord``, ``iad``, ``lon``, ``syd``.
+
+Old code:
+
+.. sourcecode:: python
+
+    from libcloud.loadbalancer.types import Provider
+    from libcloud.loadbalancer.providers import get_driver
+
+    cls1 = get_driver(Provider.RACKSPACE_US)
+    cls2 = get_driver(Provider.RACKSPACE_UK)
+
+    driver1 = cls1('username', 'api_key')
+    driver2 = cls1('username', 'api_key')
+
+New code:
+
+.. sourcecode:: python
+
+    from libcloud.loadbalancer.types import Provider
+    from libcloud.loadbalancer.providers import get_driver
+
+    cls = get_driver(Provider.RACKSPACE)
+
+    driver1 = cls1('username', 'api_key', region='ord')
+    driver2 = cls1('username', 'api_key', region='lon')
+
 ScriptDeployment and ScriptFileDeployment constructor now takes args argument
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~