libcloud-notifications mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From anthonys...@apache.org
Subject [4/9] libcloud git commit: Improved the documentation in a few places.
Date Fri, 02 Dec 2016 10:32:26 GMT
Improved the documentation in a few places.


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

Branch: refs/heads/trunk
Commit: d1b7d78604767b4f446865da63e625cf1c48f0d5
Parents: fd9fefd
Author: Dave Halter <davidhalter88@gmail.com>
Authored: Wed Nov 23 15:55:53 2016 +0100
Committer: Dave Halter <davidhalter88@gmail.com>
Committed: Wed Nov 23 15:55:53 2016 +0100

----------------------------------------------------------------------
 docs/compute/drivers/cloudscale.rst             | 20 ++++++++++----------
 .../cloudscale/cloudscale_compute_simple.py     |  3 ++-
 libcloud/compute/drivers/cloudscale.py          |  2 +-
 3 files changed, 13 insertions(+), 12 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/libcloud/blob/d1b7d786/docs/compute/drivers/cloudscale.rst
----------------------------------------------------------------------
diff --git a/docs/compute/drivers/cloudscale.rst b/docs/compute/drivers/cloudscale.rst
index 5fbcdfc..f98981d 100644
--- a/docs/compute/drivers/cloudscale.rst
+++ b/docs/compute/drivers/cloudscale.rst
@@ -12,8 +12,8 @@ Cloudscale Compute Driver Documentation
 How to get an API Key
 ---------------------
 
-Simply visit `<https://control.cloudscale.ch/user/api-tokens>`_ and start
-having fun!
+Simply visit `<https://control.cloudscale.ch/user/api-tokens>`_ and generate
+your key.
 
 You can generate read and read/write API keys. These token types give you more
 access control. Revoking an API token is also possible.
@@ -37,14 +37,14 @@ In our :ref:`example <cloudscale-examples>` below you can see how
you use
 ``ex_create_attr`` when creating servers. Possible dictionary entries in 
 ``ex_create_attr`` are:
 
-- ``ssh_keys``: ``list`` of ``strings``; A list of SSH public keys.
-- ``volume_size_gb``:  ``integer``; The size in GB of the root volume.
-- ``bulk_volume_size_gb``: ``integer``; The size in GB of the bulk storage volume.
-- ``use_public_network``: ``boolean`` Attaching/Detaching the public network interface.
-- ``use_private_network``: ``boolean`` Attaching/Detaching the private network interface.
-- ``use_ipv6``: ``boolean`` Enabling/Disabling IPv6.
-- ``anti_affinity_with``: ``string``; Pass the UUID of another server.
-- ``user_data``: ``string``; Cloud-init configuration (cloud-config). Provide YAML.
+- ``ssh_keys`` (``list`` of ``str``) - A list of SSH public keys.
+- ``volume_size_gb`` (``int``) - The size in GB of the root volume.
+- ``bulk_volume_size_gb`` (``int``) - The size in GB of the bulk storage volume.
+- ``use_public_network`` (``bool``) - Attaching/Detaching the public network interface.
+- ``use_private_network`` (``bool``) - Attaching/Detaching the private network interface.
+- ``use_ipv6`` (``bool``) - Enabling/Disabling IPv6.
+- ``anti_affinity_with`` (``str``) - Pass the UUID of another server.
+- ``user_data`` (``str``) - Cloud-init configuration (cloud-config). Provide YAML.
 
 
 There's more extensive documentation on these parameters in our

http://git-wip-us.apache.org/repos/asf/libcloud/blob/d1b7d786/docs/examples/compute/cloudscale/cloudscale_compute_simple.py
----------------------------------------------------------------------
diff --git a/docs/examples/compute/cloudscale/cloudscale_compute_simple.py b/docs/examples/compute/cloudscale/cloudscale_compute_simple.py
index eb2f99d..872f093 100644
--- a/docs/examples/compute/cloudscale/cloudscale_compute_simple.py
+++ b/docs/examples/compute/cloudscale/cloudscale_compute_simple.py
@@ -7,7 +7,8 @@ cls = libcloud.get_driver(
     libcloud.DriverType.COMPUTE.CLOUDSCALE
 )
 
-driver = cls('3pjzjh3h3rfynqa4iemvtvc33pyfzss2')
+TOKEN = '3pjzjh3h3rfynqa4iemvtvc33pyfzss2'
+driver = cls(TOKEN)
 
 sizes = driver.list_sizes()
 images = driver.list_images()

http://git-wip-us.apache.org/repos/asf/libcloud/blob/d1b7d786/libcloud/compute/drivers/cloudscale.py
----------------------------------------------------------------------
diff --git a/libcloud/compute/drivers/cloudscale.py b/libcloud/compute/drivers/cloudscale.py
index e654e57..a998975 100644
--- a/libcloud/compute/drivers/cloudscale.py
+++ b/libcloud/compute/drivers/cloudscale.py
@@ -48,7 +48,7 @@ class CloudscaleResponse(JsonResponse):
 
 class CloudscaleConnection(ConnectionKey):
     """
-    Connection class for the Vultr driver.
+    Connection class for the cloudscale.ch driver.
     """
     host = 'api.cloudscale.ch'
     responseCls = CloudscaleResponse


Mime
View raw message