libcloud.compute.drivers.openstack.OpenStack

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Method	list_nodes	List all nodes @return: `list` of `Node` objects
Method	list_sizes	List sizes on a provider @return: `list` of `NodeSize` +objects
Method	list_images	return a list of available images Currently only returns the default +'base OS images' provided by opsource. Customer images (snapshots) are not +yet supported.
Method	list_locations	list locations (datacenters) available for instantiating servers and +networks.
Method	create_node	Create a new opsource node
Method	reboot_node	reboots the node
Method	destroy_node	Destroys the node
Method	ex_start_node	Powers on an existing deployed server
Method	ex_shutdown_graceful	No summary
Method	ex_power_off	No summary
Method	ex_list_networks	List networks deployed across all data center locations for your +organization. The response includes the location of each network.
Method	ex_get_location_by_id	Undocumented
Method	_to_networks	Undocumented
Method	_to_network	Undocumented
Method	_to_locations	Undocumented
Method	_to_location	Undocumented
Method	_to_nodes	Undocumented
Method	_to_node	Undocumented
Method	_to_base_images	Undocumented
Method	_to_base_image	Undocumented
Method	_to_status	Undocumented

+ +

+ Inherited from NodeDriver: +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Method	__init__
Method	deploy_node	Create a new node, and start deployment.
Method	_wait_until_running	Block until node is fully booted and has an IP address assigned.
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	_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 + create_node(self, **kwargs): + + + (source) + +

overrides libcloud.compute.base.NodeDriver.create_node

Create a new opsource node

Standard keyword arguments from NodeDriver.create_node:
Parameters name String with a name for this new node (required) (type: str)
image OS Image to boot on node. (required) (type: NodeImage)
auth Initial authentication information for the node (required) (type: NodeAuthPassword +
Non-standard keyword arguments:
)
ex_description description for this node (required) (type: str)
ex_network Network to create the node within (required) (type: OpsourceNetwork)
ex_isStarted Start server after creation? default true (required) (type: bool)
Returns The newly created Node. NOTE: +Opsource does not provide a way to determine the ID of the server that was +just created, so the returned 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.

l.c.d.o.OpsourceResponse(Response) : class documentation

l.c.d.o.OpsourceStatus(object) : class documentation

l.c.d.opsource : module documentation

l.c.d.r.RackspaceConnection(OpenStack_1_0_Connection) : class documentation

+ + +

+ Inherited from OpenStackComputeConnection (via OpenStack_1_0_Connection): +

+ + + + + + + + + + + +

Method

request

Request a given `action`.

+ +

+ Inherited from OpenStackBaseConnection (via OpenStack_1_0_Connection, OpenStackComputeConnection): +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Method	__init__	Initialize `user_id` and `key`; set `secure` to an `int` +based on passed value.
Method	add_default_headers	Adds default headers (such as Authorization, X-Foo-Bar) to the passed +`headers`
Method	morph_action	Undocumented
Method	base_url	Undocumented
Method	_get_base_url	Undocumented
Method	_get_default_region	Undocumented
Method	_populate_hosts_and_request_paths	OpenStack uses a separate host for API calls which is only provided +after an initial authentication request. If we haven't made that request +yet, do it here. Otherwise, just return the management host.

+ +

+ Inherited from Connection (via OpenStack_1_0_Connection, OpenStackComputeConnection, OpenStackBaseConnection, ConnectionUserAndKey, ConnectionKey): +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Method	set_context	Undocumented
Method	connect	Establish a connection with the API server.
Method	user_agent_append	Append a token to a user agent string.
Method	morph_action_hook	Undocumented
Method	add_default_params	Adds default parameters (such as API key, version, etc.) to the passed +`params`
Method	pre_connect_hook	A hook which is called before connecting to the remote server. This hook +can perform a final manipulation on the params, headers and url +parameters.
Method	encode_data	Encode body data.
Method	_tuple_from_url	Undocumented
Method	_user_agent	Undocumented

+ + +

l.c.d.r.RackspaceNodeDriver(OpenStack_1_0_NodeDriver) : class documentation

+ + + + + + + + + + + +

Method

list_locations

Lists available locations

+ +

+ Inherited from OpenStack_1_0_NodeDriver: +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Method	__init__
Method	ex_set_password	Sets the Node's root password.
Method	ex_set_server_name	Sets the Node's name.
Method	create_node	Create a new node
Method	ex_resize	Change an existing server flavor / scale the server up or down.
Method	ex_confirm_resize	Confirm a resize request which is currently in progress. If a resize +request is not explicitly confirmed or reverted it's automatically +confirmed after 24 hours.
Method	ex_revert_resize	Revert a resize request which is currently in progress. All resizes are +automatically confirmed after 24 hours if they have not already been +confirmed explicitly or reverted.
Method	ex_rebuild	Undocumented
Method	ex_create_ip_group	Undocumented
Method	ex_list_ip_groups	Undocumented
Method	ex_delete_ip_group	Undocumented
Method	ex_share_ip	Undocumented
Method	ex_unshare_ip	Undocumented
Method	ex_list_ip_addresses	Undocumented
Method	ex_limits	No summary
Method	ex_save_image	Create an image for node.
Method	ex_delete_image	Delete an image for node.
Method	_change_password_or_name	Undocumented
Method	_metadata_to_xml	Undocumented
Method	_files_to_xml	Undocumented
Method	_reboot_node	Undocumented
Method	_node_action	Undocumented
Method	_to_nodes	Undocumented
Method	_fixxpath	Undocumented
Method	_findall	Undocumented
Method	_to_node_from_obj	Undocumented
Method	_to_node	Undocumented
Method	_to_sizes	Undocumented
Method	_to_size	Undocumented
Method	_to_images	Undocumented
Method	_to_image	Undocumented
Method	_to_shared_ip_group	Undocumented
Method	_to_ip_addresses	Undocumented
Method	_get_size_price	Undocumented

