openstack-manuals/doc/common/tables/manila-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_manila_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><option>client_socket_timeout</option> = <replaceable>900</replaceable></td>
        <td>(IntOpt) Timeout for client connections socket operations. If an incoming connection is idle for this number of seconds it will be closed. A value of '0' means wait forever.</td>
      </tr>
      <tr>
        <td><option>compute_api_class</option> = <replaceable>manila.compute.nova.API</replaceable></td>
        <td>(StrOpt) The full class name of the Compute API class to use.</td>
      </tr>
      <tr>
        <td><option>enable_new_services</option> = <replaceable>True</replaceable></td>
        <td>(BoolOpt) Services to be added to the available pool on create.</td>
      </tr>
      <tr>
        <td><option>host</option> = <replaceable>localhost</replaceable></td>
        <td>(StrOpt) Name of this node.  This can be an opaque identifier.  It is not necessarily a hostname, FQDN, or IP address.</td>
      </tr>
      <tr>
        <td><option>max_over_subscription_ratio</option> = <replaceable>20.0</replaceable></td>
        <td>(FloatOpt) Float representation of the over subscription ratio when thin provisioning is involved. Default ratio is 20.0, meaning provisioned capacity can be 20 times the total physical capacity. If the ratio is 10.5, it means provisioned capacity can be 10.5 times the total physical capacity. A ratio of 1.0 means provisioned capacity cannot exceed the total physical capacity. A ratio lower than 1.0 is invalid.</td>
      </tr>
      <tr>
        <td><option>memcached_servers</option> = <replaceable>None</replaceable></td>
        <td>(ListOpt) Memcached servers or None for in process cache.</td>
      </tr>
      <tr>
        <td><option>monkey_patch</option> = <replaceable>False</replaceable></td>
        <td>(BoolOpt) Whether to log monkey patching.</td>
      </tr>
      <tr>
        <td><option>monkey_patch_modules</option> = <replaceable></replaceable></td>
        <td>(ListOpt) List of modules or decorators to monkey patch.</td>
      </tr>
      <tr>
        <td><option>my_ip</option> = <replaceable>10.0.0.1</replaceable></td>
        <td>(StrOpt) IP address of this host.</td>
      </tr>
      <tr>
        <td><option>num_shell_tries</option> = <replaceable>3</replaceable></td>
        <td>(IntOpt) Number of times to attempt to run flakey shell commands.</td>
      </tr>
      <tr>
        <td><option>periodic_fuzzy_delay</option> = <replaceable>60</replaceable></td>
        <td>(IntOpt) Range of seconds to randomly delay when starting the periodic task scheduler to reduce stampeding. (Disable by setting to 0)</td>
      </tr>
      <tr>
        <td><option>periodic_hooks_interval</option> = <replaceable>300.0</replaceable></td>
        <td>(FloatOpt) Interval in seconds between execution of periodic hooks. Used when option 'enable_periodic_hooks' is set to True. Default is 300.</td>
      </tr>
      <tr>
        <td><option>periodic_interval</option> = <replaceable>60</replaceable></td>
        <td>(IntOpt) Seconds between running periodic tasks.</td>
      </tr>
      <tr>
        <td><option>report_interval</option> = <replaceable>10</replaceable></td>
        <td>(IntOpt) Seconds between nodes reporting state to datastore.</td>
      </tr>
      <tr>
        <td><option>reserved_share_percentage</option> = <replaceable>0</replaceable></td>
        <td>(IntOpt) The percentage of backend capacity reserved.</td>
      </tr>
      <tr>
        <td><option>rootwrap_config</option> = <replaceable>None</replaceable></td>
        <td>(StrOpt) Path to the rootwrap configuration file to use for running commands as root.</td>
      </tr>
      <tr>
        <td><option>service_down_time</option> = <replaceable>60</replaceable></td>
        <td>(IntOpt) Maximum time since last check-in for up service.</td>
      </tr>
      <tr>
        <td><option>sql_idle_timeout</option> = <replaceable>3600</replaceable></td>
        <td>(IntOpt) Timeout before idle SQL connections are reaped.</td>
      </tr>
      <tr>
        <td><option>sql_max_retries</option> = <replaceable>10</replaceable></td>
        <td>(IntOpt) Maximum database connection retries during startup. (setting -1 implies an infinite retry count).</td>
      </tr>
      <tr>
        <td><option>sql_retry_interval</option> = <replaceable>10</replaceable></td>
        <td>(IntOpt) Interval between retries of opening a SQL connection.</td>
      </tr>
      <tr>
        <td><option>sqlite_clean_db</option> = <replaceable>clean.sqlite</replaceable></td>
        <td>(StrOpt) File name of clean sqlite database.</td>
      </tr>
      <tr>
        <td><option>sqlite_db</option> = <replaceable>manila.sqlite</replaceable></td>
        <td>(StrOpt) The filename to use with sqlite.</td>
      </tr>
      <tr>
        <td><option>sqlite_synchronous</option> = <replaceable>True</replaceable></td>
        <td>(BoolOpt) If passed, use synchronous mode for sqlite.</td>
      </tr>
      <tr>
        <td><option>state_path</option> = <replaceable>/var/lib/manila</replaceable></td>
        <td>(StrOpt) Top-level directory for maintaining manila's state.</td>
      </tr>
      <tr>
        <td><option>storage_availability_zone</option> = <replaceable>nova</replaceable></td>
        <td>(StrOpt) Availability zone of this node.</td>
      </tr>
      <tr>
        <td><option>tcp_keepalive</option> = <replaceable>True</replaceable></td>
        <td>(BoolOpt) Sets the value of TCP_KEEPALIVE (True/False) for each server socket.</td>
      </tr>
      <tr>
        <td><option>tcp_keepalive_count</option> = <replaceable>None</replaceable></td>
        <td>(IntOpt) Sets the value of TCP_KEEPCNT for each server socket. Not supported on OS X.</td>
      </tr>
      <tr>
        <td><option>tcp_keepalive_interval</option> = <replaceable>None</replaceable></td>
        <td>(IntOpt) Sets the value of TCP_KEEPINTVL in seconds for each server socket. Not supported on OS X.</td>
      </tr>
      <tr>
        <td><option>tcp_keepidle</option> = <replaceable>600</replaceable></td>
        <td>(IntOpt) Sets the value of TCP_KEEPIDLE in seconds for each server socket. Not supported on OS X.</td>
      </tr>
      <tr>
        <td><option>until_refresh</option> = <replaceable>0</replaceable></td>
        <td>(IntOpt) Count of reservations until usage is refreshed.</td>
      </tr>
      <tr>
        <td><option>use_forwarded_for</option> = <replaceable>False</replaceable></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><option>wsgi_keep_alive</option> = <replaceable>True</replaceable></td>
        <td>(BoolOpt) If False, closes the client socket connection explicitly. Setting it to True to maintain backward compatibility. Recommended setting is set it to False.</td>
      </tr>
    </tbody>
  </table>
</para>