openstack/openstack-manuals
Code Issues Proposed changes

Update cinder config reference tables

Browse Source 
The mapping file and xml table have been generated using the autohelp.py script
from openstack-doc-tools.

Change-Id: Iec1d8b7d17a5b2b666b0faf7aed141c7179d0440
This commit is contained in:
Gauvain Pocentek 2014-03-02 12:14:53 +01:00
parent 49aa5dd02b
commit 96931557e0
18 changed files with 335 additions and 69 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
doc/common/tables/cinder-api.xml
View File

@ -38,6 +38,10 @@
<td>enable_v2_api = True</td> <td>enable_v2_api = True</td>
<td>(BoolOpt) Deploy v2 of the Cinder API.</td> <td>(BoolOpt) Deploy v2 of the Cinder API.</td>
</tr> </tr>
<tr>
<td>max_header_line = 16384</td>
<td>(IntOpt) Maximum line size of message headers to be accepted. max_header_line may need to be increased when using large tokens (typically those generated by the Keystone v3 API with big service catalogs).</td>
</tr>
<tr> <tr>
<td>osapi_max_limit = 1000</td> <td>osapi_max_limit = 1000</td>
<td>(IntOpt) the maximum number of items returned in a single response from a collection resource</td> <td>(IntOpt) the maximum number of items returned in a single response from a collection resource</td>
@ -66,6 +70,10 @@
<td>osapi_volume_listen_port = 8776</td> <td>osapi_volume_listen_port = 8776</td>
<td>(IntOpt) port for os volume api to listen</td> <td>(IntOpt) port for os volume api to listen</td>
</tr> </tr>
<tr>
<td>osapi_volume_workers = None</td>
<td>(IntOpt) Number of workers for OpenStack Volume API service</td>
</tr>
<tr> <tr>
<td>transfer_api_class = cinder.transfer.api.API</td> <td>transfer_api_class = cinder.transfer.api.API</td>
<td>(StrOpt) The full class name of the volume transfer API class</td> <td>(StrOpt) The full class name of the volume transfer API class</td>

4
doc/common/tables/cinder-backups.xml
View File

@ -34,6 +34,10 @@
<td>backup_manager = cinder.backup.manager.BackupManager</td> <td>backup_manager = cinder.backup.manager.BackupManager</td>
<td>(StrOpt) full class name for the Manager for volume backup</td> <td>(StrOpt) full class name for the Manager for volume backup</td>
</tr> </tr>
<tr>
<td>backup_metadata_version = 1</td>
<td>(IntOpt) Backup metadata version to be used when backing up volume metadata. If this number is bumped, make sure the service doing the restore supports the new version.</td>
</tr>
<tr> <tr>
<td>backup_name_template = backup-%s</td> <td>backup_name_template = backup-%s</td>
<td>(StrOpt) Template string to be used to generate backup names</td> <td>(StrOpt) Template string to be used to generate backup names</td>

14
doc/common/tables/cinder-backups_ceph.xml
View File

@ -20,31 +20,31 @@
</tr> </tr>
<tr> <tr>
<td>backup_ceph_chunk_size = 134217728</td> <td>backup_ceph_chunk_size = 134217728</td>
<td>(IntOpt) the chunk size in bytes that a backup will be broken into before transfer to backup store</td> <td>(IntOpt) The chunk size, in bytes, that a backup is broken into before transfer to the Ceph object store.</td>
</tr> </tr>
<tr> <tr>
<td>backup_ceph_conf = /etc/ceph/ceph.conf</td> <td>backup_ceph_conf = /etc/ceph/ceph.conf</td>
<td>(StrOpt) Ceph config file to use.</td> <td>(StrOpt) Ceph configuration file to use.</td>
</tr> </tr>
<tr> <tr>
<td>backup_ceph_pool = backups</td> <td>backup_ceph_pool = backups</td>
<td>(StrOpt) the Ceph pool to backup to</td> <td>(StrOpt) The Ceph pool where volume backups are stored.</td>
</tr> </tr>
<tr> <tr>
<td>backup_ceph_stripe_count = 0</td> <td>backup_ceph_stripe_count = 0</td>
<td>(IntOpt) RBD stripe count to use when creating a backup image</td> <td>(IntOpt) RBD stripe count to use when creating a backup image.</td>
</tr> </tr>
<tr> <tr>
<td>backup_ceph_stripe_unit = 0</td> <td>backup_ceph_stripe_unit = 0</td>
<td>(IntOpt) RBD stripe unit to use when creating a backup image</td> <td>(IntOpt) RBD stripe unit to use when creating a backup image.</td>
</tr> </tr>
<tr> <tr>
<td>backup_ceph_user = cinder</td> <td>backup_ceph_user = cinder</td>
<td>(StrOpt) the Ceph user to connect with</td> <td>(StrOpt) The Ceph user to connect with. Default here is to use the same user as for Cinder volumes. If not using cephx this should be set to None.</td>
</tr> </tr>
<tr> <tr>
<td>restore_discard_excess_bytes = True</td> <td>restore_discard_excess_bytes = True</td>
<td>(BoolOpt) If True, always discard excess bytes when restoring volumes.</td> <td>(BoolOpt) If True, always discard excess bytes when restoring volumes i.e. pad with zeroes.</td>
</tr> </tr>
</tbody> </tbody>
</table> </table>

