Repository: libcloud Updated Branches: refs/heads/trunk cc9a01304 -> 97afa8b95
Clean up DigitalOcean docs after removal of API v1 support. Additionally updated the list of DigitalOcean datacenters and logo. Closes #892 Project: http://git-wip-us.apache.org/repos/asf/libcloud/repo Commit: http://git-wip-us.apache.org/repos/asf/libcloud/commit/97afa8b9 Tree: http://git-wip-us.apache.org/repos/asf/libcloud/tree/97afa8b9 Diff: http://git-wip-us.apache.org/repos/asf/libcloud/diff/97afa8b9 Branch: refs/heads/trunk Commit: 97afa8b95b67ac97259e06ae38a18b79265146af Parents: cc9a013 Author: Andrew Starr-Bochicchio <a.star...@gmail.com> Authored: Wed Oct 5 21:20:25 2016 -0400 Committer: Anthony Shaw <anthonys...@apache.org> Committed: Fri Oct 7 09:24:15 2016 +1100 ---------------------------------------------------------------------- .../images/provider_logos/digitalocean.png | Bin 82057 -> 3376 bytes docs/compute/drivers/digital_ocean.rst | 29 +++++-------------- docs/dns/drivers/digital_ocean.rst | 10 +++---- .../digitalocean/instantiate_api_v1.0.py | 5 ---- libcloud/compute/drivers/digitalocean.py | 13 ++++----- 5 files changed, 18 insertions(+), 39 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/libcloud/blob/97afa8b9/docs/_static/images/provider_logos/digitalocean.png ---------------------------------------------------------------------- diff --git a/docs/_static/images/provider_logos/digitalocean.png b/docs/_static/images/provider_logos/digitalocean.png index 9e24762..ec1fd03 100644 Binary files a/docs/_static/images/provider_logos/digitalocean.png and b/docs/_static/images/provider_logos/digitalocean.png differ http://git-wip-us.apache.org/repos/asf/libcloud/blob/97afa8b9/docs/compute/drivers/digital_ocean.rst ---------------------------------------------------------------------- diff --git a/docs/compute/drivers/digital_ocean.rst b/docs/compute/drivers/digital_ocean.rst index 2031943..558871f 100644 --- a/docs/compute/drivers/digital_ocean.rst +++ b/docs/compute/drivers/digital_ocean.rst @@ -1,9 +1,9 @@ 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, -Singapore and Frankfurt. +`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. .. figure:: /_static/images/provider_logos/digitalocean.png :align: center @@ -13,11 +13,9 @@ Singapore and Frankfurt. Instantiating a driver ---------------------- -DigitalOcean driver supports two API versions - old API v1.0 and the new API -v2.0. Since trunk (to be libcloud v0.18.0), the driver uses the correct API -based on the initialization with the Client ID (key) and Access Token (secret) -for v1.0 or the Personal Access Token (key) in v2.0 and will throw an -exception if the `api_version` is set explicitly without the proper arguments. +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 ------------------------------------- @@ -25,13 +23,7 @@ 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 - -Creating a droplet using API v2.0 +Creating a Droplet using API v2.0 --------------------------------- .. literalinclude:: /examples/compute/digitalocean/create_api_v2.0.py @@ -47,11 +39,6 @@ API v2.0 :members: :inherited-members: -API v1.0 -~~~~~~~~ - -.. autoclass:: libcloud.compute.drivers.digitalocean.DigitalOcean_v1_NodeDriver - :members: - :inherited-members: .. _`DigitalOcean`: https://www.digitalocean.com/ +.. _`reached end of life on November 9, 2015`: https://developers.digitalocean.com/documentation/changelog/api-v1/sunsetting-api-v1/ \ No newline at end of file http://git-wip-us.apache.org/repos/asf/libcloud/blob/97afa8b9/docs/dns/drivers/digital_ocean.rst ---------------------------------------------------------------------- diff --git a/docs/dns/drivers/digital_ocean.rst b/docs/dns/drivers/digital_ocean.rst index b6a60ab..8d6b8c0 100644 --- a/docs/dns/drivers/digital_ocean.rst +++ b/docs/dns/drivers/digital_ocean.rst @@ -1,9 +1,9 @@ DigitalOcean DNS 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, -Singapore and Frankfurt. +`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. .. figure:: /_static/images/provider_logos/digitalocean.png :align: center @@ -13,8 +13,8 @@ Singapore and Frankfurt. Instantiating a driver ---------------------- -DigitalOcean dns driver only supports the v2.0 API requiring a Personal Access -Token to initialize as the key. +The DigitalOcean DNS driver only supports the v2.0 API requiring a Personal +Access Token to initialize as the key. Instantiating the driver ------------------------ http://git-wip-us.apache.org/repos/asf/libcloud/blob/97afa8b9/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 deleted file mode 100644 index ea498d1..0000000 --- a/docs/examples/compute/digitalocean/instantiate_api_v1.0.py +++ /dev/null @@ -1,5 +0,0 @@ -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/97afa8b9/libcloud/compute/drivers/digitalocean.py ---------------------------------------------------------------------- diff --git a/libcloud/compute/drivers/digitalocean.py b/libcloud/compute/drivers/digitalocean.py index dd9836d..b195bae 100644 --- a/libcloud/compute/drivers/digitalocean.py +++ b/libcloud/compute/drivers/digitalocean.py @@ -39,18 +39,15 @@ class DigitalOceanNodeDriver(NodeDriver): """ DigitalOcean NodeDriver defaulting to using APIv2. - :keyword key: Required for authentication. Used in both ``v1`` and - ``v2`` implementations. + :keyword key: Personal Access Token required for authentication. :type key: ``str`` - :keyword secret: Used in driver authentication with key. Defaults to - None and when set, will cause driver to use ``v1`` for - connection and response. (optional) + :keyword secret: Previously used with API version ``v1``. (deprecated) :type secret: ``str`` - :keyword api_version: Specifies the API version to use. ``v1`` and - ``v2`` are the only valid options. Defaults to - using ``v2`` (optional) + :keyword api_version: Specifies the API version to use. Defaults to + using ``v2``, currently the only valid option. + (optional) :type api_version: ``str`` """ type = Provider.DIGITAL_OCEAN
