DigitalOcean Spaces Storage Driver Documentation¶

Spaces is an S3-interoperable object storage service from cloud provider DigitalOcean.

Connecting to Spaces¶

To connect to DigitalOcean Spaces you need an access key and secret key. These can be retrieved on the “Applications & API” page of the DigitalOcean control panel.

Instantiating a driver¶

Once you have obtained your credentials you can instantiate the driver as shown below.

from libcloud.storage.types import Provider
from libcloud.storage.providers import get_driver

cls = get_driver(Provider.DIGITALOCEAN_SPACES)

driver = cls(key='DO_ACCESS_KEY', secret='DO_SECRET_KEY')

Spaces supports both the v2 and v4 AWS signature types. By default, this driver will use v2. You can configure it to use v4 by passing the signature_version argument when instantiating the driver as shown below.

from libcloud.storage.types import Provider
from libcloud.storage.providers import get_driver

cls = get_driver(Provider.DIGITALOCEAN_SPACES)

driver = cls(key='DO_ACCESS_KEY',
             secret='DO_SECRET_KEY',
             signature_version='4')

Specifying canned ACLs¶

Spaces supports a limited set of canned ACLs. In order to specify an ACL when uploading an object, you can pass an extra argument with the acl attribute to the upload methods.

For example:

from libcloud.storage.types import Provider
from libcloud.storage.providers import get_driver

FILE_PATH = '/home/user/myfile.tar.gz'

cls = get_driver(Provider.DIGITALOCEAN_SPACES)
driver = cls('api key', 'api secret key')

container = driver.get_container(container_name='my-backups-12345')

# This method blocks until all the parts have been uploaded.
extra = {'content_type': 'application/octet-stream',
         'acl': 'public-read'}

with open(FILE_PATH, 'rb') as iterator:
    obj = driver.upload_object_via_stream(iterator=iterator,
                                          container=container,
                                          object_name='backup.tar.gz',
                                          extra=extra)

At this time, valid values for this attribute are only:

private (default)
public-read

API Docs¶

class libcloud.storage.drivers.digitalocean_spaces.DigitalOceanSpacesStorageDriver(key, secret=None, secure=True, host=None, port=None, api_version=None, region='nyc3', **kwargs)[source]¶

enable_container_cdn(container)¶

Enable container CDN.

Parameters:	container (`Container`) – Container instance
Return type:	`bool`

enable_object_cdn(obj)¶

Enable object CDN.

Parameters:	obj (`Object`) – Object instance
Return type:	`bool`

ex_cleanup_all_multipart_uploads(container, prefix=None)¶

Extension method for removing all partially completed S3 multipart uploads.

Parameters:	container (`Container`) – The container holding the uploads prefix (`str`) – Delete only uploads of objects with this prefix

ex_iterate_multipart_uploads(container, prefix=None, delimiter=None)¶

Extension method for listing all in-progress S3 multipart uploads.

Each multipart upload which has not been committed or aborted is considered in-progress.

Parameters:	container (`Container`) – The container holding the uploads prefix (`str`) – Print only uploads of objects with this prefix delimiter (`str`) – The object/key names are grouped based on being split by this delimiter
Returns:	A generator of S3MultipartUpload instances.
Return type:	`generator` of `S3MultipartUpload`

get_container_cdn_url(container)¶

Return a container CDN URL.

Parameters:	container (`Container`) – Container instance
Returns:	A CDN URL for this container.
Return type:	`str`

get_object_cdn_url(obj)¶

Return an object CDN URL.

Parameters:	obj (`Object`) – Object instance
Returns:	A CDN URL for this object.
Return type:	`str`

iterate_container_objects(container, ex_prefix=None)¶

Return a generator of objects for the given container.

Parameters:	container (`Container`) – Container instance ex_prefix (`str`) – Only return objects starting with ex_prefix
Returns:	A generator of Object instances.
Return type:	`generator` of `Object`

list_container_objects(container, ex_prefix=None)¶

Return a list of objects for the given container.

Parameters:	container (`Container`) – Container instance. ex_prefix (`str`) – Only return objects starting with ex_prefix
Returns:	A list of Object instances.
Return type:	`list` of `Object`

list_containers()¶

Return a list of containers.

Returns:	A list of Container instances.
Return type:	`list` of `Container`

upload_object(file_path, container, object_name, extra=None, verify_hash=True, ex_storage_class=None)¶

@inherits: StorageDriver.upload_object

Parameters:	ex_storage_class (`str`) – Storage class

upload_object_via_stream(iterator, container, object_name, extra=None, ex_storage_class=None)¶

@inherits: StorageDriver.upload_object_via_stream

Parameters:	ex_storage_class (`str`) – Storage class