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

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

   * - Configuration option = Default value
     - Description
   * - **[vertica]**
     -
   * - ``api_strategy`` = ``trove.common.strategies.cluster.experimental.vertica.api.VerticaAPIStrategy``
     - (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`` = ``None``
     - (String) Namespace to load backup strategies from.
   * - ``backup_strategy`` = ``None``
     - (String) Default strategy to perform backups.
   * - ``cluster_member_count`` = ``3``
     - (Integer) Number of members in Vertica cluster.
   * - ``cluster_support`` = ``True``
     - (Boolean) Enable clusters to be created and managed.
   * - ``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.vertica.guestagent.VerticaGuestAgentStrategy``
     - (String) Class that implements datastore-specific Guest Agent API logic.
   * - ``icmp`` = ``False``
     - (Boolean) Whether to permit ICMP.
   * - ``min_ksafety`` = ``0``
     - (Integer) Minimum k-safety setting permitted for vertica clusters
   * - ``mount_point`` = ``/var/lib/vertica``
     - (String) Filesystem path for mounting volumes if volume support is enabled.
   * - ``readahead_size`` = ``2048``
     - (Integer) Size(MB) to be set as readahead_size for data volume
   * - ``replication_strategy`` = ``None``
     - (String) Default strategy for replication.
   * - ``restore_namespace`` = ``None``
     - (String) Namespace to load restore strategies from.
   * - ``root_controller`` = ``trove.extensions.vertica.service.VerticaRootController``
     - (String) Root controller implementation for Vertica.
   * - ``taskmanager_strategy`` = ``trove.common.strategies.cluster.experimental.vertica.taskmanager.VerticaTaskManagerStrategy``
     - (String) Class that implements datastore-specific task manager logic.
   * - ``tcp_ports`` = ``5433, 5434, 22, 5444, 5450, 4803``
     - (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`` = ``5433, 4803, 4804, 6453``
     - (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.