From: Mike Perez <thingee@gmail.com>
Date: Tue, 23 Jul 2013 21:58:06 +0000 (-0700)
Subject: Adding driver minimum features and volume stats to dev doc
X-Git-Url: https://review.fuel-infra.org/gitweb?a=commitdiff_plain;h=72ebea66b63ed386f78049f2f9c923f44f8e0c89;p=openstack-build%2Fcinder-build.git

Adding driver minimum features and volume stats to dev doc

This is a first pass in getting information out of the wiki and into the
dev docs, so changes can be reviewed properly as discussed at the Havana
summit.

Change-Id: I75e71b3e5df69e6b507ee64d330a9ec2455266c5
---

diff --git a/doc/source/devref/drivers.rst b/doc/source/devref/drivers.rst
new file mode 100644
index 000000000..9f45a8e2c
--- /dev/null
+++ b/doc/source/devref/drivers.rst
@@ -0,0 +1,67 @@
+..
+      Copyright (c) 2013 OpenStack, LLC.
+      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.
+
+Drivers
+=======
+
+Cinder exposes an API to users to interact with different storage backend
+solutions. The following are standards across all drivers for Cinder services
+to properly interact with a driver.
+
+Minimum Features
+----------------
+
+Minimum features are enforced to avoid having a grid of what features are
+supported by which drivers and which releases. Cinder Core requires that all
+drivers implement the following minimum features.
+
+Havana
+------
+
+* Volume Create/Delete
+* Volume Attach/Detach
+* Snapshot Create/Delete
+* Create Volume from Snapshot
+* Get Volume Stats
+* Copy Image to Volume
+* Copy Volume to Image
+* Clone Volume
+
+Icehouse
+--------
+
+* All of the above plus
+* Extend Volume
+
+Volume Stats
+------------
+
+Volume stats are used by the different schedulers for the drivers to provide
+a report on their current state of the backend. The following should be
+provided by a driver.
+
+* driver_version
+* free_capacity_gb
+* reserved_percentage
+* storage_protocol
+* total_capacity_gb
+* vendor_name
+* volume_backend_name
+
+**NOTE:** If the driver is unable to provide a value for free_capacity_gb or
+total_capacity_gb, keywords can be provided instead. Please use 'unknown' if
+the array cannot report the value or 'infinite' if the array has no upper
+limit.
diff --git a/doc/source/devref/index.rst b/doc/source/devref/index.rst
index 4ea636745..15542dfad 100644
--- a/doc/source/devref/index.rst
+++ b/doc/source/devref/index.rst
@@ -29,6 +29,7 @@ Programming HowTos and Tutorials
     development.environment
     unit_tests
     addmethod.openstackapi
+    drivers
 
 
 Background Concepts for Cinder