openstack/openstack-manuals
Code Issues Proposed changes

Update the config-ref tables for cinder

Browse Source 
Move the HDS HNAS options in their own files.

Change-Id: I8300c883c6989509fe3124133c024178c7cdb7b6
This commit is contained in:
Gauvain Pocentek 2014-07-21 21:20:02 +02:00
parent f96ecae12c
commit 361f5122c3
11 changed files with 74 additions and 42 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -77,6 +77,10 @@
<td>osapi_volume_listen_port = 8776</td>
<td>(IntOpt) Port on which OpenStack Volume API listens</td>
</tr>
<tr>
<td>osapi_volume_workers = None</td>
<td>(IntOpt) Number of workers for OpenStack Volume API service. The default is equal to the number of CPUs available.</td>
</tr>
<tr>
<td>transfer_api_class = cinder.transfer.api.API</td>
<td>(StrOpt) The full class name of the volume transfer API class</td>
@ -89,6 +93,10 @@
<td>volume_name_template = volume-%s</td>
<td>(StrOpt) Template string to be used to generate volume names</td>
</tr>
<tr>
<td>volume_number_multiplier = -1.0</td>
<td>(FloatOpt) Multiplier used for weighing volume number. Negative numbers mean to spread vs stack.</td>
</tr>
<tr>
<td>volume_transfer_key_length = 16</td>
<td>(IntOpt) The number of characters in the autogenerated auth key.</td>

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

@ -54,7 +54,7 @@
<td>(BoolOpt) make exception message format errors fatal</td>
</tr>
<tr>
<td>host = oslo</td>
<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>
@ -215,7 +215,7 @@
</tr>
<tr>
<td>use_syslog = False</td>
<td>(BoolOpt) Use syslog for logging. Existing syslog format is DEPRECATED during I, and will chang in J to honor RFC5424.</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>

44
doc/common/tables/cinder-database.xml
View File

