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/12/09 13:23:44 UTC

[1/5] git commit: docs: Also document VolumeSnapshot class.

Updated Branches:
  refs/heads/trunk b6cb0699f -> 9e4397034


docs: Also document VolumeSnapshot class.


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

Branch: refs/heads/trunk
Commit: 03f962c1497c490c781fc435c2d5edffa2f73c86
Parents: b6cb069
Author: Tomaz Muraus <to...@apache.org>
Authored: Sun Dec 8 23:28:46 2013 +0100
Committer: Tomaz Muraus <to...@apache.org>
Committed: Sun Dec 8 23:28:46 2013 +0100

----------------------------------------------------------------------
 docs/compute/api.rst | 3 +++
 1 file changed, 3 insertions(+)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/libcloud/blob/03f962c1/docs/compute/api.rst
----------------------------------------------------------------------
diff --git a/docs/compute/api.rst b/docs/compute/api.rst
index 334f463..eec1504 100644
--- a/docs/compute/api.rst
+++ b/docs/compute/api.rst
@@ -25,6 +25,9 @@ Compute Base API
 .. autoclass:: libcloud.compute.base.StorageVolume
     :members:
 
+.. autoclass:: libcloud.compute.base.VolumeSnapshot
+    :members:
+
 .. autoclass:: libcloud.compute.types.NodeState
     :members:
 


[2/5] git commit: docs: Use ":class:" when referencing a class in the terminology section.

Posted by to...@apache.org.
docs: Use ":class:" when referencing a class in the terminology section.


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

Branch: refs/heads/trunk
Commit: 1e66bb4c58beba70ba49f35314da8342d54dc421
Parents: 03f962c
Author: Tomaz Muraus <to...@apache.org>
Authored: Sun Dec 8 23:29:02 2013 +0100
Committer: Tomaz Muraus <to...@apache.org>
Committed: Sun Dec 8 23:29:02 2013 +0100

----------------------------------------------------------------------
 docs/compute/index.rst      | 26 ++++++++++++++++----------
 docs/dns/index.rst          | 12 ++++++------
 docs/loadbalancer/index.rst | 10 ++++++----
 docs/storage/index.rst      | 11 ++++++-----
 4 files changed, 34 insertions(+), 25 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/libcloud/blob/1e66bb4c/docs/compute/index.rst
----------------------------------------------------------------------
diff --git a/docs/compute/index.rst b/docs/compute/index.rst
index 836925b..e142522 100644
--- a/docs/compute/index.rst
+++ b/docs/compute/index.rst
@@ -22,20 +22,26 @@ Terminology
 Compute
 ~~~~~~~
 
-* **Node** - represents a cloud or virtual server.
-* **NodeSize** - represents node hardware configuration. Usually this is amount
-  of the available RAM, bandwidth, CPU speed and disk size. Most of the drivers
-  also expose hourly price (in dollars) for the Node of this size.
-* **NodeImage** - represents an operating system image.
-* **NodeLocation** - represents a physical location where a server can be.
-* **NodeState** - represents a node state. Standard states are: ``running``,
-  ``stopped``, ``rebooting``, ``terminated``, ``pending``, and ``unknown``.
+* :class:`~libcloud.compute.base.Node` - represents a cloud or virtual server.
+* :class:`~libcloud.compute.base.NodeSize` - represents node hardware
+  configuration. Usually this is amount of the available RAM, bandwidth,
+  CPU speed and disk size. Most of the drivers also expose an hourly price
+  (in dollars) for the Node of this size.
+* :class:`~libcloud.compute.base.NodeImage` - represents an operating system
+  image.
+* :class:`~libcloud.compute.base.NodeLocation` - represents a physical location
+  where a server can be.
+* :class:`~libcloud.compute.types.NodeState` - represents a node state.
+  Standard states are: ``running``, ``stopped``, ``rebooting``, ``terminated``,
+  ``pending``, and ``unknown``.
 
 Block Storage
 ~~~~~~~~~~~~~
 
-* **StorageVolume** - represents a block storage volume
-* **VolumeSnapshot** - represents a point in time snapshot of a StorageVolume
+* :class:`~libcloud.compute.base.StorageVolume` - represents a block storage
+  volume
+* :class:`~libcloud.compute.base.VolumeSnapshot` - represents a point in time
+  snapshot of a StorageVolume
 
 Supported Providers
 -------------------

http://git-wip-us.apache.org/repos/asf/libcloud/blob/1e66bb4c/docs/dns/index.rst
----------------------------------------------------------------------
diff --git a/docs/dns/index.rst b/docs/dns/index.rst
index 7580cfe..3f9af19 100644
--- a/docs/dns/index.rst
+++ b/docs/dns/index.rst
@@ -11,16 +11,16 @@ Rackspace Cloud DNS and others.
 Terminology
 -----------
 
