b88212e062
Generate the config tables with the autohelp script and include the new tables in the config ref sections. For consistency, use the 'database' and 'auth_token' keywords in all projects. Split the LBaaS tables. Closes-Bug: #1327802 Closes-Bug: #1331180 Closes-Bug: #1331175 Closes-Bug: #1330279 Closes-Bug: #1323946 Closes-Bug: #1323437 Closes-Bug: #1322075 Closes-Bug: #1321621 Closes-Bug: #1319564 Closes-Bug: #1318081 Closes-Bug: #1311474 Change-Id: I5602dda76fdf929d9124f5aa67d31ca4ac17c6d5
114 lines
4.1 KiB
XML
114 lines
4.1 KiB
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_ceilometer_database">
|
|
<caption>Description of configuration options for database</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>database_connection = None</td>
|
|
<td>(StrOpt) DEPRECATED - Database connection string.</td>
|
|
</tr>
|
|
<tr>
|
|
<th colspan="2">[database]</th>
|
|
</tr>
|
|
<tr>
|
|
<td>backend = sqlalchemy</td>
|
|
<td>(StrOpt) The backend to use for db</td>
|
|
</tr>
|
|
<tr>
|
|
<td>connection = None</td>
|
|
<td>(StrOpt) The SQLAlchemy connection string used 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>
|
|
</tr>
|
|
<tr>
|
|
<td>connection_trace = False</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>
|
|
</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>
|
|
</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>
|
|
</tr>
|
|
<tr>
|
|
<td>db_retry_interval = 1</td>
|
|
<td>(IntOpt) seconds between db connection retries</td>
|
|
</tr>
|
|
<tr>
|
|
<td>idle_timeout = 3600</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>
|
|
</tr>
|
|
<tr>
|
|
<td>max_pool_size = None</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>
|
|
</tr>
|
|
<tr>
|
|
<td>min_pool_size = 1</td>
|
|
<td>(IntOpt) Minimum number of SQL connections to keep open in a pool</td>
|
|
</tr>
|
|
<tr>
|
|
<td>mysql_sql_mode = TRADITIONAL</td>
|
|
<td>(StrOpt) The SQL mode to be used for MySQL sessions. This option, including the default, overrides any server-set SQL mode. To use whatever SQL mode is set by the server configuration, set this to no value. Example: mysql_sql_mode=</td>
|
|
</tr>
|
|
<tr>
|
|
<td>pool_timeout = None</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>
|
|
</tr>
|
|
<tr>
|
|
<td>sqlite_db = ceilometer.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>
|
|
</tr>
|
|
<tr>
|
|
<td>time_to_live = -1</td>
|
|
<td>(IntOpt) Number of seconds that samples are kept in the database for (<= 0 means forever).</td>
|
|
</tr>
|
|
<tr>
|
|
<td>use_db_reconnect = False</td>
|
|
<td>(BoolOpt) Enable the experimental use of database reconnect on connection lost</td>
|
|
</tr>
|
|
<tr>
|
|
<td>use_tpool = False</td>
|
|
<td>(BoolOpt) Enable the experimental use of thread pooling for all DB API calls</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</para>
|