882326f3db
Deprecated the driver specific option eqlx_cli_timeout in favor of generic option ssh_conn_timeout Closes Bug: #1476352 Change-Id: Id643bd1e75ae29330b684bcd7d6cbc0c3e82cb88
182 lines
8.0 KiB
XML
182 lines
8.0 KiB
XML
<?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-equallogic-driver" version="5.0">
|
||
<title>Dell EqualLogic volume driver</title>
|
||
<para>The Dell EqualLogic volume driver interacts with configured
|
||
EqualLogic arrays and supports various operations.</para>
|
||
<itemizedlist>
|
||
<title>Supported operations</title>
|
||
<listitem>
|
||
<para>Create, delete, attach, and detach volumes.</para>
|
||
</listitem>
|
||
<listitem>
|
||
<para>Create, list, and delete volume snapshots.</para>
|
||
</listitem>
|
||
<listitem>
|
||
<para>Clone a volume.</para>
|
||
</listitem>
|
||
</itemizedlist>
|
||
<para>The OpenStack Block Storage service supports:</para>
|
||
<itemizedlist>
|
||
<listitem><para>Multiple instances of Dell EqualLogic Groups or Dell
|
||
EqualLogic Group Storage Pools and multiple pools on a single array.</para>
|
||
</listitem>
|
||
<listitem><para>Multiple instances of Dell EqualLogic Groups or Dell
|
||
EqualLogic Group Storage Pools or multiple pools on a single array.</para>
|
||
</listitem>
|
||
</itemizedlist>
|
||
<para>The Dell EqualLogic volume driver's ability to access the EqualLogic
|
||
Group is dependent upon the generic block storage driver's SSH settings
|
||
in the <filename>/etc/cinder/cinder.conf</filename> file (see <xref
|
||
linkend="section_block-storage-sample-configuration-files"/> for reference).</para>
|
||
<xi:include href="../../../common/tables/cinder-eqlx.xml"/>
|
||
<para>The following sample <filename>/etc/cinder/cinder.conf</filename>
|
||
configuration lists the relevant settings for a typical Block Storage
|
||
service using a single Dell EqualLogic Group:</para>
|
||
<example><title>Default (single-instance) configuration</title>
|
||
<programlisting language="ini">[DEFAULT]
|
||
#Required settings
|
||
|
||
volume_driver = cinder.volume.drivers.eqlx.DellEQLSanISCSIDriver
|
||
san_ip = <replaceable>IP_EQLX</replaceable>
|
||
san_login = <replaceable>SAN_UNAME</replaceable>
|
||
san_password = <replaceable>SAN_PW</replaceable>
|
||
eqlx_group_name = <replaceable>EQLX_GROUP</replaceable>
|
||
eqlx_pool = <replaceable>EQLX_POOL</replaceable>
|
||
|
||
#Optional settings
|
||
|
||
san_thin_provision = <replaceable>true|false</replaceable>
|
||
eqlx_use_chap = <replaceable>true|false</replaceable>
|
||
eqlx_chap_login = <replaceable>EQLX_UNAME</replaceable>
|
||
eqlx_chap_password = <replaceable>EQLX_PW</replaceable>
|
||
eqlx_cli_max_retries = 5
|
||
san_ssh_port = 22
|
||
ssh_conn_timeout = 30
|
||
san_private_key = <replaceable>SAN_KEY_PATH</replaceable>
|
||
ssh_min_pool_conn = 1
|
||
ssh_max_pool_conn = 5</programlisting>
|
||
</example>
|
||
<para>In this example, replace the following variables accordingly:</para>
|
||
<variablelist>
|
||
<varlistentry>
|
||
<term>IP_EQLX</term>
|
||
<listitem>
|
||
<para>The IP address used to reach the Dell EqualLogic Group through
|
||
SSH. This field has no default value.</para>
|
||
</listitem>
|
||
</varlistentry>
|
||
<varlistentry>
|
||
<term>SAN_UNAME</term>
|
||
<listitem>
|
||
<para>The user name to login to the Group manager via SSH at
|
||
the <literal>san_ip</literal>. Default user name is <literal>grpadmin</literal>.</para>
|
||
</listitem>
|
||
</varlistentry>
|
||
<varlistentry>
|
||
<term>SAN_PW</term>
|
||
<listitem>
|
||
<para>The corresponding password of <replaceable>SAN_UNAME</replaceable>.
|
||
Not used when <literal>san_private_key</literal> is set. Default
|
||
password is <literal>password</literal>.</para>
|
||
</listitem>
|
||
</varlistentry>
|
||
<varlistentry>
|
||
<term>EQLX_GROUP</term>
|
||
<listitem>
|
||
<para>The group to be used for a pool where the Block Storage service
|
||
will create volumes and snapshots. Default group is <literal>group-0</literal>.</para>
|
||
</listitem>
|
||
</varlistentry>
|
||
<varlistentry>
|
||
<term>EQLX_POOL</term>
|
||
<listitem>
|
||
<para>The pool where the Block Storage service will create volumes
|
||
and snapshots. Default pool is <literal>default</literal>. This
|
||
option cannot be used for multiple pools utilized by the Block
|
||
Storage service on a single Dell EqualLogic Group.</para>
|
||
</listitem>
|
||
</varlistentry>
|
||
<varlistentry>
|
||
<term>EQLX_UNAME</term>
|
||
<listitem>
|
||
<para>The CHAP login account for each
|
||
volume in a pool, if <literal>eqlx_use_chap</literal> is set
|
||
to <literal>true</literal>. Default account name is <literal>chapadmin</literal>.</para>
|
||
</listitem>
|
||
</varlistentry>
|
||
<varlistentry>
|
||
<term>EQLX_PW</term>
|
||
<listitem>
|
||
<para>The corresponding password of <replaceable>EQLX_UNAME</replaceable>.
|
||
The default password is randomly generated in hexadecimal, so you
|
||
must set this password manually.</para>
|
||
</listitem>
|
||
</varlistentry>
|
||
<varlistentry>
|
||
<term>SAN_KEY_PATH (optional)</term>
|
||
<listitem>
|
||
<para>The filename of the private key used
|
||
for SSH authentication. This provides password-less login to the
|
||
EqualLogic Group. Not used when <literal>san_password</literal>
|
||
is set. There is no default value.</para>
|
||
</listitem>
|
||
</varlistentry>
|
||
</variablelist>
|
||
<para>In addition, enable thin provisioning for SAN volumes using the
|
||
default <literal>san_thin_provision = <replaceable>true</replaceable></literal>
|
||
setting.</para>
|
||
<example>
|
||
<title>Multi back-end Dell EqualLogic configuration</title>
|
||
<para>The following example shows the typical configuration for a Block
|
||
Storage service that uses two Dell EqualLogic back ends:</para>
|
||
<programlisting language="ini">enabled_backends = backend1,backend2
|
||
san_ssh_port = 22
|
||
ssh_conn_timeout = 30
|
||
san_thin_provision = <replaceable>true</replaceable>
|
||
|
||
[backend1]
|
||
volume_driver = cinder.volume.drivers.eqlx.DellEQLSanISCSIDriver
|
||
volume_backend_name = <replaceable>backend1</replaceable>
|
||
san_ip = <replaceable>IP_EQLX1</replaceable>
|
||
san_login = <replaceable>SAN_UNAME</replaceable>
|
||
san_password = <replaceable>SAN_PW</replaceable>
|
||
eqlx_group_name = <replaceable>EQLX_GROUP</replaceable>
|
||
eqlx_pool = <replaceable>EQLX_POOL</replaceable>
|
||
|
||
[backend2]
|
||
volume_driver = cinder.volume.drivers.eqlx.DellEQLSanISCSIDriver
|
||
volume_backend_name = <replaceable>backend2</replaceable>
|
||
san_ip = <replaceable>IP_EQLX2</replaceable>
|
||
san_login = <replaceable>SAN_UNAME</replaceable>
|
||
san_password = <replaceable>SAN_PW</replaceable>
|
||
eqlx_group_name = <replaceable>EQLX_GROUP</replaceable>
|
||
eqlx_pool = <replaceable>EQLX_POOL</replaceable></programlisting>
|
||
<para>In this example:</para>
|
||
<itemizedlist>
|
||
<listitem><para>Thin provisioning for SAN volumes is enabled
|
||
(<literal>san_thin_provision = <replaceable>true</replaceable></literal>). This is
|
||
recommended when setting up Dell EqualLogic back ends.</para></listitem>
|
||
<listitem><para>Each Dell EqualLogic back-end configuration
|
||
(<literal>[backend1]</literal> and <literal>[backend2]</literal>)
|
||
has the same required settings as a single back-end configuration,
|
||
with the addition of <literal>volume_backend_name</literal>.</para></listitem>
|
||
<listitem><para>The <literal>san_ssh_port</literal> option is set
|
||
to its default value, 22. This option sets the port used
|
||
for SSH.</para></listitem>
|
||
<listitem><para>The <literal>ssh_conn_timeout</literal> option is
|
||
also set to its default value, 30. This option sets the
|
||
timeout in seconds for CLI commands over SSH.</para></listitem>
|
||
<listitem><para>The <literal>IP_EQLX1</literal> and <literal>IP_EQLX2</literal>
|
||
refer to the IP addresses used to reach the Dell EqualLogic
|
||
Group of <literal>backend1</literal> and <literal>backend2</literal>
|
||
through SSH, respectively.</para></listitem>
|
||
</itemizedlist>
|
||
</example>
|
||
<para>For information on configuring multiple back ends, see <link
|
||
xlink:href="http://docs.openstack.org/admin-guide-cloud/blockstorage_multi_backend.html">
|
||
Configure a multiple-storage back end</link>.</para>
|
||
</section>
|