openstack-manuals/doc/common/tables/cinder-storage.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_storage">
    <caption>Description of storage 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>allocated_capacity_weight_multiplier</option> = <replaceable>-1.0</replaceable></td>
        <td>(FloatOpt) Multiplier used for weighing volume capacity. Negative numbers mean to stack vs spread.</td>
      </tr>
      <tr>
        <td><option>capacity_weight_multiplier</option> = <replaceable>1.0</replaceable></td>
        <td>(FloatOpt) Multiplier used for weighing volume capacity. Negative numbers mean to stack vs spread.</td>
      </tr>
      <tr>
        <td><option>enabled_backends</option> = <replaceable>None</replaceable></td>
        <td>(ListOpt) A list of backend names to use. These backend names should be backed by a unique [CONFIG] group with its options</td>
      </tr>
      <tr>
        <td><option>iscsi_helper</option> = <replaceable>tgtadm</replaceable></td>
        <td>(StrOpt) iSCSI target user-land tool to use. tgtadm is default, use lioadm for LIO iSCSI support, scstadmin for SCST target support, iseradm for the ISER protocol, ietadm for iSCSI Enterprise Target, iscsictl for Chelsio iSCSI Target or fake for testing.</td>
      </tr>
      <tr>
        <td><option>iscsi_iotype</option> = <replaceable>fileio</replaceable></td>
        <td>(StrOpt) Sets the behavior of the iSCSI target to either perform blockio or fileio optionally, auto can be set and Cinder will autodetect type of backing device</td>
      </tr>
      <tr>
        <td><option>iscsi_ip_address</option> = <replaceable>$my_ip</replaceable></td>
        <td>(StrOpt) The IP address that the iSCSI daemon is listening on</td>
      </tr>
      <tr>
        <td><option>iscsi_num_targets</option> = <replaceable>None</replaceable></td>
        <td>(IntOpt) This option is deprecated and unused. It will be removed in the Liberty release.</td>
      </tr>
      <tr>
        <td><option>iscsi_port</option> = <replaceable>3260</replaceable></td>
        <td>(IntOpt) The port that the iSCSI daemon is listening on</td>
      </tr>
      <tr>
        <td><option>iscsi_protocol</option> = <replaceable>iscsi</replaceable></td>
        <td>(StrOpt) Determines the iSCSI protocol for new iSCSI volumes, created with tgtadm or lioadm target helpers. In order to enable RDMA, this parameter should be set with the value "iser". The supported iSCSI protocol values are "iscsi" and "iser".</td>
      </tr>
      <tr>
        <td><option>iscsi_target_prefix</option> = <replaceable>iqn.2010-10.org.openstack:</replaceable></td>
        <td>(StrOpt) Prefix for iSCSI volumes</td>
      </tr>
      <tr>
        <td><option>iscsi_write_cache</option> = <replaceable>on</replaceable></td>
        <td>(StrOpt) Sets the behavior of the iSCSI target to either perform write-back(on) or write-through(off). This parameter is valid if iscsi_helper is set to tgtadm or iseradm.</td>
      </tr>
      <tr>
        <td><option>iser_helper</option> = <replaceable>tgtadm</replaceable></td>
        <td>(StrOpt) The name of the iSER target user-land tool to use</td>
      </tr>
      <tr>
        <td><option>iser_ip_address</option> = <replaceable>$my_ip</replaceable></td>
        <td>(StrOpt) The IP address that the iSER daemon is listening on</td>
      </tr>
      <tr>
        <td><option>iser_num_targets</option> = <replaceable>None</replaceable></td>
        <td>(IntOpt) This option is deprecated and unused. It will be removed in the Liberty release.</td>
      </tr>
      <tr>
        <td><option>iser_port</option> = <replaceable>3260</replaceable></td>
        <td>(IntOpt) The port that the iSER daemon is listening on</td>
      </tr>
      <tr>
        <td><option>iser_target_prefix</option> = <replaceable>iqn.2010-10.org.openstack:</replaceable></td>
        <td>(StrOpt) Prefix for iSER volumes</td>
      </tr>
      <tr>
        <td><option>max_gigabytes</option> = <replaceable>10000</replaceable></td>
        <td>(IntOpt) This configure option has been deprecated along with the SimpleScheduler.  New scheduler is able to gather capacity information for each host, thus setting the maximum number of volume gigabytes for host is no longer needed.  It's safe to remove this configure from cinder.conf.</td>
      </tr>
      <tr>
        <td><option>migration_create_volume_timeout_secs</option> = <replaceable>300</replaceable></td>
        <td>(IntOpt) Timeout for creating the volume to migrate to when performing volume migration (seconds)</td>
      </tr>
      <tr>
        <td><option>num_iser_scan_tries</option> = <replaceable>3</replaceable></td>
        <td>(IntOpt) The maximum number of times to rescan iSER targetto find volume</td>
      </tr>
      <tr>
        <td><option>num_volume_device_scan_tries</option> = <replaceable>3</replaceable></td>
        <td>(IntOpt) The maximum number of times to rescan targets to find volume</td>
      </tr>
      <tr>
        <td><option>volume_backend_name</option> = <replaceable>None</replaceable></td>
        <td>(StrOpt) The backend name for a given driver implementation</td>
      </tr>
      <tr>
        <td><option>volume_clear</option> = <replaceable>zero</replaceable></td>
        <td>(StrOpt) Method used to wipe old volumes</td>
      </tr>
      <tr>
        <td><option>volume_clear_ionice</option> = <replaceable>None</replaceable></td>
        <td>(StrOpt) The flag to pass to ionice to alter the i/o priority of the process used to zero a volume after deletion, for example "-c3" for idle only priority.</td>
      </tr>
      <tr>
        <td><option>volume_clear_size</option> = <replaceable>0</replaceable></td>
        <td>(IntOpt) Size in MiB to wipe at start of old volumes. 0 =&gt; all</td>
      </tr>
      <tr>
        <td><option>volume_copy_blkio_cgroup_name</option> = <replaceable>cinder-volume-copy</replaceable></td>
        <td>(StrOpt) The blkio cgroup name to be used to limit bandwidth of volume copy</td>
      </tr>
      <tr>
        <td><option>volume_copy_bps_limit</option> = <replaceable>0</replaceable></td>
        <td>(IntOpt) The upper limit of bandwidth of volume copy. 0 =&gt; unlimited</td>
      </tr>
      <tr>
        <td><option>volume_dd_blocksize</option> = <replaceable>1M</replaceable></td>
        <td>(StrOpt) The default block size used when copying/clearing volumes</td>
      </tr>
      <tr>
        <td><option>volume_driver</option> = <replaceable>cinder.volume.drivers.lvm.LVMISCSIDriver</replaceable></td>
        <td>(StrOpt) Driver to use for volume creation</td>
      </tr>
      <tr>
        <td><option>volume_manager</option> = <replaceable>cinder.volume.manager.VolumeManager</replaceable></td>
        <td>(StrOpt) Full class name for the Manager for volume</td>
      </tr>
      <tr>
        <td><option>volume_service_inithost_offload</option> = <replaceable>False</replaceable></td>
        <td>(BoolOpt) Offload pending volume delete during volume service startup</td>
      </tr>
      <tr>
        <td><option>volume_usage_audit_period</option> = <replaceable>month</replaceable></td>
        <td>(StrOpt) Time period for which to generate volume usages. The options are hour, day, month, or year.</td>
      </tr>
      <tr>
        <td><option>volumes_dir</option> = <replaceable>$state_path/volumes</replaceable></td>
        <td>(StrOpt) Volume configuration file storage directory</td>
      </tr>
    </tbody>
  </table>
</para>