You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@libcloud.apache.org by to...@apache.org on 2013/08/01 20:30:20 UTC
[08/22] git commit: Initial set of indices for each component
Initial set of indices for each component
Signed-off-by: Tomaz Muraus <to...@apache.org>
Project: http://git-wip-us.apache.org/repos/asf/libcloud/repo
Commit: http://git-wip-us.apache.org/repos/asf/libcloud/commit/e8101cb4
Tree: http://git-wip-us.apache.org/repos/asf/libcloud/tree/e8101cb4
Diff: http://git-wip-us.apache.org/repos/asf/libcloud/diff/e8101cb4
Branch: refs/heads/0.13.x
Commit: e8101cb4cbbf682eb2c459ff80be245c26bb6fbd
Parents: ade45fd
Author: Alex Gaynor <al...@gmail.com>
Authored: Wed Jul 31 14:28:30 2013 -0700
Committer: Tomaz Muraus <to...@apache.org>
Committed: Thu Aug 1 20:28:48 2013 +0200
----------------------------------------------------------------------
docs/compute/index.rst | 23 +++++++++++++++++++++++
docs/dns/index.rst | 2 ++
docs/index.rst | 27 +++++++++++++++++++++++----
docs/loadbalancers/index.rst | 2 ++
docs/storage/index.rst | 2 ++
5 files changed, 52 insertions(+), 4 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/libcloud/blob/e8101cb4/docs/compute/index.rst
----------------------------------------------------------------------
diff --git a/docs/compute/index.rst b/docs/compute/index.rst
new file mode 100644
index 0000000..7a618a0
--- /dev/null
+++ b/docs/compute/index.rst
@@ -0,0 +1,23 @@
+Compute
+=======
+
+The compute component of ``libcloud`` allows you to manage cloud and virtual
+servers offered by different providers, more than 20 in total.
+
+In addition to managing the servers this component also allows you to run
+deployment scripts on newly created servers. Deployment or "bootstrap" scripts
+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.
+
+Terminology
+-----------
+
+* **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
+ also expose hourly price (in dollars) for the Node of this size.
+* **NodeImage** - represents an operating system image.
+* **NodeLocation** - represents a physical location where a server can be.
+* **NodeState** - represents a node state. Standard states are: ``running``,
+ ``rebooting``, ``terminated``, ``pending``, and ``unknown```.
http://git-wip-us.apache.org/repos/asf/libcloud/blob/e8101cb4/docs/dns/index.rst
----------------------------------------------------------------------
diff --git a/docs/dns/index.rst b/docs/dns/index.rst
new file mode 100644
index 0000000..51bbfe3
--- /dev/null
+++ b/docs/dns/index.rst
@@ -0,0 +1,2 @@
+DNS
+===
http://git-wip-us.apache.org/repos/asf/libcloud/blob/e8101cb4/docs/index.rst
----------------------------------------------------------------------
diff --git a/docs/index.rst b/docs/index.rst
index 9d3438c..bf200e0 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -1,11 +1,30 @@
Welcome to Apache Libcloud's documentation!
===========================================
-Right now we're in the progress of migrating our existing documentation to
-Sphinx, so this may be incomplete. We apologize for the inconvenience and we
-hope the upcoming awesomeness will make up for it.
+.. note::
+
+ Right now we're in the progress of migrating our existing documentation to
+ Sphinx, so this may be incomplete. We apologize for the inconvenience and we
+ hope the upcoming awesomeness will make up for it.
+
+Apache Libcloud is a Python library which abstracts away the differences
+between multiple cloud providers. It current can manage four different cloud
+resources:
+
+* :doc:`Cloud servers <compute/index>` - services such as Amazon EC2 and
+ RackSpace CloudServers
+* :doc:`Cloud object storage <storage/index>` - services such as Amazon S3 and
+ Rackspace CloudFiles
+* :doc:`Load Balancers as a Service <loadbalancers/index>`
+* :doc:`DNS as a Service <dns/index>`
+
Contents:
.. toctree::
- :maxdepth: 2
+ :maxdepth: 1
+
+ compute/index
+ storage/index
+ loadbalancers/index
+ dns/index
http://git-wip-us.apache.org/repos/asf/libcloud/blob/e8101cb4/docs/loadbalancers/index.rst
----------------------------------------------------------------------
diff --git a/docs/loadbalancers/index.rst b/docs/loadbalancers/index.rst
new file mode 100644
index 0000000..35c5ed1
--- /dev/null
+++ b/docs/loadbalancers/index.rst
@@ -0,0 +1,2 @@
+Load Balancers
+==============
http://git-wip-us.apache.org/repos/asf/libcloud/blob/e8101cb4/docs/storage/index.rst
----------------------------------------------------------------------
diff --git a/docs/storage/index.rst b/docs/storage/index.rst
new file mode 100644
index 0000000..17a6f7c
--- /dev/null
+++ b/docs/storage/index.rst
@@ -0,0 +1,2 @@
+Object Storage
+==============