+ +

+ Inherited from OpenStackNodeDriver (via OpenStack_1_0_NodeDriver): +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Method	__new__	Undocumented
Method	list_nodes	List all nodes @return: `list` of `Node` objects
Method	list_sizes	List sizes on a provider @return: `list` of `NodeSize` +objects
Method	list_images	List images on a provider @return: `list` of `NodeImage` +objects
Method	ex_get_node_details	Undocumented
Method	destroy_node	Destroy a node.
Method	ex_soft_reboot_node	Undocumented
Method	ex_hard_reboot_node	Undocumented
Method	reboot_node	Reboot a node. @return: `bool` True if the reboot was +successful, otherwise False
Method	_ex_connection_class_kwargs	Return extra connection keyword arguments which are passed to the +Connection class constructor.

+ +

+ Inherited from NodeDriver (via OpenStack_1_0_NodeDriver, OpenStackNodeDriver): +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Method	deploy_node	Create a new node, and start deployment.
Method	_wait_until_running	Block until node is fully booted and has an IP address assigned.
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	_run_deployment_script	Run the deployment script on the provided node. At this point it is +assumed that SSH connection has already been established.

+ + +

Class	OpenStack_Response	Undocumented
Class	OpenStackComputeConnection	Undocumented
Class	OpenStackNodeDriver	Undocumented
Class	OpenStack_1_0_Response	Undocumented
Class	OpenStack_1_0_Connection	Undocumented
Class	OpenStack_1_0_NodeDriver	OpenStack node driver.
Class	OpenStack_1_0_SharedIpGroup	Shared IP group info.
Class	OpenStack_1_0_NodeIpAddresses	List of public and private IP addresses of a Node.
Class	OpenStack_1_1_Response	Undocumented
Class	OpenStack_1_1_Connection	Undocumented
Class	OpenStack_1_1_NodeDriver	OpenStack node driver.

Method	parse_body	Parse response body.
Method	parse_error	Parse the error messages.

Class	OpsourceResponse	Undocumented
Class	OpsourceAPIException	Undocumented
Class	OpsourceConnection	Connection class for the Opsource driver
Class	OpsourceStatus	Opsource API pending operation status class action, requestTime, +username, numberOfSteps, updateTime, step.name, step.number, +step.percentComplete, failureReason,
Class	OpsourceNetwork	Opsource network with location
Class	OpsourceNodeDriver	Opsource node driver

l.c.d.o.OpenStack_Response(Response) : class documentation

l.c.d.openstack : module documentation

l.c.d.o.OpsourceAPIException(LibcloudError) : class documentation

l.c.d.o.OpsourceConnection(ConnectionUserAndKey) : class documentation

l.c.d.o.OpsourceNetwork(object) : class documentation

l.c.d.o.OpsourceNodeDriver(NodeDriver) : class documentation

l.c.d.o.OpsourceResponse(Response) : class documentation

l.c.d.o.OpsourceStatus(object) : class documentation

l.c.d.opsource : module documentation

l.c.d.r.RackspaceConnection(OpenStack_1_0_Connection) : class documentation

l.c.d.r.RackspaceNodeDriver(OpenStack_1_0_NodeDriver) : class documentation

Method	success	Undocumented
Method	has_content_type	Undocumented
Method	parse_body	Undocumented
Method	parse_error	Undocumented

Parameters	name	String with a name for this new node (required) (type: str)
	image	OS Image to boot on node. (required) (type: `NodeImage`)
	auth	Initial authentication information for the node (required) (type: `NodeAuthPassword` + Non-standard keyword arguments: )
	ex_description	description for this node (required) (type: `str`)
	ex_network	Network to create the node within (required) (type: `OpsourceNetwork`)
	ex_isStarted	Start server after creation? default true (required) (type: `bool`)
Returns	The newly created `Node`. NOTE: +Opsource does not provide a way to determine the ID of the server that was +just created, so the returned `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.

Method	add_default_headers	Undocumented
Method	request	Undocumented
Method	request_with_orgId	Undocumented
Method	get_resource_path	this method returns a resource path which is necessary for referencing +resources that require a full path instead of just an ID, such as networks, +and customer snapshots.
Method	_get_orgId	send the /myaccount API request to opsource cloud and parse the 'orgId' +from the XML response object. We need the orgId to use most of the other +API functions