docs: Add info about block storage methods to the compute section.
Project: http://git-wip-us.apache.org/repos/asf/libcloud/repo Commit: http://git-wip-us.apache.org/repos/asf/libcloud/commit/6ed10daa Tree: http://git-wip-us.apache.org/repos/asf/libcloud/tree/6ed10daa Diff: http://git-wip-us.apache.org/repos/asf/libcloud/diff/6ed10daa Branch: refs/heads/trunk Commit: 6ed10daabe4967bacd3a8b228e9849b36c41ae2f Parents: 04a06cd Author: Tomaz Muraus <[email protected]> Authored: Sat Aug 3 23:32:56 2013 +0200 Committer: Tomaz Muraus <[email protected]> Committed: Sat Aug 3 23:32:56 2013 +0200 ---------------------------------------------------------------------- docs/compute/api.rst | 3 +++ docs/compute/index.rst | 15 +++++++++++++++ docs/index.rst | 2 +- 3 files changed, 19 insertions(+), 1 deletion(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/libcloud/blob/6ed10daa/docs/compute/api.rst ---------------------------------------------------------------------- diff --git a/docs/compute/api.rst b/docs/compute/api.rst index 13d9a1f..ec93283 100644 --- a/docs/compute/api.rst +++ b/docs/compute/api.rst @@ -3,3 +3,6 @@ Compute Base API .. autoclass:: libcloud.compute.base.NodeDriver :members: + +.. autoclass:: libcloud.compute.base.StorageVolume + :members: http://git-wip-us.apache.org/repos/asf/libcloud/blob/6ed10daa/docs/compute/index.rst ---------------------------------------------------------------------- diff --git a/docs/compute/index.rst b/docs/compute/index.rst index af0dbb8..ca8c909 100644 --- a/docs/compute/index.rst +++ b/docs/compute/index.rst @@ -10,9 +10,18 @@ allow you to execute arbitrary shell commands. This functionality is usually used to prepare your freshly created server, install your SSH key, and run a configuration management tool (such as Puppet, Chef, or cfengine) on it. +Besides managing cloud and virtual servers, compute components allso allows you +to manage cloud block storage (not to be confused with cloud object storage) +for providers which support it. +Block storage management is lives under compute API, because it is in most cases +tightly coupled with compute resources. + Terminology ----------- +Compute +~~~~~~~ + * **Node** - represents a cloud or virtual server. * **NodeSize** - represents node hardware configuration. Usually this is amount of the available RAM, bandwidth, CPU speed and disk size. Most of the drivers @@ -22,6 +31,12 @@ Terminology * **NodeState** - represents a node state. Standard states are: ``running``, ``rebooting``, ``terminated``, ``pending``, and ``unknown``. +Block Storage +~~~~~~~~~~~~~ + +* **StorageVolume** - represents a block storage volume +* **VolumeSnapshot** - represents a point in time snapshot of a StorageVolume + Examples -------- http://git-wip-us.apache.org/repos/asf/libcloud/blob/6ed10daa/docs/index.rst ---------------------------------------------------------------------- diff --git a/docs/index.rst b/docs/index.rst index 9305655..984a5b2 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -32,7 +32,7 @@ Resource you can manage with Libcloud are divided in the following categories: .. toctree:: :glob: - :maxdepth: 2 + :maxdepth: 3 :hidden: compute/*