@ -25,64 +25,60 @@
<td>db_driver = cinder.db</td>
<td>(StrOpt) Driver to use for database access</td>
</tr>
<tr>
<td>sqlite_clean_db = clean.sqlite</td>
<td>(StrOpt) File name of clean sqlite db</td>
</tr>
<tr>
<th colspan="2">[database]</th>
</tr>
<tr>
<td>backend = sqlalchemy</td>
<td>(StrOpt) The backend to use for db</td>
<td>(StrOpt) The back end to use for the database.</td>
</tr>
<tr>
<td>connection = sqlite:///$state_path/$sqlite_db</td>
<td>(StrOpt) The SQLAlchemy connection string used to connect to the database</td>
<td>connection = None</td>
<td>(StrOpt) The SQLAlchemy connection string to use to connect to the database.</td>
</tr>
<tr>
<td>connection_debug = 0</td>
<td>(IntOpt) Verbosity of SQL debugging information. 0=None, 100=Everything</td>
<td>(IntOpt) Verbosity of SQL debugging information: 0=None, 100=Everything.</td>
</tr>
<tr>
<td>connection_trace = False</td>
<td>(BoolOpt) Add python stack traces to SQL as comment strings</td>
<td>(BoolOpt) Add Python stack traces to SQL as comment strings.</td>
</tr>
<tr>
<td>db_inc_retry_interval = True</td>
<td>(BoolOpt) Whether to increase interval between db connection retries, up to db_max_retry_interval</td>
<td>(BoolOpt) If True, increases the interval between database connection retries up to db_max_retry_interval.</td>
</tr>
<tr>
<td>db_max_retries = 20</td>
<td>(IntOpt) maximum db connection retries before error is raised. (setting -1 implies an infinite retry count)</td>
<td>(IntOpt) Maximum database connection retries before error is raised. Set to -1 to specify an infinite retry count.</td>
</tr>
<tr>
<td>db_max_retry_interval = 10</td>
<td>(IntOpt) max seconds between db connection retries, if db_inc_retry_interval is enabled</td>
<td>(IntOpt) If db_inc_retry_interval is set, the maximum seconds between database connection retries.</td>
</tr>
<tr>
<td>db_retry_interval = 1</td>
<td>(IntOpt) seconds between db connection retries</td>
<td>(IntOpt) Seconds between database connection retries.</td>
</tr>
<tr>
<td>idle_timeout = 3600</td>
<td>(IntOpt) Timeout before idle sql connections are reaped</td>
<td>(IntOpt) Timeout before idle SQL connections are reaped.</td>
</tr>
<tr>
<td>max_overflow = None</td>
<td>(IntOpt) If set, use this value for max_overflow with sqlalchemy</td>
<td>(IntOpt) If set, use this value for max_overflow with SQLAlchemy.</td>
</tr>
<tr>
<td>max_pool_size = None</td>
<td>(IntOpt) Maximum number of SQL connections to keep open in a pool</td>
<td>(IntOpt) Maximum number of SQL connections to keep open in a pool.</td>
</tr>
<tr>
<td>max_retries = 10</td>
<td>(IntOpt) Maximum db connection retries during startup. (setting -1 implies an infinite retry count)</td>
<td>(IntOpt) Maximum db connection retries during startup. Set to -1 to specify an infinite retry count.</td>
</tr>
<tr>
<td>min_pool_size = 1</td>
<td>(IntOpt) Minimum number of SQL connections to keep open in a pool</td>
<td>(IntOpt) Minimum number of SQL connections to keep open in a pool.</td>
</tr>
<tr>
<td>mysql_sql_mode = TRADITIONAL</td>
@ -90,23 +86,23 @@
</tr>
<tr>
<td>pool_timeout = None</td>
<td>(IntOpt) If set, use this value for pool_timeout with sqlalchemy</td>
<td>(IntOpt) If set, use this value for pool_timeout with SQLAlchemy.</td>
</tr>
<tr>
<td>retry_interval = 10</td>
<td>(IntOpt) Interval between retries of opening a sql connection</td>
<td>(IntOpt) Interval between retries of opening a SQL connection.</td>
</tr>
<tr>
<td>sqlite_db = cinder.sqlite</td>
<td>(StrOpt) The file name to use with SQLite</td>
<td>sqlite_db = oslo.sqlite</td>
<td>(StrOpt) The file name to use with SQLite.</td>
</tr>
<tr>
<td>sqlite_synchronous = True</td>
<td>(BoolOpt) If True, SQLite uses synchronous mode</td>
<td>(BoolOpt) If True, SQLite uses synchronous mode.</td>
</tr>
<tr>
<td>use_db_reconnect = False</td>
<td>(BoolOpt) Enable the experimental use of database reconnect on connection lost</td>
<td>(BoolOpt) Enable the experimental use of database reconnect on connection lost.</td>
</tr>
<tr>
<td>use_tpool = False</td>

30
doc/common/tables/cinder-hds-hnas.xml Normal file
View File

@ -0,0 +1,30 @@
<?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_hds-hnas">
<caption>Description of configuration options for hds-hnas</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>hds_hnas_iscsi_config_file = /opt/hds/hnas/cinder_iscsi_conf.xml</td>
<td>(StrOpt) configuration file for HDS iSCSI cinder plugin</td>
</tr>
<tr>
<td>hds_hnas_nfs_config_file = /opt/hds/hnas/cinder_nfs_conf.xml</td>
<td>(StrOpt) configuration file for HDS NFS cinder plugin</td>
</tr>
</tbody>
</table>
</para>

8
doc/common/tables/cinder-hds-hus.xml
View File

@ -21,14 +21,6 @@
<td>hds_cinder_config_file = /opt/hds/hus/cinder_hus_conf.xml</td>
<td>(StrOpt) The configuration file for the Cinder HDS driver for HUS</td>
</tr>
<tr>
<td>hds_hnas_iscsi_config_file = /opt/hds/hnas/cinder_iscsi_conf.xml</td>
<td>(StrOpt) configuration file for HDS iSCSI cinder plugin</td>
</tr>
<tr>
<td>hds_hnas_nfs_config_file = /opt/hds/hnas/cinder_nfs_conf.xml</td>
<td>(StrOpt) configuration file for HDS NFS cinder plugin</td>
</tr>
</tbody>
</table>
</para>

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

