l.c.d.d.DigitalOceanNodeDriver(NodeDriver) : class documentation

Part of libcloud.compute.drivers.digitalocean View Source View In Hierarchy

DigitalOceanNode node driver.
Method list_nodes List all nodes @return: list of node objects @rtype: C{list} of L{Node}
Method list_locations List data centers for a provider
Method list_images List images on a provider
Method list_sizes List sizes on a provider
Method create_node Create a node.
Method reboot_node Reboot a node.
Method destroy_node Destroy a node.
Method ex_list_ssh_keys List all the available SSH keys.
Method ex_create_ssh_key Create a new SSH key.
Method ex_destroy_ssh_key Delete an existing SSH key.
Method _to_node Undocumented
Method _to_image Undocumented
Method _to_location Undocumented
Method _to_size Undocumented
Method _to_ssh_key Undocumented

Inherited from NodeDriver:

Method __init__ @param key: API key or username to be used (required) @type key: C{str}
Method deploy_node Create a new node, and start deployment.
Method create_volume Create a new volume.
Method destroy_volume Destroys a storage volume.
Method attach_volume Attaches volume to node.
Method detach_volume Detaches a volume from a node.
Method wait_until_running Block until the given nodes are fully booted and have an IP address assigned.
Method _wait_until_running Undocumented
Method _ssh_client_connect Try to connect to the remote SSH server. If a connection times out or is refused it is retried up to timeout number of seconds.
Method _connect_and_run_deployment_script Undocumented
Method _run_deployment_script Run the deployment script on the provided node. At this point it is assumed that SSH connection has already been established.
Method _get_size_price Undocumented

Inherited from BaseDriver (via NodeDriver):

Method _ex_connection_class_kwargs Return extra connection keyword arguments which are passed to the Connection class constructor.
def list_nodes(self): (source)
List all nodes
@return:  list of node objects
@rtype: C{list} of L{Node}
def list_locations(self): (source)
List data centers for a provider

@return: list of node location objects
@rtype: C{list} of L{NodeLocation}
def list_images(self): (source)
List images on a provider

@keyword location: The location at which to list images
@type location: L{NodeLocation}

@return: list of node image objects
@rtype: C{list} of L{NodeImage}
def list_sizes(self): (source)
List sizes on a provider

@keyword location: The location at which to list sizes
@type location: L{NodeLocation}

@return: list of node size objects
@rtype: C{list} of L{NodeSize}
def create_node(self, name, size, image, location, ex_ssh_key_ids=None, **kwargs): (source)
Create a node.

@keyword    ex_ssh_key_ids: A list of ssh key ids which will be added
                           to the server. (optional)
@type       ex_ssh_key_ids: C{list} of C{str}

@return: The newly created node.
@rtype: L{Node}
def reboot_node(self, node): (source)
Reboot a node.

@param node: The node to be rebooted
@type node: L{Node}

@return: True if the reboot was successful, otherwise False
@rtype: C{bool}
def destroy_node(self, node): (source)
Destroy a node.

Depending upon the provider, this may destroy all data associated with
the node, including backups.

@param node: The node to be destroyed
@type node: L{Node}

@return: True if the destroy was successful, otherwise False
@rtype: C{bool}
def ex_list_ssh_keys(self): (source)
List all the available SSH keys.

@return: Available SSH keys.
@rtype: C{list} of L{SSHKey}
def ex_create_ssh_key(self, name, ssh_key_pub): (source)
Create a new SSH key.

@param      name: Key name (required)
@type       name: C{str}

@param      name: Valid public key string (required)
@type       name: C{str}
def ex_destroy_ssh_key(self, key_id): (source)
Delete an existing SSH key.

@param      key_id: SSH key id (required)
@type       key_id: C{str}
def _to_node(self, data): (source)
Undocumented
def _to_image(self, data): (source)
Undocumented
def _to_location(self, data): (source)
Undocumented
def _to_size(self, data): (source)
Undocumented
def _to_ssh_key(self, data): (source)
Undocumented
API Documentation for libcloud, generated by pydoctor at 2013-07-01 17:02:02.