Shilla Saebi 0bb7e61115 change to drivers.xml
no upper? added "upper limit" and a . at the end

Change-Id: I0934360b6a4090402134fa87e801237a03102310
2014-03-12 20:24:43 -05:00

114 lines
3.7 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<section xmlns="http://docbook.org/ns/docbook"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0"
xml:id="drivers">
<title>Drivers</title>
<!--<section xml:id="header">
<title>Header</title>
<para>
..
Copyright (c) 2013 OpenStack Foundation
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.
</para>
</section>
<section xml:id="Drivers">
<title>Drivers</title>-->
<para>Cinder exposes an API to enable users to interact with
different storage back-end solutions. The following standards are
required across all drivers for Cinder services to properly
interact with a driver.</para>
<para>Minimum features are enforced to avoid having a grid of which
features are supported by which drivers in which releases. Cinder
core requires that all drivers implement the following minimum
features.</para>
<section xml:id="havana">
<title>Havana</title>
<para>
<itemizedlist>
<listitem>
<para>Volume Create/Delete</para>
</listitem>
<listitem>
<para>Volume Attach/Detach</para>
</listitem>
<listitem>
<para>Snapshot Create/Delete</para>
</listitem>
<listitem>
<para>Create Volume from Snapshot</para>
</listitem>
<listitem>
<para>Get Volume Stats</para>
</listitem>
<listitem>
<para>Copy Image to Volume</para>
</listitem>
<listitem>
<para>Copy Volume to Image</para>
</listitem>
<listitem>
<para>Clone Volume</para>
</listitem>
</itemizedlist>
</para>
</section>
<section xml:id="Icehouse">
<title>Icehouse</title>
<para>
<itemizedlist>
<listitem>
<para>All of the above plus</para>
</listitem>
<listitem>
<para>Extend Volume</para>
</listitem>
</itemizedlist>
</para>
</section>
<section xml:id="Volume-Stats">
<title>Volume-Stats</title>
<para>Volume stats are used by the different schedulers for the
drivers to provide a report on their current state of the back
end. A driver must provide these stats:</para>
<itemizedlist>
<listitem>
<para>driver_version</para>
</listitem>
<listitem>
<para>free_capacity_gb</para>
</listitem>
<listitem>
<para>reserved_percentage</para>
</listitem>
<listitem>
<para>storage_protocol</para>
</listitem>
<listitem>
<para>total_capacity_gb</para>
</listitem>
<listitem>
<para>vendor_name</para>
</listitem>
<listitem>
<para>volume_backend_name</para>
</listitem>
</itemizedlist>
<para>If the driver cannot provide a value for
<literal>free_capacity_gb</literal> or
<literal>total_capacity_gb</literal>, the driver can provide
keywords instead. If the array cannot report the value, use
<literal>unknown</literal>. If the array has no upper limit,
use <literal>infinite</literal>.</para>
</section>
</section>