-* **Zone** - Represents a DNS zone or so called domain.
-* **Record** - Represents a DNS record. Each record belongs to a Zone and has
-  a ``type`` and ``data`` attribute. Value of the ``data`` attribute depends on
-  the record type.
+* :class:`~libcloud.dns.base.Zone` - Represents a DNS zone or so called domain.
+* :class:`~libcloud.dns.base.Record` - Represents a DNS record. Each record
+  belongs to a Zone and has a ``type`` and ``data`` attribute. Value of the
+  ``data`` attribute depends on the record type.
   Some record types also require user to associate additional attributes with
   them. Those additional attributes are stored in the ``extra`` attribute
   (dictionary) on the record object. An example include ``MX`` and ``SRV``
   record type which also contains a priority.
-* **RecordType** - Represents a DNS record type (``A``, ``AAAA``, ``MX``,
-  ``TXT``, ``SRV``, ``PTR``, ``NS``, etc.)
+* :class:`~libcloud.dns.types.RecordType` - Represents a DNS record type
+  (``A``, ``AAAA``, ``MX``, ``TXT``, ``SRV``, ``PTR``, ``NS``, etc.)
 * **Zone Type** - Each zone has a ``type`` attribute. This attribute represents
   a zone type. Type can either be ``master`` (also called primary) or ``slave``
   (also called secondary).

http://git-wip-us.apache.org/repos/asf/libcloud/blob/1e66bb4c/docs/loadbalancer/index.rst
----------------------------------------------------------------------
diff --git a/docs/loadbalancer/index.rst b/docs/loadbalancer/index.rst
index f432017..fd68114 100644
--- a/docs/loadbalancer/index.rst
+++ b/docs/loadbalancer/index.rst
@@ -12,10 +12,12 @@ Balancers.
 Terminology
 -----------
 
-* **LoadBalancer** - represents a load balancer instance.
-* **Member** - represents a load balancer member.
-* **Algorithm** - represents a load balancing algorithm (round-robin, random,
-  least connections, etc.).
+* :class:`~libcloud.loadbalancer.base.LoadBalancer` - represents a load
+  balancer instance.
+* :class:`~libcloud.loadbalancer.base.Member` - represents a load balancer
+  member.
+* :class:`~libcloud.loadbalancer.base.Algorithm` - represents a load balancing
+  algorithm (round-robin, random, least connections, etc.).
 
 Supported Providers
 -------------------

http://git-wip-us.apache.org/repos/asf/libcloud/blob/1e66bb4c/docs/storage/index.rst
----------------------------------------------------------------------
diff --git a/docs/storage/index.rst b/docs/storage/index.rst
index fe1042d..4eba053 100644
--- a/docs/storage/index.rst
+++ b/docs/storage/index.rst
@@ -15,11 +15,12 @@ CDN management functionality.
 Terminology
 -----------
 
-* **Object** - represents an object or so called BLOB.
-* **Container** - represents a container which can contain multiple objects.
-  You can think of it as a folder on a file system. Difference between
-  container and a folder on file system is that containers cannot be nested.
-  Some APIs and providers (e.g. AWS) refer to it as a Bucket.
+* :class:`~libcloud.storage.base.Container` - represents a container which can
+  contain multiple objects. You can think of it as a folder on a file system.
+  Difference between container and a folder on file system is that containers
+  cannot be nested. Some APIs and providers (e.g. AWS) refer to it as a Bucket.
+* :class:`~libcloud.storage.base.Object` - represents an object or so called
+  BLOB.
 
 Supported Providers
 -------------------


[5/5] git commit: docs: Re-order sections.

Posted by to...@apache.org.
docs: Re-order sections.


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

Branch: refs/heads/trunk
Commit: 9e4397034591b5ead5f54e89ca9436dc9d1fe34c
Parents: 9a71335
Author: Tomaz Muraus <to...@apache.org>
Authored: Sun Dec 8 23:42:30 2013 +0100
Committer: Tomaz Muraus <to...@apache.org>
Committed: Sun Dec 8 23:42:30 2013 +0100

----------------------------------------------------------------------
 docs/other/ssl-certificate-validation.rst | 32 +++++++++++++-------------
 1 file changed, 16 insertions(+), 16 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/libcloud/blob/9e439703/docs/other/ssl-certificate-validation.rst
