openstack/openstack-manuals
Code Issues Proposed changes

Add basic Quobyte Cinder driver documentation

Browse Source 
Gives some short hints on basic concepts of the Quobyte Cinder driver
and where to get help.

Implements: blueprint quobyte-cinder-driver-doc

Change-Id: I25d2b9db329dfad173777c2fe90b9806c28cbe2b
This commit is contained in:
Silvan Kaiser 2015-11-13 14:11:26 +01:00
parent af6d1b0df4
commit e038f2df3a
3 changed files with 56 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

55
doc/config-reference/block-storage/drivers/quobyte-driver.xml Normal file
View File

@ -0,0 +1,55 @@
<section xml:id="Quobyte-driver"
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">
<title>Quobyte driver</title>
<para>The <link xlink:href="http://www.quobyte.com/">Quobyte</link> volume
driver enables storing Block Storage service volumes on a Quobyte storage
back end. Block Storage service back ends are mapped to Quobyte volumes
and individual Block Storage service volumes are stored as files on a
Quobyte volume. Selection of the appropriate Quobyte volume is done by the
aforementioned back end configuration that specifies the Quobyte volume
explicitely.</para>
<note><para>Note the dual use of the term 'volume' in the context of Block
Storage service volumes and in the context of Quobyte volumes.
</para></note>
<para>For more information see
<link xlink:href="http://support.quobyte.com/">the Quobyte support webpage
</link>.</para>
<para>The Quobyte volume driver supports the following volume operations:
</para>
<itemizedlist>
<listitem><para>Create, delete, attach, and detach volumes</para>
</listitem>
<listitem><para>Secure NAS operation (Starting with Mitaka release
secure NAS operation is optional but still default)</para></listitem>
<listitem><para>Create and delete a snapshot</para></listitem>
<listitem><para>Create a volume from a snapshot</para></listitem>
<listitem><para>Extend a volume</para></listitem>
<listitem><para>Clone a volume</para></listitem>
<listitem><para>Copy a volume to image</para></listitem>
<listitem><para>Generic volume migration (no back end optimization)
</para></listitem>
</itemizedlist>
<note><para>When running VM instances off Quobyte volumes, ensure that the
<link xlink:href="https://wiki.openstack.org/wiki/Nova/Quobyte">
Quobyte Compute service driver</link> has been configured in your
OpenStack cloud.</para></note>
<para>To activate the Quobyte volume driver, configure the corresponding
volume_driver parameter:
<programlisting>volume_driver = cinder.volume.drivers.quobyte.QuobyteDriver
</programlisting></para>
<para>The following table contains the configuration options
supported by the Quobyte driver.</para>
<xi:include href="../../../common/tables/cinder-quobyte.xml" />
</section>

1
doc/config-reference/block-storage/section_misc.xml
View File

@ -39,7 +39,6 @@
<xi:include href="../../common/tables/cinder-profiler.xml"/>
<xi:include href="../../common/tables/cinder-pure.xml"/>
<xi:include href="../../common/tables/cinder-qpid.xml"/>
<xi:include href="../../common/tables/cinder-quobyte.xml"/>
<xi:include href="../../common/tables/cinder-quota.xml"/>
<xi:include href="../../common/tables/cinder-rabbitmq.xml"/>
<xi:include href="../../common/tables/cinder-redis.xml"/>

1
doc/config-reference/block-storage/section_volume-drivers.xml
View File

@ -43,6 +43,7 @@
<xi:include href="drivers/nfs-volume-driver.xml"/>
<xi:include href="drivers/prophetstor-dpl-driver.xml"/>
<xi:include href="drivers/pure-storage-driver.xml"/>
<xi:include href="drivers/quobyte-driver.xml"/>
<xi:include href="drivers/scality-sofs-driver.xml"/>
<xi:include href="drivers/sheepdog-driver.xml"/>
<xi:include href="drivers/smbfs-volume-driver.xml"/>