Add doc for IBM FlashSystem iSCSI volume driver
This patch applies, * Modify sector "Configure user authentication for the driver" to make it more readable * Modify configuration flag "flashsystem_connection_protocol" for IBM FlashSystem FC volume driver * Initial configuration reference for IBM FlashSystem iSCSI volume driver * Modify "Limitation and known issues" for we are supporting both FC and iSCSI now * Add a new limitation to "Limitation and known issues" for IBM FlashSystem behaviour Change-Id: I3f9b25addff250d5ac7f6fdda704bd07ded1ca4b
This commit is contained in:
yanlin ren
parent
b4e7e21243
commit
3feeb9dc34
@ -5,12 +5,48 @@ xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0">
|
||||
<title>IBM FlashSystem volume driver</title>
|
||||
<para>The volume driver for FlashSystem provides OpenStack Block
|
||||
Storage hosts with access to IBM FlashSystems.</para>
|
||||
<section xml:id="configure-flashsystem">
|
||||
<section xml:id="configure-ibm-flashsystem">
|
||||
<title>Configure FlashSystem</title>
|
||||
<simplesect>
|
||||
<title>Configure storage array</title>
|
||||
<para>The volume driver requires a pre-defined array. Users
|
||||
need to create an array on FlashSystem before using
|
||||
the volume driver. An existing array also can be used
|
||||
and existing data will not be destroyed.</para>
|
||||
<note>
|
||||
<para>FlashSystem can only create one array, so no
|
||||
configuration option is needed for the IBM
|
||||
FlashSystem driver to assign it.</para>
|
||||
</note>
|
||||
</simplesect>
|
||||
<simplesect>
|
||||
<title>Configure user authentication for the
|
||||
driver</title>
|
||||
<para>The driver requires access to the FlashSystem
|
||||
management interface using SSH. It should be provided with
|
||||
the FlashSystem management IP using the
|
||||
<literal>san_ip</literal> flag, and the management port
|
||||
should be provided by the <literal>san_ssh_port</literal>
|
||||
flag. By default, the port value is configured to be
|
||||
port 22 (SSH).</para>
|
||||
<note>
|
||||
<para>Make sure the compute node running the
|
||||
<systemitem class="service">cinder-volume</systemitem>
|
||||
driver has SSH network access to the storage
|
||||
system.</para>
|
||||
</note>
|
||||
<para>Using password authentication, assign a password
|
||||
to the user on the FlashSystem. See the driver
|
||||
configuration flags for the user and password in
|
||||
<xref linkend="enable-ibm-flashsystem-fc-driver"/> or
|
||||
<xref linkend="enable-ibm-flashsystem-iscsi-driver"/>.
|
||||
</para>
|
||||
</simplesect>
|
||||
</section>
|
||||
<section xml:id="ibm-flashsystem-fc-driver">
|
||||
<title>IBM FlashSystem FC driver</title>
|
||||
<section xml:id="ibm-flashsystem-fc-driver-data-path-configuration">
|
||||
<title>Data Path configuration</title>
|
||||
<para>The FlashSystem should be configured for Fiber
|
||||
Channel (FC).</para>
|
||||
<para>Using Fiber Channel (FC), each FlashSystem node
|
||||
should have at least one WWPN port configured. If the
|
||||
<literal>flashsystem_multipath_enabled</literal>
|
||||
@ -29,52 +65,14 @@ xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0">
|
||||
<para>Using FC, ensure that the block storage hosts
|
||||
have FC connectivity to the FlashSystem.</para>
|
||||
</note>
|
||||
</simplesect>
|
||||
<simplesect>
|
||||
<title>Configure storage array</title>
|
||||
<para>The volume driver requires a pre-defined array. Users
|
||||
need to create an array on FlashSystem before using
|
||||
the volume driver. An existing array also can be used
|
||||
and existing data will not be destroyed.</para>
|
||||
<note>
|
||||
<para>FlashSystem can only create one array, so no
|
||||
configuration option is needed for the IBM
|
||||
FlashSystem driver to assign it.</para>
|
||||
</note>
|
||||
</simplesect>
|
||||
<simplesect>
|
||||
<title>Configure user authentication for the
|
||||
driver</title>
|
||||
<para>The driver requires access to the FlashSystem
|
||||
management interface. The driver communicates with the
|
||||
management using SSH. The driver should be provided with
|
||||
the FlashSystem management IP using the
|
||||
<literal>san_ip</literal> flag, and the management port
|
||||
should be provided by the <literal>san_ssh_port</literal>
|
||||
flag. By default, the port value is configured to be
|
||||
port 22 (SSH).</para>
|
||||
<note>
|
||||
<para>Make sure the compute node running the
|
||||
<systemitem class="service">cinder-volume</systemitem>
|
||||
driver has SSH network access to the storage
|
||||
system.</para>
|
||||
</note>
|
||||
<para>Using password authentication, assign a password
|
||||
to the user on the FlashSystem. See the driver
|
||||
configuration flags for the user and password in section
|
||||
<link linkend="enable-ibm-flashsystem-fc-driver">"Enable IBM FlashSystem FC driver"</link>.
|
||||
</para>
|
||||
</simplesect>
|
||||
</section>
|
||||
<section xml:id="ibm-flashsystem-fc-driver">
|
||||
<title>IBM FlashSystem FC driver</title>
|
||||
</section>
|
||||
<section xml:id="enable-ibm-flashsystem-fc-driver">
|
||||
<title>Enable IBM FlashSystem FC driver</title>
|
||||
<para>Set the volume driver to the FlashSystem
|
||||
driver by setting the <literal>volume_driver</literal>
|
||||
option in configuration file
|
||||
<filename>cinder.conf</filename> as follows:</para>
|
||||
<programlisting>volume_driver = cinder.volume.drivers.ibm.flashsystem.FlashSystemDriver</programlisting>
|
||||
<programlisting>volume_driver = cinder.volume.drivers.ibm.flashsystem_fc.FlashSystemFCDriver</programlisting>
|
||||
<para>To enable IBM FlashSystem FC driver, configure the
|
||||
following options in configuration file
|
||||
<filename>cinder.conf</filename>:</para>
|
||||
@ -119,14 +117,14 @@ xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0">
|
||||
</tr>
|
||||
<tr>
|
||||
<td><para><literal>flashsystem_connection_protocol</literal></para></td>
|
||||
<td><para>Optional</para></td>
|
||||
<td><para>FC</para></td>
|
||||
<td><para>Connection protocol should be FC</para></td>
|
||||
<td><para>Required</para></td>
|
||||
<td><para/></td>
|
||||
<td><para>Connection protocol should be set to <literal>FC</literal></para></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><para><literal>flashsystem_multipath_enabled</literal></para></td>
|
||||
<td><para>Optional</para></td>
|
||||
<td><para>False</para></td>
|
||||
<td><para>Required</para></td>
|
||||
<td><para/></td>
|
||||
<td><para>Enable multipath for FC connections</para></td>
|
||||
</tr>
|
||||
<tr>
|
||||
@ -136,7 +134,104 @@ xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0">
|
||||
<td><para>True</para></td>
|
||||
<td>
|
||||
<para>Enable mapping vdisks to multiple hosts
|
||||
<footnote xml:id="flashsystem-fn3">
|
||||
<footnote xml:id="ibm-flashsystem-fn2">
|
||||
<para>This option allows the driver to
|
||||
map a vdisk to more than one host at a
|
||||
time. This scenario occurs during
|
||||
migration of a virtual machine with an
|
||||
attached volume; the volume is
|
||||
simultaneously mapped to both the source
|
||||
and destination compute hosts. If your
|
||||
deployment does not require attaching
|
||||
vdisks to multiple hosts, setting this
|
||||
flag to <literal>False</literal> will
|
||||
provide addedsafety.</para></footnote>
|
||||
</para>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</section>
|
||||
</section>
|
||||
<section xml:id="ibm-flashsystem-iscsi-driver">
|
||||
<title>IBM FlashSystem iSCSI driver</title>
|
||||
<section xml:id="ibm-flashsystem-iscsi-driver-network-configuration">
|
||||
<title>Network configuration</title>
|
||||
<para>Using iSCSI, each FlashSystem node
|
||||
should have at least one iSCSI port configured.
|
||||
iSCSI IP addresses of IBM FlashSystem can be
|
||||
obtained by FlashSystem GUI or CLI.
|
||||
Please refer to the redbook of FlashSystem.</para>
|
||||
<note>
|
||||
<para>Using iSCSI, ensure that the compute nodes
|
||||
have iSCSI network access to IBM FlashSystem.</para>
|
||||
</note>
|
||||
</section>
|
||||
<section xml:id="enable-ibm-flashsystem-iscsi-driver">
|
||||
<title>Enable IBM FlashSystem iSCSI driver</title>
|
||||
<para>Set the volume driver to the FlashSystem
|
||||
driver by setting the <literal>volume_driver</literal>
|
||||
option in configuration file
|
||||
<filename>cinder.conf</filename> as follows:</para>
|
||||
<programlisting>volume_driver = cinder.volume.drivers.ibm.flashsystem_iscsi.FlashSystemISCSIDriver</programlisting>
|
||||
<para>To enable IBM FlashSystem iSCSI driver, configure the
|
||||
following options in configuration file
|
||||
<filename>cinder.conf</filename>:</para>
|
||||
<table rules="all">
|
||||
<caption>List of configuration flags for IBM FlashSystem iSCSI driver</caption>
|
||||
<col width="40%"/>
|
||||
<col width="10%"/>
|
||||
<col width="12%"/>
|
||||
<col width="38%"/>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Flag name</th>
|
||||
<th>Type</th>
|
||||
<th>Default</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><para><literal>san_ip</literal></para></td>
|
||||
<td><para>Required</para></td>
|
||||
<td><para/></td>
|
||||
<td><para>Management IP or host name</para></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><para><literal>san_ssh_port</literal></para></td>
|
||||
<td><para>Optional</para></td>
|
||||
<td><para>22</para></td>
|
||||
<td><para>Management port</para></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><para><literal>san_login</literal></para></td>
|
||||
<td><para>Required</para></td>
|
||||
<td><para/></td>
|
||||
<td><para>Management login user name</para></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><para><literal>san_password</literal></para></td>
|
||||
<td><para>Required</para></td>
|
||||
<td><para/></td>
|
||||
<td><para>Management login password</para></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><para><literal>flashsystem_connection_protocol</literal></para></td>
|
||||
<td><para>Required</para></td>
|
||||
<td><para/></td>
|
||||
<td>
|
||||
<para>Connection protocol should be set to <literal>iSCSI</literal></para>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><para><literal>flashsystem_multihost_enabled</literal></para>
|
||||
</td>
|
||||
<td><para>Optional</para></td>
|
||||
<td><para>True</para></td>
|
||||
<td>
|
||||
<para>Enable mapping vdisks to multiple hosts
|
||||
<footnote xml:id="ibm-flashsystem-fn3">
|
||||
<para>This option allows the driver to
|
||||
map a vdisk to more than one host at a
|
||||
time. This scenario occurs during
|
||||
@ -151,16 +246,42 @@ xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0">
|
||||
</para>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><para><literal>iscsi_ip_address</literal></para></td>
|
||||
<td><para>Required</para></td>
|
||||
<td><para/></td>
|
||||
<td>
|
||||
<para>Set to one of the iSCSI IP addresses obtained by FlashSystem GUI or CLI
|
||||
<footnote xml:id="ibm-flashsystem-fn4">
|
||||
<para>On cluster of FlashSystem, iSCSI IP address column
|
||||
is the seventh column <literal>IP_address</literal>
|
||||
of the output of <literal>lsportip</literal>.</para></footnote>
|
||||
</para>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><para><literal>flashsystem_iscsi_portid</literal></para></td>
|
||||
<td><para>Required</para></td>
|
||||
<td><para/></td>
|
||||
<td>
|
||||
<para>Set to the id of the iscsi_ip_address obtained by FlashSystem GUI or CLI
|
||||
<footnote xml:id="ibm-flashsystem-fn5">
|
||||
<para>On cluster of FlashSystem, port
|
||||
ID column is the first column <literal>id</literal>
|
||||
of the output of <literal>lsportip</literal>,
|
||||
not the sixth colume <literal>port_id</literal>.</para></footnote>
|
||||
</para>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</section>
|
||||
</section>
|
||||
<section xml:id="limitation-and-known-issues">
|
||||
<section xml:id="ibm-flashsystem-limitation-and-known-issues">
|
||||
<title>Limitation and known issues</title>
|
||||
<itemizedlist>
|
||||
<listitem>
|
||||
<para>IBM FlashSystem cinder driver only supports Fibre
|
||||
Channel (FC) now.</para>
|
||||
<para>IBM FlashSystem only works when:<programlisting>open_access_enabled=off</programlisting></para>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
</section>
|
||||
|
||||
Loading…
Reference in New Issue
Block a user