107 lines
4.8 KiB
XML
107 lines
4.8 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_ironic_database">
|
|
<caption>Description of database 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">[database]</th>
|
|
</tr>
|
|
<tr>
|
|
<td><option>backend</option> = <replaceable>sqlalchemy</replaceable></td>
|
|
<td>(StrOpt) The back end to use for the database.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><option>connection</option> = <replaceable>None</replaceable></td>
|
|
<td>(StrOpt) The SQLAlchemy connection string to use to connect to the database.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><option>connection_debug</option> = <replaceable>0</replaceable></td>
|
|
<td>(IntOpt) Verbosity of SQL debugging information: 0=None, 100=Everything.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><option>connection_trace</option> = <replaceable>False</replaceable></td>
|
|
<td>(BoolOpt) Add Python stack traces to SQL as comment strings.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><option>db_inc_retry_interval</option> = <replaceable>True</replaceable></td>
|
|
<td>(BoolOpt) If True, increases the interval between database connection retries up to db_max_retry_interval.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><option>db_max_retries</option> = <replaceable>20</replaceable></td>
|
|
<td>(IntOpt) Maximum database connection retries before error is raised. Set to -1 to specify an infinite retry count.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><option>db_max_retry_interval</option> = <replaceable>10</replaceable></td>
|
|
<td>(IntOpt) If db_inc_retry_interval is set, the maximum seconds between database connection retries.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><option>db_retry_interval</option> = <replaceable>1</replaceable></td>
|
|
<td>(IntOpt) Seconds between database connection retries.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><option>idle_timeout</option> = <replaceable>3600</replaceable></td>
|
|
<td>(IntOpt) Timeout before idle SQL connections are reaped.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><option>max_overflow</option> = <replaceable>None</replaceable></td>
|
|
<td>(IntOpt) If set, use this value for max_overflow with SQLAlchemy.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><option>max_pool_size</option> = <replaceable>None</replaceable></td>
|
|
<td>(IntOpt) Maximum number of SQL connections to keep open in a pool.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><option>max_retries</option> = <replaceable>10</replaceable></td>
|
|
<td>(IntOpt) Maximum number of database connection retries during startup. Set to -1 to specify an infinite retry count.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><option>min_pool_size</option> = <replaceable>1</replaceable></td>
|
|
<td>(IntOpt) Minimum number of SQL connections to keep open in a pool.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><option>mysql_engine</option> = <replaceable>InnoDB</replaceable></td>
|
|
<td>(StrOpt) MySQL engine to use.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><option>mysql_sql_mode</option> = <replaceable>TRADITIONAL</replaceable></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><option>pool_timeout</option> = <replaceable>None</replaceable></td>
|
|
<td>(IntOpt) If set, use this value for pool_timeout with SQLAlchemy.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><option>retry_interval</option> = <replaceable>10</replaceable></td>
|
|
<td>(IntOpt) Interval between retries of opening a SQL connection.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><option>slave_connection</option> = <replaceable>None</replaceable></td>
|
|
<td>(StrOpt) The SQLAlchemy connection string to use to connect to the slave database.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><option>sqlite_db</option> = <replaceable>oslo.sqlite</replaceable></td>
|
|
<td>(StrOpt) The file name to use with SQLite.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><option>sqlite_synchronous</option> = <replaceable>True</replaceable></td>
|
|
<td>(BoolOpt) If True, SQLite uses synchronous mode.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><option>use_db_reconnect</option> = <replaceable>False</replaceable></td>
|
|
<td>(BoolOpt) Enable the experimental use of database reconnect on connection lost.</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</para>
|