5fca287eb5
There are several instances of "Block Storage Service" in the upstream documentation. As was recently clarified in the docs mailing list, these should be "Block Storage service". This patch applies the fix. Change-Id: I591c100ab031b75f1c0d27d45f53e32401a26e30 Partial-Bug: #1217503
189 lines
9.0 KiB
XML
189 lines
9.0 KiB
XML
<?xml version="1.0" encoding="UTF-8"?>
|
|
<!DOCTYPE section [
|
|
<!-- Some useful entities borrowed from HTML -->
|
|
<!ENTITY nbsp " ">
|
|
]>
|
|
<section xml:id="section_ts_cinder_config"
|
|
xmlns="http://docbook.org/ns/docbook"
|
|
xmlns:xi="http://www.w3.org/2001/XInclude"
|
|
xmlns:xlink="http://www.w3.org/1999/xlink" version="1.0"
|
|
linkend="section_ts_cinder_config">
|
|
<title xml:id="ts_block_config">Troubleshoot the Block Storage
|
|
configuration</title>
|
|
<para>Most Block Storage errors are caused by incorrect volume
|
|
configurations that result in volume creation failues. To resolve
|
|
these failures, review these logs:</para>
|
|
<itemizedlist>
|
|
<listitem><para><systemitem class="service">cinder-api</systemitem>
|
|
log (<filename>/var/log/cinder/api.log</filename>)</para></listitem>
|
|
<listitem><para><systemitem class="service">cinder-volume</systemitem>
|
|
log (<filename>/var/log/cinder/volume.log</filename>)</para></listitem>
|
|
</itemizedlist>
|
|
<para>The <systemitem class="service">cinder-api</systemitem> log
|
|
is useful for determining if you have endpoint or connectivity
|
|
issues. If you send a request to create a volume and it fails,
|
|
review the <systemitem class="service" >cinder-api</systemitem>
|
|
log to determine whether the request made it to the Block Storage
|
|
service. If the request is logged and you see no errors or
|
|
trace-backs, check the
|
|
<systemitem class="service">cinder-volume</systemitem> log for
|
|
errors or trace-backs.</para>
|
|
<note>
|
|
<para>Create commands are listed in the <systemitem
|
|
class="service">cinder-api</systemitem> log.</para>
|
|
</note>
|
|
<para>These entries in the
|
|
<filename>cinder.openstack.common.log</filename> file can
|
|
be used to assist in troubleshooting your block storage
|
|
configuration.</para>
|
|
<programlisting language="ini">
|
|
# Print debugging output (set logging level to DEBUG instead
|
|
# of default WARNING level). (boolean value)
|
|
#debug=false
|
|
|
|
# Print more verbose output (set logging level to INFO instead
|
|
# of default WARNING level). (boolean value)
|
|
#verbose=false
|
|
|
|
# Log output to standard error (boolean value)
|
|
#use_stderr=true
|
|
|
|
# Default file mode used when creating log files (string
|
|
# value)
|
|
#logfile_mode=0644
|
|
|
|
# format string to use for log messages with context (string
|
|
# value)
|
|
#logging_context_format_string=%(asctime)s.%(msecs)03d %(levelname)s %(name)s [%(request_id)s %(user)s %(tenant)s] %(instance)s%(message)s
|
|
|
|
# format string to use for log mes #logging_default_format_string=%(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [-] %(instance)s%(message)s
|
|
|
|
# data to append to log format when level is DEBUG (string
|
|
# value)
|
|
#logging_debug_format_suffix=%(funcName)s %(pathname)s:%(lineno)d
|
|
|
|
# prefix each line of exception output with this format
|
|
# (string value)
|
|
#logging_exception_prefix=%(asctime)s.%(msecs)03d %(process)d TRACE %(name)s %(instance)s
|
|
|
|
# list of logger=LEVEL pairs (list value)
|
|
#default_log_levels=amqplib=WARN,sqlalchemy=WARN,boto=WARN,suds=INFO,keystone=INFO,eventlet.wsgi.server=WARNsages without context
|
|
# (string value)
|
|
|
|
# If an instance is passed with the log message, format it
|
|
# like this (string value)
|
|
#instance_format="[instance: %(uuid)s]"
|
|
|
|
# If an instance UUID is passed with the log message, format
|
|
# it like this (string value)
|
|
# A logging.Formatter log message format string which may use
|
|
# any of the available logging.LogRecord attributes. Default:
|
|
# %(default)s (string value)
|
|
#log_format=%(asctime)s %(levelname)8s [%(name)s] %(message)s
|
|
|
|
# Format string for %%(asctime)s in log records. Default:
|
|
# %(default)s (string value)
|
|
#log_date_format=%Y-%m-%d %H:%M:%S
|
|
|
|
# (Optional) Name of log file to output to. If not set,
|
|
# logging will go to stdout. (string value)
|
|
#log_file=<None>
|
|
|
|
# (Optional) The directory to keep log files in (will be
|
|
# prepended to --log-file) (string value)
|
|
#log_dir=<None>
|
|
#instance_uuid_format="[instance: %(uuid)s]"
|
|
|
|
# If this option is specified, the logging configuration file
|
|
# specified is used and overrides any other logging options
|
|
# specified. Please see the Python logging module
|
|
# documentation for details on logging configuration files.
|
|
# (string value) # Use syslog for logging. (boolean value)
|
|
#use_syslog=false
|
|
|
|
# syslog facility to receive log lines (string value)
|
|
#syslog_log_facility=LOG_USER
|
|
#log_config=<None></programlisting>
|
|
<para>These common issues might occur during configuration. To
|
|
correct, use these suggested solutions.</para>
|
|
<itemizedlist>
|
|
<listitem>
|
|
<para>Issues with <literal>state_path</literal> and
|
|
<literal>volumes_dir</literal> settings.</para>
|
|
<para>The OpenStack Block Storage uses <command>tgtd</command>
|
|
as the default iscsi helper and implements persistent targets.
|
|
This means that in the case of a tgt restart or even a
|
|
node reboot your existing volumes on that node will be
|
|
restored automatically with their original IQN.</para>
|
|
<para>In order to make this possible the iSCSI target
|
|
information needs to be stored in a file on creation
|
|
that can be queried in case of restart of the tgt
|
|
daemon. By default, Block Storage uses a
|
|
<literal>state_path</literal> variable, which if
|
|
installing with Yum or APT should be set to
|
|
<filename>/var/lib/cinder/</filename>. The next
|
|
part is the <literal>volumes_dir</literal> variable,
|
|
by default this just simply appends a
|
|
"<literal>volumes</literal>" directory to the
|
|
<literal>state_path</literal>. The result is a
|
|
file-tree
|
|
<filename>/var/lib/cinder/volumes/</filename>.</para>
|
|
<para>While this should all be handled by the installer,
|
|
it can go wrong. If you have trouble creating volumes
|
|
and this directory does not exist you should see an
|
|
error message in the <systemitem class="service"
|
|
>cinder-volume</systemitem> log indicating that
|
|
the <literal>volumes_dir</literal> does not exist, and
|
|
it should provide information about which path it was
|
|
looking for.</para>
|
|
</listitem>
|
|
<listitem>
|
|
<para>The persistent tgt include file.</para>
|
|
<para>Along with the <option>volumes_dir</option> option,
|
|
the iSCSI target driver also needs to be configured to
|
|
look in the correct place for the persist files. This
|
|
is a simple entry in the
|
|
<filename>/etc/tgt/conf.d</filename> file that you
|
|
should have set when you installed OpenStack. If
|
|
issues occur, verify that you have a
|
|
<filename>/etc/tgt/conf.d/cinder.conf</filename>
|
|
file.</para>
|
|
<para>If the file is not present, create it with this
|
|
command:</para>
|
|
<screen><prompt>#</prompt> <userinput>echo 'include /var/lib/cinder/volumes/ *' >> /etc/tgt/conf.d/cinder.conf</userinput></screen>
|
|
</listitem>
|
|
<listitem>
|
|
<para>No sign of attach call in the <systemitem
|
|
class="service">cinder-api</systemitem>
|
|
log.</para>
|
|
<para>This is most likely going to be a minor adjustment
|
|
to your <filename>nova.conf</filename> file. Make sure
|
|
that your <filename>nova.conf</filename> has this
|
|
entry:</para>
|
|
<programlisting language="ini">volume_api_class=nova.volume.cinder.API</programlisting>
|
|
</listitem>
|
|
<listitem>
|
|
<para>Failed to create iscsi target error in the
|
|
<filename>cinder-volume.log</filename>
|
|
file.</para>
|
|
<programlisting language="bash">2013-03-12 01:35:43 1248 TRACE cinder.openstack.common.rpc.amqp ISCSITargetCreateFailed: Failed to create iscsi target for volume volume-137641b2-af72-4a2f-b243-65fdccd38780.</programlisting>
|
|
<para>You might see this error in
|
|
<filename>cinder-volume.log</filename> after
|
|
trying to create a volume that is 1 GB. To fix this
|
|
issue:</para>
|
|
<para>Change content of the
|
|
<filename>/etc/tgt/targets.conf</filename> from
|
|
<literal>include /etc/tgt/conf.d/*.conf</literal>
|
|
to <literal>include
|
|
/etc/tgt/conf.d/cinder_tgt.conf</literal>, as
|
|
follows:</para>
|
|
<programlisting language="bash">include /etc/tgt/conf.d/cinder_tgt.conf
|
|
include /etc/tgt/conf.d/cinder.conf
|
|
default-driver iscsi</programlisting>
|
|
<para>Restart <systemitem class="service">tgt</systemitem>
|
|
and <systemitem class="service">cinder-*</systemitem>
|
|
services so they pick up the new configuration.</para>
|
|
</listitem>
|
|
</itemizedlist>
|
|
</section>
|