Updated Branches: refs/heads/trunk c32bb6cf4 -> 5d755f352
docs: Update pricing page, link to it from the compute index page. Project: http://git-wip-us.apache.org/repos/asf/libcloud/repo Commit: http://git-wip-us.apache.org/repos/asf/libcloud/commit/5d755f35 Tree: http://git-wip-us.apache.org/repos/asf/libcloud/tree/5d755f35 Diff: http://git-wip-us.apache.org/repos/asf/libcloud/diff/5d755f35 Branch: refs/heads/trunk Commit: 5d755f35206fa13c9cd27953ce0d567fb5e61ff7 Parents: c32bb6c Author: Tomaz Muraus <[email protected]> Authored: Thu Aug 8 22:44:04 2013 +0200 Committer: Tomaz Muraus <[email protected]> Committed: Thu Aug 8 22:44:04 2013 +0200 ---------------------------------------------------------------------- docs/compute/index.rst | 9 +++++++++ docs/compute/pricing.rst | 16 +++++++++++++++- 2 files changed, 24 insertions(+), 1 deletion(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/libcloud/blob/5d755f35/docs/compute/index.rst ---------------------------------------------------------------------- diff --git a/docs/compute/index.rst b/docs/compute/index.rst index 25c8a9b..d40fd74 100644 --- a/docs/compute/index.rst +++ b/docs/compute/index.rst @@ -43,6 +43,15 @@ Supported Providers For a list of supported providers see :doc:`supported providers page </compute/supported_providers>`. +Pricing +------- + +For majority of the compute providers Libcloud provides estimated pricing +information which tells users how much it costs per hour to run a :class:`Node` +with a specific :class:`NodeSize`. + +For more information, please see the :doc:`pricing page </compute/pricing>`. + Examples -------- http://git-wip-us.apache.org/repos/asf/libcloud/blob/5d755f35/docs/compute/pricing.rst ---------------------------------------------------------------------- diff --git a/docs/compute/pricing.rst b/docs/compute/pricing.rst index 9dedf8f..92699f4 100644 --- a/docs/compute/pricing.rst +++ b/docs/compute/pricing.rst @@ -5,7 +5,7 @@ For majority of the compute providers Libcloud provides estimated pricing information. Pricing information is available via the :attr:`price` attribute on the :class:`NodeSize` object. :attr:`price` attribute is a :func:`float` type and tells user how much it costs (in US dollars) to run a ``Node`` with a -specified ``NodeSize`` for an hour. +specified :class:`NodeSize` for an hour. Example bellow shows how to retrieve pricing for ``NodeSize`` objects using :func:`list_sizes` method. @@ -42,9 +42,23 @@ Using a custom pricing file This functionality is only available in Libcloud trunk and higher. +By default Libcloud reads pricing data from ``data/pricing.json`` file which +is included in the release package. If you want to use a custom pricing file, +simply put move the file to ``~/.libcloud.pricing.json``. + +If ``~/.libcloud.pricing.json`` file is available, Libcloud will use it instead +of the default pricing file which comes bundled with the release. + Updating pricing ---------------- .. note:: This functionality is only available in Libcloud trunk and higher. + +Currently only way to update pricing is programmatically using +:func:`libcloud.pricing.download_pricing_file` function. By default this +function retrieves the latest pricing file from our git repository and saves it +to ``~/.libcloud.pricing.json``. + +.. autofunction:: libcloud.pricing.download_pricing_file
