Merge "Add docs for Dell Storage Center Cinder drivers"

This commit is contained in:
Jenkins 2014-12-22 02:27:26 +00:00 committed by Gerrit Code Review
commit a5c50bb2a3
5 changed files with 162 additions and 0 deletions
doc
common/tables
config-reference/block-storage
tools/autogenerate-config-flagmappings

@ -0,0 +1,38 @@
<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in openstack-doc-tools repository. -->
<table rules="all" xml:id="config_table_cinder_dellsc">
<caption>Description of Dell Storage Center volume driver configuration options</caption>
<col width="50%"/>
<col width="50%"/>
<thead>
<tr>
<th>Configuration option = Default value</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<th colspan="2">[DEFAULT]</th>
</tr>
<tr>
<td>dell_sc_api_port = 3033</td>
<td>(IntOpt) Dell API port</td>
</tr>
<tr>
<td>dell_sc_server_folder = openstack</td>
<td>(StrOpt) Name of the server folder to use on the Storage Center</td>
</tr>
<tr>
<td>dell_sc_ssn = 64702</td>
<td>(IntOpt) Storage Center System Serial Number</td>
</tr>
<tr>
<td>dell_sc_volume_folder = openstack</td>
<td>(StrOpt) Name of the volume folder to use on the Storage Center</td>
</tr>
</tbody>
</table>
</para>

@ -0,0 +1,118 @@
<?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="dell-storagecenter-driver" version="5.0">
<title>Dell Storage Center Fibre Channel and iSCSI drivers</title>
<para>The Dell Storage Center volume driver interacts with configured
Storage Center arrays.</para>
<para>The Dell Storage Center driver manages Storage Center arrays through
Enterprise Manager. Enterprise Manager connection settings and Storage
Center options are defined in the <filename>cinder.conf</filename> file.
</para>
<simplesect>
<title>Supported operations</title>
<para>The Dell Storage Center volume driver provides the following
Cinder 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>
</itemizedlist>
</simplesect>
<simplesect>
<title>iSCSI Configuration</title>
<para>Use the following instructions to update the configuration
file for iSCSI:
<example><title>Sample iSCSI Configuration</title>
<programlisting language="ini">
default_volume_type = delliscsi
enabled_backends = delliscsi
[delliscsi]
# Name to give this storage backend
volume_backend_name = delliscsi
# The iSCSI driver to load
volume_driver = cinder.volume.drivers.dell.dell_storagecenter_iscsi.DellStorageCenterISCSIDriver
# IP address of Enterprise Manager
san_ip = 172.23.8.101
# Enterprise Manager user name
san_login = Admin
# Enterprise Manager password
san_password = mmmm
# The Storage Center iSCSI IP address
iscsi_ip_address = 192.168.0.20
# The Storage Center serial number to use
dell_sc_ssn = 64702
# ==Optional settings==
# The Enterprise Manager API port
dell_sc_api_port = 3033
# Server folder to place new server definitions
dell_sc_server_folder = devstacksrv
# Volume folder to place created volumes
dell_sc_volume_folder = devstackvol/Cinder
# The iSCSI IP port
iscsi_port = 3260</programlisting>
</example>
</para>
</simplesect>
<simplesect>
<title>Fibre Channel Configuration</title>
<para>Use the following instructions to update the configuration
file for fibre channel:
<example><title>Sample FC Configuration</title>
<programlisting language="ini">
default_volume_type = dellfc
enabled_backends = dellfc
[dellfc]
# Name to give this storage backend
volume_backend_name = delliscsi
# The FC driver to load
volume_driver = cinder.volume.drivers.dell.dell_storagecenter_fc.DellStorageCenterFCDriver
# IP address of Enterprise Manager
san_ip = 172.23.8.101
# Enterprise Manager user name
san_login = Admin
# Enterprise Manager password
san_password = mmmm
# The Storage Center serial number to use
dell_sc_ssn = 64702
# Optional settings
# The Enterprise Manager API port
dell_sc_api_port = 3033
# Server folder to place new server definitions
dell_sc_server_folder = devstacksrv
# Volume folder to place created volumes
dell_sc_volume_folder = devstackvol/Cinder</programlisting>
</example>
</para>
</simplesect>
<simplesect>
<title>Driver options</title>
<para>The following table contains the configation options specific to the
Dell Storage Center volume driver.</para>
<xi:include href="../../../common/tables/cinder-dellsc.xml"/>
</simplesect>
</section>

@ -18,6 +18,7 @@
<xi:include href="drivers/ceph-rbd-volume-driver.xml"/> <xi:include href="drivers/ceph-rbd-volume-driver.xml"/>
<xi:include href="drivers/coraid-driver.xml"/> <xi:include href="drivers/coraid-driver.xml"/>
<xi:include href="drivers/dell-equallogic-driver.xml"/> <xi:include href="drivers/dell-equallogic-driver.xml"/>
<xi:include href="drivers/dell-storagecenter-driver.xml"/>
<xi:include href="drivers/emc-vmax-driver.xml"/> <xi:include href="drivers/emc-vmax-driver.xml"/>
<xi:include href="drivers/emc-vnx-direct-driver.xml"/> <xi:include href="drivers/emc-vnx-direct-driver.xml"/>
<xi:include href="drivers/emc-xtremio-driver.xml"/> <xi:include href="drivers/emc-xtremio-driver.xml"/>

@ -58,6 +58,10 @@ default_availability_zone common
default_log_levels logging default_log_levels logging
default_timeout api default_timeout api
default_volume_type common default_volume_type common
dell_sc_api_port dellsc
dell_sc_server_folder dellsc
dell_sc_ssn dellsc
dell_sc_volume_folder dellsc
destroy_empty_storage_group emc destroy_empty_storage_group emc
disable_process_locking debug disable_process_locking debug
dpl_pool prophetstor_dpl dpl_pool prophetstor_dpl

@ -5,6 +5,7 @@ backups_tsm IBM Tivoli Storage Manager backup driver
block-device block device block-device block device
coraid Coraid AoE driver coraid Coraid AoE driver
datera Datera volume driver datera Datera volume driver
dellsc Dell Storage Center volume driver
emc EMC emc EMC
eqlx Dell EqualLogic volume driver eqlx Dell EqualLogic volume driver
fujitsu_eternus_dx Fujitsu ETERNUS DX volume driver fujitsu_eternus_dx Fujitsu ETERNUS DX volume driver