Merge "Updates HNAS driver documentation for Kilo"
This commit is contained in:
Jenkins
@@ -8,24 +8,13 @@
|
||||
xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0">
|
||||
<title>HDS HNAS iSCSI and NFS driver</title>
|
||||
<?dbhtml stop-chunking?>
|
||||
<para>This Block Storage volume driver provides iSCSI and NFS support for <link
|
||||
xlink:href="http://www.hds.com/products/file-and-content/network-attached-storage/"
|
||||
>HNAS (Hitachi Network-attached Storage)</link> arrays such as,
|
||||
HNAS 3000 and 4000 family.</para>
|
||||
<section xml:id="hds-hnas-reqs">
|
||||
<title>System requirements</title>
|
||||
<para>Use the HDS <command>ssc</command> command to
|
||||
communicate with an HNAS array. This utility package is available in the
|
||||
physical media distributed with the hardware or it can be copied from
|
||||
the SMU (<filename>/usr/local/bin/ssc</filename>).</para>
|
||||
<para>Platform: Ubuntu 12.04 LTS or newer.</para>
|
||||
</section>
|
||||
<para>This Block Storage volume driver provides iSCSI and NFS support for
|
||||
<link xlink:href="http://www.hds.com/products/file-and-content/network-attached-storage/"
|
||||
>HNAS (Hitachi Network-attached Storage)</link>
|
||||
arrays such as, HNAS 3000 and 4000 family.</para>
|
||||
<section xml:id="hds-hnas-supported-operations">
|
||||
<title>Supported operations</title>
|
||||
<para>
|
||||
The base NFS driver combined with the HNAS driver
|
||||
extensions support these operations:
|
||||
</para>
|
||||
<para>The NFS and iSCSI drivers support these operations:</para>
|
||||
<itemizedlist>
|
||||
<listitem>
|
||||
<para>Create, delete, attach, and detach volumes.</para>
|
||||
@@ -53,317 +42,266 @@
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
</section>
|
||||
<section xml:id="hds-hnas-config">
|
||||
<title>Configuration</title>
|
||||
<para>The HDS driver supports the concept of differentiated services
|
||||
(also referred to as quality of service) by mapping volume types
|
||||
to services provided through HNAS. HNAS supports a variety of
|
||||
storage options and file system capabilities which are selected
|
||||
through volume typing and the use of multiple back-ends. The HDS driver
|
||||
maps up to 4 volume types into separate exports/filesystems, and can
|
||||
support any number using multiple back-ends.</para>
|
||||
<para>Configuration is read from an XML-formatted file (one per backend). Examples
|
||||
are shown for single and multi back-end cases.</para>
|
||||
<note>
|
||||
<itemizedlist>
|
||||
<listitem>
|
||||
<para>Configuration is read from an XML file. This
|
||||
example shows the configuration for single
|
||||
back-end and for multi-back-end cases.</para>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
<itemizedlist>
|
||||
<listitem>
|
||||
<para>The <literal>default</literal> volume type
|
||||
needs to be set in configuration file. If there is no
|
||||
<literal>default</literal> volume type,
|
||||
only matching volume types will work.</para>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
</note>
|
||||
<xi:include href="../../../common/tables/cinder-hds-hnas.xml"/>
|
||||
<simplesect>
|
||||
<title>HNAS setup</title>
|
||||
<para>Before using iSCSI and NFS services, use the HNAS Web Interface to create storage pool(s),
|
||||
filesystem(s), and assign an EVS. For NFS, NFS exports should be created.
|
||||
For iSCSI, a SCSI Domain needs to be set.</para>
|
||||
</simplesect>
|
||||
<simplesect>
|
||||
<title>Single back-end</title>
|
||||
<para>In a single back-end deployment, only one OpenStack Block Storage
|
||||
instance runs on the OpenStack Block Storage server and controls one
|
||||
HNAS array: this deployment requires these configuration
|
||||
files:</para>
|
||||
<orderedlist>
|
||||
<listitem>
|
||||
<para>Set the
|
||||
<option>hds_hnas_iscsi_config_file</option>
|
||||
option in the
|
||||
<filename>/etc/cinder/cinder.conf</filename>
|
||||
file to use the HNAS iSCSI volume driver. Or
|
||||
<option>hds_hnas_nfs_config_file</option>
|
||||
to use HNAS NFS driver. This option
|
||||
points to a configuration file.<footnote
|
||||
xml:id="hds-hnas-no-fixed-location-1">
|
||||
<para>The configuration file location
|
||||
may differ.</para>
|
||||
</footnote></para>
|
||||
<para>For HNAS iSCSI driver:</para>
|
||||
<programlisting language="ini">volume_driver = cinder.volume.drivers.hds.iscsi.HDSISCSIDriver
|
||||
hds_hnas_iscsi_config_file = /opt/hds/hnas/cinder_iscsi_conf.xml</programlisting>
|
||||
<para>For HNAS NFS driver:</para>
|
||||
<programlisting language="ini">volume_driver = cinder.volume.drivers.hds.nfs.HDSNFSDriver
|
||||
hds_hnas_nfs_config_file = /opt/hds/hnas/cinder_nfs_conf.xml</programlisting>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>For HNAS iSCSI, configure
|
||||
<option>hds_hnas_iscsi_config_file</option> at
|
||||
the location specified previously. For
|
||||
example,
|
||||
<filename>/opt/hds/hnas/cinder_iscsi_conf.xml</filename>:</para>
|
||||
<programlisting language="xml"><?xml version="1.0" encoding="UTF-8" ?>
|
||||
<config>
|
||||
<mgmt_ip0>172.17.44.16</mgmt_ip0>
|
||||
<hnas_cmd>ssc</hnas_cmd>
|
||||
<chap_enabled>True</chap_enabled>
|
||||
<username>supervisor</username>
|
||||
<password>supervisor</password>
|
||||
<svc_0>
|
||||
<volume_type>default</volume_type>
|
||||
<iscsi_ip>172.17.39.132</iscsi_ip>
|
||||
<hdp>fs-01</hdp>
|
||||
</svc_0>
|
||||
</config></programlisting>
|
||||
<para>For HNAS NFS, configure
|
||||
<option>hds_hnas_nfs_config_file</option> at
|
||||
the location specified previously. For
|
||||
example,
|
||||
<filename>/opt/hds/hnas/cinder_nfs_conf.xml</filename>:</para>
|
||||
<programlisting language="xml"><?xml version="1.0" encoding="UTF-8" ?>
|
||||
<config>
|
||||
<mgmt_ip0>172.17.44.16</mgmt_ip0>
|
||||
<hnas_cmd>ssc</hnas_cmd>
|
||||
<username>supervisor</username>
|
||||
<password>supervisor</password>
|
||||
<chap_enabled>False</chap_enabled>
|
||||
<svc_0>
|
||||
<volume_type>default</volume_type>
|
||||
<hdp>172.17.44.100:/virtual-01</hdp>
|
||||
</svc_0>
|
||||
</config></programlisting>
|
||||
</listitem>
|
||||
</orderedlist>
|
||||
<para>Up to 4 service stanzas can be included in the XML file; named
|
||||
<literal>svc_0</literal>, <literal>svc_1</literal>,
|
||||
<literal>svc_2</literal> and <literal>svc_3</literal>.
|
||||
Additional services can be enabled using multi-backend
|
||||
as described below.</para>
|
||||
</simplesect>
|
||||
<simplesect>
|
||||
<title>Multi back-end</title>
|
||||
<para>In a multi back-end deployment, more than one OpenStack Block Storage
|
||||
instance runs on the same server. In this example, two
|
||||
HNAS arrays are used, possibly providing different
|
||||
storage performance:</para>
|
||||
<procedure>
|
||||
<step>
|
||||
<para>For HNAS iSCSI, configure
|
||||
<filename>/etc/cinder/cinder.conf</filename>:
|
||||
the <literal>hnas1</literal> and
|
||||
<literal>hnas2</literal> configuration blocks are
|
||||
created. Set the
|
||||
<option>hds_hnas_iscsi_config_file</option>
|
||||
option to point to an unique configuration
|
||||
file for each block. Set the
|
||||
<option>volume_driver</option> option for
|
||||
each back-end to
|
||||
<literal>cinder.volume.drivers.hds.iscsi.HDSISCSIDriver</literal>.</para>
|
||||
<programlisting language="ini">enabled_backends=hnas1,hnas2
|
||||
|
||||
[hnas1]
|
||||
volume_driver = cinder.volume.drivers.hds.iscsi.HDSISCSIDriver
|
||||
hds_hnas_iscsi_config_file = /opt/hds/hnas/cinder_iscsi1_conf.xml
|
||||
volume_backend_name=hnas-1
|
||||
|
||||
[hnas2]
|
||||
volume_driver = cinder.volume.drivers.hds.iscsi.HDSISCSIDriver
|
||||
hds_hnas_iscsi_config_file = /opt/hds/hnas/cinder_iscsi2_conf.xml
|
||||
volume_backend_name=hnas-2</programlisting>
|
||||
</step>
|
||||
<step>
|
||||
<para>Configure the
|
||||
<filename>/opt/hds/hnas/cinder_iscsi1_conf.xml</filename>
|
||||
file:</para>
|
||||
<programlisting language="xml"><?xml version="1.0" encoding="UTF-8" ?>
|
||||
<config>
|
||||
<mgmt_ip0>172.17.44.16</mgmt_ip0>
|
||||
<hnas_cmd>ssc</hnas_cmd>
|
||||
<chap_enabled>True</chap_enabled>
|
||||
<username>supervisor</username>
|
||||
<password>supervisor</password>
|
||||
<svc_0>
|
||||
<volume_type>regular</volume_type>
|
||||
<iscsi_ip>172.17.39.132</iscsi_ip>
|
||||
<hdp>fs-01</hdp>
|
||||
</svc_0>
|
||||
</config></programlisting>
|
||||
</step>
|
||||
<step>
|
||||
<para>Configure the
|
||||
<filename>/opt/hds/hnas/cinder_iscsi2_conf.xml</filename>
|
||||
file:</para>
|
||||
<programlisting language="xml"><?xml version="1.0" encoding="UTF-8" ?>
|
||||
<config>
|
||||
<mgmt_ip0>172.17.44.20</mgmt_ip0>
|
||||
<hnas_cmd>ssc</hnas_cmd>
|
||||
<chap_enabled>True</chap_enabled>
|
||||
<username>supervisor</username>
|
||||
<password>supervisor</password>
|
||||
<svc_0>
|
||||
<volume_type>platinum</volume_type>
|
||||
<iscsi_ip>172.17.30.130</iscsi_ip>
|
||||
<hdp>fs-02</hdp>
|
||||
</svc_0>
|
||||
</config></programlisting>
|
||||
</step>
|
||||
</procedure>
|
||||
<procedure>
|
||||
<step>
|
||||
<para>For NFS, configure
|
||||
<filename>/etc/cinder/cinder.conf</filename>:
|
||||
the <literal>hnas1</literal> and
|
||||
<literal>hnas2</literal> configuration blocks are
|
||||
created. Set the
|
||||
<option>hds_hnas_nfs_config_file</option>
|
||||
option to point to an unique configuration
|
||||
file for each block. Set the
|
||||
<option>volume_driver</option> option for
|
||||
each back-end to
|
||||
<literal>cinder.volume.drivers.hds.nfs.HDSNFSDriver</literal>.</para>
|
||||
<programlisting language="ini">enabled_backends=hnas1,hnas2
|
||||
|
||||
[hnas1]
|
||||
volume_driver = cinder.volume.drivers.hds.nfs.HDSNFSDriver
|
||||
hds_hnas_nfs_config_file = /opt/hds/hnas/cinder_nfs1_conf.xml
|
||||
volume_backend_name=hnas-1
|
||||
|
||||
[hnas2]
|
||||
volume_driver = cinder.volume.drivers.hds.nfs.HDSNFSDriver
|
||||
hds_hnas_nfs_config_file = /opt/hds/hnas/cinder_nfs2_conf.xml
|
||||
volume_backend_name=hnas-2</programlisting>
|
||||
</step>
|
||||
<step>
|
||||
<para>Configure the
|
||||
<filename>/opt/hds/hnas/cinder_nfs1_conf.xml</filename>
|
||||
file:</para>
|
||||
<programlisting language="xml"><?xml version="1.0" encoding="UTF-8" ?>
|
||||
<config>
|
||||
<mgmt_ip0>172.17.44.16</mgmt_ip0>
|
||||
<hnas_cmd>ssc</hnas_cmd>
|
||||
<username>supervisor</username>
|
||||
<password>supervisor</password>
|
||||
<chap_enabled>False</chap_enabled>
|
||||
<svc_0>
|
||||
<volume_type>regular</volume_type>
|
||||
<hdp>172.17.44.100:/virtual-01</hdp>
|
||||
</svc_0>
|
||||
</config></programlisting>
|
||||
</step>
|
||||
<step>
|
||||
<para>Configure the
|
||||
<filename>/opt/hds/hnas/cinder_nfs2_conf.xml</filename>
|
||||
file:</para>
|
||||
<programlisting language="xml"><?xml version="1.0" encoding="UTF-8" ?>
|
||||
<config>
|
||||
<mgmt_ip0>172.17.44.20</mgmt_ip0>
|
||||
<hnas_cmd>ssc</hnas_cmd>
|
||||
<username>supervisor</username>
|
||||
<password>supervisor</password>
|
||||
<chap_enabled>False</chap_enabled>
|
||||
<svc_0>
|
||||
<volume_type>platinum</volume_type>
|
||||
<hdp>172.17.44.100:/virtual-02</hdp>
|
||||
</svc_0>
|
||||
</config></programlisting>
|
||||
</step>
|
||||
</procedure>
|
||||
</simplesect>
|
||||
<simplesect>
|
||||
<title>Type extra specs: <option>volume_backend</option>
|
||||
and volume type</title>
|
||||
<para>If you use volume types, you must configure them in
|
||||
the configuration file and set the
|
||||
<option>volume_backend_name</option> option to the
|
||||
appropriate back-end. In the previous multi back-end
|
||||
example, the <literal>platinum</literal> volume type
|
||||
is served by hnas-2, and the <literal>regular</literal>
|
||||
volume type is served by hnas-1.</para>
|
||||
<programlisting>cinder type-key regular set volume_backend_name=hnas-1
|
||||
cinder type-key platinum set volume_backend_name=hnas-2</programlisting>
|
||||
</simplesect>
|
||||
<simplesect>
|
||||
<title>Non-differentiated deployment of HNAS arrays</title>
|
||||
<para>You can deploy multiple OpenStack HNAS drivers instances that each
|
||||
control a separate HNAS array. Each instance does not need to have a
|
||||
volume type associated with it. The OpenStack Block Storage filtering
|
||||
algorithm selects the HNAS array with the largest
|
||||
available free space. In each configuration file, you
|
||||
must define the <literal>default</literal>
|
||||
volume type in the service labels.</para>
|
||||
</simplesect>
|
||||
</section>
|
||||
<section xml:id="hds-hnas-options">
|
||||
<title>HDS HNAS volume driver configuration options</title>
|
||||
<para>These details apply to the XML format configuration file
|
||||
that is read by HDS volume driver. These differentiated
|
||||
service labels are predefined: <literal>svc_0</literal>,
|
||||
<literal>svc_1</literal>, <literal>svc_2</literal>
|
||||
and <literal>svc_3</literal><footnote
|
||||
xml:id="hds-hnas-no-weight">
|
||||
<para>There is no relative precedence or weight among
|
||||
these four labels.</para>
|
||||
</footnote>. Each respective service label associates with
|
||||
these parameters and tags:</para>
|
||||
<section xml:id="hds-hnas-storage-reqs">
|
||||
<title>HNAS storage requirements</title>
|
||||
<para>
|
||||
Before using iSCSI and NFS services, use the HNAS Web
|
||||
Interface to create storage pool(s), file system(s), and assign
|
||||
an EVS. Make sure that the file system used is not created as
|
||||
<literal>replication targets</literal>. Additionally:
|
||||
</para>
|
||||
<variablelist>
|
||||
<varlistentry><term>volume_type</term>
|
||||
<listitem><para>A create_volume
|
||||
call with a certain volume type shall be matched
|
||||
up with this tag. The value <literal>default</literal>
|
||||
is special in that any service associated with this
|
||||
type is used to create volume when no other labels
|
||||
match. Other labels are case sensitive and should
|
||||
exactly match. If no configured volume types match
|
||||
the incoming requested type, an error occurs in
|
||||
volume creation.</para></listitem>
|
||||
</varlistentry>
|
||||
<varlistentry><term>hdp</term>
|
||||
<varlistentry><term><emphasis>For NFS:</emphasis></term>
|
||||
<listitem>
|
||||
<para>(iSCSI only) Virtual filesystem label associated
|
||||
with the service.</para>
|
||||
<para>(NFS only) Path to the volume
|
||||
<literal><ip_address>:/<path></literal> associated with
|
||||
the service. Additionally, this entry must be added
|
||||
in the file used to list available NFS shares. This file is located,
|
||||
by default, in <filename>/etc/cinder/nfs_shares</filename>
|
||||
or you can specify the location in the <option>nfs_shares_config</option>
|
||||
option in the cinder configuration file.</para>
|
||||
<para>
|
||||
Create NFS exports, choose a path for them (it must
|
||||
be different from "/") and set the <guilabel>Show
|
||||
snapshots</guilabel> option to <literal>hide and disable
|
||||
access</literal>.
|
||||
</para>
|
||||
<para>
|
||||
Also, configure the option <literal>norootsquash
|
||||
</literal> as <option>"* (rw, norootsquash)",</option> so
|
||||
cinder services can change the permissions of its volumes.
|
||||
</para>
|
||||
<para>
|
||||
In order to use the hardware accelerated features of
|
||||
NFS HNAS, we recommend setting <literal>max-nfs-version
|
||||
</literal> to 3.
|
||||
Refer to HNAS command line reference to see how to
|
||||
configure this option.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry><term>iscsi_ip</term>
|
||||
<listitem><para>(iSCSI only) An iSCSI IP address dedicated
|
||||
to the service.</para></listitem>
|
||||
<varlistentry><term><emphasis>For iSCSI:</emphasis></term>
|
||||
<listitem>
|
||||
<para>You need to set an iSCSI domain.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
<para>Typically an OpenStack Block Storage volume instance has only one such
|
||||
service label. For example, any <literal>svc_0</literal>,
|
||||
<literal>svc_1</literal>, <literal>svc_2</literal> or
|
||||
<literal>svc_3</literal> can be associated with it.
|
||||
But any mix of these service labels can be used in the
|
||||
same instance <footnote xml:id="hds-hnas-stats-all-hdp">
|
||||
<para>The <code>get_volume_stats()</code> function always provides the available
|
||||
capacity based on the combined sum of all the HDPs
|
||||
that are used in these services labels.</para>
|
||||
</footnote>.</para>
|
||||
</section>
|
||||
<section xml:id="hds-hnas-cinder-reqs">
|
||||
<title>Block storage host requirements</title>
|
||||
<variablelist>
|
||||
<varlistentry><term><emphasis>All versions:</emphasis></term>
|
||||
<listitem>
|
||||
<orderedlist>
|
||||
<listitem>
|
||||
<para><package>nfs-utils</package> for RPM packages</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>
|
||||
<package>nfs-common</package>, <package>libc6-i386</package>
|
||||
for DEB packages (<package>libc6-i386</package> only required on
|
||||
Ubuntu 12.04)
|
||||
</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>
|
||||
HDS SSC package (<package>hds-ssc-v1.0-1</package>) to
|
||||
communicate with an HNAS array using the <command>SSC
|
||||
</command> command. This utility package is available
|
||||
in the RPM package distributed with the hardware
|
||||
through physical media or it can be manually
|
||||
copied from the SMU to the Block Storage host.
|
||||
</para>
|
||||
</listitem>
|
||||
</orderedlist>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry><term><emphasis>Version: 2.2-1:</emphasis></term>
|
||||
<listitem>
|
||||
<orderedlist>
|
||||
<listitem>
|
||||
<para>
|
||||
Icehouse OpenStack deployment for RHOSP 5
|
||||
(RH 7.0), SUSE Cloud 4, and Mirantis Fuel (Ubuntu or
|
||||
CentOS hosts)
|
||||
</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para><package>hds-ssc-v1.0-1</package> package if not using SSH auth
|
||||
</para>
|
||||
</listitem>
|
||||
</orderedlist>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</section>
|
||||
<section xml:id="hds-hnas-pkg-install">
|
||||
<title>Package installation</title>
|
||||
<procedure>
|
||||
<para>If you are installing the driver from an RPM or DEB package,
|
||||
follow the steps bellow:</para>
|
||||
<step><para>Install SSC:</para>
|
||||
<screen><prompt>$</prompt> <userinput>rpm -i hds-ssc-v1.0-1.rpm</userinput></screen>
|
||||
<para>Or in Ubuntu:</para>
|
||||
<screen><prompt>$</prompt> <userinput>dpkg -i hds-ssc_1.0-1_all.deb</userinput></screen>
|
||||
</step>
|
||||
<step><para>Install the dependencies:</para>
|
||||
<screen><prompt>#</prompt> <userinput>yum install nfs-utils nfs-utils-lib</userinput></screen>
|
||||
<para>Or in Ubuntu:</para>
|
||||
<screen><prompt>#</prompt> <userinput>apt-get install nfs-common</userinput></screen>
|
||||
<para>Or in openSUSE and SUSE Linux Enterprise Server:</para>
|
||||
<screen><prompt>#</prompt> <userinput>zypper install nfs-client</userinput></screen>
|
||||
<para>If you are using Ubuntu 12.04, you also need to install
|
||||
<package>libc6-i386</package></para>
|
||||
</step>
|
||||
<step><para>Configure the driver as described in the "Driver
|
||||
Configuration" section.</para></step>
|
||||
<step><para>Restart all cinder services (volume, scheduler and
|
||||
backup).</para></step>
|
||||
</procedure>
|
||||
</section>
|
||||
<section xml:id="hds-hnas-drive-config">
|
||||
<title>Driver configuration</title>
|
||||
<para>The HDS driver supports the concept of differentiated
|
||||
services (also referred to as quality of service) by mapping
|
||||
volume types to services provided through HNAS.</para>
|
||||
<para>HNAS supports a variety of storage options and file
|
||||
system capabilities, which are selected through the definition
|
||||
of volume types and the use of multiple back ends. The driver
|
||||
maps up to four volume types into separated exports or file
|
||||
systems, and can support any number if using multiple back
|
||||
ends.</para>
|
||||
<para>The configuration for the driver is read from an
|
||||
XML-formatted file (one per back end), which you need to create
|
||||
and set its path in the <filename>cinder.conf</filename> configuration
|
||||
file. Below are the configuration needed in
|
||||
the <filename>cinder.conf</filename> configuration file
|
||||
<footnote xml:id="hds-hnas-no-fixed-location-1">
|
||||
<para>The configuration file location may differ.</para>
|
||||
</footnote>:
|
||||
</para>
|
||||
<programlisting language="ini">[DEFAULT]
|
||||
enabled_backends = hnas_iscsi1, hnas_nfs1</programlisting>
|
||||
<para>For HNAS iSCSI driver create this section:</para>
|
||||
<programlisting language="ini">[hnas_iscsi1]
|
||||
volume_driver = cinder.volume.drivers.hds.iscsi.HDSISCSIDriver
|
||||
hds_hnas_iscsi_config_file = <replaceable>/path/to/config/hnas_config_file.xml</replaceable>
|
||||
volume_backend_name = <replaceable>HNAS-ISCSI</replaceable></programlisting>
|
||||
<para>For HNAS NFS driver create this section:</para>
|
||||
<programlisting language="ini">[hnas_nfs1]
|
||||
volume_driver = cinder.volume.drivers.hds.nfs.HDSNFSDriver
|
||||
hds_hnas_nfs_config_file = <replaceable>/path/to/config/hnas_config_file.xml</replaceable>
|
||||
volume_backend_name = <replaceable>HNAS-NFS</replaceable></programlisting>
|
||||
<para>The XML file has the following format:
|
||||
</para>
|
||||
<programlisting language="xml"><?xml version = "1.0" encoding = "UTF-8" ?>
|
||||
<config>
|
||||
<mgmt_ip0>172.24.44.15</mgmt_ip0>
|
||||
<hnas_cmd>ssc</hnas_cmd>
|
||||
<chap_enabled>False</chap_enabled>
|
||||
<ssh_enabled>False</ssh_enabled>
|
||||
<cluster_admin_ip0>10.1.1.1</cluster_admin_ip0>
|
||||
<username>supervisor</username>
|
||||
<password>supervisor</password>
|
||||
<svc_0>
|
||||
<volume_type>default</volume_type>
|
||||
<iscsi_ip>172.24.44.20</iscsi_ip>
|
||||
<hdp>fs01-husvm</hdp>
|
||||
</svc_0>
|
||||
<svc_1>
|
||||
<volume_type>platinun</volume_type>
|
||||
<iscsi_ip>172.24.44.20</iscsi_ip>
|
||||
<hdp>fs01-platinun</hdp>
|
||||
</svc_1>
|
||||
</config></programlisting>
|
||||
</section>
|
||||
<section xml:id="hds-hnas-xml-config-options">
|
||||
<title>HNAS volume driver XML configuration options</title>
|
||||
<para>An OpenStack Block Storage node using HNAS drivers can have up to
|
||||
four services. Each service is defined by a <literal>svc_n
|
||||
</literal> tag (<literal>svc_0</literal>, <literal>svc_1</literal>,
|
||||
<literal>svc_2</literal>, or <literal>svc_3</literal>
|
||||
<footnote xml:id="hds-hnas-stats-all-hdp">
|
||||
<para>There is no relative precedence or weight among these
|
||||
four labels.</para>
|
||||
</footnote>, for example). These are the configuration options
|
||||
avaliable for each service label:
|
||||
</para>
|
||||
<table rules="all">
|
||||
<caption>Configuration options for service labels</caption>
|
||||
<col width="25%"/>
|
||||
<col width="10%"/>
|
||||
<col width="15%"/>
|
||||
<col width="50%"/>
|
||||
<thead>
|
||||
<tr>
|
||||
<td>Option</td>
|
||||
<td>Type</td>
|
||||
<td>Default</td>
|
||||
<td>Description</td>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<para><option>volume_type</option></para>
|
||||
</td>
|
||||
<td><para>Required</para></td>
|
||||
<td><para><literal>default</literal></para></td>
|
||||
<td>
|
||||
<para>
|
||||
When a <literal>create_volume</literal> call with
|
||||
a certain volume type happens, the volume type will
|
||||
try to be matched up with this tag. In each
|
||||
configuration file you must define the <literal>
|
||||
default</literal> volume type in the service
|
||||
labels and, if no volume type is specified, the
|
||||
<literal>default</literal> is used. Other labels
|
||||
are case sensitive and should match exactly. If no
|
||||
configured volume types match the incoming
|
||||
requested type, an error occurs in the volume
|
||||
creation.
|
||||
</para>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<para><option>iscsi_ip</option></para>
|
||||
</td>
|
||||
<td><para>Required only for iSCSI</para></td>
|
||||
<td><para/></td>
|
||||
<td>
|
||||
<para>
|
||||
An iSCSI IP address dedicated to the service.
|
||||
</para>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<para><option>hdp</option></para>
|
||||
</td>
|
||||
<td><para>Required</para></td>
|
||||
<td><para/></td>
|
||||
<td>
|
||||
<para>
|
||||
For iSCSI driver: virtual file system label
|
||||
associated with the service.
|
||||
</para>
|
||||
<para>
|
||||
For NFS driver: path to the volume
|
||||
(<ip_address>:/<path>) associated with
|
||||
the service.
|
||||
</para>
|
||||
<para>
|
||||
Additionally, this entry must be added in the file
|
||||
used to list available NFS shares. This file is
|
||||
located, by default, in
|
||||
<filename>/etc/cinder/nfs_shares</filename> or you
|
||||
can specify the location in the
|
||||
<literal>nfs_shares_config</literal> option in the
|
||||
<filename>cinder.conf</filename> configuration file.
|
||||
</para>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<para>
|
||||
These are the configuration options available to the
|
||||
<literal>config</literal> section of the XML config file:
|
||||
</para>
|
||||
<table rules="all">
|
||||
<caption>Configuration options</caption>
|
||||
<col width="25%"/>
|
||||
@@ -384,28 +322,34 @@ cinder type-key platinum set volume_backend_name=hnas-2</programlisting>
|
||||
</td>
|
||||
<td><para>Required</para></td>
|
||||
<td><para/></td>
|
||||
<td><para>Management Port 0 IP address. Should be the IP
|
||||
address of the 'Admin' EVS.</para>
|
||||
<td>
|
||||
<para>
|
||||
Management Port 0 IP address. Should be the IP
|
||||
address of the "Admin" EVS.
|
||||
</para>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><para><option>hnas_cmd</option></para>
|
||||
</td>
|
||||
<td><para>Optional</para></td>
|
||||
<td><para><command>ssc</command></para></td>
|
||||
<td><para>ssc</para></td>
|
||||
<td>
|
||||
<para><option>hnas_cmd</option> is a command to
|
||||
communicate to HNAS array.</para>
|
||||
<para>
|
||||
Command to communicate to HNAS array.
|
||||
</para>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><para><option>chap_enabled</option></para>
|
||||
</td>
|
||||
<td><para>Optional</para></td>
|
||||
<td><para>True</para></td>
|
||||
<td><para>Optional (iSCSI only)</para></td>
|
||||
<td><para><literal>True</literal></para></td>
|
||||
<td>
|
||||
<para>(iSCSI only) <option>chap_enabled</option> is a boolean tag used
|
||||
to enable CHAP authentication protocol.</para>
|
||||
<para>
|
||||
Boolean tag used to enable CHAP authentication
|
||||
protocol.
|
||||
</para>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
@@ -414,7 +358,7 @@ cinder type-key platinum set volume_backend_name=hnas-2</programlisting>
|
||||
<td><para>Required</para></td>
|
||||
<td><para>supervisor</para></td>
|
||||
<td>
|
||||
<para>Username is always required on HNAS.</para>
|
||||
<para>It's always required on HNAS.</para>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
@@ -428,59 +372,248 @@ cinder type-key platinum set volume_backend_name=hnas-2</programlisting>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<para><option>svc_0, svc_1, svc_2, svc_3
|
||||
</option></para>
|
||||
<para>
|
||||
<option>svc_0, svc_1, svc_2, svc_3</option>
|
||||
</para>
|
||||
</td>
|
||||
<td><para>Optional</para></td>
|
||||
<td><para>(at least one label has to be
|
||||
defined)</para></td>
|
||||
<td>
|
||||
<para>Service labels: these four predefined
|
||||
<para>Optional</para>
|
||||
</td>
|
||||
<td>
|
||||
<para>
|
||||
(at least one label has to be defined)
|
||||
</para>
|
||||
</td>
|
||||
<td>
|
||||
<para>
|
||||
Service labels: these four predefined
|
||||
names help four different sets of
|
||||
configuration options. Each can specify
|
||||
HDP and a unique volume type.</para>
|
||||
HDP and a unique volume type.
|
||||
</para>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<para><option>volume_type</option></para>
|
||||
<para>
|
||||
<option>cluster_admin_ip0</option>
|
||||
</para>
|
||||
</td>
|
||||
<td><para>Required</para></td>
|
||||
<td><para><literal>default</literal></para></td>
|
||||
<td>
|
||||
<para>volume_type tag is used
|
||||
to match volume type.
|
||||
<literal>default</literal> meets any
|
||||
type of volume type, or
|
||||
if it is not specified. Any other
|
||||
volume type is selected if exactly matched
|
||||
during volume creation.</para>
|
||||
<para>Optional if <option>ssh_enabled</option>
|
||||
is <literal>True</literal></para>
|
||||
</td>
|
||||
<td>
|
||||
</td>
|
||||
<td>
|
||||
<para>
|
||||
The address of HNAS cluster admin.
|
||||
</para>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<para><option>iscsi_ip</option></para>
|
||||
<para>
|
||||
<option>ssh_enabled</option>
|
||||
</para>
|
||||
</td>
|
||||
<td><para>Required</para></td>
|
||||
<td><para/></td>
|
||||
<td>
|
||||
<para>(iSCSI only) iSCSI IP address where volume
|
||||
attaches for this volume type.</para>
|
||||
<para>Optional</para>
|
||||
</td>
|
||||
<td>
|
||||
<para><literal>False</literal></para>
|
||||
</td>
|
||||
<td>
|
||||
<para>
|
||||
Enables SSH authentication between Block Storage
|
||||
host and the SMU.
|
||||
</para>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<para><option>hdp</option></para>
|
||||
<para>
|
||||
<option>ssh_private_key</option>
|
||||
</para>
|
||||
</td>
|
||||
<td><para>Required</para></td>
|
||||
<td><para/></td>
|
||||
<td>
|
||||
<para>HDP, for HNAS iSCSI is the virtual filesystem label
|
||||
or the path (for HNAS NFS) where volume, or
|
||||
snapshot should be created.</para>
|
||||
<para>Required if <literal>ssh_enabled</literal> is
|
||||
<literal>True</literal></para>
|
||||
</td>
|
||||
<td>
|
||||
<para><literal>False</literal></para>
|
||||
</td>
|
||||
<td>
|
||||
<para>
|
||||
Path to the SSH private key used to authenticate
|
||||
in HNAS SMU. The public key must be uploaded to
|
||||
HNAS SMU using <literal>ssh-register-public-key
|
||||
</literal> (this is an SSH subcommand). Note that
|
||||
copying the public key HNAS using
|
||||
<literal>ssh-copy-id</literal> doesn't work
|
||||
properly as the SMU periodically wipe out those
|
||||
keys.
|
||||
</para>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</section>
|
||||
<section xml:id="hds-hnas-service-labels">
|
||||
<title>Service labels</title>
|
||||
<para>
|
||||
HNAS driver supports differentiated types of service using the service
|
||||
labels. It is possible to create up to four types of them, as gold,
|
||||
platinun, silver and ssd, for example.
|
||||
</para>
|
||||
<para>
|
||||
Each service is treated by OpenStack Block Storage as a unit of
|
||||
scheduling (pool). After creating the services in the XML
|
||||
configuration file, you must configure one
|
||||
<literal>volume_type</literal> per service. Each <literal>
|
||||
volume_type</literal> must have the metadata <literal>
|
||||
service_label</literal> with the same name configured in the
|
||||
<literal><volume_type> </literal> section of that
|
||||
service. If this is not set, OpenStack Block Storage will
|
||||
schedule the volume creation to the pool with largest avaliable
|
||||
free space or other criteria configured in volume filters.
|
||||
</para>
|
||||
<screen><prompt>$</prompt> <userinput>cinder type-create 'default'</userinput>
|
||||
<prompt>$</prompt> <userinput>cinder type-key 'default' set service_label = 'default'</userinput>
|
||||
<prompt>$</prompt> <userinput>cinder type-create 'platinun-tier'</userinput>
|
||||
<prompt>$</prompt> <userinput>cinder type-key 'platinun' set service_label = 'platinun'</userinput></screen>
|
||||
</section>
|
||||
<section xml:id="hds-hnas-multibend-config">
|
||||
<title>Multi-back-end configuration</title>
|
||||
<para>
|
||||
If you use multiple back ends and intend to enable the creation of
|
||||
a volume in a specific back end, you must configure volume types to
|
||||
set the <literal>volume_backend_name</literal> option to the
|
||||
appropriate back end. Then, create <literal>volume_type</literal>
|
||||
configurations with the same <literal>volume_backend_name
|
||||
</literal>.
|
||||
</para>
|
||||
<screen><prompt>$</prompt> <userinput>cinder type-create 'iscsi'</userinput>
|
||||
<prompt>$</prompt> <userinput>cinder type-key 'iscsi' set volume_backend_name = 'HNAS-ISCSI'</userinput>
|
||||
<prompt>$</prompt> <userinput>cinder type-create 'nfs'</userinput>
|
||||
<prompt>$</prompt> <userinput>cinder type-key 'nfs' set volume_backend_name = 'HNAS-NFS'</userinput></screen>
|
||||
<para>
|
||||
You can deploy multiple OpenStack HNAS drivers instances that each
|
||||
control a separate HNAS array. Each service (<literal>svc_0, svc_1,
|
||||
svc_2, svc_3</literal>) on the instances need to have a volume_type
|
||||
and service_label metadata associated with it. If no metadata is
|
||||
associated with a pool, OpenStack Block Storage filtering algorithm
|
||||
selects the pool with the largest available free space.
|
||||
</para>
|
||||
</section>
|
||||
<section xml:id="hds-hnas-ssh-config">
|
||||
<title>SSH configuration</title>
|
||||
<para>
|
||||
Instead of using <command>SSC</command> on the Block Storage host
|
||||
and store its credential on the XML configuration file, HNAS driver
|
||||
supports <command>SSH</command> authentication. To configure that:
|
||||
</para>
|
||||
<procedure>
|
||||
<step>
|
||||
<para>
|
||||
Create a pair of public keys in the Block Storage host
|
||||
(leave the pass-phrase empty):
|
||||
</para>
|
||||
<screen><prompt>$</prompt> <userinput>mkdir -p <replaceable>/opt/hds/ssh</replaceable></userinput></screen>
|
||||
</step>
|
||||
<step>
|
||||
<para>
|
||||
Change the owner of the key to <literal>cinder</literal>
|
||||
(or the user the volume service will be run):
|
||||
</para>
|
||||
<screen><prompt>#</prompt> <userinput>chown -R cinder.cinder <replaceable>/opt/hds/ssh</replaceable></userinput></screen>
|
||||
</step>
|
||||
<step>
|
||||
<para>
|
||||
Export your pubkey to SMU (HNAS):
|
||||
</para>
|
||||
<screen><prompt>$</prompt> <userinput>ssh-copy-id -i <replaceable>/opt/hds/ssh/hnaskey.pub</replaceable> [manager|supervisor]@<smu-ip></userinput></screen>
|
||||
</step>
|
||||
<step>
|
||||
<para>
|
||||
Check the communication with HNAS:
|
||||
</para>
|
||||
<screen><prompt>$</prompt> <userinput>ssh [manager|supervisor]@<smu-ip> 'ssc <cluster_admin_ip0> df -a'</userinput></screen>
|
||||
</step>
|
||||
</procedure>
|
||||
<para>
|
||||
<literal><cluster_admin_ip0></literal> is "localhost" for
|
||||
single node deployments. This should return a list of avaliable
|
||||
file systems on HNAS.
|
||||
</para>
|
||||
</section>
|
||||
<section xml:id="hds-hnas-xml-config">
|
||||
<title>Editing the XML config file:</title>
|
||||
<orderedlist>
|
||||
<listitem>
|
||||
<para>
|
||||
Set the "username".
|
||||
</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>
|
||||
Enable SSH adding the line <literal>"<ssh_enabled>
|
||||
True</ssh_enabled>"</literal> under <literal>
|
||||
"<config>"</literal> session.
|
||||
</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>
|
||||
Set the private key path: <literal>"<ssh_private_key>
|
||||
/opt/hds/ssh/hnaskey</ssh_private_key>" </literal>under
|
||||
<literal>"<config>"</literal> session.
|
||||
</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>
|
||||
If the HNAS is in a multi-cluster configuration set <literal>
|
||||
"<cluster_admin_ip0>"</literal> to the cluster
|
||||
node admin IP. In a single node HNAS, leave it empty.
|
||||
</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>
|
||||
Restart the cinder service.
|
||||
</para>
|
||||
</listitem>
|
||||
</orderedlist>
|
||||
</section>
|
||||
<section xml:id="hds-hnas-additional-notes">
|
||||
<title>Additional notes</title>
|
||||
<itemizedlist>
|
||||
<listitem>
|
||||
<para>
|
||||
The <literal>get_volume_stats()</literal> function always
|
||||
provides the available capacity based on the
|
||||
combined sum of all the HDPs that are used in these
|
||||
services labels.
|
||||
</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>
|
||||
After changing the configuration on the storage,
|
||||
the OpenStack Block Storage driver must be
|
||||
restarted.
|
||||
</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>
|
||||
HNAS iSCSI driver, due to an HNAS limitation,
|
||||
allows only 32 volumes per target.
|
||||
</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>
|
||||
On RedHat, if the system is configured to use SELinux, you
|
||||
need to set <option>"virt_use_nfs = on"</option> for NFS
|
||||
driver work properly.
|
||||
</para>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
</section>
|
||||
</section>
|
||||
|
||||
Reference in New Issue
Block a user