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

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

   * - Configuration option = Default value
     - Description
   * - **[couchbase]**
     -
   * - ``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.couchbase_impl``
     - (String) Namespace to load backup strategies from.
   * - ``backup_strategy`` = ``CbBackup``
     - (String) Default strategy to perform backups.
   * - ``default_password_length`` = ``24``
     - (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.
   * - ``icmp`` = ``False``
     - (Boolean) Whether to permit ICMP.
   * - ``mount_point`` = ``/var/lib/couchbase``
     - (String) Filesystem path for mounting volumes if volume support is enabled.
   * - ``replication_strategy`` = ``None``
     - (String) Default strategy for replication.
   * - ``restore_namespace`` = ``trove.guestagent.strategies.restore.experimental.couchbase_impl``
     - (String) Namespace to load restore strategies from.
   * - ``root_controller`` = ``trove.extensions.common.service.DefaultRootController``
     - (String) Root controller implementation for couchbase.
   * - ``root_on_create`` = ``False``
     - (Boolean) Enable the automatic creation of the root user for the service during instance-create. The generated password for the root user is immediately returned in the response of instance-create as the 'password' field.
   * - ``tcp_ports`` = ``8091, 8092, 4369, 11209-11211, 21100-21199``
     - (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.
   * - **[couchdb]**
     -
   * - ``volume_support`` = ``True``
     - (Boolean) Whether to provision a Cinder volume for datadir.