Repository: libcloud Updated Branches: refs/heads/trunk 624032598 -> 9ef8ccfb7
docs: Improve documentation AuroraObjects Closes #619 Signed-off-by: Tomaz Muraus <[email protected]> Project: http://git-wip-us.apache.org/repos/asf/libcloud/repo Commit: http://git-wip-us.apache.org/repos/asf/libcloud/commit/9ef8ccfb Tree: http://git-wip-us.apache.org/repos/asf/libcloud/tree/9ef8ccfb Diff: http://git-wip-us.apache.org/repos/asf/libcloud/diff/9ef8ccfb Branch: refs/heads/trunk Commit: 9ef8ccfb768d62b7c65349a51579f96b5173523a Parents: 6240325 Author: Wido den Hollander <[email protected]> Authored: Thu Oct 29 15:13:45 2015 +0100 Committer: Tomaz Muraus <[email protected]> Committed: Sun Nov 1 19:58:35 2015 +0100 ---------------------------------------------------------------------- .../storage/auroraobjects/instantiate.py | 8 ++++++++ docs/storage/drivers/auroraobjects.rst | 20 +++++++++++++++++--- libcloud/storage/drivers/auroraobjects.py | 2 +- 3 files changed, 26 insertions(+), 4 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/libcloud/blob/9ef8ccfb/docs/examples/storage/auroraobjects/instantiate.py ---------------------------------------------------------------------- diff --git a/docs/examples/storage/auroraobjects/instantiate.py b/docs/examples/storage/auroraobjects/instantiate.py new file mode 100644 index 0000000..53fa783 --- /dev/null +++ b/docs/examples/storage/auroraobjects/instantiate.py @@ -0,0 +1,8 @@ +from libcloud.storage.types import Provider +from libcloud.storage.providers import get_driver + +access_key = 'XXXXXX' +secret_key = 'YYYYYY' + +cls = get_driver(Provider.AURORAOBJECTS) +driver = cls(access_key, secret_key) http://git-wip-us.apache.org/repos/asf/libcloud/blob/9ef8ccfb/docs/storage/drivers/auroraobjects.rst ---------------------------------------------------------------------- diff --git a/docs/storage/drivers/auroraobjects.rst b/docs/storage/drivers/auroraobjects.rst index e81efa5..4a0881e 100644 --- a/docs/storage/drivers/auroraobjects.rst +++ b/docs/storage/drivers/auroraobjects.rst @@ -9,7 +9,7 @@ All data is stored on servers in the European Union. .. figure:: /_static/images/provider_logos/pcextreme.png :align: center :width: 300 - :target: https://www.pcextreme.nl/en/aurora/objects + :target: https://www.pcextreme.com/aurora/objects Protocol ------------------ @@ -22,6 +22,19 @@ a LibcloudError. As a backend AuroraObjects uses `Ceph`_ for storage. + +Instantiating a driver +---------------------- + +When instantiating the AuroraObjects you need a access key and secret key. +These can be obtained from the `Control Panel`_ of AuroraObjects. + +With these credentials you can instantiate the driver: + +.. literalinclude:: /examples/storage/auroraobjects/instantiate.py + :language: python + + Multipart uploads ------------------ @@ -49,9 +62,10 @@ Please refer to the Amazon S3 storage driver documentation for examples. API Docs -------- -.. autoclass:: libcloud.compute.drivers.auroraobjects.AuroraObjectsStorageDriver +.. autoclass:: libcloud.storage.drivers.auroraobjects.AuroraObjectsStorageDriver :members: :inherited-members: -.. _`PCextreme B.V.`: https://www.pcextreme.nl/ +.. _`PCextreme B.V.`: https://www.pcextreme.com/ .. _`Ceph`: https://ceph.com/ +.. _`Control Panel`: https://cp.pcextreme.nl/ http://git-wip-us.apache.org/repos/asf/libcloud/blob/9ef8ccfb/libcloud/storage/drivers/auroraobjects.py ---------------------------------------------------------------------- diff --git a/libcloud/storage/drivers/auroraobjects.py b/libcloud/storage/drivers/auroraobjects.py index 0369c5c..96e7313 100644 --- a/libcloud/storage/drivers/auroraobjects.py +++ b/libcloud/storage/drivers/auroraobjects.py @@ -33,7 +33,7 @@ class BaseAuroraObjectsConnection(BaseS3Connection): class BaseAuroraObjectsStorageDriver(BaseS3StorageDriver): type = Provider.AURORAOBJECTS name = 'PCextreme AuroraObjects' - website = 'https://www.pcextreme.nl/en/aurora/objects' + website = 'https://www.pcextreme.com/aurora/objects' class AuroraObjectsStorageDriver(BaseAuroraObjectsStorageDriver):