14
doc/common/tables/cinder-common.xml
View File

@ -31,7 +31,7 @@
<td>(StrOpt) default availability zone to use when creating a new volume. If this is not set then we use the value from the storage_availability_zone option as the default availability_zone for new volumes.</td> <td>(StrOpt) default availability zone to use when creating a new volume. If this is not set then we use the value from the storage_availability_zone option as the default availability_zone for new volumes.</td>
</tr> </tr>
<tr> <tr>
<td>default_log_levels = amqp=WARN, amqplib=WARN, boto=WARN, keystone=INFO, qpid=WARN, sqlalchemy=WARN, suds=INFO, iso8601=WARN</td> <td>default_log_levels = amqp=WARN, amqplib=WARN, boto=WARN, qpid=WARN, sqlalchemy=WARN, suds=INFO, iso8601=WARN</td>
<td>(ListOpt) list of logger=LEVEL pairs</td> <td>(ListOpt) list of logger=LEVEL pairs</td>
</tr> </tr>
<tr> <tr>
@ -99,7 +99,7 @@
<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> <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>
<tr> <tr>
<td>logging_context_format_string = %(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [%(request_id)s %(user)s %(tenant)s] %(instance)s%(message)s</td> <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> <td>(StrOpt) format string to use for log messages with context</td>
</tr> </tr>
<tr> <tr>
@ -150,10 +150,6 @@
<td>policy_file = policy.json</td> <td>policy_file = policy.json</td>
<td>(StrOpt) JSON file representing policy</td> <td>(StrOpt) JSON file representing policy</td>
</tr> </tr>
<tr>
<td>pybasedir = /usr/lib/python/site-packages</td>
<td>(StrOpt) Directory where the cinder python module is installed</td>
</tr>
<tr> <tr>
<td>report_interval = 10</td> <td>report_interval = 10</td>
<td>(IntOpt) seconds between nodes reporting state to datastore</td> <td>(IntOpt) seconds between nodes reporting state to datastore</td>
@ -162,10 +158,6 @@
<td>reserved_percentage = 0</td> <td>reserved_percentage = 0</td>
<td>(IntOpt) The percentage of backend capacity is reserved</td> <td>(IntOpt) The percentage of backend capacity is reserved</td>
</tr> </tr>
<tr>
<td>root_helper = sudo</td>
<td>(StrOpt) Deprecated: command to use for running commands as root</td>
</tr>
<tr> <tr>
<td>rootwrap_config = /etc/cinder/rootwrap.conf</td> <td>rootwrap_config = /etc/cinder/rootwrap.conf</td>
<td>(StrOpt) Path to the rootwrap configuration file to use for running commands as root</td> <td>(StrOpt) Path to the rootwrap configuration file to use for running commands as root</td>
@ -199,7 +191,7 @@
<td>(StrOpt) Private key file to use when starting the server securely</td> <td>(StrOpt) Private key file to use when starting the server securely</td>
</tr> </tr>
<tr> <tr>
<td>state_path = $pybasedir</td> <td>state_path = /var/lib/cinder</td>
<td>(StrOpt) Top-level directory for maintaining cinder's state</td> <td>(StrOpt) Top-level directory for maintaining cinder's state</td>
</tr> </tr>
<tr> <tr>

2
doc/common/tables/cinder-compute.xml
View File

@ -40,7 +40,7 @@
</tr> </tr>
<tr> <tr>
<td>nova_endpoint_template = None</td> <td>nova_endpoint_template = None</td>
<td>(StrOpt) Override service catalog lookup with template for nova endpoint e.g. http://localhost:8774/v2/%(tenant_id)s</td> <td>(StrOpt) Override service catalog lookup with template for nova endpoint e.g. http://localhost:8774/v2/%(project_id)s</td>
</tr> </tr>
<tr> <tr>
<td>os_region_name = None</td> <td>os_region_name = None</td>

27
doc/common/tables/cinder-emc.xml Normal file
View File

@ -0,0 +1,27 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<table rules="all">
<caption>Description of configuration options for emc</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>cinder_emc_config_file = /etc/cinder/cinder_emc_config.xml</td>
<td>(StrOpt) use this file for cinder emc plugin config data</td>
</tr>
</tbody>
</table>
</para>

47
doc/common/tables/cinder-hplefthand.xml Normal file
View File

@ -0,0 +1,47 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<table rules="all">
<caption>Description of configuration options for hplefthand</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>hplefthand_api_url = None</td>
<td>(StrOpt) HP LeftHand WSAPI Server Url like https://&lt;LeftHand ip&gt;:8081/lhos</td>
</tr>
<tr>
<td>hplefthand_clustername = None</td>
<td>(StrOpt) HP LeftHand cluster name</td>
</tr>
<tr>
<td>hplefthand_debug = False</td>
<td>(BoolOpt) Enable HTTP debugging to LeftHand</td>
</tr>
<tr>
<td>hplefthand_iscsi_chap_enabled = False</td>
<td>(BoolOpt) Configure CHAP authentication for iSCSI connections (Default: Disabled)</td>
</tr>
<tr>
<td>hplefthand_password = None</td>
<td>(StrOpt) HP LeftHand Super user password</td>
</tr>
<tr>
<td>hplefthand_username = None</td>
<td>(StrOpt) HP LeftHand Super user username</td>
</tr>
</tbody>
</table>
</para>

27
doc/common/tables/cinder-hpmsa.xml Normal file
View File

@ -0,0 +1,27 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<table rules="all">
<caption>Description of configuration options for hpmsa</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>msa_vdisk = OpenStack</td>
<td>(StrOpt) The VDisk to use for volume creation.</td>
</tr>
</tbody>
</table>
</para>

43
doc/common/tables/cinder-nas.xml Normal file
View File

@ -0,0 +1,43 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<table rules="all">
<caption>Description of configuration options for nas</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>nas_ip = </td>
<td>(StrOpt) IP address or Hostname of NAS system.</td>
</tr>
<tr>
<td>nas_login = admin</td>
<td>(StrOpt) User name to connect to NAS system.</td>
</tr>
<tr>
<td>nas_password = </td>
<td>(StrOpt) Password to connect to NAS system.</td>
</tr>
<tr>
<td>nas_private_key = </td>
<td>(StrOpt) Filename of private key to use for SSH authentication.</td>
</tr>
<tr>
<td>nas_ssh_port = 22</td>
<td>(IntOpt) SSH port to use to connect to NAS system.</td>
</tr>
</tbody>
</table>
</para>

12
doc/common/tables/cinder-nexenta_nfs.xml
View File

@ -18,10 +18,6 @@
<tr> <tr>
<th colspan="2">[DEFAULT]</th> <th colspan="2">[DEFAULT]</th>
</tr> </tr>
<tr>
<td>nexenta_mount_options = None</td>
<td>(StrOpt) Mount options passed to the nfs client. See section of the nfs man page for details</td>
</tr>
<tr> <tr>
<td>nexenta_mount_point_base = $state_path/mnt</td> <td>nexenta_mount_point_base = $state_path/mnt</td>
<td>(StrOpt) Base dir containing mount points for nfs shares</td> <td>(StrOpt) Base dir containing mount points for nfs shares</td>
@ -30,18 +26,10 @@
<td>nexenta_nms_cache_volroot = True</td> <td>nexenta_nms_cache_volroot = True</td>
<td>(BoolOpt) If set True cache NexentaStor appliance volroot option value.</td> <td>(BoolOpt) If set True cache NexentaStor appliance volroot option value.</td>
</tr> </tr>
<tr>
<td>nexenta_oversub_ratio = 1.0</td>
<td>(FloatOpt) This will compare the allocated to available space on the volume destination. If the ratio exceeds this number, the destination will no longer be valid.</td>
</tr>
<tr> <tr>
<td>nexenta_shares_config = /etc/cinder/nfs_shares</td> <td>nexenta_shares_config = /etc/cinder/nfs_shares</td>
<td>(StrOpt) File with the list of available nfs shares</td> <td>(StrOpt) File with the list of available nfs shares</td>
</tr> </tr>
<tr>
<td>nexenta_used_ratio = 0.95</td>
<td>(FloatOpt) Percent of ACTUAL usage of the underlying volume before no new volumes can be allocated to the volume destination.</td>
</tr>
<tr> <tr>
<td>nexenta_volume_compression = on</td> <td>nexenta_volume_compression = on</td>
<td>(StrOpt) Default compression value for new ZFS folders.</td> <td>(StrOpt) Default compression value for new ZFS folders.</td>

16
doc/common/tables/cinder-rpc.xml
View File

@ -20,7 +20,7 @@
</tr> </tr>
<tr> <tr>
<td>allowed_rpc_exception_modules = nova.exception, cinder.exception, exceptions</td> <td>allowed_rpc_exception_modules = nova.exception, cinder.exception, exceptions</td>
<td>(ListOpt) Modules of exceptions that are permitted to be recreatedupon receiving exception data from an rpc call.</td> <td>(ListOpt) Modules of exceptions that are permitted to be recreated upon receiving exception data from an rpc call.</td>
</tr> </tr>
<tr> <tr>
<td>amqp_auto_delete = False</td> <td>amqp_auto_delete = False</td>
@ -30,10 +30,6 @@
<td>amqp_durable_queues = False</td> <td>amqp_durable_queues = False</td>
<td>(BoolOpt) Use durable queues in amqp.</td> <td>(BoolOpt) Use durable queues in amqp.</td>
</tr> </tr>
<tr>
<td>amqp_rpc_single_reply_queue = False</td>
<td>(BoolOpt) Enable a fast single reply queue if using AMQP based RPC like RabbitMQ or Qpid.</td>
</tr>
<tr> <tr>
<td>control_exchange = openstack</td> <td>control_exchange = openstack</td>
<td>(StrOpt) AMQP exchange to connect to if using RabbitMQ or Qpid</td> <td>(StrOpt) AMQP exchange to connect to if using RabbitMQ or Qpid</td>
@ -56,7 +52,7 @@
</tr> </tr>
<tr> <tr>
<td>kombu_ssl_version = </td> <td>kombu_ssl_version = </td>
<td>(StrOpt) SSL version to use (valid only if SSL enabled)</td> <td>(StrOpt) SSL version to use (valid only if SSL enabled). valid values are TLSv1, SSLv23 and SSLv3. SSLv2 may be available on some distributions</td>
</tr> </tr>
<tr> <tr>
<td>matchmaker_heartbeat_freq = 300</td> <td>matchmaker_heartbeat_freq = 300</td>
@ -66,10 +62,6 @@
<td>matchmaker_heartbeat_ttl = 600</td> <td>matchmaker_heartbeat_ttl = 600</td>
<td>(IntOpt) Heartbeat time-to-live.</td> <td>(IntOpt) Heartbeat time-to-live.</td>
</tr> </tr>
<tr>
<td>matchmaker_ringfile = /etc/nova/matchmaker_ring.json</td>
<td>(StrOpt) Matchmaker ring file (JSON)</td>
</tr>
<tr> <tr>
<td>notification_driver = []</td> <td>notification_driver = []</td>
<td>(MultiStrOpt) Driver or drivers to handle sending notifications</td> <td>(MultiStrOpt) Driver or drivers to handle sending notifications</td>
@ -87,7 +79,7 @@
<td>(IntOpt) Seconds between connection keepalive heartbeats</td> <td>(IntOpt) Seconds between connection keepalive heartbeats</td>
</tr> </tr>
<tr> <tr>
<td>qpid_hostname = localhost</td> <td>qpid_hostname = oslo</td>
<td>(StrOpt) Qpid broker hostname</td> <td>(StrOpt) Qpid broker hostname</td>
</tr> </tr>
<tr> <tr>
@ -127,7 +119,7 @@
<td>(BoolOpt) use H/A queues in RabbitMQ (x-ha-policy: all).You need to wipe RabbitMQ database when changing this option.</td> <td>(BoolOpt) use H/A queues in RabbitMQ (x-ha-policy: all).You need to wipe RabbitMQ database when changing this option.</td>
</tr> </tr>
<tr> <tr>
<td>rabbit_host = localhost</td> <td>rabbit_host = oslo</td>
<td>(StrOpt) The RabbitMQ broker address where a single node is used</td> <td>(StrOpt) The RabbitMQ broker address where a single node is used</td>
</tr> </tr>
<tr> <tr>

35
doc/common/tables/cinder-ssl.xml Normal file
View File

@ -0,0 +1,35 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<table rules="all">
<caption>Description of configuration options for ssl</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">[ssl]</th>
</tr>
<tr>
<td>ca_file = None</td>
<td>(StrOpt) CA certificate file to use to verify connecting clients</td>
</tr>
<tr>
<td>cert_file = None</td>
<td>(StrOpt) Certificate file to use when starting the server securely</td>
</tr>
<tr>
<td>key_file = None</td>
<td>(StrOpt) Private key file to use when starting the server securely</td>
</tr>
</tbody>
</table>
</para>

12
doc/common/tables/cinder-storage.xml
View File

@ -22,10 +22,6 @@
<td>allocated_capacity_weight_multiplier = -1.0</td> <td>allocated_capacity_weight_multiplier = -1.0</td>
<td>(FloatOpt) Multiplier used for weighing volume capacity. Negative numbers mean to stack vs spread.</td> <td>(FloatOpt) Multiplier used for weighing volume capacity. Negative numbers mean to stack vs spread.</td>
</tr> </tr>
<tr>
<td>bindir = $pybasedir/bin</td>
<td>(StrOpt) Directory where cinder binaries are installed</td>
</tr>
<tr> <tr>
<td>capacity_weight_multiplier = 1.0</td> <td>capacity_weight_multiplier = 1.0</td>
<td>(FloatOpt) Multiplier used for weighing volume capacity. Negative numbers mean to stack vs spread.</td> <td>(FloatOpt) Multiplier used for weighing volume capacity. Negative numbers mean to stack vs spread.</td>
@ -102,6 +98,10 @@
<td>volume_clear = zero</td> <td>volume_clear = zero</td>
<td>(StrOpt) Method used to wipe old voumes (valid options are: none, zero, shred)</td> <td>(StrOpt) Method used to wipe old voumes (valid options are: none, zero, shred)</td>
</tr> </tr>
<tr>
<td>volume_clear_ionice = None</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> <tr>
<td>volume_clear_size = 0</td> <td>volume_clear_size = 0</td>
<td>(IntOpt) Size in MiB to wipe at start of old volumes. 0 =&gt; all</td> <td>(IntOpt) Size in MiB to wipe at start of old volumes. 0 =&gt; all</td>
@ -130,10 +130,6 @@
<td>volumes_dir = $state_path/volumes</td> <td>volumes_dir = $state_path/volumes</td>
<td>(StrOpt) Volume configuration file storage directory</td> <td>(StrOpt) Volume configuration file storage directory</td>
</tr> </tr>
<tr>
<td>zadara_default_stripesize = 64</td>
<td>(StrOpt) Default stripe size for volumes</td>
</tr>
<tr> <tr>
<th colspan="2">[database]</th> <th colspan="2">[database]</th>
</tr> </tr>

4
doc/common/tables/cinder-storage_gpfs.xml
View File

@ -38,6 +38,10 @@
<td>gpfs_sparse_volumes = True</td> <td>gpfs_sparse_volumes = True</td>
<td>(BoolOpt) Specifies that volumes are created as sparse files which initially consume no space. If set to False, the volume is created as a fully allocated file, in which case, creation may take a significantly longer time.</td> <td>(BoolOpt) Specifies that volumes are created as sparse files which initially consume no space. If set to False, the volume is created as a fully allocated file, in which case, creation may take a significantly longer time.</td>
</tr> </tr>
<tr>
<td>gpfs_storage_pool = None</td>
<td>(StrOpt) Specifies the storage pool that volumes are assigned to. By default, the system storage pool is used.</td>
</tr>
</tbody> </tbody>
</table> </table>
</para> </para>

2
doc/common/tables/cinder-vmware.xml
View File

@ -44,7 +44,7 @@
</tr> </tr>
<tr> <tr>
<td>vmware_task_poll_interval = 5</td> <td>vmware_task_poll_interval = 5</td>
<td>(IntOpt) The interval used for polling remote tasks invoked on VMware ESX/VC server.</td> <td>(IntOpt) The interval (in seconds) for polling remote tasks invoked on VMware ESX/VC server.</td>
</tr> </tr>
<tr> <tr>
<td>vmware_volume_folder = cinder-volumes</td> <td>vmware_volume_folder = cinder-volumes</td>

4
doc/common/tables/cinder-zadara.xml
View File

@ -18,10 +18,6 @@
<tr> <tr>
<th colspan="2">[DEFAULT]</th> <th colspan="2">[DEFAULT]</th>
</tr> </tr>
<tr>
<td>zadara_default_striping_mode = simple</td>
<td>(StrOpt) Default striping mode for volumes</td>
</tr>
<tr> <tr>
<td>zadara_password = None</td> <td>zadara_password = None</td>
<td>(StrOpt) Password for the VPSA</td> <td>(StrOpt) Password for the VPSA</td>

85
doc/common/tables/cinder-zoning.xml Normal file
View File

@ -0,0 +1,85 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- Warning: Do not edit this file. It is automatically
generated and your changes will be overwritten.
The tool to do so lives in the tools directory of this
repository -->
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
<table rules="all">
<caption>Description of configuration options for zoning</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>zoning_mode = none</td>
<td>(StrOpt) FC Zoning mode configured</td>
</tr>
<tr>
<th colspan="2">[BRCD_FABRIC_EXAMPLE]</th>
</tr>
<tr>
<td>fc_fabric_address = </td>
<td>(StrOpt) Management IP of fabric</td>
</tr>
<tr>
<td>fc_fabric_password = </td>
<td>(StrOpt) Password for user</td>
</tr>
<tr>
<td>fc_fabric_port = 22</td>
<td>(IntOpt) Connecting port</td>
</tr>
<tr>
<td>fc_fabric_user = </td>
<td>(StrOpt) Fabric user ID</td>
</tr>
<tr>
<td>principal_switch_wwn = None</td>
<td>(StrOpt) Principal switch WWN of the fabric</td>
</tr>
<tr>
<td>zone_activate = True</td>
<td>(BoolOpt) overridden zoning activation state</td>
</tr>
<tr>
<td>zone_name_prefix = None</td>
<td>(StrOpt) overridden zone name prefix</td>
</tr>
<tr>
<td>zoning_policy = initiator-target</td>
<td>(StrOpt) overridden zoning policy</td>
</tr>
<tr>
<th colspan="2">[fc-zone-manager]</th>
</tr>
<tr>
<td>brcd_sb_connector = cinder.zonemanager.drivers.brocade.brcd_fc_zone_client_cli.BrcdFCZoneClientCLI</td>
<td>(StrOpt) Southbound connector for zoning operation</td>
</tr>
<tr>
<td>fc_fabric_names = None</td>
<td>(StrOpt) Comma separated list of fibre channel fabric names. This list of names is used to retrieve other SAN credentials for connecting to each SAN fabric</td>
</tr>
<tr>
<td>fc_san_lookup_service = cinder.zonemanager.drivers.brocade.brcd_fc_san_lookup_service.BrcdFCSanLookupService</td>
<td>(StrOpt) FC San Lookup Service</td>
</tr>
<tr>
<td>zone_driver = cinder.zonemanager.drivers.brocade.brcd_fc_zone_driver.BrcdFCZoneDriver</td>
<td>(StrOpt) FC Zone Driver responsible for zone management</td>
</tr>
<tr>
<td>zoning_policy = initiator-target</td>
<td>(StrOpt) Zoning policy configured by user</td>
</tr>
</tbody>
</table>
</para>

48
tools/autogenerate-config-flagmappings/cinder.flagmappings
View File

@ -3,13 +3,11 @@ allowed_direct_url_schemes images
allowed_rpc_exception_modules rpc allowed_rpc_exception_modules rpc
amqp_auto_delete rpc amqp_auto_delete rpc
amqp_durable_queues rpc amqp_durable_queues rpc
amqp_rpc_single_reply_queue rpc
api_paste_config api api_paste_config api
api_rate_limit api api_rate_limit api
auth_strategy auth auth_strategy auth
available_devices block-device available_devices block-device
backdoor_port api backdoor_port api
backlog log
backup_api_class backups backup_api_class backups
backup_ceph_chunk_size backups_ceph backup_ceph_chunk_size backups_ceph
backup_ceph_conf backups_ceph backup_ceph_conf backups_ceph
@ -20,6 +18,7 @@ backup_ceph_user backups_ceph
backup_compression_algorithm backups backup_compression_algorithm backups
backup_driver backups backup_driver backups
backup_manager backups backup_manager backups
backup_metadata_version backups
backup_name_template backups backup_name_template backups
backup_swift_auth backups_swift backup_swift_auth backups_swift
backup_swift_container backups_swift backup_swift_container backups_swift
@ -33,8 +32,8 @@ backup_topic backups
backup_tsm_compression backups_tsm backup_tsm_compression backups_tsm
backup_tsm_password backups_tsm backup_tsm_password backups_tsm
backup_tsm_volume_prefix backups_tsm backup_tsm_volume_prefix backups_tsm
bindir storage
capacity_weight_multiplier storage capacity_weight_multiplier storage
cinder_emc_config_file emc
cinder_huawei_conf_file huawei cinder_huawei_conf_file huawei
cloned_volume_same_az zones cloned_volume_same_az zones
compute_api_class common compute_api_class common
@ -66,7 +65,6 @@ eqlx_pool eqlx
eqlx_use_chap eqlx eqlx_use_chap eqlx
expiry_thres_minutes netapp_7mode_nfs netapp_cdot_nfs expiry_thres_minutes netapp_7mode_nfs netapp_cdot_nfs
fake_rabbit rpc fake_rabbit rpc
fake_tests Unknown
fatal_deprecations common fatal_deprecations common
fatal_exception_format_errors common fatal_exception_format_errors common
glance_api_insecure images glance_api_insecure images
@ -86,6 +84,7 @@ gpfs_images_share_mode storage_gpfs
gpfs_max_clone_depth storage_gpfs gpfs_max_clone_depth storage_gpfs
gpfs_mount_point_base storage_gpfs gpfs_mount_point_base storage_gpfs
gpfs_sparse_volumes storage_gpfs gpfs_sparse_volumes storage_gpfs
gpfs_storage_pool storage_gpfs
hds_cinder_config_file hds hds_cinder_config_file hds
host common host common
hp3par_api_url hp3par hp3par_api_url hp3par
@ -97,6 +96,12 @@ hp3par_password hp3par
hp3par_snapshot_expiration hp3par hp3par_snapshot_expiration hp3par
hp3par_snapshot_retention hp3par hp3par_snapshot_retention hp3par
hp3par_username hp3par hp3par_username hp3par
hplefthand_api_url hplefthand
hplefthand_clustername hplefthand
hplefthand_debug hplefthand
hplefthand_iscsi_chap_enabled hplefthand
hplefthand_password hplefthand
hplefthand_username hplefthand
iet_conf common iet_conf common
image_conversion_dir images image_conversion_dir images
instance_format images instance_format images
@ -131,13 +136,19 @@ lvm_mirrors lvm
lvm_type lvm lvm_type lvm
matchmaker_heartbeat_freq rpc matchmaker_heartbeat_freq rpc
matchmaker_heartbeat_ttl rpc matchmaker_heartbeat_ttl rpc
matchmaker_ringfile rpc
max_age quota max_age quota
max_gigabytes storage max_gigabytes storage
max_header_line api
migration_create_volume_timeout_secs storage migration_create_volume_timeout_secs storage
monkey_patch common monkey_patch common
monkey_patch_modules common monkey_patch_modules common
msa_vdisk hpmsa
my_ip common my_ip common
nas_ip nas
nas_login nas
nas_password nas
nas_private_key nas
nas_ssh_port nas
netapp_login netapp_7mode_iscsi netapp_7mode_nfs netapp_cdot_iscsi netapp_cdot_nfs netapp_login netapp_7mode_iscsi netapp_7mode_nfs netapp_cdot_iscsi netapp_cdot_nfs
netapp_password netapp_7mode_iscsi netapp_7mode_nfs netapp_cdot_iscsi netapp_cdot_nfs netapp_password netapp_7mode_iscsi netapp_7mode_nfs netapp_cdot_iscsi netapp_cdot_nfs
netapp_server_hostname netapp_7mode_iscsi netapp_7mode_nfs netapp_cdot_iscsi netapp_cdot_nfs netapp_server_hostname netapp_7mode_iscsi netapp_7mode_nfs netapp_cdot_iscsi netapp_cdot_nfs
@ -152,10 +163,8 @@ netapp_vserver netapp_cdot_iscsi netapp_cdot_nfs
nexenta_blocksize nexenta_iscsi nexenta_blocksize nexenta_iscsi
nexenta_host nexenta_iscsi nexenta_host nexenta_iscsi
nexenta_iscsi_target_portal_port nexenta_iscsi nexenta_iscsi_target_portal_port nexenta_iscsi
nexenta_mount_options nexenta_nfs
nexenta_mount_point_base nexenta_nfs nexenta_mount_point_base nexenta_nfs
nexenta_nms_cache_volroot nexenta_nfs nexenta_nms_cache_volroot nexenta_nfs
nexenta_oversub_ratio nexenta_nfs
nexenta_password nexenta_iscsi nexenta_password nexenta_iscsi
nexenta_rest_port nexenta_iscsi nexenta_rest_port nexenta_iscsi
nexenta_rest_protocol nexenta_iscsi nexenta_rest_protocol nexenta_iscsi
@ -167,7 +176,6 @@ nexenta_sparse nexenta_iscsi
nexenta_sparsed_volumes nexenta_iscsi nexenta_sparsed_volumes nexenta_iscsi
nexenta_target_group_prefix nexenta_iscsi nexenta_target_group_prefix nexenta_iscsi
nexenta_target_prefix nexenta_iscsi nexenta_target_prefix nexenta_iscsi
nexenta_used_ratio nexenta_nfs
nexenta_user nexenta_iscsi nexenta_user nexenta_iscsi
nexenta_volume nexenta_iscsi nexenta_volume nexenta_iscsi
nexenta_volume_compression nexenta_nfs nexenta_volume_compression nexenta_nfs
@ -197,12 +205,12 @@ osapi_volume_ext_list api
osapi_volume_extension api osapi_volume_extension api
osapi_volume_listen api osapi_volume_listen api
osapi_volume_listen_port api osapi_volume_listen_port api
osapi_volume_workers api
periodic_fuzzy_delay common periodic_fuzzy_delay common
periodic_interval common periodic_interval common
policy_default_rule common policy_default_rule common
policy_file common policy_file common
publish_errors rpc publish_errors rpc
pybasedir common
qpid_heartbeat rpc qpid_heartbeat rpc
qpid_hostname rpc qpid_hostname rpc
qpid_hosts rpc qpid_hosts rpc
@ -238,7 +246,6 @@ report_interval common
reservation_expire quota reservation_expire quota
reserved_percentage common reserved_percentage common
restore_discard_excess_bytes backups_ceph restore_discard_excess_bytes backups_ceph
root_helper common
rootwrap_config common rootwrap_config common
rpc_backend rpc rpc_backend rpc
rpc_cast_timeout rpc rpc_cast_timeout rpc
@ -280,7 +287,6 @@ sf_api_port solidfire
sf_emulate_512 solidfire sf_emulate_512 solidfire
snapshot_name_template backups snapshot_name_template backups
snapshot_same_host backups snapshot_same_host backups
sqlite_clean_db Unknown
sqlite_db common sqlite_db common
sqlite_synchronous common sqlite_synchronous common
ssh_conn_timeout san ssh_conn_timeout san
@ -328,6 +334,7 @@ vmware_wsdl_location vmware
volume_api_class api volume_api_class api
volume_backend_name storage volume_backend_name storage
volume_clear storage volume_clear storage
volume_clear_ionice storage
volume_clear_size storage volume_clear_size storage
volume_dd_blocksize storage volume_dd_blocksize storage
volume_driver storage volume_driver storage
@ -348,8 +355,6 @@ xenapi_nfs_serverpath storage_xen
xenapi_sr_base_path storage_xen xenapi_sr_base_path storage_xen
xiv_ds8k_connection_type xiv xiv_ds8k_connection_type xiv
xiv_ds8k_proxy xiv xiv_ds8k_proxy xiv
zadara_default_stripesize storage
zadara_default_striping_mode zadara
zadara_password zadara zadara_password zadara
zadara_user zadara zadara_user zadara
zadara_vol_encrypt zadara zadara_vol_encrypt zadara
@ -361,6 +366,15 @@ zadara_vpsa_ip zadara
zadara_vpsa_poolname zadara zadara_vpsa_poolname zadara
zadara_vpsa_port zadara zadara_vpsa_port zadara
zadara_vpsa_use_ssl zadara zadara_vpsa_use_ssl zadara
zoning_mode zoning
BRCD_FABRIC_EXAMPLE/fc_fabric_address zoning
BRCD_FABRIC_EXAMPLE/fc_fabric_password zoning
BRCD_FABRIC_EXAMPLE/fc_fabric_port zoning
BRCD_FABRIC_EXAMPLE/fc_fabric_user zoning
BRCD_FABRIC_EXAMPLE/principal_switch_wwn zoning
BRCD_FABRIC_EXAMPLE/zone_activate zoning
BRCD_FABRIC_EXAMPLE/zone_name_prefix zoning
BRCD_FABRIC_EXAMPLE/zoning_policy zoning
database/backend storage database/backend storage
database/connection connection database/connection connection
database/connection_debug connection database/connection_debug connection
@ -372,6 +386,11 @@ database/max_retries storage
database/min_pool_size storage database/min_pool_size storage
database/retry_interval common database/retry_interval common
database/use_tpool common database/use_tpool common
fc-zone-manager/brcd_sb_connector zoning
fc-zone-manager/fc_fabric_names zoning
fc-zone-manager/fc_san_lookup_service zoning
fc-zone-manager/zone_driver zoning
fc-zone-manager/zoning_policy zoning
keymgr/api_class keymgr keymgr/api_class keymgr
keymgr/fixed_key keymgr keymgr/fixed_key keymgr
matchmaker_redis/host common matchmaker_redis/host common
@ -379,3 +398,6 @@ matchmaker_redis/password common
matchmaker_redis/port common matchmaker_redis/port common
matchmaker_ring/ringfile rpc matchmaker_ring/ringfile rpc
rpc_notifier2/topics common rpc_notifier2/topics common
ssl/ca_file ssl
ssl/cert_file ssl
ssl/key_file ssl