----------------------------------------------------------------------
diff --git a/docs/other/ssl-certificate-validation.rst b/docs/other/ssl-certificate-validation.rst
index 98cfcfd..2ba4dca 100644
--- a/docs/other/ssl-certificate-validation.rst
+++ b/docs/other/ssl-certificate-validation.rst
@@ -26,22 +26,6 @@ If the above packages are unavailable to you, and you don't wish to roll
 your own, the makers of cURL provides an excellent resource, generated
 from Mozilla: http://curl.haxx.se/docs/caextract.html.
 
-Adding additional CA certificate to the path
---------------------------------------------
-
-If you want to add an additional CA certificate to the ``CA_CERTS_PATH``, you
-can do this by appending a path to your CA file to the
-``libcloud.security.CA_CERTS_PATH`` list.
-
-For example:
-
-.. sourcecode:: python
-
-    import libcloud.security
-    libcloud.security.CA_CERTS_PATH.append('/home/user/path-to-your-ca-file.crt')
-
-    # Instantiate and work with the driver here...
-
 Using a custom CA certificate
 -----------------------------
 
@@ -64,6 +48,22 @@ certificate, you can do that using two different approaches:
 
     # Instantiate and work with the driver here...
 
+Adding additional CA certificate to the path
+--------------------------------------------
+
+If you want to add an additional CA certificate to the ``CA_CERTS_PATH``, you
+can do this by appending a path to your CA file to the
+``libcloud.security.CA_CERTS_PATH`` list.
+
+For example:
+
+.. sourcecode:: python
+
+    import libcloud.security
+    libcloud.security.CA_CERTS_PATH.append('/home/user/path-to-your-ca-file.crt')
+
+    # Instantiate and work with the driver here...
+
 Disabling SSL certificate validation
 ------------------------------------
 


[3/5] git commit: Update __all__ in libcloud.compute.base module.

Posted by to...@apache.org.
Update __all__ in libcloud.compute.base module.


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

Branch: refs/heads/trunk
Commit: 01b2487f14ab33f87e292281ab28869718844e21
Parents: 1e66bb4
Author: Tomaz Muraus <to...@apache.org>
Authored: Sun Dec 8 23:30:23 2013 +0100
Committer: Tomaz Muraus <to...@apache.org>
Committed: Sun Dec 8 23:30:23 2013 +0100

----------------------------------------------------------------------
 libcloud/compute/base.py | 3 +++
 1 file changed, 3 insertions(+)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/libcloud/blob/01b2487f/libcloud/compute/base.py
----------------------------------------------------------------------
diff --git a/libcloud/compute/base.py b/libcloud/compute/base.py
index 326c59d..82350f8 100644
--- a/libcloud/compute/base.py
+++ b/libcloud/compute/base.py
@@ -56,6 +56,9 @@ __all__ = [
     'NodeAuthPassword',
     'NodeDriver',
 
+    'StorageVolume',
+    'VolumeSnapshot',
+
     # Deprecated, moved to libcloud.utils.networking
     'is_private_subnet',
     'is_valid_ip_address'


[4/5] git commit: docs: Update "SSL Certificate Validation".

Posted by to...@apache.org.
docs: Update "SSL Certificate Validation".


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

Branch: refs/heads/trunk
Commit: 9a7133567d53ac715b09f80cf9ce19647b5b9999
Parents: 01b2487
Author: Tomaz Muraus <to...@apache.org>
Authored: Sun Dec 8 23:41:37 2013 +0100
Committer: Tomaz Muraus <to...@apache.org>
Committed: Sun Dec 8 23:41:37 2013 +0100

----------------------------------------------------------------------
 docs/other/ssl-certificate-validation.rst | 12 +++++++++---
 1 file changed, 9 insertions(+), 3 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/libcloud/blob/9a713356/docs/other/ssl-certificate-validation.rst
----------------------------------------------------------------------
diff --git a/docs/other/ssl-certificate-validation.rst b/docs/other/ssl-certificate-validation.rst
index 9df5765..98cfcfd 100644
--- a/docs/other/ssl-certificate-validation.rst
+++ b/docs/other/ssl-certificate-validation.rst
@@ -46,10 +46,16 @@ Using a custom CA certificate
 -----------------------------
 
 If you want to use a custom CA certificate file for validating the server
-certificate, you can do that by setting ``libcloud.security.CA_CERTS_PATH``
-variable (``list``) to point to your CA file.
+certificate, you can do that using two different approaches:
 
-For example:
+1. Setting ``SSL_CERT_FILE`` environment variable to point to your CA file
+
+.. sourcecode:: bash
+
+    SSL_CERT_FILE=/home/user/path-to-your-ca-file.crt python my_script.py
+
+2. Setting ``libcloud.security.CA_CERTS_PATH`` variable in your script to 
+   point to your CA file
 
 .. sourcecode:: python