openstack/openstack-manuals
Code Issues Proposed changes

Add Scality SOFS Cinder driver documentation

Browse Source 
Change-Id: I6ae749dd6a825e8d463b2cf1801081399acd418a
This commit is contained in:
Nicolas Trangez 2015-01-28 14:29:14 +01:00
parent 6b9ca1d250
commit ccec00e479
3 changed files with 77 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

76
doc/config-reference/block-storage/drivers/scality-sofs-driver.xml Normal file
View File

@ -0,0 +1,76 @@
<?xml version="1.0"?>
<section xmlns="http://docbook.org/ns/docbook"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink"
xml:id="scality-sfused-driver" version="5.0">
<title>Scality SOFS driver</title>
<para>The Scality SOFS volume driver interacts with configured
sfused mounts.</para>
<para>The Scality SOFS driver manages volumes as sparse files stored on
a Scality Ring through sfused. Ring connection settings and sfused options
are defined in the <filename>cinder.conf</filename> file and the
configuration file pointed to by the <option>scality_sofs_config</option>
option, typically <filename>/etc/sfused.conf</filename>.
</para>
<simplesect>
<title>Supported operations</title>
<para>The Scality SOFS volume driver provides the following
Block Storage volume operations:</para>
<itemizedlist>
<listitem>
<para>Create, delete, attach (map), and detach (unmap) volumes.</para>
</listitem>
<listitem>
<para>Create, list, and delete volume snapshots.</para>
</listitem>
<listitem>
<para>Create a volume from a snapshot.</para>
</listitem>
<listitem>
<para>Copy an image to a volume.</para>
</listitem>
<listitem>
<para>Copy a volume to an image.</para>
</listitem>
<listitem>
<para>Clone a volume.</para>
</listitem>
<listitem>
<para>Extend a volume.</para>
</listitem>
<listitem>
<para>Backup a volume.</para>
</listitem>
<listitem>
<para>Restore backup to new or existing volume.</para>
</listitem>
</itemizedlist>
</simplesect>
<simplesect>
<title>Configuration</title>
<para>Use the following instructions to update the
<filename>cinder.conf</filename> configuration file:
<example><title>Sample Block Storage Configuration</title>
<programlisting language="ini">[DEFAULT]
enabled_backends = scality-1
[scality-1]
volume_driver=cinder.volume.drivers.scality.ScalityDriver
volume_backend_name = scality-1
scality_sofs_config=/etc/sfused.conf
scality_sofs_mount_point=/cinder
scality_sofs_volume_dir=cinder/volumes</programlisting>
</example>
</para>
<para>Use the following instructions to update the
<filename>nova.conf</filename> configuration file:
<example><title>Sample Compute Configuration</title>
<programlisting language="ini">[libvirt]
scality_sofs_mount_point = /cinder
scality_sofs_config = /etc/sfused.conf</programlisting>
</example>
</para>
<xi:include href="../../../common/tables/cinder-scality.xml"/>
</simplesect>
</section>

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

@ -36,7 +36,6 @@
<xi:include href="../../common/tables/cinder-hp3par.xml"/>
<xi:include href="../../common/tables/cinder-api.xml"/>
<xi:include href="../../common/tables/cinder-hplefthand.xml"/>
<xi:include href="../../common/tables/cinder-scality.xml"/>
<xi:include href="../../common/tables/cinder-block-device.xml"/>
<xi:include href="../../common/tables/cinder-compute.xml"/>
<xi:include href="../../common/tables/cinder-san.xml"/>

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

@ -40,6 +40,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/scality-sofs-driver.xml"/>
<xi:include href="drivers/sheepdog-driver.xml"/>
<xi:include href="drivers/smbfs-volume-driver.xml"/>
<xi:include href="drivers/solidfire-volume-driver.xml"/>