Add some basic docs for the DigitalOcean driver.
Project: http://git-wip-us.apache.org/repos/asf/libcloud/repo Commit: http://git-wip-us.apache.org/repos/asf/libcloud/commit/4f330e79 Tree: http://git-wip-us.apache.org/repos/asf/libcloud/tree/4f330e79 Diff: http://git-wip-us.apache.org/repos/asf/libcloud/diff/4f330e79 Branch: refs/heads/trunk Commit: 4f330e79941e82968e190f68ff2e34168f0f861f Parents: 24f6f3a Author: Tomaz Muraus <[email protected]> Authored: Sun Mar 29 17:21:44 2015 +0200 Committer: Tomaz Muraus <[email protected]> Committed: Sun Mar 29 17:21:44 2015 +0200 ---------------------------------------------------------------------- docs/compute/drivers/digitalocean.rst | 49 ++++++++++++++++++++ .../digitalocean/instantiate_api_v1.0.py | 5 ++ .../digitalocean/instantiate_api_v2.0.py | 9 ++++ 3 files changed, 63 insertions(+) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/libcloud/blob/4f330e79/docs/compute/drivers/digitalocean.rst ---------------------------------------------------------------------- diff --git a/docs/compute/drivers/digitalocean.rst b/docs/compute/drivers/digitalocean.rst new file mode 100644 index 0000000..6b71ed3 --- /dev/null +++ b/docs/compute/drivers/digitalocean.rst @@ -0,0 +1,49 @@ +DigitalOcean Compute Driver Documentation +========================================= + +`DigitalOcean`_ is an American virtual private server provider based in New York +City with data centers in New York, Amsterdam, San Francisco, London and +Singapore. + +.. figure:: /_static/images/provider_logos/digitalocean.png + :align: center + :width: 300 + :target: https://www.digitalocean.com/ + +Instantiating a driver +---------------------- + +DigitalOcean driver supports two API versions - old API v1.0 and the new API +v2.0 which is currently in beta. Since trunk (to be libcloud v0.18.0), the +driver uses new API v2.0 by default. + +Instantiating a driver using API v2.0 +------------------------------------- + +.. literalinclude:: /examples/compute/digitalocean/instantiate_api_v2.0.py + :language: python + +Instantiating a driver using API v1.0 +------------------------------------- + +.. literalinclude:: /examples/compute/digitalocean/instantiate_api_v1.0.py + :language: python + +API Docs +-------- + +API v2.0 +~~~~~~~~ + +.. autoclass:: libcloud.compute.drivers.digitalocean.DigitalOcean_v2_NodeDriver + :members: + :inherited-members: + +API v1.0 +~~~~~~~~ + +.. autoclass:: libcloud.compute.drivers.digitalocean.DigitalOcean_v1_NodeDriver + :members: + :inherited-members: + +.. _`DigitalOcean`: https://www.digitalocean.com/ http://git-wip-us.apache.org/repos/asf/libcloud/blob/4f330e79/docs/examples/compute/digitalocean/instantiate_api_v1.0.py ---------------------------------------------------------------------- diff --git a/docs/examples/compute/digitalocean/instantiate_api_v1.0.py b/docs/examples/compute/digitalocean/instantiate_api_v1.0.py new file mode 100644 index 0000000..ea498d1 --- /dev/null +++ b/docs/examples/compute/digitalocean/instantiate_api_v1.0.py @@ -0,0 +1,5 @@ +from libcloud.compute.types import Provider +from libcloud.compute.providers import get_driver + +cls = get_driver(Provider.DIGITAL_OCEAN) +driver = cls('client id', 'api key', api_version='v1') http://git-wip-us.apache.org/repos/asf/libcloud/blob/4f330e79/docs/examples/compute/digitalocean/instantiate_api_v2.0.py ---------------------------------------------------------------------- diff --git a/docs/examples/compute/digitalocean/instantiate_api_v2.0.py b/docs/examples/compute/digitalocean/instantiate_api_v2.0.py new file mode 100644 index 0000000..c2c950a --- /dev/null +++ b/docs/examples/compute/digitalocean/instantiate_api_v2.0.py @@ -0,0 +1,9 @@ +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') +# Note: Driver defaults to v2.0 so api_version argument can be omitted and the +# following is the same +driver = cls('access token')
