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

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

   * - Configuration option = Default value
     - Description
   * - **[cassandra]**
     -
   * - ``api_strategy`` = ``trove.common.strategies.cluster.experimental.cassandra.api.CassandraAPIStrategy``
     - (String) Class that implements datastore-specific API logic.
   * - ``backup_incremental_strategy`` = ``{}``
     - (Dict) Incremental strategy based on the default backup strategy. For strategies that do not implement incremental backups, the runner performs full backup instead.
   * - ``backup_namespace`` = ``trove.guestagent.strategies.backup.experimental.cassandra_impl``
     - (String) Namespace to load backup strategies from.
   * - ``backup_strategy`` = ``NodetoolSnapshot``
     - (String) Default strategy to perform backups.
   * - ``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`` = ``system``
     - (String) List of Guest Logs to expose for publishing.
   * - ``guestagent_strategy`` = ``trove.common.strategies.cluster.experimental.cassandra.guestagent.CassandraGuestAgentStrategy``
     - (String) Class that implements datastore-specific Guest Agent API logic.
   * - ``icmp`` = ``False``
     - (Boolean) Whether to permit ICMP.
   * - ``ignore_dbs`` = ``system, system_auth, system_traces``
     - (List) Databases to exclude when listing databases.
   * - ``ignore_users`` = ``os_admin``
     - (List) Users to exclude when listing users.
   * - ``mount_point`` = ``/var/lib/cassandra``
     - (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.cassandra_impl``
     - (String) Namespace to load restore strategies from.
   * - ``root_controller`` = ``trove.extensions.cassandra.service.CassandraRootController``
     - (String) Root controller implementation for Cassandra.
   * - ``system_log_level`` = ``INFO``
     - (String) Cassandra log verbosity.
   * - ``taskmanager_strategy`` = ``trove.common.strategies.cluster.experimental.cassandra.taskmanager.CassandraTaskManagerStrategy``
     - (String) Class that implements datastore-specific task manager logic.
   * - ``tcp_ports`` = ``7000, 7001, 7199, 9042, 9160``
     - (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.