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 2012/07/21 06:24:27 UTC
svn commit: r1364039 [3/4] - in /libcloud/trunk: ./ libcloud/common/
libcloud/compute/ libcloud/compute/drivers/
Modified: libcloud/trunk/libcloud/compute/drivers/opennebula.py
URL: http://svn.apache.org/viewvc/libcloud/trunk/libcloud/compute/drivers/opennebula.py?rev=1364039&r1=1364038&r2=1364039&view=diff
==============================================================================
--- libcloud/trunk/libcloud/compute/drivers/opennebula.py (original)
+++ libcloud/trunk/libcloud/compute/drivers/opennebula.py Sat Jul 21 04:24:25 2012
@@ -167,8 +167,8 @@ class OpenNebulaConnection(ConnectionUse
@return: Dictionary containing updated headers.
"""
pass_sha1 = hashlib.sha1(b(self.key)).hexdigest()
- headers['Authorization'] = ('Basic %s' % b64encode(b('%s:%s' %
- (self.user_id,
+ headers['Authorization'] =\
+ ('Basic %s' % b64encode(b('%s:%s' % (self.user_id,
pass_sha1))).decode('utf-8'))
return headers
@@ -299,14 +299,12 @@ class OpenNebulaNodeDriver(NodeDriver):
"""
Create a new OpenNebula node.
- See L{NodeDriver.create_node} for more keyword args.
- @type networks: L{OpenNebulaNetwork} or C{list}
- of L{OpenNebulaNetwork}s
+ @inherits: L{NodeDriver.create_node}
+
@keyword networks: List of virtual networks to which this node should
connect. (optional)
-
- @rtype: L{Node}
- @return: Instance of a newly created node.
+ @type networks: L{OpenNebulaNetwork} or
+ C{list} of L{OpenNebulaNetwork}
"""
compute = ET.Element('COMPUTE')
@@ -317,8 +315,9 @@ class OpenNebulaNodeDriver(NodeDriver):
instance_type.text = kwargs['size'].name
storage = ET.SubElement(compute, 'STORAGE')
- ET.SubElement(storage, 'DISK', {'image': '%s' %
- (str(kwargs['image'].id))})
+ ET.SubElement(storage,
+ 'DISK',
+ {'image': '%s' % (str(kwargs['image'].id))})
if 'networks' in kwargs:
if not isinstance(kwargs['networks'], list):
@@ -328,11 +327,11 @@ class OpenNebulaNodeDriver(NodeDriver):
for network in kwargs['networks']:
if network.address:
ET.SubElement(networkGroup, 'NIC',
- {'network': '%s' % (str(network.id)),
- 'ip': network.address})
+ {'network': '%s' % (str(network.id)),
+ 'ip': network.address})
else:
ET.SubElement(networkGroup, 'NIC',
- {'network': '%s' % (str(network.id))})
+ {'network': '%s' % (str(network.id))})
xml = ET.tostring(compute)
node = self.connection.request('/compute', method='POST',
@@ -356,33 +355,33 @@ class OpenNebulaNodeDriver(NodeDriver):
"""
Return list of sizes on a provider.
- See L{NodeDriver.list_sizes} for more args.
+ @inherits: L{NodeDriver.list_sizes}
- @rtype: C{list} of L{OpenNebulaNodeSize}
@return: List of compute node sizes supported by the cloud provider.
+ @rtype: C{list} of L{OpenNebulaNodeSize}
"""
return [
NodeSize(id=1,
- name='small',
- ram=None,
- disk=None,
- bandwidth=None,
- price=None,
- driver=self),
+ name='small',
+ ram=None,
+ disk=None,
+ bandwidth=None,
+ price=None,
+ driver=self),
NodeSize(id=2,
- name='medium',
- ram=None,
- disk=None,
- bandwidth=None,
- price=None,
- driver=self),
+ name='medium',
+ ram=None,
+ disk=None,
+ bandwidth=None,
+ price=None,
+ driver=self),
NodeSize(id=3,
- name='large',
- ram=None,
- disk=None,
- bandwidth=None,
- price=None,
- driver=self),
+ name='large',
+ ram=None,
+ disk=None,
+ bandwidth=None,
+ price=None,
+ driver=self),
]
def list_locations(self):
@@ -396,9 +395,9 @@ class OpenNebulaNodeDriver(NodeDriver):
@param location: Location from which to request a list of virtual
networks. (optional)
- @rtype: C{list} of L{OpenNebulaNetwork}
@return: List of virtual networks available to be connected to a
compute node.
+ @rtype: C{list} of L{OpenNebulaNetwork}
"""
return self._to_networks(self.connection.request('/network').object)
@@ -410,14 +409,15 @@ class OpenNebulaNodeDriver(NodeDriver):
action which should be carried out on that compute node. Then
instruct the node to carry out that action.
- @type node: L{Node}
@param node: Compute node instance.
- @type action: C{str}
+ @type node: L{Node}
+
@param action: Action to be carried out on the compute node.
+ @type action: C{str}
- @rtype: C{bool}
@return: False if an HTTP Bad Request is received, else, True is
returned.
+ @rtype: C{bool}
"""
compute_node_id = str(node.id)
@@ -433,7 +433,7 @@ class OpenNebulaNodeDriver(NodeDriver):
url = '/compute/%s' % compute_node_id
resp = self.connection.request(url, method='PUT',
- data=xml)
+ data=xml)
if resp.status == httplib.BAD_REQUEST:
return False
@@ -455,8 +455,8 @@ class OpenNebulaNodeDriver(NodeDriver):
images = []
for element in object.findall('DISK'):
image_id = element.attrib['href'].partition('/storage/')[2]
- image = self.connection.request(('/storage/%s' % (
- image_id))).object
+ image = self.connection.request(
+ ('/storage/%s' % (image_id))).object
images.append(self._to_image(image))
return images
@@ -493,8 +493,8 @@ class OpenNebulaNodeDriver(NodeDriver):
networks = []
for element in object.findall('NETWORK'):
network_id = element.attrib['href'].partition('/network/')[2]
- network_element = self.connection.request(('/network/%s' % (
- network_id))).object
+ network_element = self.connection.request(
+ ('/network/%s' % (network_id))).object
networks.append(self._to_network(network_element))
return networks
@@ -511,10 +511,10 @@ class OpenNebulaNodeDriver(NodeDriver):
@return: The newly extracted L{OpenNebulaNetwork}.
"""
return OpenNebulaNetwork(id=element.findtext('ID'),
- name=element.findtext('NAME'),
- address=element.findtext('ADDRESS'),
- size=element.findtext('SIZE'),
- driver=self.connection.driver)
+ name=element.findtext('NAME'),
+ address=element.findtext('ADDRESS'),
+ size=element.findtext('SIZE'),
+ driver=self.connection.driver)
def _to_nodes(self, object):
"""
@@ -531,8 +531,8 @@ class OpenNebulaNodeDriver(NodeDriver):
computes = []
for element in object.findall('COMPUTE'):
compute_id = element.attrib['href'].partition('/compute/')[2]
- compute = self.connection.request(('/compute/%s' % (
- compute_id))).object
+ compute = self.connection.request(
+ ('/compute/%s' % (compute_id))).object
computes.append(self._to_node(compute))
return computes
@@ -583,10 +583,10 @@ class OpenNebulaNodeDriver(NodeDriver):
for element in network_list.findall('NIC'):
networks.append(
OpenNebulaNetwork(id=element.attrib.get('network', None),
- name=None,
- address=element.attrib.get('ip', None),
- size=1,
- driver=self.connection.driver))
+ name=None,
+ address=element.attrib.get('ip', None),
+ size=1,
+ driver=self.connection.driver))
return networks
@@ -610,9 +610,9 @@ class OpenNebulaNodeDriver(NodeDriver):
for element in disk_list.findall('DISK'):
disks.append(
NodeImage(id=element.attrib.get('image', None),
- name=None,
- driver=self.connection.driver,
- extra={'dev': element.attrib.get('dev', None)}))
+ name=None,
+ driver=self.connection.driver,
+ extra={'dev': element.attrib.get('dev', None)}))
# @TODO: Return all disks when the Node type accepts multiple
# attached disks per node.
@@ -640,17 +640,19 @@ class OpenNebula_2_0_NodeDriver(OpenNebu
"""
Create a new OpenNebula node.
- See L{NodeDriver.create_node} for more keyword args.
- @type networks: L{OpenNebulaNetwork} or C{list}
- of L{OpenNebulaNetwork}s
+ @inherits: L{NodeDriver.create_node}
+
@keyword networks: List of virtual networks to which this node should
connect. (optional)
- @type context: C{dict}
+ @type networks: L{OpenNebulaNetwork} or C{list}
+ of L{OpenNebulaNetwork}
+
@keyword context: Custom (key, value) pairs to be injected into
compute node XML description. (optional)
+ @type context: C{dict}
- @rtype: L{Node}
@return: Instance of a newly created node.
+ @rtype: L{Node}
"""
compute = ET.Element('COMPUTE')
@@ -661,8 +663,9 @@ class OpenNebula_2_0_NodeDriver(OpenNebu
instance_type.text = kwargs['size'].name
disk = ET.SubElement(compute, 'DISK')
- ET.SubElement(disk, 'STORAGE', {'href': '/storage/%s' %
- (str(kwargs['image'].id))})
+ ET.SubElement(disk,
+ 'STORAGE',
+ {'href': '/storage/%s' % (str(kwargs['image'].id))})
if 'networks' in kwargs:
if not isinstance(kwargs['networks'], list):
@@ -671,7 +674,7 @@ class OpenNebula_2_0_NodeDriver(OpenNebu
for network in kwargs['networks']:
nic = ET.SubElement(compute, 'NIC')
ET.SubElement(nic, 'NETWORK',
- {'href': '/network/%s' % (str(network.id))})
+ {'href': '/network/%s' % (str(network.id))})
if network.address:
ip_line = ET.SubElement(nic, 'IP')
ip_line.text = network.address
@@ -699,44 +702,44 @@ class OpenNebula_2_0_NodeDriver(OpenNebu
"""
Return list of sizes on a provider.
- See L{NodeDriver.list_sizes} for more args.
+ @inherits: L{NodeDriver.list_sizes}
- @rtype: C{list} of L{OpenNebulaNodeSize}
@return: List of compute node sizes supported by the cloud provider.
+ @rtype: C{list} of L{OpenNebulaNodeSize}
"""
return [
- OpenNebulaNodeSize(id=1,
- name='small',
- ram=1024,
- cpu=1,
- disk=None,
- bandwidth=None,
- price=None,
- driver=self),
- OpenNebulaNodeSize(id=2,
- name='medium',
- ram=4096,
- cpu=4,
- disk=None,
- bandwidth=None,
- price=None,
- driver=self),
- OpenNebulaNodeSize(id=3,
- name='large',
- ram=8192,
- cpu=8,
- disk=None,
- bandwidth=None,
- price=None,
- driver=self),
- OpenNebulaNodeSize(id=4,
- name='custom',
- ram=0,
- cpu=0,
- disk=None,
- bandwidth=None,
- price=None,
- driver=self),
+ OpenNebulaNodeSize(id=1,
+ name='small',
+ ram=1024,
+ cpu=1,
+ disk=None,
+ bandwidth=None,
+ price=None,
+ driver=self),
+ OpenNebulaNodeSize(id=2,
+ name='medium',
+ ram=4096,
+ cpu=4,
+ disk=None,
+ bandwidth=None,
+ price=None,
+ driver=self),
+ OpenNebulaNodeSize(id=3,
+ name='large',
+ ram=8192,
+ cpu=8,
+ disk=None,
+ bandwidth=None,
+ price=None,
+ driver=self),
+ OpenNebulaNodeSize(id=4,
+ name='custom',
+ ram=0,
+ cpu=0,
+ disk=None,
+ bandwidth=None,
+ price=None,
+ driver=self),
]
def _to_images(self, object):
@@ -754,8 +757,8 @@ class OpenNebula_2_0_NodeDriver(OpenNebu
images = []
for element in object.findall('STORAGE'):
image_id = element.attrib["href"].partition("/storage/")[2]
- image = self.connection.request(("/storage/%s" %
- (image_id))).object
+ image = self.connection.request(
+ ("/storage/%s" % (image_id))).object
images.append(self._to_image(image))
return images
@@ -829,11 +832,11 @@ class OpenNebula_2_0_NodeDriver(OpenNebu
networks.append(
OpenNebulaNetwork(id=network_id,
- name=network.attrib.get('name', None),
- address=element.findtext('IP'),
- size=1,
- driver=self.connection.driver,
- extra={'mac': element.findtext('MAC')}))
+ name=network.attrib.get('name', None),
+ address=element.findtext('IP'),
+ size=1,
+ driver=self.connection.driver,
+ extra={'mac': element.findtext('MAC')}))
return networks
@@ -858,10 +861,10 @@ class OpenNebula_2_0_NodeDriver(OpenNebu
disks.append(
NodeImage(id=disk_id,
- name=disk.attrib.get('name', None),
- driver=self.connection.driver,
- extra={'type': element.findtext('TYPE'),
- 'target': element.findtext('TARGET')}))
+ name=disk.attrib.get('name', None),
+ driver=self.connection.driver,
+ extra={'type': element.findtext('TYPE'),
+ 'target': element.findtext('TARGET')}))
# @TODO: Return all disks when the Node type accepts multiple
# attached disks per node.
@@ -887,7 +890,7 @@ class OpenNebula_2_0_NodeDriver(OpenNebu
try:
return next((node_size for node_size in self.list_sizes()
- if node_size.name == instance_type.text))
+ if node_size.name == instance_type.text))
except StopIteration:
return None
@@ -928,15 +931,16 @@ class OpenNebula_3_0_NodeDriver(OpenNebu
which will be saved, and the name under which the image will be saved
upon shutting down the compute node.
- @type node: L{Node}
@param node: Compute node instance.
- @type name: C{str}
+ @type node: L{Node}
+
@param name: Name under which the image should be saved after shutting
down the compute node.
+ @type name: C{str}
- @rtype: C{bool}
@return: False if an HTTP Bad Request is received, else, True is
returned.
+ @rtype: C{bool}
"""
compute_node_id = str(node.id)
@@ -947,9 +951,9 @@ class OpenNebula_3_0_NodeDriver(OpenNebu
disk = ET.SubElement(compute, 'DISK', {'id': str(node.image.id)})
- ET.SubElement(disk, 'STORAGE', {'href': '/storage/%s' %
- (str(node.image.id)),
- 'name': node.image.name})
+ ET.SubElement(disk, 'STORAGE',
+ {'href': '/storage/%s' % (str(node.image.id)),
+ 'name': node.image.name})
ET.SubElement(disk, 'SAVE_AS', {'name': str(name)})
@@ -957,7 +961,7 @@ class OpenNebula_3_0_NodeDriver(OpenNebu
url = '/compute/%s' % compute_node_id
resp = self.connection.request(url, method='PUT',
- data=xml)
+ data=xml)
if resp.status == httplib.BAD_REQUEST:
return False
@@ -972,15 +976,15 @@ class OpenNebula_3_0_NodeDriver(OpenNebu
Take XML representation containing a network description and
convert to OpenNebulaNetwork object.
- @rtype: L{OpenNebulaNetwork}
@return: The newly extracted L{OpenNebulaNetwork}.
+ @rtype: L{OpenNebulaNetwork}
"""
return OpenNebulaNetwork(id=element.findtext('ID'),
- name=element.findtext('NAME'),
- address=element.findtext('ADDRESS'),
- size=element.findtext('SIZE'),
- driver=self.connection.driver,
- extra={'public': element.findtext('PUBLIC')})
+ name=element.findtext('NAME'),
+ address=element.findtext('ADDRESS'),
+ size=element.findtext('SIZE'),
+ driver=self.connection.driver,
+ extra={'public': element.findtext('PUBLIC')})
class OpenNebula_3_2_NodeDriver(OpenNebula_3_0_NodeDriver):
@@ -995,10 +999,10 @@ class OpenNebula_3_2_NodeDriver(OpenNebu
"""
Return list of sizes on a provider.
- See L{NodeDriver.list_sizes} for more args.
+ @inherits: L{NodeDriver.list_sizes}
- @rtype: C{list} of L{OpenNebulaNodeSize}
@return: List of compute node sizes supported by the cloud provider.
+ @rtype: C{list} of L{OpenNebulaNodeSize}
"""
return self._to_sizes(self.connection.request('/instance_type').object)
@@ -1011,8 +1015,8 @@ class OpenNebula_3_2_NodeDriver(OpenNebu
and issue a request to convert each XML object representation of an
instance type to an OpenNebulaNodeSize object.
- @rtype: C{list} of L{OpenNebulaNodeSize}
@return: List of instance types.
+ @rtype: C{list} of L{OpenNebulaNodeSize}
"""
sizes = []
ids = 1
Modified: libcloud/trunk/libcloud/compute/drivers/openstack.py
URL: http://svn.apache.org/viewvc/libcloud/trunk/libcloud/compute/drivers/openstack.py?rev=1364039&r1=1364038&r2=1364039&view=diff
==============================================================================
--- libcloud/trunk/libcloud/compute/drivers/openstack.py (original)
+++ libcloud/trunk/libcloud/compute/drivers/openstack.py Sat Jul 21 04:24:25 2012
@@ -54,7 +54,7 @@ __all__ = [
'OpenStack_1_1_Connection',
'OpenStack_1_1_NodeDriver',
'OpenStackNodeDriver'
- ]
+]
ATOM_NAMESPACE = "http://www.w3.org/2005/Atom"
@@ -62,7 +62,6 @@ DEFAULT_API_VERSION = '1.1'
class OpenStackResponse(Response):
-
node_driver = None
def success(self):
@@ -166,7 +165,6 @@ class OpenStackNodeDriver(NodeDriver, Op
'VERIFY_RESIZE': NodeState.RUNNING,
'PASSWORD': NodeState.PENDING,
'RESCUE': NodeState.PENDING,
- 'REBUILD': NodeState.PENDING,
'REBOOT': NodeState.REBOOTING,
'HARD_REBOOT': NodeState.REBOOTING,
'SHARE_IP': NodeState.PENDING,
@@ -176,7 +174,7 @@ class OpenStackNodeDriver(NodeDriver, Op
}
def __new__(cls, key, secret=None, secure=True, host=None, port=None,
- api_version=DEFAULT_API_VERSION, **kwargs):
+ api_version=DEFAULT_API_VERSION, **kwargs):
"""
@requires: key, secret
"""
@@ -209,16 +207,23 @@ class OpenStackNodeDriver(NodeDriver, Op
return self._reboot_node(node, reboot_type='HARD')
def list_nodes(self):
- return self._to_nodes(self.connection.request('/servers/detail')
- .object)
+ return self._to_nodes(
+ self.connection.request('/servers/detail').object)
def list_images(self, location=None, ex_only_active=True):
- return self._to_images(self.connection.request('/images/detail')
- .object, ex_only_active)
+ """
+ @inherits: L{NodeDriver.list_images}
+
+ @param ex_only_active: True if list only active
+ @type ex_only_active: C{bool}
+
+ """
+ return self._to_images(
+ self.connection.request('/images/detail').object, ex_only_active)
def list_sizes(self, location=None):
- return self._to_sizes(self.connection.request('/flavors/detail')
- .object)
+ return self._to_sizes(
+ self.connection.request('/flavors/detail').object)
def list_locations(self):
return [NodeLocation(0, '', '', self)]
@@ -227,6 +232,14 @@ class OpenStackNodeDriver(NodeDriver, Op
return self.openstack_connection_kwargs()
def ex_get_node_details(self, node_id):
+ """
+ Lists details of the specified server.
+
+ @param node_id: ID of the node which should be used
+ @type node_id: C{str}
+
+ @rtype: L{Node}
+ """
# @TODO: Remove this if in 0.6
if isinstance(node_id, Node):
node_id = node_id.id
@@ -239,14 +252,29 @@ class OpenStackNodeDriver(NodeDriver, Op
return self._to_node_from_obj(resp.object)
def ex_soft_reboot_node(self, node):
+ """
+ Soft reboots the specified server
+
+ @param node: node
+ @type node: L{Node}
+
+ @rtype: C{bool}
+ """
return self._reboot_node(node, reboot_type='SOFT')
def ex_hard_reboot_node(self, node):
+ """
+ Hard reboots the specified server
+
+ @param node: node
+ @type node: L{Node}
+
+ @rtype: C{bool}
+ """
return self._reboot_node(node, reboot_type='HARD')
class OpenStack_1_0_Response(OpenStackResponse):
-
def __init__(self, *args, **kwargs):
# done because of a circular reference from
# NodeDriver -> Connection -> Response
@@ -293,15 +321,17 @@ class OpenStack_1_0_NodeDriver(OpenStack
def _to_image(self, element):
return NodeImage(id=element.get('id'),
- name=element.get('name'),
- driver=self.connection.driver,
- extra={'updated': element.get('updated'),
- 'created': element.get('created'),
- 'status': element.get('status'),
- 'serverId': element.get('serverId'),
- 'progress': element.get('progress'),
- 'minDisk': element.get('minDisk'),
- 'minRam': element.get('minRam')})
+ name=element.get('name'),
+ driver=self.connection.driver,
+ extra={'updated': element.get('updated'),
+ 'created': element.get('created'),
+ 'status': element.get('status'),
+ 'serverId': element.get('serverId'),
+ 'progress': element.get('progress'),
+ 'minDisk': element.get('minDisk'),
+ 'minRam': element.get('minRam')
+ }
+ )
def _change_password_or_name(self, node, name=None, password=None):
uri = '/servers/%s' % (node.id)
@@ -310,9 +340,9 @@ class OpenStack_1_0_NodeDriver(OpenStack
name = node.name
body = {'xmlns': self.XML_NAMESPACE,
- 'name': name}
+ 'name': name}
- if password != None:
+ if password is not None:
body['adminPass'] = password
server_elm = ET.Element('server', body)
@@ -320,7 +350,7 @@ class OpenStack_1_0_NodeDriver(OpenStack
resp = self.connection.request(
uri, method='PUT', data=ET.tostring(server_elm))
- if resp.status == httplib.NO_CONTENT and password != None:
+ if resp.status == httplib.NO_CONTENT and password is not None:
node.extra['password'] = password
return resp.status == httplib.NO_CONTENT
@@ -329,7 +359,8 @@ class OpenStack_1_0_NodeDriver(OpenStack
"""
Create a new node
- See L{NodeDriver.create_node} for more keyword args.
+ @inherits: L{NodeDriver.create_node}
+
@keyword ex_metadata: Key/Value metadata to associate with a node
@type ex_metadata: C{dict}
@@ -342,16 +373,16 @@ class OpenStack_1_0_NodeDriver(OpenStack
size = kwargs['size']
attributes = {'xmlns': self.XML_NAMESPACE,
- 'name': name,
- 'imageId': str(image.id),
- 'flavorId': str(size.id)}
+ 'name': name,
+ 'imageId': str(image.id),
+ 'flavorId': str(size.id)}
if 'ex_shared_ip_group' in kwargs:
# Deprecate this. Be explicit and call the variable
# ex_shared_ip_group_id since user needs to pass in the id, not the
# name.
- warnings.warn('ex_shared_ip_group argument is deprecated. Please'
- + ' use ex_shared_ip_group_id')
+ warnings.warn('ex_shared_ip_group argument is deprecated.'
+ ' Please use ex_shared_ip_group_id')
if 'ex_shared_ip_group_id' in kwargs:
shared_ip_group_id = kwargs['ex_shared_ip_group_id']
@@ -378,8 +409,16 @@ class OpenStack_1_0_NodeDriver(OpenStack
This will reboot the instance to complete the operation.
- L{node.extra['password']} will be set to the new value if the
+ L{Node.extra['password']} will be set to the new value if the
operation was successful.
+
+ @param node: node to set password
+ @type node: L{Node}
+
+ @param password: new password.
+ @type password: C{str}
+
+ @rtype: C{bool}
"""
return self._change_password_or_name(node, password=password)
@@ -388,6 +427,14 @@ class OpenStack_1_0_NodeDriver(OpenStack
Sets the Node's name.
This will reboot the instance to complete the operation.
+
+ @param node: node to set name
+ @type node: L{Node}
+
+ @param name: new name
+ @type name: C{str}
+
+ @rtype: C{bool}
"""
return self._change_password_or_name(node, name=name)
@@ -395,17 +442,18 @@ class OpenStack_1_0_NodeDriver(OpenStack
"""
Change an existing server flavor / scale the server up or down.
- @keyword node: node to resize.
- @param node: C{Node}
+ @param node: node to resize.
+ @type node: L{Node}
+
+ @param size: new size.
+ @type size: L{NodeSize}
- @keyword size: new size.
- @param size: C{NodeSize}
+ @rtype: C{bool}
"""
elm = ET.Element(
'resize',
{'xmlns': self.XML_NAMESPACE,
- 'flavorId': str(size.id),
- }
+ 'flavorId': str(size.id)}
)
resp = self.connection.request("/servers/%s/action" % (node.id),
@@ -421,8 +469,10 @@ class OpenStack_1_0_NodeDriver(OpenStack
For more info refer to the API documentation: http://goo.gl/zjFI1
- @keyword node: node for which the resize request will be confirmed.
- @param node: C{Node}
+ @param node: node for which the resize request will be confirmed.
+ @type node: L{Node}
+
+ @rtype: C{bool}
"""
elm = ET.Element(
'confirmResize',
@@ -442,8 +492,10 @@ class OpenStack_1_0_NodeDriver(OpenStack
For more info refer to the API documentation: http://goo.gl/AizBu
- @keyword node: node for which the resize request will be reverted.
- @param node: C{Node}
+ @param node: node for which the resize request will be reverted.
+ @type node: L{Node}
+
+ @rtype: C{bool}
"""
elm = ET.Element(
'revertResize',
@@ -456,6 +508,17 @@ class OpenStack_1_0_NodeDriver(OpenStack
return resp.status == httplib.NO_CONTENT
def ex_rebuild(self, node_id, image_id):
+ """
+ Rebuilds the specified server.
+
+ @param node_id: ID of the node which should be used
+ @type node_id: C{str}
+
+ @param image_id: ID of the image which should be used
+ @type image_id: C{str}
+
+ @rtype: C{bool}
+ """
# @TODO: Remove those ifs in 0.6
if isinstance(node_id, Node):
node_id = node_id.id
@@ -466,8 +529,7 @@ class OpenStack_1_0_NodeDriver(OpenStack
elm = ET.Element(
'rebuild',
{'xmlns': self.XML_NAMESPACE,
- 'imageId': image_id,
- }
+ 'imageId': image_id}
)
resp = self.connection.request("/servers/%s/action" % node_id,
@@ -476,6 +538,17 @@ class OpenStack_1_0_NodeDriver(OpenStack
return resp.status == httplib.ACCEPTED
def ex_create_ip_group(self, group_name, node_id=None):
+ """
+ Creates a shared IP group.
+
+ @param group_name: group name which should be used
+ @type group_name: C{str}
+
+ @param node_id: ID of the node which should be used
+ @type node_id: C{str}
+
+ @rtype: C{bool}
+ """
# @TODO: Remove this if in 0.6
if isinstance(node_id, Node):
node_id = node_id.id
@@ -483,12 +556,12 @@ class OpenStack_1_0_NodeDriver(OpenStack
group_elm = ET.Element(
'sharedIpGroup',
{'xmlns': self.XML_NAMESPACE,
- 'name': group_name,
- }
+ 'name': group_name}
)
if node_id:
- ET.SubElement(group_elm,
+ ET.SubElement(
+ group_elm,
'server',
{'id': node_id}
)
@@ -499,19 +572,53 @@ class OpenStack_1_0_NodeDriver(OpenStack
return self._to_shared_ip_group(resp.object)
def ex_list_ip_groups(self, details=False):
+ """
+ Lists IDs and names for shared IP groups.
+ If details lists all details for shared IP groups.
+
+ @param details: True if details is required
+ @type details: C{bool}
+
+ @rtype: C{list} of L{OpenStack_1_0_SharedIpGroup}
+ """
uri = '/shared_ip_groups/detail' if details else '/shared_ip_groups'
resp = self.connection.request(uri,
method='GET')
groups = findall(resp.object, 'sharedIpGroup',
- self.XML_NAMESPACE)
+ self.XML_NAMESPACE)
return [self._to_shared_ip_group(el) for el in groups]
def ex_delete_ip_group(self, group_id):
+ """
+ Deletes the specified shared IP group.
+
+ @param group_id: group id which should be used
+ @type group_id: C{str}
+
+ @rtype: C{bool}
+ """
uri = '/shared_ip_groups/%s' % group_id
resp = self.connection.request(uri, method='DELETE')
return resp.status == httplib.NO_CONTENT
def ex_share_ip(self, group_id, node_id, ip, configure_node=True):
+ """
+ Shares an IP address to the specified server.
+
+ @param group_id: group id which should be used
+ @type group_id: C{str}
+
+ @param node_id: ID of the node which should be used
+ @type node_id: C{str}
+
+ @param ip: ip which should be used
+ @type ip: C{str}
+
+ @param configure_node: configure node
+ @type configure_node: C{bool}
+
+ @rtype: C{bool}
+ """
# @TODO: Remove this if in 0.6
if isinstance(node_id, Node):
node_id = node_id.id
@@ -536,6 +643,17 @@ class OpenStack_1_0_NodeDriver(OpenStack
return resp.status == httplib.ACCEPTED
def ex_unshare_ip(self, node_id, ip):
+ """
+ Removes a shared IP address from the specified server.
+
+ @param node_id: ID of the node which should be used
+ @type node_id: C{str}
+
+ @param ip: ip which should be used
+ @type ip: C{str}
+
+ @rtype: C{bool}
+ """
# @TODO: Remove this if in 0.6
if isinstance(node_id, Node):
node_id = node_id.id
@@ -547,6 +665,14 @@ class OpenStack_1_0_NodeDriver(OpenStack
return resp.status == httplib.ACCEPTED
def ex_list_ip_addresses(self, node_id):
+ """
+ List all server addresses.
+
+ @param node_id: ID of the node which should be used
+ @type node_id: C{str}
+
+ @rtype: C{bool}
+ """
# @TODO: Remove this if in 0.6
if isinstance(node_id, Node):
node_id = node_id.id
@@ -598,8 +724,7 @@ class OpenStack_1_0_NodeDriver(OpenStack
return [self._to_node(el) for el in node_elements]
def _to_node_from_obj(self, obj):
- return self._to_node(findall(obj, 'server',
- self.XML_NAMESPACE)[0])
+ return self._to_node(findall(obj, 'server', self.XML_NAMESPACE)[0])
def _to_node(self, el):
def get_ips(el):
@@ -612,11 +737,11 @@ class OpenStack_1_0_NodeDriver(OpenStack
return d
public_ip = get_ips(findall(el, 'addresses/public/ip',
- self.XML_NAMESPACE))
+ self.XML_NAMESPACE))
private_ip = get_ips(findall(el, 'addresses/private/ip',
- self.XML_NAMESPACE))
+ self.XML_NAMESPACE))
metadata = get_meta_dict(findall(el, 'metadata/meta',
- self.XML_NAMESPACE))
+ self.XML_NAMESPACE))
n = Node(id=el.get('id'),
name=el.get('name'),
@@ -626,14 +751,14 @@ class OpenStack_1_0_NodeDriver(OpenStack
private_ips=private_ip,
driver=self.connection.driver,
extra={
- 'password': el.get('adminPass'),
- 'hostId': el.get('hostId'),
- 'imageId': el.get('imageId'),
- 'flavorId': el.get('flavorId'),
- 'uri': "https://%s%s/servers/%s" % (
+ 'password': el.get('adminPass'),
+ 'hostId': el.get('hostId'),
+ 'imageId': el.get('imageId'),
+ 'flavorId': el.get('flavorId'),
+ 'uri': "https://%s%s/servers/%s" % (
self.connection.host,
self.connection.request_path, el.get('id')),
- 'metadata': metadata,
+ 'metadata': metadata,
})
return n
@@ -643,14 +768,14 @@ class OpenStack_1_0_NodeDriver(OpenStack
def _to_size(self, el):
return NodeSize(id=el.get('id'),
- name=el.get('name'),
- ram=int(el.get('ram')),
- disk=int(el.get('disk')),
- # XXX: needs hardcode
- bandwidth=None,
- # Hardcoded
- price=self._get_size_price(el.get('id')),
- driver=self.connection.driver)
+ name=el.get('name'),
+ ram=int(el.get('ram')),
+ disk=int(el.get('disk')),
+ # XXX: needs hardcode
+ bandwidth=None,
+ # Hardcoded
+ price=self._get_size_price(el.get('id')),
+ driver=self.connection.driver)
def ex_limits(self):
"""
@@ -659,7 +784,8 @@ class OpenStack_1_0_NodeDriver(OpenStack
and absolute limits like total amount of available
RAM to be used by servers.
- @return: C{dict} with keys 'rate' and 'absolute'
+ @return: dict with keys 'rate' and 'absolute'
+ @rtype: C{dict}
"""
def _to_rate(el):
@@ -674,10 +800,10 @@ class OpenStack_1_0_NodeDriver(OpenStack
limits = self.connection.request("/limits").object
rate = [_to_rate(el) for el in findall(limits, 'rate/limit',
- self.XML_NAMESPACE)]
+ self.XML_NAMESPACE)]
absolute = {}
for item in findall(limits, 'absolute/limit',
- self.XML_NAMESPACE):
+ self.XML_NAMESPACE):
absolute.update(_to_absolute(item))
return {"rate": rate, "absolute": absolute}
@@ -685,27 +811,33 @@ class OpenStack_1_0_NodeDriver(OpenStack
def ex_save_image(self, node, name):
"""Create an image for node.
- @keyword node: node to use as a base for image
- @param node: L{Node}
- @keyword name: name for new image
- @param name: C{string}
+ @param node: node to use as a base for image
+ @type node: L{Node}
+
+ @param name: name for new image
+ @type name: C{str}
+
+ @rtype: L{NodeImage}
"""
image_elm = ET.Element(
- 'image',
- {'xmlns': self.XML_NAMESPACE,
- 'name': name,
- 'serverId': node.id})
-
- return self._to_image(self.connection.request("/images",
- method="POST",
- data=ET.tostring(image_elm)).object)
+ 'image',
+ {'xmlns': self.XML_NAMESPACE,
+ 'name': name,
+ 'serverId': node.id}
+ )
+
+ return self._to_image(
+ self.connection.request("/images", method="POST",
+ data=ET.tostring(image_elm)).object)
def ex_delete_image(self, image):
"""Delete an image for node.
- @keyword image: the image to be deleted
- @param image: L{NodeImage}
+ @param image: the image to be deleted
+ @type image: L{NodeImage}
+
+ @rtype: C{bool}
"""
uri = '/images/%s' % image.id
resp = self.connection.request(uri, method='DELETE')
@@ -716,20 +848,20 @@ class OpenStack_1_0_NodeDriver(OpenStack
if servers_el:
servers = [s.get('id')
for s in findall(servers_el[0], 'server',
- self.XML_NAMESPACE)]
+ self.XML_NAMESPACE)]
else:
servers = None
return OpenStack_1_0_SharedIpGroup(id=el.get('id'),
- name=el.get('name'),
- servers=servers)
+ name=el.get('name'),
+ servers=servers)
def _to_ip_addresses(self, el):
- public_ips = [ip.get('addr') for ip in findall(findall(el, 'public',
- self.XML_NAMESPACE)[0],
- 'ip', self.XML_NAMESPACE)]
- private_ips = [ip.get('addr') for ip in findall(findall(el, 'private',
- self.XML_NAMESPACE)[0],
- 'ip', self.XML_NAMESPACE)]
+ public_ips = [ip.get('addr') for ip in findall(
+ findall(el, 'public', self.XML_NAMESPACE)[0],
+ 'ip', self.XML_NAMESPACE)]
+ private_ips = [ip.get('addr') for ip in findall(
+ findall(el, 'private', self.XML_NAMESPACE)[0],
+ 'ip', self.XML_NAMESPACE)]
return OpenStack_1_0_NodeIpAddresses(public_ips, private_ips)
@@ -764,7 +896,6 @@ class OpenStack_1_0_NodeIpAddresses(obje
class OpenStack_1_1_Response(OpenStackResponse):
-
def __init__(self, *args, **kwargs):
# done because of a circular reference from
# NodeDriver -> Connection -> Response
@@ -791,7 +922,6 @@ class OpenStack_1_1_NodeDriver(OpenStack
features = {"create_node": ["generates_password"]}
def __init__(self, *args, **kwargs):
-
self._ex_force_api_version = str(kwargs.pop('ex_force_api_version',
None))
super(OpenStack_1_1_NodeDriver, self).__init__(*args, **kwargs)
@@ -799,23 +929,23 @@ class OpenStack_1_1_NodeDriver(OpenStack
def create_node(self, **kwargs):
"""Create a new node
- See L{NodeDriver.create_node} for more keyword args.
+ @inherits: L{NodeDriver.create_node}
+
@keyword ex_metadata: Key/Value metadata to associate with a node
@type ex_metadata: C{dict}
@keyword ex_files: File Path => File contents to create on
- the node
+ the no de
@type ex_files: C{dict}
@keyword ex_keyname: Name of existing public key to inject into
instance
- @type ex_keyname: C{string}
+ @type ex_keyname: C{str}
@keyword ex_userdata: String containing user data
see
https://help.ubuntu.com/community/CloudInit
- @type ex_userdata: C{string}
-
+ @type ex_userdata: C{str}
"""
server_params = self._create_args_to_params(None, **kwargs)
@@ -825,7 +955,8 @@ class OpenStack_1_1_NodeDriver(OpenStack
data={'server': server_params})
create_response = resp.object['server']
- server_resp = self.connection.request('/servers/%s' % create_response['id'])
+ server_resp = self.connection.request(
+ '/servers/%s' % create_response['id'])
server_object = server_resp.object['server']
server_object['adminPass'] = create_response['adminPass']
@@ -843,20 +974,20 @@ class OpenStack_1_1_NodeDriver(OpenStack
def _to_image(self, api_image):
server = api_image.get('server', {})
return NodeImage(
- id=api_image['id'],
- name=api_image['name'],
- driver=self,
- extra=dict(
- updated=api_image['updated'],
- created=api_image['created'],
- status=api_image['status'],
- progress=api_image.get('progress'),
- metadata=api_image.get('metadata'),
- serverId=server.get('id'),
- minDisk=api_image.get('minDisk'),
- minRam=api_image.get('minRam'),
- )
- )
+ id=api_image['id'],
+ name=api_image['name'],
+ driver=self,
+ extra=dict(
+ updated=api_image['updated'],
+ created=api_image['created'],
+ status=api_image['status'],
+ progress=api_image.get('progress'),
+ metadata=api_image.get('metadata'),
+ serverId=server.get('id'),
+ minDisk=api_image.get('minDisk'),
+ minRam=api_image.get('minRam'),
+ )
+ )
def _to_nodes(self, obj):
servers = obj['servers']
@@ -911,6 +1042,17 @@ class OpenStack_1_1_NodeDriver(OpenStack
return resp.status == httplib.ACCEPTED
def ex_set_password(self, node, password):
+ """
+ Changes the administrator password for a specified server.
+
+ @param node: Node to rebuild.
+ @type node: L{Node}
+
+ @param password: The administrator password.
+ @type password: C{str}
+
+ @rtype: C{bool}
+ """
resp = self._node_action(node, 'changePassword', adminPass=password)
node.extra['password'] = password
return resp.status == httplib.ACCEPTED
@@ -919,11 +1061,13 @@ class OpenStack_1_1_NodeDriver(OpenStack
"""
Rebuild a Node.
- @type node: C{Node}
- @param node: Node to rebuild.
+ @param node: Node to rebuild.
+ @type node: L{Node}
- @type image: C{NodeImage}
- @param image: New image to use.
+ @param image: New image to use.
+ @type image: L{NodeImage}
+
+ @rtype: C{bool}
"""
server_params = self._create_args_to_params(node, image=image)
resp = self._node_action(node, 'rebuild', **server_params)
@@ -933,26 +1077,57 @@ class OpenStack_1_1_NodeDriver(OpenStack
"""
Change a node size.
- @type node: C{Node}
- @param node: Node to resize.
+ @param node: Node to resize.
+ @type node: L{Node}
- @type image: C{NodeSize}
- @param image: New size to use.
- """
+ @type size: L{NodeSize}
+ @param size: New size to use.
+ @rtype: C{bool}
+ """
server_params = self._create_args_to_params(node, size=size)
resp = self._node_action(node, 'resize', **server_params)
return resp.status == httplib.ACCEPTED
def ex_confirm_resize(self, node):
+ """
+ Confirms a pending resize action.
+
+ @param node: Node to resize.
+ @type node: L{Node}
+
+ @rtype: C{bool}
+ """
resp = self._node_action(node, 'confirmResize')
return resp.status == httplib.NO_CONTENT
def ex_revert_resize(self, node):
+ """
+ Cancels and reverts a pending resize action.
+
+ @param node: Node to resize.
+ @type node: L{Node}
+
+ @rtype: C{bool}
+ """
resp = self._node_action(node, 'revertResize')
return resp.status == httplib.ACCEPTED
def ex_save_image(self, node, name, metadata=None):
+ """
+ Creates a new image.
+
+ @param node: Node
+ @type node: L{Node}
+
+ @param name: The name for the new image.
+ @type name: C{str}
+
+ @param metadata: Key and value pairs for metadata.
+ @type metadata: C{dict}
+
+ @rtype: L{NodeImage}
+ """
optional_params = {}
if metadata:
optional_params['metadata'] = metadata
@@ -964,6 +1139,14 @@ class OpenStack_1_1_NodeDriver(OpenStack
def ex_set_server_name(self, node, name):
"""
Sets the Node's name.
+
+ @param node: Node
+ @type node: L{Node}
+
+ @param name: The name of the server.
+ @type name: C{str}
+
+ @rtype: L{Node}
"""
return self._update_node(node, name=name)
@@ -971,24 +1154,32 @@ class OpenStack_1_1_NodeDriver(OpenStack
"""
Get a Node's metadata.
- @return Key/Value metadata associated with node.
- @type C{dict}
+ @param node: Node
+ @type node: L{Node}
+
+ @return: Key/Value metadata associated with node.
+ @rtype: C{dict}
"""
return self.connection.request(
- '/servers/%s/metadata' % (node.id,), method='GET',
- ).object['metadata']
+ '/servers/%s/metadata' % (node.id,),
+ method='GET',).object['metadata']
def ex_set_metadata(self, node, metadata):
"""
Sets the Node's metadata.
- @keyword metadata: Key/Value metadata to associate with a node
+ @param node: Node
+ @type node: L{Node}
+
+ @param metadata: Key/Value metadata to associate with a node
@type metadata: C{dict}
+
+ @rtype: C{dict}
"""
return self.connection.request(
- '/servers/%s/metadata' % (node.id,), method='PUT',
- data={'metadata': metadata}
- ).object['metadata']
+ '/servers/%s/metadata' % (node.id,), method='PUT',
+ data={'metadata': metadata}
+ ).object['metadata']
def ex_update_node(self, node, **node_updates):
"""
@@ -997,24 +1188,51 @@ class OpenStack_1_1_NodeDriver(OpenStack
The driver currently only supports updating the node name.
+ @param node: Node
+ @type node: L{Node}
+
@keyword name: New name for the server
@type name: C{str}
+
+ @rtype: L{Node}
"""
potential_data = self._create_args_to_params(node, **node_updates)
updates = {'name': potential_data['name']}
return self._update_node(node, **updates)
def ex_get_size(self, size_id):
- return self._to_size(self.connection.request('/flavors/%s' %
- (size_id,))
- .object['flavor'])
+ """
+ Get a NodeSize
+
+ @param size_id: ID of the size which should be used
+ @type size_id: C{str}
+
+ @rtype: L{NodeSize}
+ """
+ return self._to_size(self.connection.request(
+ '/flavors/%s' % (size_id,)) .object['flavor'])
def ex_get_image(self, image_id):
- return self._to_image(self.connection.request('/images/%s' %
- (image_id,))
- .object['image'])
+ """
+ Get a NodeImage
+
+ @param image_id: ID of the image which should be used
+ @type image_id: C{str}
+
+ @rtype: L{NodeImage}
+ """
+ return self._to_image(self.connection.request(
+ '/images/%s' % (image_id,)).object['image'])
def ex_delete_image(self, image):
+ """
+ Delete a NodeImage
+
+ @param image: image witch should be used
+ @type image: L{NodeImage}
+
+ @rtype: C{bool}
+ """
resp = self.connection.request('/images/%s' % (image.id,),
method='DELETE')
return resp.status == httplib.NO_CONTENT
@@ -1046,10 +1264,10 @@ class OpenStack_1_1_NodeDriver(OpenStack
state=self.NODE_STATE_MAP.get(api_node['status'],
NodeState.UNKNOWN),
public_ips=[addr_desc['addr'] for addr_desc in
- chain(api_node['addresses'].get('public', []),
- api_node['addresses'].get('internet', []))],
+ chain(api_node['addresses'].get('public', []),
+ api_node['addresses'].get('internet', []))],
private_ips=[addr_desc['addr'] for addr_desc in
- api_node['addresses'].get('private', [])],
+ api_node['addresses'].get('private', [])],
driver=self,
extra=dict(
hostId=api_node['hostId'],
@@ -1059,7 +1277,7 @@ class OpenStack_1_1_NodeDriver(OpenStack
imageId=api_node['image']['id'],
flavorId=api_node['flavor']['id'],
uri=next(link['href'] for link in api_node['links'] if
- link['rel'] == 'self'),
+ link['rel'] == 'self'),
metadata=api_node['metadata'],
password=api_node.get('adminPass'),
created=api_node['created'],
@@ -1085,14 +1303,14 @@ class OpenStack_1_1_NodeDriver(OpenStack
)
def _get_size_price(self, size_id):
- try:
- return get_size_price(
- driver_type='compute',
- driver_name=self.api_name,
- size_id=size_id,
- )
- except KeyError:
- return(0.0)
+ try:
+ return get_size_price(
+ driver_type='compute',
+ driver_name=self.api_name,
+ size_id=size_id,
+ )
+ except KeyError:
+ return(0.0)
def _extract_image_id_from_url(self, location_header):
path = urlparse.urlparse(location_header).path
@@ -1101,6 +1319,17 @@ class OpenStack_1_1_NodeDriver(OpenStack
def ex_rescue(self, node, password=None):
# Requires Rescue Mode extension
+ """
+ Rescue a node
+
+ @param node: node
+ @type node: L{Node}
+
+ @param password: password
+ @type password: C{str}
+
+ @rtype: L{Node}
+ """
if password:
resp = self._node_action(node, 'rescue', adminPass=password)
else:
@@ -1110,5 +1339,13 @@ class OpenStack_1_1_NodeDriver(OpenStack
return node
def ex_unrescue(self, node):
+ """
+ Unrescue a node
+
+ @param node: node
+ @type node: L{Node}
+
+ @rtype: C{bool}
+ """
resp = self._node_action(node, 'unrescue')
return resp.status == httplib.ACCEPTED
Modified: libcloud/trunk/libcloud/compute/drivers/opsource.py
URL: http://svn.apache.org/viewvc/libcloud/trunk/libcloud/compute/drivers/opsource.py?rev=1364039&r1=1364038&r2=1364039&view=diff
==============================================================================
--- libcloud/trunk/libcloud/compute/drivers/opsource.py (original)
+++ libcloud/trunk/libcloud/compute/drivers/opsource.py Sat Jul 21 04:24:25 2012
@@ -103,8 +103,8 @@ class OpsourceResponse(XmlResponse):
code = findtext(body, 'resultCode', SERVER_NS)
message = findtext(body, 'resultDetail', SERVER_NS)
raise OpsourceAPIException(code,
- message,
- driver=OpsourceNodeDriver)
+ message,
+ driver=OpsourceNodeDriver)
return self.body
@@ -135,8 +135,8 @@ class OpsourceConnection(ConnectionUserA
responseCls = OpsourceResponse
def add_default_headers(self, headers):
- headers['Authorization'] = ('Basic %s' % b64encode(b('%s:%s' %
- (self.user_id,
+ headers['Authorization'] = \
+ ('Basic %s' % b64encode(b('%s:%s' % (self.user_id,
self.key))).decode('utf-8'))
return headers
@@ -165,7 +165,7 @@ class OpsourceConnection(ConnectionUserA
networks, and customer snapshots.
"""
return ("%s/%s/%s" % (self.api_path, self.api_version,
- self._get_orgId()))
+ self._get_orgId()))
def _get_orgId(self):
"""
@@ -173,7 +173,7 @@ class OpsourceConnection(ConnectionUserA
'orgId' from the XML response object. We need the orgId to use most
of the other API functions
"""
- if self._orgId == None:
+ if self._orgId is None:
body = self.request('myaccount').object
self._orgId = findtext(body, 'orgId', DIRECTORY_NS)
return self._orgId
@@ -186,9 +186,9 @@ class OpsourceStatus(object):
step.name, step.number, step.percentComplete, failureReason,
"""
def __init__(self, action=None, requestTime=None, userName=None,
- numberOfSteps=None, updateTime=None, step_name=None,
- step_number=None, step_percentComplete=None,
- failureReason=None):
+ numberOfSteps=None, updateTime=None, step_name=None,
+ step_number=None, step_percentComplete=None,
+ failureReason=None):
self.action = action
self.requestTime = requestTime
self.userName = userName
@@ -200,14 +200,14 @@ class OpsourceStatus(object):
self.failureReason = failureReason
def __repr__(self):
- return (('<OpsourceStatus: action=%s, requestTime=%s, userName=%s, ' \
- 'numberOfSteps=%s, updateTime=%s, step_name=%s, ' \
- 'step_number=%s, step_percentComplete=%s, ' \
- 'failureReason=%s')
- % (self.action, self.requestTime, self.userName,
- self.numberOfSteps, self.updateTime, self.step_name,
- self.step_number, self.step_percentComplete,
- self.failureReason))
+ return (('<OpsourceStatus: action=%s, requestTime=%s, userName=%s, '
+ 'numberOfSteps=%s, updateTime=%s, step_name=%s, '
+ 'step_number=%s, step_percentComplete=%s, '
+ 'failureReason=%s')
+ % (self.action, self.requestTime, self.userName,
+ self.numberOfSteps, self.updateTime, self.step_name,
+ self.step_number, self.step_percentComplete,
+ self.failureReason))
class OpsourceNetwork(object):
@@ -216,7 +216,7 @@ class OpsourceNetwork(object):
"""
def __init__(self, id, name, description, location, privateNet,
- multicast, status):
+ multicast, status):
self.id = str(id)
self.name = name
self.description = description
@@ -226,7 +226,7 @@ class OpsourceNetwork(object):
self.status = status
def __repr__(self):
- return (('<OpsourceNetwork: id=%s, name=%s, description=%s, ' \
+ return (('<OpsourceNetwork: id=%s, name=%s, description=%s, '
'location=%s, privateNet=%s, multicast=%s>')
% (self.id, self.name, self.description, self.location,
self.privateNet, self.multicast))
@@ -247,9 +247,8 @@ class OpsourceNodeDriver(NodeDriver):
"""
Create a new opsource node
- Standard keyword arguments from L{NodeDriver.create_node}:
@keyword name: String with a name for this new node (required)
- @type name: str
+ @type name: C{str}
@keyword image: OS Image to boot on node. (required)
@type image: L{NodeImage}
@@ -258,7 +257,6 @@ class OpsourceNodeDriver(NodeDriver):
node (required)
@type auth: L{NodeAuthPassword}
- Non-standard keyword arguments:
@keyword ex_description: description for this node (required)
@type ex_description: C{str}
@@ -274,6 +272,7 @@ class OpsourceNodeDriver(NodeDriver):
so the returned L{Node} is not guaranteed to be the same one
that was created. This is only the case when multiple nodes
with the same name exist.
+ @rtype: L{Node}
"""
name = kwargs['name']
image = kwargs['image']
@@ -303,7 +302,7 @@ class OpsourceNodeDriver(NodeDriver):
imageResourcePath = image.extra['resourcePath']
else:
imageResourcePath = "%s/%s" % (self.connection.get_resource_path(),
- image.id)
+ image.id)
server_elm = ET.Element('Server', {'xmlns': SERVER_NS})
ET.SubElement(server_elm, "name").text = name
@@ -314,8 +313,8 @@ class OpsourceNodeDriver(NodeDriver):
ET.SubElement(server_elm, "isStarted").text = str(ex_isStarted)
self.connection.request_with_orgId('server',
- method='POST',
- data=ET.tostring(server_elm)).object
+ method='POST',
+ data=ET.tostring(server_elm)).object
# XXX: return the last node in the list that has a matching name. this
# is likely but not guaranteed to be the node we just created
@@ -323,23 +322,23 @@ class OpsourceNodeDriver(NodeDriver):
return list(filter(lambda x: x.name == name, self.list_nodes()))[-1]
def destroy_node(self, node):
- body = self.connection.request_with_orgId('server/%s?delete' %
- (node.id)).object
+ body = self.connection.request_with_orgId(
+ 'server/%s?delete' % (node.id)).object
result = findtext(body, 'result', GENERAL_NS)
return result == 'SUCCESS'
def reboot_node(self, node):
- body = self.connection.request_with_orgId('server/%s?restart' %
- (node.id)).object
+ body = self.connection.request_with_orgId(
+ 'server/%s?restart' % (node.id)).object
result = findtext(body, 'result', GENERAL_NS)
return result == 'SUCCESS'
def list_nodes(self):
- nodes = self._to_nodes(self.connection
- .request_with_orgId('server/deployed').object)
- nodes.extend(self._to_nodes(self.connection
- .request_with_orgId('server/pendingDeploy').object))
+ nodes = self._to_nodes(
+ self.connection.request_with_orgId('server/deployed').object)
+ nodes.extend(self._to_nodes(
+ self.connection.request_with_orgId('server/pendingDeploy').object))
return nodes
def list_images(self, location=None):
@@ -347,6 +346,8 @@ class OpsourceNodeDriver(NodeDriver):
return a list of available images
Currently only returns the default 'base OS images' provided by
opsource. Customer images (snapshots) are not yet supported.
+
+ @inherits: L{NodeDriver.list_images}
"""
return self._to_base_images(self.connection.request('base/image')
.object)
@@ -354,31 +355,38 @@ class OpsourceNodeDriver(NodeDriver):
def list_sizes(self, location=None):
return [
NodeSize(id=1,
- name="default",
- ram=0,
- disk=0,
- bandwidth=0,
- price=0,
- driver=self.connection.driver),
+ name="default",
+ ram=0,
+ disk=0,
+ bandwidth=0,
+ price=0,
+ driver=self.connection.driver),
]
def list_locations(self):
"""
list locations (datacenters) available for instantiating servers and
networks.
+
+ @inherits: L{NodeDriver.list_locations}
"""
- return self._to_locations(self.connection
- .request_with_orgId('datacenter').object)
+ return self._to_locations(
+ self.connection.request_with_orgId('datacenter').object)
def list_networks(self, location=None):
"""
List networks deployed across all data center locations for your
organization. The response includes the location of each network.
- Returns a list of OpsourceNetwork objects
+
+ @keyword location: The location
+ @type location: L{NodeLocation}
+
+ @return: a list of OpsourceNetwork objects
+ @rtype: C{list} of L{OpsourceNetwork}
"""
- return self._to_networks(self.connection
- .request_with_orgId('networkWithLocation').object)
+ return self._to_networks(
+ self.connection.request_with_orgId('networkWithLocation').object)
def _to_base_images(self, object):
images = []
@@ -399,28 +407,33 @@ class OpsourceNodeDriver(NodeDriver):
'description': findtext(element, 'description', SERVER_NS),
'OS_type': findtext(element, 'operatingSystem/type', SERVER_NS),
'OS_displayName': findtext(element, 'operatingSystem/displayName',
- SERVER_NS),
+ SERVER_NS),
'cpuCount': findtext(element, 'cpuCount', SERVER_NS),
'resourcePath': findtext(element, 'resourcePath', SERVER_NS),
'memory': findtext(element, 'memory', SERVER_NS),
'osStorage': findtext(element, 'osStorage', SERVER_NS),
'additionalStorage': findtext(element, 'additionalStorage',
- SERVER_NS),
+ SERVER_NS),
'created': findtext(element, 'created', SERVER_NS),
'location': location,
}
return NodeImage(id=str(findtext(element, 'id', SERVER_NS)),
- name=str(findtext(element, 'name', SERVER_NS)),
- extra=extra,
- driver=self.connection.driver)
+ name=str(findtext(element, 'name', SERVER_NS)),
+ extra=extra,
+ driver=self.connection.driver)
def ex_start_node(self, node):
"""
Powers on an existing deployed server
+
+ @param node: Node which should be used
+ @type node: L{Node}
+
+ @rtype: C{bool}
"""
- body = self.connection.request_with_orgId('server/%s?start' %
- node.id).object
+ body = self.connection.request_with_orgId(
+ 'server/%s?start' % node.id).object
result = findtext(body, 'result', GENERAL_NS)
return result == 'SUCCESS'
@@ -430,9 +443,14 @@ class OpsourceNodeDriver(NodeDriver):
initiating a shutdown sequence within the guest operating system.
A successful response on this function means the system has
successfully passed the request into the operating system.
+
+ @param node: Node which should be used
+ @type node: L{Node}
+
+ @rtype: C{bool}
"""
- body = self.connection.request_with_orgId('server/%s?shutdown' %
- (node.id)).object
+ body = self.connection.request_with_orgId(
+ 'server/%s?shutdown' % (node.id)).object
result = findtext(body, 'result', GENERAL_NS)
return result == 'SUCCESS'
@@ -442,9 +460,14 @@ class OpsourceNodeDriver(NodeDriver):
ex_shutdown_graceful, success ensures the node will stop but some OS
and application configurations may be adversely affected by the
equivalent of pulling the power plug out of the machine.
+
+ @param node: Node which should be used
+ @type node: L{Node}
+
+ @rtype: C{bool}
"""
- body = self.connection.request_with_orgId('server/%s?poweroff' %
- node.id).object
+ body = self.connection.request_with_orgId(
+ 'server/%s?poweroff' % node.id).object
result = findtext(body, 'result', GENERAL_NS)
return result == 'SUCCESS'
@@ -453,16 +476,26 @@ class OpsourceNodeDriver(NodeDriver):
List networks deployed across all data center locations for your
organization. The response includes the location of each network.
- Returns a list of OpsourceNetwork objects
+ @return: a list of OpsourceNetwork objects
+ @rtype: C{list} of L{OpsourceNetwork}
"""
response = self.connection.request_with_orgId('networkWithLocation') \
.object
return self._to_networks(response)
def ex_get_location_by_id(self, id):
+ """
+ Get location by ID.
+
+ @param id: ID of the node location which should be used
+ @type id: C{str}
+
+ @rtype: L{NodeLocation}
+ """
location = None
if id is not None:
- location = list(filter(lambda x: x.id == id, self.list_locations()))[0]
+ location = list(
+ filter(lambda x: x.id == id, self.list_locations()))[0]
return location
def _to_networks(self, object):
@@ -485,10 +518,10 @@ class OpsourceNodeDriver(NodeDriver):
return OpsourceNetwork(id=findtext(element, 'id', NETWORK_NS),
name=findtext(element, 'name', NETWORK_NS),
description=findtext(element, 'description',
- NETWORK_NS),
+ NETWORK_NS),
location=location,
privateNet=findtext(element, 'privateNet',
- NETWORK_NS),
+ NETWORK_NS),
multicast=multicast,
status=status)
@@ -508,8 +541,8 @@ class OpsourceNodeDriver(NodeDriver):
def _to_nodes(self, object):
node_elements = object.findall(fixxpath('DeployedServer', SERVER_NS))
- node_elements.extend(object.findall(fixxpath('PendingDeployServer',
- SERVER_NS)))
+ node_elements.extend(object.findall(
+ fixxpath('PendingDeployServer', SERVER_NS)))
return [self._to_node(el) for el in node_elements]
def _to_node(self, element):
@@ -527,17 +560,21 @@ class OpsourceNodeDriver(NodeDriver):
'machineName': findtext(element, 'machineName', SERVER_NS),
'deployedTime': findtext(element, 'deployedTime', SERVER_NS),
'cpuCount': findtext(element, 'machineSpecification/cpuCount',
- SERVER_NS),
+ SERVER_NS),
'memoryMb': findtext(element, 'machineSpecification/memoryMb',
- SERVER_NS),
+ SERVER_NS),
'osStorageGb': findtext(element,
- 'machineSpecification/osStorageGb', SERVER_NS),
- 'additionalLocalStorageGb': findtext(element,
- 'machineSpecification/additionalLocalStorageGb', SERVER_NS),
+ 'machineSpecification/osStorageGb',
+ SERVER_NS),
+ 'additionalLocalStorageGb': findtext(
+ element, 'machineSpecification/additionalLocalStorageGb',
+ SERVER_NS),
'OS_type': findtext(element,
- 'machineSpecification/operatingSystem/type', SERVER_NS),
- 'OS_displayName': findtext(element,
- 'machineSpecification/operatingSystem/displayName', SERVER_NS),
+ 'machineSpecification/operatingSystem/type',
+ SERVER_NS),
+ 'OS_displayName': findtext(
+ element, 'machineSpecification/operatingSystem/displayName',
+ SERVER_NS),
'status': status,
}
@@ -551,21 +588,21 @@ class OpsourceNodeDriver(NodeDriver):
return n
def _to_status(self, element):
- if element == None:
+ if element is None:
return OpsourceStatus()
s = OpsourceStatus(action=findtext(element, 'action', SERVER_NS),
- requestTime=findtext(element, 'requestTime',
- SERVER_NS),
- userName=findtext(element, 'userName',
- SERVER_NS),
- numberOfSteps=findtext(element, 'numberOfSteps',
- SERVER_NS),
- step_name=findtext(element, 'step/name',
- SERVER_NS),
- step_number=findtext(element, 'step_number',
- SERVER_NS),
- step_percentComplete=findtext(element,
- 'step/percentComplete', SERVER_NS),
- failureReason=findtext(element, 'failureReason',
- SERVER_NS))
+ requestTime=findtext(element, 'requestTime',
+ SERVER_NS),
+ userName=findtext(element, 'userName',
+ SERVER_NS),
+ numberOfSteps=findtext(element, 'numberOfSteps',
+ SERVER_NS),
+ step_name=findtext(element, 'step/name',
+ SERVER_NS),
+ step_number=findtext(element, 'step_number',
+ SERVER_NS),
+ step_percentComplete=findtext(
+ element, 'step/percentComplete', SERVER_NS),
+ failureReason=findtext(element, 'failureReason',
+ SERVER_NS))
return s
Modified: libcloud/trunk/libcloud/compute/drivers/rackspace.py
URL: http://svn.apache.org/viewvc/libcloud/trunk/libcloud/compute/drivers/rackspace.py?rev=1364039&r1=1364038&r2=1364039&view=diff
==============================================================================
--- libcloud/trunk/libcloud/compute/drivers/rackspace.py (original)
+++ libcloud/trunk/libcloud/compute/drivers/rackspace.py Sat Jul 21 04:24:25 2012
@@ -17,7 +17,8 @@ Rackspace driver
"""
from libcloud.compute.types import Provider, LibcloudError
from libcloud.compute.base import NodeLocation
-from libcloud.compute.drivers.openstack import OpenStack_1_0_Connection, OpenStack_1_0_NodeDriver, OpenStack_1_0_Response
+from libcloud.compute.drivers.openstack import OpenStack_1_0_Connection,\
+ OpenStack_1_0_NodeDriver, OpenStack_1_0_Response
from libcloud.common.rackspace import (
AUTH_URL_US, AUTH_URL_UK)
@@ -37,7 +38,7 @@ class RackspaceConnection(OpenStack_1_0_
ep = {}
if '2.0' in self._auth_version:
ep = self.service_catalog.get_endpoint(service_type='compute',
- name='cloudServers')
+ name='cloudServers')
elif ('1.1' in self._auth_version) or ('1.0' in self._auth_version):
ep = self.service_catalog.get_endpoint(name='cloudServers')
@@ -59,6 +60,8 @@ class RackspaceNodeDriver(OpenStack_1_0_
Locations cannot be set or retrieved via the API, but currently
there are two locations, DFW and ORD.
+
+ @inherits: L{OpenStack_1_0_NodeDriver.list_locations}
"""
return [NodeLocation(0, "Rackspace DFW1/ORD1", 'US', self)]
Modified: libcloud/trunk/libcloud/compute/drivers/rackspacenova.py
URL: http://svn.apache.org/viewvc/libcloud/trunk/libcloud/compute/drivers/rackspacenova.py?rev=1364039&r1=1364038&r2=1364039&view=diff
==============================================================================
--- libcloud/trunk/libcloud/compute/drivers/rackspacenova.py (original)
+++ libcloud/trunk/libcloud/compute/drivers/rackspacenova.py Sat Jul 21 04:24:25 2012
@@ -16,7 +16,8 @@
Rackspace driver
"""
from libcloud.compute.providers import Provider
-from libcloud.compute.drivers.openstack import OpenStack_1_1_Connection, OpenStack_1_1_NodeDriver
+from libcloud.compute.drivers.openstack import OpenStack_1_1_Connection,\
+ OpenStack_1_1_NodeDriver
from libcloud.common.types import LibcloudError
@@ -26,16 +27,18 @@ class RackspaceNovaConnection(OpenStack_
def get_endpoint(self):
if not self.get_endpoint_args:
- raise LibcloudError('RackspaceNovaConnection must have get_endpoint_args set')
+ raise LibcloudError(
+ 'RackspaceNovaConnection must have get_endpoint_args set')
# Only support auth 2.0_*
if '2.0' in self._auth_version:
ep = self.service_catalog.get_endpoint(**self.get_endpoint_args)
else:
- raise LibcloudError('Auth version "%s" not supported' % (self._auth_version))
+ raise LibcloudError(
+ 'Auth version "%s" not supported' % (self._auth_version))
- # It's possible to authenticate but the service catalog not have the correct
- # endpoint for this driver, so we throw here.
+ # It's possible to authenticate but the service catalog not have
+ # the correct endpoint for this driver, so we throw here.
if 'publicURL' in ep:
return ep['publicURL']
else: