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>consistencygroup_api_class = cinder.consistencygroup.api.API</td>
        <td>(StrOpt) The full class name of the consistencygroup API class</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_volume_type = None</td>
        <td>(StrOpt) Default volume type to use</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>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>memcached_servers = None</td>
        <td>(ListOpt) Memcached servers or None for in process cache.</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) Default rule. Enforced when a requested rule is not found.</td>
      </tr>
      <tr>
        <td>policy_file = policy.json</td>
        <td>(StrOpt) The JSON file that defines policies.</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>ssh_hosts_key_file = $state_path/ssh_known_hosts</td>
        <td>(StrOpt) File containing SSH host keys for the systems with which Cinder needs to communicate.  OPTIONAL: Default=$state_path/ssh_known_hosts</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>strict_ssh_host_key_policy = False</td>
        <td>(BoolOpt) Option to enable strict host key checking.  When set to "True" Cinder will only connect to systems with a host key present in the configured "ssh_hosts_key_file".  When set to "False" the host key will be saved upon first connection and used for subsequent connections.  Default=False</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>
        <th colspan="2">[keystone_authtoken]</th>
      </tr>
      <tr>
        <td>memcached_servers = None</td>
        <td>(ListOpt) Optionally specify a list of memcached server(s) to use for caching. If left undefined, tokens will instead be cached in-process.</td>
      </tr>
    </tbody>
  </table>
</para>