..
    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.

.. _trove-db_mongodb:

.. list-table:: Description of MongoDB database configuration options
   :header-rows: 1
   :class: config-ref-table

   * - Configuration option = Default value
     - Description
   * - **[mongodb]**
     -
   * - ``add_members_timeout`` = ``300``
     - (Integer) Maximum time to wait (in seconds) for a replica set initialization process to complete.
   * - ``api_strategy`` = ``trove.common.strategies.cluster.experimental.mongodb.api.MongoDbAPIStrategy``
     - (String) Class that implements datastore-specific API logic.
   * - ``backup_incremental_strategy`` = ``{}``
     - (Dict) Incremental Backup Runner based on the default strategy. For strategies that do not implement an incremental, the runner will use the default full backup.
   * - ``backup_namespace`` = ``trove.guestagent.strategies.backup.experimental.mongo_impl``
     - (String) Namespace to load backup strategies from.
   * - ``backup_strategy`` = ``MongoDump``
     - (String) Default strategy to perform backups.
   * - ``cluster_secure`` = ``True``
     - (Boolean) Create secure clusters. If False then the Role-Based Access Control will be disabled.
   * - ``cluster_support`` = ``True``
     - (Boolean) Enable clusters to be created and managed.
   * - ``configsvr_port`` = ``27019``
     - (Port number) Port for instances running as config servers.
   * - ``default_password_length`` = ``36``
     - (Integer) Character length of generated passwords.
   * - ``device_path`` = ``/dev/vdb``
     - (String) Device path for volume if volume support is enabled.
   * - ``guest_log_exposed_logs`` =
     - (String) List of Guest Logs to expose for publishing.
   * - ``guestagent_strategy`` = ``trove.common.strategies.cluster.experimental.mongodb.guestagent.MongoDbGuestAgentStrategy``
     - (String) Class that implements datastore-specific Guest Agent API logic.
   * - ``icmp`` = ``False``
     - (Boolean) Whether to permit ICMP.
   * - ``ignore_dbs`` = ``admin, local, config``
     - (List) Databases to exclude when listing databases.
   * - ``ignore_users`` = ``admin.os_admin, admin.root``
     - (List) Users to exclude when listing users.
   * - ``mongodb_port`` = ``27017``
     - (Port number) Port for mongod and mongos instances.
   * - ``mount_point`` = ``/var/lib/mongodb``
     - (String) Filesystem path for mounting volumes if volume support is enabled.
   * - ``num_config_servers_per_cluster`` = ``3``
     - (Integer) The number of config servers to create per cluster.
   * - ``num_query_routers_per_cluster`` = ``1``
     - (Integer) The number of query routers (mongos) to create per cluster.
   * - ``replication_strategy`` = ``None``
     - (String) Default strategy for replication.
   * - ``restore_namespace`` = ``trove.guestagent.strategies.restore.experimental.mongo_impl``
     - (String) Namespace to load restore strategies from.
   * - ``root_controller`` = ``trove.extensions.mongodb.service.MongoDBRootController``
     - (String) Root controller implementation for mongodb.
   * - ``taskmanager_strategy`` = ``trove.common.strategies.cluster.experimental.mongodb.taskmanager.MongoDbTaskManagerStrategy``
     - (String) Class that implements datastore-specific task manager logic.
   * - ``tcp_ports`` = ``2500, 27017, 27019``
     - (List) List of TCP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True).
   * - ``udp_ports`` =
     - (List) List of UDP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True).
   * - ``volume_support`` = ``True``
     - (Boolean) Whether to provision a Cinder volume for datadir.