DigitalOcean Compute Driver Documentation¶
DigitalOcean is an American cloud provider based in New York City with data centers in New York, Amsterdam, San Francisco, London, Singapore, Frankfurt, Toronto, and Bangalore.
Instantiating a driver¶
The DigitalOcean driver supports API v2.0, requiring a Personal Access Token to initialize as the key. The older API v1.0 reached end of life on November 9, 2015. Support for API v1.0 was removed in libcloud v1.2.2.
Instantiating a driver using API v2.0¶
from libcloud.compute.types import Provider
from libcloud.compute.providers import get_driver
cls = get_driver(Provider.DIGITAL_OCEAN)
driver = cls('access token', api_version='v2')
Creating a Droplet using API v2.0¶
from libcloud.compute.types import Provider
from libcloud.compute.providers import get_driver
cls = get_driver(Provider.DIGITAL_OCEAN)
driver = cls('access token', api_version='v2')
options = {'backups': True,
'private_networking': True,
'ssh_keys': [123456, 123457]}
name = 'test.domain.tld'
size = driver.list_sizes()[0]
image = driver.list_images()[0]
location = driver.list_locations()[0]
node = driver.create_node(name, size, image, location,
ex_create_attr=options)
API Docs¶
API v2.0¶
- class libcloud.compute.drivers.digitalocean.DigitalOcean_v2_NodeDriver(key, secret=None, api_version='v2', **kwargs)[source]¶
DigitalOcean NodeDriver using v2 of the API.
- Parameters
key (
str
) – API key or username to be used (required)secret (
str
) – Secret password to be used (required)secure (
bool
) – Whether to use HTTPS or HTTP. Note: Some providers only support HTTPS, and it is on by default.host (
str
) – Override hostname used for connections.port (
int
) – Override port used for connections.api_version (
str
) – Optional API version. Only used by drivers which support multiple API versions.region (
str
) – Optional driver region. Only used by drivers which support multiple regions.
- Return type
None
- attach_volume(node, volume, device=None)[source]¶
Attaches volume to node.
- Parameters
node (
Node
) – Node to attach volume to.volume (
StorageVolume
) – Volume to attach.device (
str
) – Where the device is exposed, e.g. ‘/dev/sdb’
- Rytpe
bool
- connectionCls¶
alias of
libcloud.common.digitalocean.DigitalOcean_v2_Connection
- copy_image(source_region, node_image, name, description=None)¶
Copies an image from a source region to the current region.
- create_image(node, name)[source]¶
Create an image from a Node.
@inherits:
NodeDriver.create_image
- Parameters
node (
str
) – Node to use as base for imagenode – Name for image
- Return type
bool
- create_key_pair(name, public_key='')[source]¶
Create a new SSH key.
- Parameters
name (
str
) – Key name (required)public_key (
str
) – Valid public key string (required)
- create_node(name, size, image, location, ex_create_attr=None, ex_ssh_key_ids=None, ex_user_data=None)[source]¶
Create a node.
The ex_create_attr parameter can include the following dictionary key and value pairs:
backups:
bool
defaults to Falseipv6:
bool
defaults to Falseprivate_networking:
bool
defaults to Falsetags:
list
ofstr
tagsuser_data:
str
for cloud-config datassh_keys:
list
ofint
key ids orstr
fingerprints
ex_create_attr[‘ssh_keys’] will override ex_ssh_key_ids assignment.
- Parameters
ex_create_attr (
dict
) – A dictionary of optional attributes for droplet creationex_ssh_key_ids (
list
ofint
key ids orstr
key fingerprints) – A list of ssh key ids which will be added to the server. (optional)ex_user_data (
str
) – User data to be added to the node on create. (optional)
- Returns
The newly created node.
- Return type
Node
- create_volume(size, name, location=None, snapshot=None)[source]¶
Create a new volume.
- Parameters
size (
int
) – Size of volume in gigabytes (required)name (
str
) – Name of the volume to be createdlocation (
NodeLocation
) – Which data center to create a volume in. If empty, undefined behavior will be selected. (optional)snapshot (
VolumeSnapshot
) – Snapshot from which to create the new volume. (optional)
- Returns
The newly created volume.
- Return type
StorageVolume
- create_volume_snapshot(volume, name)[source]¶
Create a new volume snapshot.
- Parameters
volume (class:StorageVolume) – Volume to create a snapshot for
- Returns
The newly created volume snapshot.
- Return type
VolumeSnapshot
- delete_image(image)[source]¶
Delete an image for node.
@inherits:
NodeDriver.delete_image
- Parameters
image (
NodeImage
) – the image to be deleted- Return type
bool
- delete_key_pair(key)[source]¶
Delete an existing SSH key.
- Parameters
key (
KeyPair
) – SSH key (required)
- delete_volume_snapshot(snapshot)[source]¶
Delete a volume snapshot
- Parameters
snapshot (class:VolumeSnapshot) – volume snapshot to delete
- Return type
bool
- deploy_node(deploy, ssh_username='root', ssh_alternate_usernames=None, ssh_port=22, ssh_timeout=10, ssh_key=None, ssh_key_password=None, auth=None, timeout=300, max_tries=3, ssh_interface='public_ips', at_exit_func=None, wait_period=5, **create_node_kwargs)¶
Create a new node, and start deployment.
In order to be able to SSH into a created node access credentials are required.
A user can pass either a
NodeAuthPassword
orNodeAuthSSHKey
to theauth
argument. If thecreate_node
implementation supports that kind if credential (as declared inself.features['create_node']
) then it is passed on tocreate_node
. Otherwise it is not passed on tocreate_node
and it is only used for authentication.If the
auth
parameter is not supplied but the driver declares it supportsgenerates_password
then the password returned bycreate_node
will be used to SSH into the server.Finally, if the
ssh_key_file
is supplied that key will be used to SSH into the server.This function may raise a
DeploymentException
, if a create_node call was successful, but there is a later error (like SSH failing or timing out). This exception includes a Node object which you may want to destroy if incomplete deployments are not desirable.>>> from libcloud.compute.drivers.dummy import DummyNodeDriver >>> from libcloud.compute.deployment import ScriptDeployment >>> from libcloud.compute.deployment import MultiStepDeployment >>> from libcloud.compute.base import NodeAuthSSHKey >>> driver = DummyNodeDriver(0) >>> key = NodeAuthSSHKey('...') # read from file >>> script = ScriptDeployment("yum -y install emacs strace tcpdump") >>> msd = MultiStepDeployment([key, script]) >>> def d(): ... try: ... driver.deploy_node(deploy=msd) ... except NotImplementedError: ... print ("not implemented for dummy driver") >>> d() not implemented for dummy driver
Deploy node is typically not overridden in subclasses. The existing implementation should be able to handle most such.
- Parameters
deploy (
Deployment
) – Deployment to run once machine is online and available to SSH.ssh_username (
str
) – Optional name of the account which is used when connecting to SSH server (default is root)ssh_alternate_usernames (
list
) – Optional list of ssh usernames to try to connect with if using the default one failsssh_port (
int
) – Optional SSH server port (default is 22)ssh_timeout (
float
) – Optional SSH connection timeout in seconds (default is 10)auth (
NodeAuthSSHKey
orNodeAuthPassword
) – Initial authentication information for the node (optional)ssh_key (
str
orlist
ofstr
) – A path (or paths) to an SSH private key with which to attempt to authenticate. (optional)ssh_key_password (
str
) – Optional password used for encrypted keys.timeout (
int
) – How many seconds to wait before timing out. (default is 600)max_tries (
int
) – How many times to retry if a deployment fails before giving up (default is 3)ssh_interface (
str
) – The interface to wait for. Default is ‘public_ips’, other option is ‘private_ips’.at_exit_func (
func
) –Optional atexit handler function which will be registered and called with created node if user cancels the deploy process (e.g. CTRL+C), after the node has been created, but before the deploy process has finished.
This method gets passed in two keyword arguments:
driver -> node driver in question
node -> created Node object
Keep in mind that this function will only be called in such scenario. In case the method finishes (this includes throwing an exception), at exit handler function won’t be called.
wait_period (
int
) – How many seconds to wait between each iteration while waiting for node to transition into running state and have IP assigned. (default is 5)
- destroy_node(node)[source]¶
Destroy a node.
Depending upon the provider, this may destroy all data associated with the node, including backups.
- Parameters
node (
Node
) – The node to be destroyed- Returns
True if the destroy was successful, False otherwise.
- Return type
bool
- destroy_volume(volume)[source]¶
Destroys a storage volume.
- Parameters
volume (
StorageVolume
) – Volume to be destroyed- Return type
bool
- destroy_volume_snapshot(snapshot)¶
Destroys a snapshot.
- Parameters
snapshot (
VolumeSnapshot
) – The snapshot to delete- Return type
- detach_volume(volume)[source]¶
Detaches a volume from a node.
- Parameters
volume (
StorageVolume
) – Volume to be detached- Return type
bool
- ex_attach_floating_ip_to_node(node, ip)[source]¶
Attach the floating IP to the node
- Parameters
node (
Node
) – nodeip (
str
orDigitalOcean_v2_FloatingIpAddress
) – floating IP to attach
- Return type
bool
- ex_create_floating_ip(location)[source]¶
Create new floating IP reserved to a region.
The newly created floating IP will not be associated to a Droplet.
See https://developers.digitalocean.com/documentation/v2/#floating-ips
- Parameters
location (
NodeLocation
) – Which data center to create the floating IP in.- Return type
DigitalOcean_v2_FloatingIpAddress
- ex_delete_floating_ip(ip)[source]¶
Delete specified floating IP
- Parameters
ip (
DigitalOcean_v2_FloatingIpAddress
) – floating IP to remove- Return type
bool
- ex_detach_floating_ip_from_node(node, ip)[source]¶
Detach a floating IP from the given node
Note: the ‘node’ object is not used in this method but it is added to the signature of ex_detach_floating_ip_from_node anyway so it conforms to the interface of the method of the same name for other drivers like for example OpenStack.
- Parameters
node (
Node
) – Node from which the IP should be detachedip (
DigitalOcean_v2_FloatingIpAddress
) – Floating IP to detach
- Return type
bool
- ex_get_event(event_id)¶
Get an event object
- Parameters
event_id (
str
) – Event id (required)
- ex_get_floating_ip(ip)[source]¶
Get specified floating IP
- Parameters
ip (
str
) – floating IP to get- Return type
DigitalOcean_v2_FloatingIpAddress
- ex_get_node_details(node_id)[source]¶
Lists details of the specified server.
- Parameters
node_id (
str
) – ID of the node which should be used- Return type
Node
- ex_list_floating_ips()[source]¶
List floating IPs
- Return type
list
ofDigitalOcean_v2_FloatingIpAddress
- ex_rebuild_node(node)[source]¶
Destroy and rebuild the node using its base image.
- Parameters
node (
Node
) – Node to rebuild
:return True if the operation began successfully :rtype
bool
- ex_resize_node(node, size)[source]¶
Resize the node to a different machine size. Note that some resize operations are reversible, and others are irreversible.
- Parameters
node (
NodeSize
) – Node to rebuildsize – New size for this machine
:return True if the operation began successfully :rtype
bool
- get_image(image_id)[source]¶
Get an image based on an image_id
@inherits:
NodeDriver.get_image
- Parameters
image_id (
int
) – Image identifier- Returns
A NodeImage object
- Return type
NodeImage
- get_key_pair(name)[source]¶
Retrieve a single key pair.
- Parameters
name (
str
) – Name of the key pair to retrieve.- Return type
- import_key_pair_from_file(name, key_file_path)¶
Import a new public key from string.
- Parameters
name (
str
) – Key pair name.key_file_path (
str
) – Path to the public key file.
- Return type
KeyPair
object
- import_key_pair_from_string(name, key_material)¶
Import a new public key from string.
- Parameters
name (
str
) – Key pair name.key_material (
str
) – Public key material.
- Return type
KeyPair
object
- list_images()[source]¶
List images on a provider.
- Parameters
location (
NodeLocation
) – The location at which to list images.- Returns
list of node image objects.
- Return type
list
ofNodeImage
- list_key_pairs()[source]¶
List all the available SSH keys.
- Returns
Available SSH keys.
- Return type
list
ofKeyPair
- list_locations(ex_available=True)[source]¶
List locations
- Parameters
ex_available – Only return locations which are available.
- list_sizes(location=None)[source]¶
List sizes on a provider
- Parameters
location (
NodeLocation
) – The location at which to list sizes- Returns
list of node size objects
- Return type
list
ofNodeSize
- list_volume_snapshots(volume)[source]¶
List snapshots for a volume.
- Parameters
volume (class:StorageVolume) – Volume to list snapshots for
- Returns
List of volume snapshots.
- Return type
list
of :class: StorageVolume
- list_volumes()[source]¶
List storage volumes.
- Return type
list
ofStorageVolume
- reboot_node(node)[source]¶
Reboot a node.
- Parameters
node (
Node
) – The node to be rebooted- Returns
True if the reboot was successful, otherwise False
- Return type
bool
- start_node(node)¶
Start a node.
- Parameters
node (
Node
) – The node to be started- Returns
True if the start was successful, otherwise False
- Return type
bool
- stop_node(node)¶
Stop a node
- Parameters
node (
Node
) – The node to be stopped.- Returns
True if the stop was successful, otherwise False
- Return type
bool
- wait_until_running(nodes, wait_period=5, timeout=600, ssh_interface='public_ips', force_ipv4=True, ex_list_nodes_kwargs=None)¶
Block until the provided nodes are considered running.
Node is considered running when it’s state is “running” and when it has at least one IP address assigned.
- Parameters
nodes (
list
ofNode
) – List of nodes to wait for.wait_period (
int
) – How many seconds to wait between each loop iteration. (default is 3)timeout (
int
) – How many seconds to wait before giving up. (default is 600)ssh_interface (
str
) – Which attribute on the node to use to obtain an IP address. Valid options: public_ips, private_ips. Default is public_ips.force_ipv4 (
bool
) – Ignore IPv6 addresses (default is True).ex_list_nodes_kwargs (
dict
) – Optional driver-specific keyword arguments which are passed to thelist_nodes
method.
- Returns
[(Node, ip_addresses)]
list of tuple of Node instance and list of ip_address on success.- Return type
list
oftuple