@ -63,11 +63,11 @@
</tr>
<tr>
<td>instance_format = "[instance: %(uuid)s] "</td>
<td>(StrOpt) The format for an instance that is passed with the log message. </td>
<td>(StrOpt) The format for an instance that is passed with the log message.</td>
</tr>
<tr>
<td>instance_uuid_format = "[instance: %(uuid)s] "</td>
<td>(StrOpt) The format for an instance UUID that is passed with the log message. </td>
<td>(StrOpt) The format for an instance UUID that is passed with the log message.</td>
</tr>
<tr>
<td>use_multipath_for_image_xfer = False</td>

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

@ -19,7 +19,7 @@
</tr>
<tr>
<td>lvm_mirrors = 0</td>
<td>(IntOpt) If set, create lvms with multiple mirrors. Note that this requires lvm_mirrors + 2 pvs with available space</td>
<td>(IntOpt) If &gt;0, create LVs with multiple mirrors. Note that this requires lvm_mirrors + 2 PVs with available space</td>
</tr>
<tr>
<td>lvm_type = default</td>

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

@ -206,7 +206,7 @@
<td>(IntOpt) Number of ZeroMQ contexts, defaults to 1.</td>
</tr>
<tr>
<td>rpc_zmq_host = oslo</td>
<td>rpc_zmq_host = localhost</td>
<td>(StrOpt) Name of this node. Must be a valid hostname, FQDN, or IP address. Must match "host" option, if running Nova.</td>
</tr>
<tr>

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

@ -31,7 +31,7 @@
</tr>
<tr>
<td>iscsi_helper = tgtadm</td>
<td>(StrOpt) iSCSI target user-land tool to use</td>
<td>(StrOpt) iSCSI target user-land tool to use. tgtadm is default, use lioadm for LIO iSCSI support, iseradm for the ISER protocol, or fake for testing.</td>
</tr>
<tr>
<td>iscsi_iotype = fileio</td>

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

@ -17,6 +17,10 @@
<tr>
<th colspan="2">[DEFAULT]</th>
</tr>
<tr>
<td>rados_connect_timeout = -1</td>
<td>(IntOpt) Timeout value (in seconds) used when connecting to ceph cluster. If value &lt; 0, no timeout is set and default librados value is used.</td>
</tr>
<tr>
<td>rbd_ceph_conf = </td>
<td>(StrOpt) Path to the ceph configuration file</td>

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

@ -88,8 +88,8 @@ gpfs_mount_point_base storage_gpfs
gpfs_sparse_volumes storage_gpfs
gpfs_storage_pool storage_gpfs
hds_cinder_config_file hds-hus
hds_hnas_iscsi_config_file hds-hus
hds_hnas_nfs_config_file hds-hus
hds_hnas_iscsi_config_file hds-hnas
hds_hnas_nfs_config_file hds-hnas
host common
hp3par_api_url hp3par
hp3par_cpg hp3par
@ -218,6 +218,7 @@ osapi_volume_ext_list api
osapi_volume_extension api
osapi_volume_listen api
osapi_volume_listen_port api
osapi_volume_workers api
password rpc
periodic_fuzzy_delay common
periodic_interval common
@ -251,6 +252,7 @@ rabbit_retry_interval rpc
rabbit_use_ssl rpc
rabbit_userid rpc
rabbit_virtual_host rpc
rados_connect_timeout storage_ceph
rbd_ceph_conf storage_ceph
rbd_flatten_volume_from_snapshot storage_ceph
rbd_max_clone_depth storage_ceph
@ -303,7 +305,6 @@ sf_api_port solidfire
sf_emulate_512 solidfire
snapshot_name_template backups
snapshot_same_host backups
sqlite_clean_db database
ssh_conn_timeout san
ssh_max_pool_conn san
ssh_min_pool_conn san
@ -365,6 +366,7 @@ volume_driver storage
volume_group lvm
volume_manager storage
volume_name_template api
volume_number_multiplier api
volume_service_inithost_offload storage
volume_tmp_dir storage_ceph
volume_topic rpc