summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorTodd Willey <todd@ansolabs.com>2010-10-28 13:23:43 -0400
committerTodd Willey <todd@ansolabs.com>2010-10-28 13:23:43 -0400
commit7d367e04c3e0dcdf7ce2121c464884c0825a552c (patch)
tree849d03a037549406a4af252ec66740a423218fd1 /doc
parent4bd42d5ee9eadb9affb40ee6ed0f98b13609c895 (diff)
Clean up volumes / storage info.
Diffstat (limited to 'doc')
-rw-r--r--doc/source/concepts.and.introduction.rst6
-rw-r--r--doc/source/database.rst32
-rw-r--r--doc/source/development.guide.rst2
-rw-r--r--doc/source/storage.rst47
-rw-r--r--doc/source/volume.rst17
5 files changed, 46 insertions, 58 deletions
diff --git a/doc/source/concepts.and.introduction.rst b/doc/source/concepts.and.introduction.rst
index ee03bbdd5..c3057c958 100644
--- a/doc/source/concepts.and.introduction.rst
+++ b/doc/source/concepts.and.introduction.rst
@@ -61,10 +61,12 @@ Concept: Virtualization
* qemu
-Concept: Volumes
+Concept: Storage
----------------
-Volumes
+* Ephemeral
+* Volumes
+* Swift
Concept: Quotas
diff --git a/doc/source/database.rst b/doc/source/database.rst
index 657e4399f..f0672f608 100644
--- a/doc/source/database.rst
+++ b/doc/source/database.rst
@@ -15,10 +15,32 @@
License for the specific language governing permissions and limitations
under the License.
-Nova Database Programming Guide
-===============================
+Database Programming Guide
+==========================
-::
+The :mod:`api` Module
+---------------------
+
+.. automodule:: nova.db.api
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+
+Drivers
+-------
+
+The :mod:sqlalchemy Driver
+~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. automodule:: nova.db.sqlalchemy.api
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+
+.. automodule:: nova.db.sqlalchemy.models
+ :members:
+ :undoc-members:
+ :show-inheritance:
- * general interface
- * sqlalchemy implementation
diff --git a/doc/source/development.guide.rst b/doc/source/development.guide.rst
index 1581b8baf..d9a7c46f9 100644
--- a/doc/source/development.guide.rst
+++ b/doc/source/development.guide.rst
@@ -28,7 +28,7 @@ Contents
:maxdepth: 1
database
- storage
+ volume
compute
network
auth
diff --git a/doc/source/storage.rst b/doc/source/storage.rst
deleted file mode 100644
index 72880a4a1..000000000
--- a/doc/source/storage.rst
+++ /dev/null
@@ -1,47 +0,0 @@
-..
- Copyright 2010 United States Government as represented by the
- Administrator of the National Aeronautics and Space Administration.
- All Rights Reserved.
-
- Licensed under the Apache License, Version 2.0 (the "License"); you may
- not use this file except in compliance with the License. You may obtain
- a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing, software
- distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
- WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
- License for the specific language governing permissions and limitations
- under the License.
-
-Storage in the Nova Cloud
-=========================
-
-
-from etherpad todo
--------------------
-::
- * Volume Manager
- * public methods
- * responsibilities
- * Volume Driver
- * public methods
- * AoE implementation
- * ISCSI implementation
-
-
-legacy docs
------------
-
-There are three primary classes of storage in a nova cloud environment:
-
-* Ephemeral Storage (local disk within an instance)
-* Volume Storage (network-attached FS)
-* Object Storage (redundant KVS with locality and MR)
-
-.. toctree::
- :maxdepth: 2
-
- volume
- objectstore
diff --git a/doc/source/volume.rst b/doc/source/volume.rst
index 619968458..c55961a46 100644
--- a/doc/source/volume.rst
+++ b/doc/source/volume.rst
@@ -15,9 +15,20 @@
License for the specific language governing permissions and limitations
under the License.
-Volume Documentation
-====================
-
+Volume Programming Guide
+=========================
+
+The :mod:`nova.volume.manager` Module
+-------------------------------------
+
+.. automodule:: nova.volume.manager
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+OLDHAT
+------
+
Nova uses ata-over-ethernet (AoE) to export storage volumes from multiple storage nodes. These AoE exports are attached (using libvirt) directly to running instances.
Nova volumes are exported over the primary system VLAN (usually VLAN 1), and not over individual VLANs.