openstack-manuals/doc/common/tables/cinder-common.xml

<?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_common">
    <caption>Description of common 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>compute_api_class = cinder.compute.nova.API</td>
        <td>(StrOpt) The full class name of the compute API class to use</td>
      </tr>
      <tr>
        <td>debug = False</td>
        <td>(BoolOpt) Print debugging output (set logging level to DEBUG instead of default WARNING level).</td>
      </tr>
      <tr>
        <td>default_availability_zone = None</td>
        <td>(StrOpt) Default availability zone for new volumes. If not set, the storage_availability_zone option value is used as the default for new volumes.</td>
      </tr>
      <tr>
        <td>default_log_levels = amqp=WARN, amqplib=WARN, boto=WARN, qpid=WARN, sqlalchemy=WARN, suds=INFO, oslo.messaging=INFO, iso8601=WARN, requests.packages.urllib3.connectionpool=WARN, urllib3.connectionpool=WARN, websocket=WARN, keystonemiddleware=WARN, routes.middleware=WARN</td>
        <td>(ListOpt) List of logger=LEVEL pairs.</td>
      </tr>
      <tr>
        <td>default_volume_type = None</td>
        <td>(StrOpt) Default volume type to use</td>
      </tr>
      <tr>
        <td>disable_process_locking = False</td>
        <td>(BoolOpt) Whether to disable inter-process locks</td>
      </tr>
      <tr>
        <td>enable_new_services = True</td>
        <td>(BoolOpt) Services to be added to the available pool on create</td>
      </tr>
      <tr>
        <td>fatal_deprecations = False</td>
        <td>(BoolOpt) Enables or disables fatal status of deprecations.</td>
      </tr>
      <tr>
        <td>fatal_exception_format_errors = False</td>
        <td>(BoolOpt) Make exception message format errors fatal.</td>
      </tr>
      <tr>
        <td>host = localhost</td>
        <td>(StrOpt) Name of this node.  This can be an opaque identifier. It is not necessarily a host name, FQDN, or IP address.</td>
      </tr>
      <tr>
        <td>iet_conf = /etc/iet/ietd.conf</td>
        <td>(StrOpt) IET configuration file</td>
      </tr>
      <tr>
        <td>lio_initiator_iqns = </td>
        <td>(StrOpt) Comma-separated list of initiator IQNs allowed to connect to the iSCSI target. (From Nova compute nodes.)</td>
      </tr>
      <tr>
        <td>lock_path = None</td>
        <td>(StrOpt) Directory to use for lock files. Default to a temp directory</td>
      </tr>
      <tr>
        <td>log_config_append = None</td>
        <td>(StrOpt) The name of a logging configuration file. This file is appended to any existing logging configuration files. For details about logging configuration files, see the Python logging module documentation.</td>
      </tr>
      <tr>
        <td>log_date_format = %Y-%m-%d %H:%M:%S</td>
        <td>(StrOpt) Format string for %%(asctime)s in log records. Default: %(default)s .</td>
      </tr>
      <tr>
        <td>log_dir = None</td>
        <td>(StrOpt) (Optional) The base directory used for relative --log-file paths.</td>
      </tr>
      <tr>
        <td>log_file = None</td>
        <td>(StrOpt) (Optional) Name of log file to output to. If no default is set, logging will go to stdout.</td>
      </tr>
      <tr>
        <td>log_format = None</td>
        <td>(StrOpt) DEPRECATED. A logging.Formatter log message format string which may use any of the available logging.LogRecord attributes. This option is deprecated.  Please use logging_context_format_string and logging_default_format_string instead.</td>
      </tr>
      <tr>
        <td>logging_context_format_string = %(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [%(request_id)s %(user_identity)s] %(instance)s%(message)s</td>
        <td>(StrOpt) Format string to use for log messages with context.</td>
      </tr>
      <tr>
        <td>logging_debug_format_suffix = %(funcName)s %(pathname)s:%(lineno)d</td>
        <td>(StrOpt) Data to append to log format when level is DEBUG.</td>
      </tr>
      <tr>
        <td>logging_default_format_string = %(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [-] %(instance)s%(message)s</td>
        <td>(StrOpt) Format string to use for log messages without context.</td>
      </tr>
      <tr>
        <td>logging_exception_prefix = %(asctime)s.%(msecs)03d %(process)d TRACE %(name)s %(instance)s</td>
        <td>(StrOpt) Prefix each line of exception output with this format.</td>
      </tr>
      <tr>
        <td>monkey_patch = False</td>
        <td>(BoolOpt) Enable monkey patching</td>
      </tr>
      <tr>
        <td>monkey_patch_modules = </td>
        <td>(ListOpt) List of modules/decorators to monkey patch</td>
      </tr>
      <tr>
        <td>my_ip = 10.0.0.1</td>
        <td>(StrOpt) IP address of this host</td>
      </tr>
      <tr>
        <td>no_snapshot_gb_quota = False</td>
        <td>(BoolOpt) Whether snapshots count against GigaByte quota</td>
      </tr>
      <tr>
        <td>num_shell_tries = 3</td>
        <td>(IntOpt) Number of times to attempt to run flakey shell commands</td>
      </tr>
      <tr>
        <td>periodic_fuzzy_delay = 60</td>
        <td>(IntOpt) Range, in seconds, to randomly delay when starting the periodic task scheduler to reduce stampeding. (Disable by setting to 0)</td>
      </tr>
      <tr>
        <td>periodic_interval = 60</td>
        <td>(IntOpt) Interval, in seconds, between running periodic tasks</td>
      </tr>
      <tr>
        <td>policy_default_rule = default</td>
        <td>(StrOpt) Rule checked when requested rule is not found</td>
      </tr>
      <tr>
        <td>policy_file = policy.json</td>
        <td>(StrOpt) JSON file representing policy</td>
      </tr>
      <tr>
        <td>replication_api_class = cinder.replication.api.API</td>
        <td>(StrOpt) The full class name of the volume replication API class</td>
      </tr>
      <tr>
        <td>report_interval = 10</td>
        <td>(IntOpt) Interval, in seconds, between nodes reporting state to datastore</td>
      </tr>
      <tr>
        <td>reserved_percentage = 0</td>
        <td>(IntOpt) The percentage of backend capacity is reserved</td>
      </tr>
      <tr>
        <td>rootwrap_config = /etc/cinder/rootwrap.conf</td>
        <td>(StrOpt) Path to the rootwrap configuration file to use for running commands as root</td>
      </tr>
      <tr>
        <td>run_external_periodic_tasks = True</td>
        <td>(BoolOpt) Some periodic tasks can be run in a separate process. Should we run them here?</td>
      </tr>
      <tr>
        <td>service_down_time = 60</td>
        <td>(IntOpt) Maximum time since last check-in for a service to be considered up</td>
      </tr>
      <tr>
        <td>ssl_ca_file = None</td>
        <td>(StrOpt) CA certificate file to use to verify connecting clients</td>
      </tr>
      <tr>
        <td>ssl_cert_file = None</td>
        <td>(StrOpt) Certificate file to use when starting the server securely</td>
      </tr>
      <tr>
        <td>ssl_key_file = None</td>
        <td>(StrOpt) Private key file to use when starting the server securely</td>
      </tr>
      <tr>
        <td>state_path = /var/lib/cinder</td>
        <td>(StrOpt) Top-level directory for maintaining cinder's state</td>
      </tr>
      <tr>
        <td>storage_availability_zone = nova</td>
        <td>(StrOpt) Availability zone of this node</td>
      </tr>
      <tr>
        <td>syslog_log_facility = LOG_USER</td>
        <td>(StrOpt) Syslog facility to receive log lines.</td>
      </tr>
      <tr>
        <td>tcp_keepalive = True</td>
        <td>(BoolOpt) Sets the value of TCP_KEEPALIVE (True/False) for each server socket.</td>
      </tr>
      <tr>
        <td>tcp_keepalive_count = None</td>
        <td>(IntOpt) Sets the value of TCP_KEEPCNT for each server socket. Not supported on OS X.</td>
      </tr>
      <tr>
        <td>tcp_keepalive_interval = None</td>
        <td>(IntOpt) Sets the value of TCP_KEEPINTVL in seconds for each server socket. Not supported on OS X.</td>
      </tr>
      <tr>
        <td>tcp_keepidle = 600</td>
        <td>(IntOpt) Sets the value of TCP_KEEPIDLE in seconds for each server socket. Not supported on OS X.</td>
      </tr>
      <tr>
        <td>until_refresh = 0</td>
        <td>(IntOpt) Count of reservations until usage is refreshed</td>
      </tr>
      <tr>
        <td>use_forwarded_for = False</td>
        <td>(BoolOpt) Treat X-Forwarded-For as the canonical remote address. Only enable this if you have a sanitizing proxy.</td>
      </tr>
      <tr>
        <td>use_stderr = True</td>
        <td>(BoolOpt) Log output to standard error.</td>
      </tr>
      <tr>
        <td>use_syslog = False</td>
        <td>(BoolOpt) Use syslog for logging. Existing syslog format is DEPRECATED during I, and will change in J to honor RFC5424.</td>
      </tr>
      <tr>
        <td>use_syslog_rfc_format = False</td>
        <td>(BoolOpt) (Optional) Enables or disables syslog rfc5424 format for logging. If enabled, prefixes the MSG part of the syslog message with APP-NAME (RFC5424). The format without the APP-NAME is deprecated in I, and will be removed in J.</td>
      </tr>
      <tr>
        <td>verbose = False</td>
        <td>(BoolOpt) Print more verbose output (set logging level to INFO instead of default WARNING level).</td>
      </tr>
    </tbody>
  </table>
</para>