You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@libcloud.apache.org by an...@apache.org on 2017/04/03 10:28:36 UTC
[1/6] libcloud git commit: Outscale INC doc improvements
Repository: libcloud
Updated Branches:
refs/heads/trunk 76eef996c -> c62d7c9d6
Outscale INC doc improvements
Signed-off-by: Javier M. Mellid <jm...@igalia.com>
Project: http://git-wip-us.apache.org/repos/asf/libcloud/repo
Commit: http://git-wip-us.apache.org/repos/asf/libcloud/commit/3b5a9f2f
Tree: http://git-wip-us.apache.org/repos/asf/libcloud/tree/3b5a9f2f
Diff: http://git-wip-us.apache.org/repos/asf/libcloud/diff/3b5a9f2f
Branch: refs/heads/trunk
Commit: 3b5a9f2fc8a719d47858ef46ffee972519a5a683
Parents: 36c93d4
Author: Javier M. Mellid <jm...@igalia.com>
Authored: Mon Nov 28 19:37:48 2016 +0100
Committer: Anthony Shaw <an...@apache.org>
Committed: Mon Apr 3 20:27:22 2017 +1000
----------------------------------------------------------------------
docs/compute/drivers/outscale_inc.rst | 9 ++++++---
1 file changed, 6 insertions(+), 3 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/libcloud/blob/3b5a9f2f/docs/compute/drivers/outscale_inc.rst
----------------------------------------------------------------------
diff --git a/docs/compute/drivers/outscale_inc.rst b/docs/compute/drivers/outscale_inc.rst
index f206514..a351366 100644
--- a/docs/compute/drivers/outscale_inc.rst
+++ b/docs/compute/drivers/outscale_inc.rst
@@ -3,9 +3,9 @@ Outscale INC Driver Documentation
`Outscale INC`_ provides an IaaS platform allowing
developers to benefit from all the flexibility of the Cloud.
-This IaaS platform relies on TINA OS, its Cloud manager which purpose is to
+This IaaS platform relies on TINA OS, its Cloud manager whose purpose is to
provide great performances on the Cloud.
-TINA OS is an own developed software with APIs compatible with AWS EC2 (TM).
+TINA OS is a software developed by Outscale with APIs compatible with AWS EC2 (TM).
.. figure:: /_static/images/provider_logos/outscale.jpg
:align: center
@@ -19,7 +19,9 @@ Outscale users can start virtual machines in the following regions:
* (Soon) US East (New Jersey) Region
* (Soon) Asia (Hong Kong) Region
-Outscale INC is an American company: prices are in $.
+For other Regions, see the `Outscale SAS`_ documentation.
+
+Outscale INC is an American company and uses prices in United States Dollars.
API Docs
--------
@@ -29,3 +31,4 @@ API Docs
:inherited-members:
.. _`Outscale INC`: https://www.outscale.com/
+.. _`Outscale SAS`: outscale_sas.html
[3/6] libcloud git commit: Fix long lines reported by flake8
Posted by an...@apache.org.
Fix long lines reported by flake8
Signed-off-by: Javier M. Mellid <jm...@igalia.com>
Project: http://git-wip-us.apache.org/repos/asf/libcloud/repo
Commit: http://git-wip-us.apache.org/repos/asf/libcloud/commit/36c93d40
Tree: http://git-wip-us.apache.org/repos/asf/libcloud/tree/36c93d40
Diff: http://git-wip-us.apache.org/repos/asf/libcloud/diff/36c93d40
Branch: refs/heads/trunk
Commit: 36c93d40a6b4b510cbf98237257d9ff21acd946b
Parents: 5ed482f
Author: Javier M. Mellid <jm...@igalia.com>
Authored: Mon Nov 28 19:22:23 2016 +0100
Committer: Anthony Shaw <an...@apache.org>
Committed: Mon Apr 3 20:27:22 2017 +1000
----------------------------------------------------------------------
libcloud/compute/drivers/ec2.py | 18 +++++++++++-------
1 file changed, 11 insertions(+), 7 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/libcloud/blob/36c93d40/libcloud/compute/drivers/ec2.py
----------------------------------------------------------------------
diff --git a/libcloud/compute/drivers/ec2.py b/libcloud/compute/drivers/ec2.py
index 3e94710..466b802 100644
--- a/libcloud/compute/drivers/ec2.py
+++ b/libcloud/compute/drivers/ec2.py
@@ -4367,8 +4367,8 @@ class BaseEC2NodeDriver(NodeDriver):
[{'group_name': 'default', 'user_id': '1234567890'}]
- VPC example: To allow access from any system associated with
- security group sg-47ad482e on your own account
+ VPC example: To allow access from any system associated
+ with security group sg-47ad482e on your own account
[{'group_id': ' sg-47ad482e'}]
:type group_pairs: ``list`` of ``dict``
@@ -5203,7 +5203,7 @@ class BaseEC2NodeDriver(NodeDriver):
:return: A dictionary with the following keys:
- instance_id (``str``)
- - timestamp (``datetime.datetime``) - timestamp of the last output
+ - timestamp (``datetime.datetime``) - last output timestamp
- output (``str``) - console output
:rtype: ``dict``
"""
@@ -5431,10 +5431,12 @@ class BaseEC2NodeDriver(NodeDriver):
@note: This is a non-standard extension API, and only works for EC2.
:param name: The name of the public key to import. This must be
- unique, otherwise an InvalidKeyPair.Duplicate exception is raised.
+ unique, otherwise an InvalidKeyPair. Duplicate
+ exception is raised.
:type name: ``str``
- :param keyfile: The filename with the path of the public key to import.
+ :param keyfile: The filename with the path of the public key
+ to import.
:type keyfile: ``str``
:rtype: ``dict``
@@ -7046,7 +7048,8 @@ class OutscaleNodeDriver(BaseEC2NodeDriver):
def create_node(self, **kwargs):
"""
- Creates a new Outscale node. The ex_iamprofile keyword is not supported.
+ Creates a new Outscale node. The ex_iamprofile keyword
+ is not supported.
@inherits: :class:`BaseEC2NodeDriver.create_node`
@@ -7060,7 +7063,8 @@ class OutscaleNodeDriver(BaseEC2NodeDriver):
assign to the node.
:type ex_security_groups: ``list``
- :keyword ex_metadata: The Key/Value metadata to associate with a node
+ :keyword ex_metadata: The Key/Value metadata to associate
+ with a node.
:type ex_metadata: ``dict``
:keyword ex_mincount: The minimum number of nodes to launch
[5/6] libcloud git commit: More fixes and cleanup coming from feedback
Posted by an...@apache.org.
More fixes and cleanup coming from feedback
Signed-off-by: Javier M. Mellid <jm...@igalia.com>
Closes #950
Project: http://git-wip-us.apache.org/repos/asf/libcloud/repo
Commit: http://git-wip-us.apache.org/repos/asf/libcloud/commit/2d549a76
Tree: http://git-wip-us.apache.org/repos/asf/libcloud/tree/2d549a76
Diff: http://git-wip-us.apache.org/repos/asf/libcloud/diff/2d549a76
Branch: refs/heads/trunk
Commit: 2d549a760a5dbeb7b3c46a63729691a95ac6017c
Parents: 3b5a9f2
Author: Javier M. Mellid <jm...@igalia.com>
Authored: Tue Nov 29 11:03:10 2016 +0100
Committer: Anthony Shaw <an...@apache.org>
Committed: Mon Apr 3 20:27:25 2017 +1000
----------------------------------------------------------------------
docs/compute/drivers/outscale_inc.rst | 4 ++--
docs/compute/drivers/outscale_sas.rst | 4 ++--
2 files changed, 4 insertions(+), 4 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/libcloud/blob/2d549a76/docs/compute/drivers/outscale_inc.rst
----------------------------------------------------------------------
diff --git a/docs/compute/drivers/outscale_inc.rst b/docs/compute/drivers/outscale_inc.rst
index a351366..bcfb313 100644
--- a/docs/compute/drivers/outscale_inc.rst
+++ b/docs/compute/drivers/outscale_inc.rst
@@ -5,7 +5,7 @@ Outscale INC Driver Documentation
developers to benefit from all the flexibility of the Cloud.
This IaaS platform relies on TINA OS, its Cloud manager whose purpose is to
provide great performances on the Cloud.
-TINA OS is a software developed by Outscale with APIs compatible with AWS EC2 (TM).
+TINA OS is software developed by Outscale with APIs compatible with AWS EC2 (TM).
.. figure:: /_static/images/provider_logos/outscale.jpg
:align: center
@@ -21,7 +21,7 @@ Outscale users can start virtual machines in the following regions:
For other Regions, see the `Outscale SAS`_ documentation.
-Outscale INC is an American company and uses prices in United States Dollars.
+Outscale INC is an American company and is priced in United States Dollars.
API Docs
--------
http://git-wip-us.apache.org/repos/asf/libcloud/blob/2d549a76/docs/compute/drivers/outscale_sas.rst
----------------------------------------------------------------------
diff --git a/docs/compute/drivers/outscale_sas.rst b/docs/compute/drivers/outscale_sas.rst
index 58e0727..4177d23 100644
--- a/docs/compute/drivers/outscale_sas.rst
+++ b/docs/compute/drivers/outscale_sas.rst
@@ -5,7 +5,7 @@ Outscale SAS Driver Documentation
developers to benefit from all the flexibility of the Cloud.
This IaaS platform relies on TINA OS, its Cloud manager whose purpose is to
provide great performances on the Cloud.
-TINA OS is a software developed by Outscale with APIs compatible with AWS EC2 (TM).
+TINA OS is software developed by Outscale with APIs compatible with AWS EC2 (TM).
.. figure:: /_static/images/provider_logos/outscale.jpg
:align: center
@@ -19,7 +19,7 @@ Outscale users can start virtual machines in the following regions:
For other Regions, see the `Outscale Inc.`_ documentation.
-Outscale SAS is European company and uses prices in Euros.
+Outscale SAS is European company and is priced in Euros.
API Documentation
-----------------
[2/6] libcloud git commit: Outscale SAS doc improvements and logo
update
Posted by an...@apache.org.
Outscale SAS doc improvements and logo update
Signed-off-by: Javier M. Mellid <jm...@igalia.com>
Project: http://git-wip-us.apache.org/repos/asf/libcloud/repo
Commit: http://git-wip-us.apache.org/repos/asf/libcloud/commit/3bbc6481
Tree: http://git-wip-us.apache.org/repos/asf/libcloud/tree/3bbc6481
Diff: http://git-wip-us.apache.org/repos/asf/libcloud/diff/3bbc6481
Branch: refs/heads/trunk
Commit: 3bbc6481b313d688747a0603f062db51e91a7130
Parents: 76eef99
Author: Javier M. Mellid <jm...@igalia.com>
Authored: Tue Nov 22 12:38:42 2016 +0100
Committer: Anthony Shaw <an...@apache.org>
Committed: Mon Apr 3 20:27:22 2017 +1000
----------------------------------------------------------------------
docs/_static/images/provider_logos/outscale.jpg | Bin 0 -> 17361 bytes
docs/_static/images/provider_logos/outscale.png | Bin 8437 -> 0 bytes
docs/compute/drivers/outscale_inc.rst | 2 +-
docs/compute/drivers/outscale_sas.rst | 21 ++++++++++---------
4 files changed, 12 insertions(+), 11 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/libcloud/blob/3bbc6481/docs/_static/images/provider_logos/outscale.jpg
----------------------------------------------------------------------
diff --git a/docs/_static/images/provider_logos/outscale.jpg b/docs/_static/images/provider_logos/outscale.jpg
new file mode 100644
index 0000000..3131e89
Binary files /dev/null and b/docs/_static/images/provider_logos/outscale.jpg differ
http://git-wip-us.apache.org/repos/asf/libcloud/blob/3bbc6481/docs/_static/images/provider_logos/outscale.png
----------------------------------------------------------------------
diff --git a/docs/_static/images/provider_logos/outscale.png b/docs/_static/images/provider_logos/outscale.png
deleted file mode 100644
index c11c92a..0000000
Binary files a/docs/_static/images/provider_logos/outscale.png and /dev/null differ
http://git-wip-us.apache.org/repos/asf/libcloud/blob/3bbc6481/docs/compute/drivers/outscale_inc.rst
----------------------------------------------------------------------
diff --git a/docs/compute/drivers/outscale_inc.rst b/docs/compute/drivers/outscale_inc.rst
index a6786a2..f206514 100644
--- a/docs/compute/drivers/outscale_inc.rst
+++ b/docs/compute/drivers/outscale_inc.rst
@@ -7,7 +7,7 @@ This IaaS platform relies on TINA OS, its Cloud manager which purpose is to
provide great performances on the Cloud.
TINA OS is an own developed software with APIs compatible with AWS EC2 (TM).
-.. figure:: /_static/images/provider_logos/outscale.png
+.. figure:: /_static/images/provider_logos/outscale.jpg
:align: center
:width: 300
:target: https://www.outscale.com/
http://git-wip-us.apache.org/repos/asf/libcloud/blob/3bbc6481/docs/compute/drivers/outscale_sas.rst
----------------------------------------------------------------------
diff --git a/docs/compute/drivers/outscale_sas.rst b/docs/compute/drivers/outscale_sas.rst
index 441febc..58e0727 100644
--- a/docs/compute/drivers/outscale_sas.rst
+++ b/docs/compute/drivers/outscale_sas.rst
@@ -3,29 +3,30 @@ Outscale SAS Driver Documentation
`Outscale SAS`_ provides an IaaS platform allowing
developers to benefit from all the flexibility of the Cloud.
-This IaaS platform relies on TINA OS, its Cloud manager which purpose is to
+This IaaS platform relies on TINA OS, its Cloud manager whose purpose is to
provide great performances on the Cloud.
-TINA OS is an own developed software with APIs compatible with AWS EC2 (TM).
+TINA OS is a software developed by Outscale with APIs compatible with AWS EC2 (TM).
-.. figure:: /_static/images/provider_logos/outscale.png
+.. figure:: /_static/images/provider_logos/outscale.jpg
:align: center
:width: 300
:target: https://www.outscale.com/
Outscale users can start virtual machines in the following regions:
-* EU West (Paris France) Region
-* US East (Boston US) Region
-* (Soon) US East (New Jersey) Region
-* (Soon) Asia (Hong Kong) Region
+* eu-west-1, France (Paris)
+* eu-west-2, France (Paris)
-Outscale SAS is a European company: prices are in \u20ac.
+For other Regions, see the `Outscale Inc.`_ documentation.
-API Docs
---------
+Outscale SAS is European company and uses prices in Euros.
+
+API Documentation
+-----------------
.. autoclass:: libcloud.compute.drivers.ec2.OutscaleSASNodeDriver
:members:
:inherited-members:
.. _`Outscale SAS`: https://www.outscale.com/
+.. _`Outscale Inc.`: outscale_inc.html
[6/6] libcloud git commit: changes for #950
Posted by an...@apache.org.
changes for #950
Project: http://git-wip-us.apache.org/repos/asf/libcloud/repo
Commit: http://git-wip-us.apache.org/repos/asf/libcloud/commit/c62d7c9d
Tree: http://git-wip-us.apache.org/repos/asf/libcloud/tree/c62d7c9d
Diff: http://git-wip-us.apache.org/repos/asf/libcloud/diff/c62d7c9d
Branch: refs/heads/trunk
Commit: c62d7c9d6b6dcd4ed4fffedc30aed901e211194c
Parents: 2d549a7
Author: Anthony Shaw <an...@apache.org>
Authored: Mon Apr 3 20:28:25 2017 +1000
Committer: Anthony Shaw <an...@apache.org>
Committed: Mon Apr 3 20:28:25 2017 +1000
----------------------------------------------------------------------
CHANGES.rst | 6 ++++++
1 file changed, 6 insertions(+)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/libcloud/blob/c62d7c9d/CHANGES.rst
----------------------------------------------------------------------
diff --git a/CHANGES.rst b/CHANGES.rst
index 7cab721..07b992b 100644
--- a/CHANGES.rst
+++ b/CHANGES.rst
@@ -12,6 +12,12 @@ Common
[GITHUB-970]
(Anthony Shaw)
+Compute
+~~~~~~~
+
+- Outscale SAS doc improvements and logo update
+ [GITHUB-950]
+ (Javier M Mellid)
Changes in Apache Libcloud 2.0.0rc2
-----------------------------------
[4/6] libcloud git commit: Documentation update/cleanup in
EC2/Euc/Outscale compute driver
Posted by an...@apache.org.
Documentation update/cleanup in EC2/Euc/Outscale compute driver
Signed-off-by: Javier M. Mellid <jm...@igalia.com>
Project: http://git-wip-us.apache.org/repos/asf/libcloud/repo
Commit: http://git-wip-us.apache.org/repos/asf/libcloud/commit/5ed482fe
Tree: http://git-wip-us.apache.org/repos/asf/libcloud/tree/5ed482fe
Diff: http://git-wip-us.apache.org/repos/asf/libcloud/diff/5ed482fe
Branch: refs/heads/trunk
Commit: 5ed482fef7d20134059bc5e4db3d7120cd38d574
Parents: 3bbc648
Author: Javier M. Mellid <jm...@igalia.com>
Authored: Tue Nov 22 12:38:56 2016 +0100
Committer: Anthony Shaw <an...@apache.org>
Committed: Mon Apr 3 20:27:22 2017 +1000
----------------------------------------------------------------------
libcloud/compute/drivers/ec2.py | 225 ++++++++++++++++++-----------------
1 file changed, 113 insertions(+), 112 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/libcloud/blob/5ed482fe/libcloud/compute/drivers/ec2.py
----------------------------------------------------------------------
diff --git a/libcloud/compute/drivers/ec2.py b/libcloud/compute/drivers/ec2.py
index 3cf637d..3e94710 100644
--- a/libcloud/compute/drivers/ec2.py
+++ b/libcloud/compute/drivers/ec2.py
@@ -3153,17 +3153,17 @@ class BaseEC2NodeDriver(NodeDriver):
def list_nodes(self, ex_node_ids=None, ex_filters=None):
"""
- List all nodes
+ Lists all nodes.
Ex_node_ids parameter is used to filter the list of
nodes that should be returned. Only the nodes
- with the corresponding node ids will be returned.
+ with the corresponding node IDs will be returned.
:param ex_node_ids: List of ``node.id``
:type ex_node_ids: ``list`` of ``str``
- :param ex_filters: The filters so that the response includes
- information for only certain nodes.
+ :param ex_filters: The filters so that the list includes
+ information for certain nodes only.
:type ex_filters: ``dict``
:rtype: ``list`` of :class:`Node`
@@ -3207,12 +3207,12 @@ class BaseEC2NodeDriver(NodeDriver):
def list_images(self, location=None, ex_image_ids=None, ex_owner=None,
ex_executableby=None, ex_filters=None):
"""
- List all images
+ Lists all images
@inherits: :class:`NodeDriver.list_images`
Ex_image_ids parameter is used to filter the list of
images that should be returned. Only the images
- with the corresponding image ids will be returned.
+ with the corresponding image IDs will be returned.
Ex_owner parameter is used to filter the list of
images that should be returned. Only the images
@@ -3268,7 +3268,7 @@ class BaseEC2NodeDriver(NodeDriver):
def get_image(self, image_id):
"""
- Get an image based on an image_id
+ Gets an image based on an image_id.
:param image_id: Image identifier
:type image_id: ``str``
@@ -3674,12 +3674,12 @@ class BaseEC2NodeDriver(NodeDriver):
def list_snapshots(self, snapshot=None, owner=None):
"""
- Describe all snapshots.
+ Describes all snapshots.
- :param snapshot: If provided, only return snapshot information for the
+ :param snapshot: If provided, only returns snapshot information for the
provided snapshot.
- :param owner: Owner for snapshot: self|amazon|ID
+ :param owner: The owner of the snapshot: self|amazon|ID
:type owner: ``str``
:rtype: ``list`` of :class:`VolumeSnapshot`
@@ -3879,9 +3879,9 @@ class BaseEC2NodeDriver(NodeDriver):
def ex_create_placement_group(self, name):
"""
- Creates new Placement Group
+ Creates a new placement group.
- :param name: Name for new placement Group
+ :param name: The name for the new placement group
:type name: ``str``
:rtype: ``bool``
@@ -3894,9 +3894,9 @@ class BaseEC2NodeDriver(NodeDriver):
def ex_delete_placement_group(self, name):
"""
- Deletes Placement Group
+ Deletes a placement group.
- :param name: Placement Group name
+ :param name: The placement group name
:type name: ``str``
:rtype: ``bool``
@@ -3908,7 +3908,7 @@ class BaseEC2NodeDriver(NodeDriver):
def ex_list_placement_groups(self, names=None):
"""
- List Placement Groups
+ A list of placement groups.
:param names: Placement Group names
:type names: ``list`` of ``str``
@@ -4013,17 +4013,17 @@ class BaseEC2NodeDriver(NodeDriver):
def ex_list_networks(self, network_ids=None, filters=None):
"""
- Return a list of :class:`EC2Network` objects for the
+ Returns a list of :class:`EC2Network` objects for the
current region.
- :param network_ids: Return only networks matching the provided
+ :param network_ids: Returns only networks matching the provided
network IDs. If not specified, a list of all
the networks in the corresponding region
is returned.
:type network_ids: ``list``
- :param filters: The filters so that the response includes
- information for only certain networks.
+ :param filters: The filters so that the list returned includes
+ information for certain networks only.
:type filters: ``dict``
:rtype: ``list`` of :class:`EC2Network`
@@ -4091,17 +4091,17 @@ class BaseEC2NodeDriver(NodeDriver):
def ex_list_subnets(self, subnet_ids=None, filters=None):
"""
- Return a list of :class:`EC2NetworkSubnet` objects for the
+ Returns a list of :class:`EC2NetworkSubnet` objects for the
current region.
- :param subnet_ids: Return only subnets matching the provided
+ :param subnet_ids: Returns only subnets matching the provided
subnet IDs. If not specified, a list of all
the subnets in the corresponding region
is returned.
:type subnet_ids: ``list``
- :param filters: The filters so that the response includes
- information for only certain subnets.
+ :param filters: The filters so that the list returned includes
+ information for certain subnets only.
:type filters: ``dict``
:rtype: ``list`` of :class:`EC2NetworkSubnet`
@@ -4121,7 +4121,7 @@ class BaseEC2NodeDriver(NodeDriver):
def ex_create_subnet(self, vpc_id, cidr_block,
availability_zone, name=None):
"""
- Create a network subnet within a VPC
+ Creates a network subnet within a VPC.
:param vpc_id: The ID of the VPC that the subnet should be
associated with
@@ -4172,7 +4172,7 @@ class BaseEC2NodeDriver(NodeDriver):
def ex_list_security_groups(self):
"""
- List existing Security Groups.
+ Lists existing Security Groups.
@note: This is a non-standard extension API, and only works for EC2.
@@ -4193,19 +4193,19 @@ class BaseEC2NodeDriver(NodeDriver):
def ex_get_security_groups(self, group_ids=None,
group_names=None, filters=None):
"""
- Return a list of :class:`EC2SecurityGroup` objects for the
+ Returns a list of :class:`EC2SecurityGroup` objects for the
current region.
- :param group_ids: Return only groups matching the provided
+ :param group_ids: Returns only groups matching the provided
group IDs.
:type group_ids: ``list``
- :param group_names: Return only groups matching the provided
+ :param group_names: Returns only groups matching the provided
group names.
:type group_ids: ``list``
- :param filters: The filters so that the response includes
- information for only specific security groups.
+ :param filters: The filters so that the list returned includes
+ information for specific security groups only.
:type filters: ``dict``
:rtype: ``list`` of :class:`EC2SecurityGroup`
@@ -4232,7 +4232,7 @@ class BaseEC2NodeDriver(NodeDriver):
"""
Creates a new Security Group in EC2-Classic or a targeted VPC.
- :param name: The name of the security group to Create.
+ :param name: The name of the security group to create.
This must be unique.
:type name: ``str``
@@ -4261,7 +4261,7 @@ class BaseEC2NodeDriver(NodeDriver):
def ex_delete_security_group_by_id(self, group_id):
"""
- Deletes a new Security Group using the group id.
+ Deletes a new Security Group using the group ID.
:param group_id: The ID of the security group
:type group_id: ``str``
@@ -4291,7 +4291,7 @@ class BaseEC2NodeDriver(NodeDriver):
def ex_delete_security_group(self, name):
"""
- Wrapper method which calls ex_delete_security_group_by_name.
+ A wrapper method which calls ex_delete_security_group_by_name.
:param name: The name of the security group
:type name: ``str``
@@ -4356,7 +4356,7 @@ class BaseEC2NodeDriver(NodeDriver):
:param to_port: The end of the port range to open
:type to_port: ``int``
- :param cidr_ips: The list of ip ranges to allow traffic for.
+ :param cidr_ips: The list of IP ranges to allow traffic for.
:type cidr_ips: ``list``
:param group_pairs: Source user/group pairs to allow traffic for.
@@ -4367,7 +4367,7 @@ class BaseEC2NodeDriver(NodeDriver):
[{'group_name': 'default', 'user_id': '1234567890'}]
- VPC Example: Allow access from any system associated with
+ VPC example: To allow access from any system associated with
security group sg-47ad482e on your own account
[{'group_id': ' sg-47ad482e'}]
@@ -4450,10 +4450,10 @@ class BaseEC2NodeDriver(NodeDriver):
cidr_ips=None, group_pairs=None,
protocol='tcp'):
"""
- Edit a Security Group to revoke specific ingress traffic using
+ Edits a Security Group to revoke specific ingress traffic using
CIDR blocks or either a group ID, group name or user ID (account).
- :param id: The id of the security group to edit
+ :param id: The ID of the security group to edit
:type id: ``str``
:param from_port: The beginning of the port range to open
@@ -4605,13 +4605,13 @@ class BaseEC2NodeDriver(NodeDriver):
def ex_list_availability_zones(self, only_available=True):
"""
- Return a list of :class:`ExEC2AvailabilityZone` objects for the
+ Returns a list of :class:`ExEC2AvailabilityZone` objects for the
current region.
Note: This is an extension method and is only available for EC2
driver.
- :keyword only_available: If true, return only availability zones
+ :keyword only_available: If true, returns only availability zones
with state 'available'
:type only_available: ``str``
@@ -4650,14 +4650,14 @@ class BaseEC2NodeDriver(NodeDriver):
def ex_describe_tags(self, resource):
"""
- Return a dictionary of tags for a resource (e.g. Node or
+ Returns a dictionary of tags for a resource (e.g. Node or
StorageVolume).
- :param resource: resource which should be used
+ :param resource: The resource to be used
:type resource: any resource class, such as :class:`Node,`
:class:`StorageVolume,` or :class:NodeImage`
- :return: dict Node tags
+ :return: A dictionary of Node tags
:rtype: ``dict``
"""
params = {'Action': 'DescribeTags'}
@@ -4674,9 +4674,9 @@ class BaseEC2NodeDriver(NodeDriver):
def ex_create_tags(self, resource, tags):
"""
- Create tags for a resource (Node or StorageVolume).
+ Creates tags for a resource (Node or StorageVolume).
- :param resource: Resource to be tagged
+ :param resource: The resource to be tagged
:type resource: :class:`Node` or :class:`StorageVolume` or
:class:`VolumeSnapshot`
@@ -4702,9 +4702,9 @@ class BaseEC2NodeDriver(NodeDriver):
def ex_delete_tags(self, resource, tags):
"""
- Delete tags from a resource.
+ Deletes tags from a resource.
- :param resource: Resource to be tagged
+ :param resource: The resource to be tagged
:type resource: :class:`Node` or :class:`StorageVolume`
:param tags: A dictionary or other mapping of strings to strings,
@@ -4730,7 +4730,7 @@ class BaseEC2NodeDriver(NodeDriver):
def ex_get_metadata_for_node(self, node):
"""
- Return the metadata associated with the node.
+ Returns the metadata associated with the node.
:param node: Node instance
:type node: :class:`Node`
@@ -4763,8 +4763,8 @@ class BaseEC2NodeDriver(NodeDriver):
def ex_release_address(self, elastic_ip, domain=None):
"""
- Release an Elastic IP address using the IP (EC2-Classic) or
- using the allocation ID (VPC)
+ Releases an Elastic IP address using the IP (EC2-Classic) or
+ using the allocation ID (VPC).
:param elastic_ip: Elastic IP instance
:type elastic_ip: :class:`ElasticIP`
@@ -4790,14 +4790,14 @@ class BaseEC2NodeDriver(NodeDriver):
def ex_describe_all_addresses(self, only_associated=False):
"""
- Return all the Elastic IP addresses for this account
- optionally, return only addresses associated with nodes
+ Returns all the Elastic IP addresses for this account
+ optionally, returns only addresses associated with nodes.
- :param only_associated: If true, return only those addresses
+ :param only_associated: If true, return only the addresses
that are associated with an instance.
:type only_associated: ``bool``
- :return: List of ElasticIP instances.
+ :return: List of Elastic IP addresses.
:rtype: ``list`` of :class:`ElasticIP`
"""
params = {'Action': 'DescribeAddresses'}
@@ -4854,8 +4854,8 @@ class BaseEC2NodeDriver(NodeDriver):
def ex_disassociate_address(self, elastic_ip, domain=None):
"""
- Disassociate an Elastic IP address using the IP (EC2-Classic)
- or the association ID (VPC)
+ Disassociates an Elastic IP address using the IP (EC2-Classic)
+ or the association ID (VPC).
:param elastic_ip: ElasticIP instance
:type elastic_ip: :class:`ElasticIP`
@@ -4882,9 +4882,9 @@ class BaseEC2NodeDriver(NodeDriver):
def ex_describe_addresses(self, nodes):
"""
- Return Elastic IP addresses for all the nodes in the provided list.
+ Returns Elastic IP addresses for all the nodes in the provided list.
- :param nodes: List of :class:`Node` instances
+ :param nodes: A list of :class:`Node` instances
:type nodes: ``list`` of :class:`Node`
:return: Dictionary where a key is a node ID and the value is a
@@ -4924,12 +4924,12 @@ class BaseEC2NodeDriver(NodeDriver):
def ex_describe_addresses_for_node(self, node):
"""
- Return a list of Elastic IP addresses associated with this node.
+ Returns a list of Elastic IP Addresses associated with this node.
:param node: Node instance
:type node: :class:`Node`
- :return: list Elastic IP addresses attached to this node.
+ :return: List Elastic IP Addresses attached to this node.
:rtype: ``list`` of ``str``
"""
node_elastic_ips = self.ex_describe_addresses([node])
@@ -4939,7 +4939,7 @@ class BaseEC2NodeDriver(NodeDriver):
def ex_list_network_interfaces(self):
"""
- Return all network interfaces
+ Returns all network interfaces.
:return: List of EC2NetworkInterface instances
:rtype: ``list`` of :class `EC2NetworkInterface`
@@ -5118,12 +5118,12 @@ class BaseEC2NodeDriver(NodeDriver):
def ex_modify_image_attribute(self, image, attributes):
"""
- Modify image attributes.
+ Modifies image attributes.
:param image: NodeImage instance
:type image: :class:`NodeImage`
- :param attributes: Dictionary with node attributes
+ :param attributes: A dictionary with node attributes
:type attributes: ``dict``
:return: True on success, False otherwise.
@@ -5166,10 +5166,10 @@ class BaseEC2NodeDriver(NodeDriver):
def ex_start_node(self, node):
"""
- Start the node by passing in the node object, does not work with
- instance store backed instances
+ Starts the node by passing in the node object, does not work with
+ instance store backed instances.
- :param node: Node which should be used
+ :param node: The node to be used
:type node: :class:`Node`
:rtype: ``bool``
@@ -5181,10 +5181,10 @@ class BaseEC2NodeDriver(NodeDriver):
def ex_stop_node(self, node):
"""
- Stop the node by passing in the node object, does not work with
+ Stops the node by passing in the node object, does not work with
instance store backed instances
- :param node: Node which should be used
+ :param node: The node to be used
:type node: :class:`Node`
:rtype: ``bool``
@@ -5196,14 +5196,14 @@ class BaseEC2NodeDriver(NodeDriver):
def ex_get_console_output(self, node):
"""
- Get console output for the node.
+ Gets console output for the node.
:param node: Node which should be used
:type node: :class:`Node`
- :return: Dictionary with the following keys:
+ :return: A dictionary with the following keys:
- instance_id (``str``)
- - timestamp (``datetime.datetime``) - ts of the last output
+ - timestamp (``datetime.datetime``) - timestamp of the last output
- output (``str``) - console output
:rtype: ``dict``
"""
@@ -5236,7 +5236,7 @@ class BaseEC2NodeDriver(NodeDriver):
def ex_list_reserved_nodes(self):
"""
- List all reserved instances/nodes which can be purchased from Amazon
+ Lists all reserved instances/nodes which can be purchased from Amazon
for one or three year terms. Reservations are made at a region level
and reduce the hourly charge for instances.
@@ -5311,7 +5311,7 @@ class BaseEC2NodeDriver(NodeDriver):
def ex_describe_all_keypairs(self):
"""
- Return names for all the available key pairs.
+ Returns names for all the available key pairs.
@note: This is a non-standard extension API, and only works for EC2.
@@ -5380,7 +5380,7 @@ class BaseEC2NodeDriver(NodeDriver):
def ex_delete_keypair(self, keypair):
"""
- Delete a key pair by name.
+ Deletes a key pair by name.
@note: This is a non-standard extension API, and only works with EC2.
@@ -5399,7 +5399,7 @@ class BaseEC2NodeDriver(NodeDriver):
def ex_import_keypair_from_string(self, name, key_material):
"""
- imports a new public key where the public key is passed in as a string
+ Imports a new public key where the public key is passed in as a string.
@note: This is a non-standard extension API, and only works for EC2.
@@ -5426,7 +5426,7 @@ class BaseEC2NodeDriver(NodeDriver):
def ex_import_keypair(self, name, keyfile):
"""
- imports a new public key where the public key is passed via a filename
+ Imports a new public key where the public key is passed via a filename.
@note: This is a non-standard extension API, and only works for EC2.
@@ -5434,7 +5434,7 @@ class BaseEC2NodeDriver(NodeDriver):
unique, otherwise an InvalidKeyPair.Duplicate exception is raised.
:type name: ``str``
- :param keyfile: The filename with path of the public key to import.
+ :param keyfile: The filename with the path of the public key to import.
:type keyfile: ``str``
:rtype: ``dict``
@@ -5485,15 +5485,15 @@ class BaseEC2NodeDriver(NodeDriver):
attached to a VPC. These are required for VPC nodes to communicate
over the Internet.
- :param gateway_ids: Return only internet gateways matching the
- provided internet gateway IDs. If not
- specified, a list of all the internet
+ :param gateway_ids: Returns only Internet gateways matching the
+ provided Internet gateway IDs. If not
+ specified, a list of all the Internet
gateways in the corresponding region is
returned.
:type gateway_ids: ``list``
- :param filters: The filters so that the response includes
- information for only certain gateways.
+ :param filters: The filters so the list returned inclues
+ information for certain gateways only.
:type filters: ``dict``
:rtype: ``list`` of :class:`.VPCInternetGateway`
@@ -5532,7 +5532,7 @@ class BaseEC2NodeDriver(NodeDriver):
def ex_delete_internet_gateway(self, gateway):
"""
- Delete a VPC Internet gateway
+ Deletes a VPC Internet gateway.
:param gateway: The gateway to delete
:type gateway: :class:`.VPCInternetGateway`
@@ -5568,7 +5568,7 @@ class BaseEC2NodeDriver(NodeDriver):
def ex_detach_internet_gateway(self, gateway, network):
"""
- Detach an Internet gateway from a VPC
+ Detaches an Internet gateway from a VPC.
:param gateway: The gateway to detach
:type gateway: :class:`.VPCInternetGateway`
@@ -5591,14 +5591,14 @@ class BaseEC2NodeDriver(NodeDriver):
Describes one or more of a VPC's route tables.
These are used to determine where network traffic is directed.
- :param route_table_ids: Return only route tables matching the
+ :param route_table_ids: Returns only route tables matching the
provided route table IDs. If not specified,
a list of all the route tables in the
corresponding region is returned.
:type route_table_ids: ``list``
- :param filters: The filters so that the response includes
- information for only certain route tables.
+ :param filters: The filters so that the list returned includes
+ information for certain route tables only.
:type filters: ``dict``
:rtype: ``list`` of :class:`.EC2RouteTable`
@@ -5617,7 +5617,7 @@ class BaseEC2NodeDriver(NodeDriver):
def ex_create_route_table(self, network, name=None):
"""
- Create a route table within a VPC.
+ Creates a route table within a VPC.
:param vpc_id: The VPC that the subnet should be created in.
:type vpc_id: :class:`.EC2Network`
@@ -5723,7 +5723,7 @@ class BaseEC2NodeDriver(NodeDriver):
:param route_table: The new route table to associate.
:type route_table: :class:`.EC2RouteTable`
- :return: New route table association ID.
+ :return: A new route table association ID.
:rtype: ``str``
"""
@@ -5755,7 +5755,7 @@ class BaseEC2NodeDriver(NodeDriver):
:param cidr: The CIDR block used for the destination match.
:type cidr: ``str``
- :param internet_gateway: The internet gateway to route
+ :param internet_gateway: The Internet gateway to route
traffic through.
:type internet_gateway: :class:`.VPCInternetGateway`
@@ -6927,7 +6927,7 @@ class EucNodeDriver(BaseEC2NodeDriver):
def list_sizes(self):
"""
- List available instance flavors/sizes
+ Lists available nodes sizes.
:rtype: ``list`` of :class:`NodeSize`
"""
@@ -7046,30 +7046,30 @@ class OutscaleNodeDriver(BaseEC2NodeDriver):
def create_node(self, **kwargs):
"""
- Create a new Outscale node. The ex_iamprofile keyword is not supported.
+ Creates a new Outscale node. The ex_iamprofile keyword is not supported.
@inherits: :class:`BaseEC2NodeDriver.create_node`
:keyword ex_keyname: The name of the key pair
:type ex_keyname: ``str``
- :keyword ex_userdata: User data
+ :keyword ex_userdata: The user data
:type ex_userdata: ``str``
:keyword ex_security_groups: A list of names of security groups to
assign to the node.
:type ex_security_groups: ``list``
- :keyword ex_metadata: Key/Value metadata to associate with a node
+ :keyword ex_metadata: The Key/Value metadata to associate with a node
:type ex_metadata: ``dict``
- :keyword ex_mincount: Minimum number of instances to launch
+ :keyword ex_mincount: The minimum number of nodes to launch
:type ex_mincount: ``int``
- :keyword ex_maxcount: Maximum number of instances to launch
+ :keyword ex_maxcount: The maximum number of nodes to launch
:type ex_maxcount: ``int``
- :keyword ex_clienttoken: Unique identifier to ensure idempotency
+ :keyword ex_clienttoken: A unique identifier to ensure idempotency
:type ex_clienttoken: ``str``
:keyword ex_blockdevicemappings: ``list`` of ``dict`` block device
@@ -7085,7 +7085,7 @@ class OutscaleNodeDriver(BaseEC2NodeDriver):
def ex_create_network(self, cidr_block, name=None):
"""
- Create a network/VPC. Outscale does not support instance_tenancy.
+ Creates a network/VPC. Outscale does not support instance_tenancy.
:param cidr_block: The CIDR block assigned to the network
:type cidr_block: ``str``
@@ -7104,8 +7104,8 @@ class OutscaleNodeDriver(BaseEC2NodeDriver):
source_dest_check=None, user_data=None,
instance_type=None):
"""
- Modify node attributes.
- Ouscale support the following attributes:
+ Modifies node attributes.
+ Ouscale supports the following attributes:
'DisableApiTermination.Value', 'EbsOptimized', 'GroupId.n',
'SourceDestCheck.Value', 'UserData.Value',
'InstanceType.Value'
@@ -7113,7 +7113,7 @@ class OutscaleNodeDriver(BaseEC2NodeDriver):
:param node: Node instance
:type node: :class:`Node`
- :param attributes: Dictionary with node attributes
+ :param attributes: A dictionary with node attributes
:type attributes: ``dict``
:return: True on success, False otherwise.
@@ -7223,9 +7223,10 @@ class OutscaleNodeDriver(BaseEC2NodeDriver):
def list_sizes(self, location=None):
"""
- List available instance flavors/sizes
+ Lists available nodes sizes.
- This override the EC2 default method in order to use Outscale infos.
+ This overrides the EC2 default method in order to use Outscale
+ information or data.
:rtype: ``list`` of :class:`NodeSize`
"""
@@ -7244,7 +7245,7 @@ class OutscaleNodeDriver(BaseEC2NodeDriver):
def ex_modify_instance_keypair(self, instance_id, key_name=None):
"""
Modifies the keypair associated with a specified instance.
- Once the modification done, you must restart the instance.
+ Once the modification is done, you must restart the instance.
:param instance_id: The ID of the instance
:type instance_id: ``string``
@@ -7322,8 +7323,8 @@ class OutscaleNodeDriver(BaseEC2NodeDriver):
:param dry_run: dry_run
:type dry_run: ``bool``
- :param filters: The filters so that the response includes
- information for only certain quotas
+ :param filters: The filters so that the response returned includes
+ information for certain quotas only.
:type filters: ``dict``
:param max_results: The maximum number of items that can be
@@ -7375,7 +7376,7 @@ class OutscaleNodeDriver(BaseEC2NodeDriver):
def ex_get_product_type(self, image_id, snapshot_id=None):
"""
- Get the product type of a specified OMI or snapshot.
+ Gets the product type of a specified OMI or snapshot.
:param image_id: The ID of the OMI
:type image_id: ``string``
@@ -7419,10 +7420,10 @@ class OutscaleNodeDriver(BaseEC2NodeDriver):
def ex_describe_product_types(self, filters=None):
"""
- Describes Product Types.
+ Describes product types.
- :param filters: The filters so that the response includes
- information for only certain quotas
+ :param filters: The filters so that the list returned includes
+ information for certain quotas only.
:type filters: ``dict``
:return: A product types list
@@ -7481,10 +7482,10 @@ class OutscaleNodeDriver(BaseEC2NodeDriver):
def ex_describe_instance_types(self, filters=None):
"""
- Describes Instance Types.
+ Describes instance types.
- :param filters: The filters so that the response includes
- information for only instance types
+ :param filters: The filters so that the list returned includes
+ information for instance types only
:type filters: ``dict``
:return: A instance types list