[config-ref] Add database configuration to common

This patch imports database content from nova as first step.
I will check and update the configuration options
for all service on the following patch.

Change-Id: I7beba01709d8efe6791bdf8d0bfa64570edf2c2c
Implements: blueprint config-ref-common-sections
This commit is contained in:
KATO Tomoyuki 2016-07-03 18:20:22 +09:00
parent b98f62403c
commit c2f457367b
3 changed files with 110 additions and 0 deletions
doc/config-reference/source

@ -13,6 +13,7 @@ for shared service and libraries.
:maxdepth: 1
common-configurations/auth.rst
common-configurations/database.rst
common-configurations/logging.rst
common-configurations/rpc.rst
common-configurations/cors.rst

@ -0,0 +1,17 @@
======================
Database configuration
======================
You can configure OpenStack Compute to use any SQLAlchemy-compatible database.
To ensure that the database schema is current, run the following command:
.. code-block:: console
# SERVICE-manage db sync
To configure the connection string for the database,
use the configuration option settings documented in the table
:ref:`common-database`.
.. include:: ../tables/common-database.rst

@ -0,0 +1,92 @@
..
Warning: Do not edit this file. It is automatically generated from the
software project's code and your changes will be overwritten.
The tool to generate this file lives in openstack-doc-tools repository.
Please make any changes needed in the code, then run the
autogenerate-config-doc tool from the openstack-doc-tools repository, or
ask for help on the documentation mailing list, IRC channel or meeting.
.. _common-database:
.. list-table:: Description of database configuration options
:header-rows: 1
:class: config-ref-table
* - Configuration option = Default value
- Description
* - **[DEFAULT]**
-
* - ``db_driver`` = ``nova.db``
- (String) DEPRECATED: The driver to use for database access
* - **[api_database]**
-
* - ``connection`` = ``None``
- (String) The SQLAlchemy connection string to use to connect to the Nova API database.
* - ``connection_debug`` = ``0``
- (Integer) Verbosity of SQL debugging information: 0=None, 100=Everything.
* - ``connection_trace`` = ``False``
- (Boolean) Add Python stack traces to SQL as comment strings.
* - ``idle_timeout`` = ``3600``
- (Integer) Timeout before idle SQL connections are reaped.
* - ``max_overflow`` = ``None``
- (Integer) If set, use this value for max_overflow with SQLAlchemy.
* - ``max_pool_size`` = ``None``
- (Integer) Maximum number of SQL connections to keep open in a pool.
* - ``max_retries`` = ``10``
- (Integer) Maximum number of database connection retries during startup. Set to -1 to specify an infinite retry count.
* - ``mysql_sql_mode`` = ``TRADITIONAL``
- (String) 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=
* - ``pool_timeout`` = ``None``
- (Integer) If set, use this value for pool_timeout with SQLAlchemy.
* - ``retry_interval`` = ``10``
- (Integer) Interval between retries of opening a SQL connection.
* - ``slave_connection`` = ``None``
- (String) The SQLAlchemy connection string to use to connect to the slave database.
* - ``sqlite_synchronous`` = ``True``
- (Boolean) If True, SQLite uses synchronous mode.
* - **[database]**
-
* - ``backend`` = ``sqlalchemy``
- (String) The back end to use for the database.
* - ``connection`` = ``None``
- (String) The SQLAlchemy connection string to use to connect to the database.
* - ``connection_debug`` = ``0``
- (Integer) Verbosity of SQL debugging information: 0=None, 100=Everything.
* - ``connection_trace`` = ``False``
- (Boolean) Add Python stack traces to SQL as comment strings.
* - ``db_inc_retry_interval`` = ``True``
- (Boolean) If True, increases the interval between retries of a database operation up to db_max_retry_interval.
* - ``db_max_retries`` = ``20``
- (Integer) Maximum retries in case of connection error or deadlock error before error is raised. Set to -1 to specify an infinite retry count.
* - ``db_max_retry_interval`` = ``10``
- (Integer) If db_inc_retry_interval is set, the maximum seconds between retries of a database operation.
* - ``db_retry_interval`` = ``1``
- (Integer) Seconds between retries of a database transaction.
* - ``idle_timeout`` = ``3600``
- (Integer) Timeout before idle SQL connections are reaped.
* - ``max_overflow`` = ``50``
- (Integer) If set, use this value for max_overflow with SQLAlchemy.
* - ``max_pool_size`` = ``None``
- (Integer) Maximum number of SQL connections to keep open in a pool.
* - ``max_retries`` = ``10``
- (Integer) Maximum number of database connection retries during startup. Set to -1 to specify an infinite retry count.
* - ``min_pool_size`` = ``1``
- (Integer) Minimum number of SQL connections to keep open in a pool.
* - ``mysql_sql_mode`` = ``TRADITIONAL``
- (String) 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=
* - ``pool_timeout`` = ``None``
- (Integer) If set, use this value for pool_timeout with SQLAlchemy.
* - ``retry_interval`` = ``10``
- (Integer) Interval between retries of opening a SQL connection.
* - ``slave_connection`` = ``None``
- (String) The SQLAlchemy connection string to use to connect to the slave database.
* - ``sqlite_db`` = ``oslo.sqlite``
- (String) The file name to use with SQLite.
* - ``sqlite_synchronous`` = ``True``
- (Boolean) If True, SQLite uses synchronous mode.
* - ``use_db_reconnect`` = ``False``
- (Boolean) Enable the experimental use of database reconnect on connection lost.
* - ``use_tpool`` = ``False``
- (Boolean) Enable the experimental use of thread pooling for all DB API calls