openstack-manuals/doc/common/tables/trove-db_couchbase.xml

<?xml version='1.0' encoding='UTF-8'?>
<para xmlns="http://docbook.org/ns/docbook" version="5.0">
  <!-- Warning: Do not edit this file. It is automatically
     generated and your changes will be overwritten.
     The tool to do so lives in openstack-doc-tools repository. -->
  <table rules="all" xml:id="config_table_trove_db_couchbase">
    <caption>Description of Couchbase database configuration options</caption>
    <col width="50%"/>
    <col width="50%"/>
    <thead>
      <tr>
        <th>Configuration option = Default value</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <th colspan="2">[couchbase]</th>
      </tr>
      <tr>
        <td><option>backup_incremental_strategy</option> = <replaceable>{}</replaceable></td>
        <td>(DictOpt) Incremental Backup Runner based on the default strategy. For strategies that do not implement an incremental, the runner will use the default full backup.</td>
      </tr>
      <tr>
        <td><option>backup_namespace</option> = <replaceable>trove.guestagent.strategies.backup.experimental.couchbase_impl</replaceable></td>
        <td>(StrOpt) Namespace to load backup strategies from.</td>
      </tr>
      <tr>
        <td><option>backup_strategy</option> = <replaceable>CbBackup</replaceable></td>
        <td>(StrOpt) Default strategy to perform backups.</td>
      </tr>
      <tr>
        <td><option>device_path</option> = <replaceable>/dev/vdb</replaceable></td>
        <td>(StrOpt) Device path for volume if volume support is enabled.</td>
      </tr>
      <tr>
        <td><option>mount_point</option> = <replaceable>/var/lib/couchbase</replaceable></td>
        <td>(StrOpt) Filesystem path for mounting volumes if volume support is enabled.</td>
      </tr>
      <tr>
        <td><option>replication_strategy</option> = <replaceable>None</replaceable></td>
        <td>(StrOpt) Default strategy for replication.</td>
      </tr>
      <tr>
        <td><option>restore_namespace</option> = <replaceable>trove.guestagent.strategies.restore.experimental.couchbase_impl</replaceable></td>
        <td>(StrOpt) Namespace to load restore strategies from.</td>
      </tr>
      <tr>
        <td><option>root_controller</option> = <replaceable>trove.extensions.common.service.DefaultRootController</replaceable></td>
        <td>(StrOpt) Root controller implementation for couchbase.</td>
      </tr>
      <tr>
        <td><option>root_on_create</option> = <replaceable>True</replaceable></td>
        <td>(BoolOpt) 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.</td>
      </tr>
      <tr>
        <td><option>tcp_ports</option> = <replaceable>8091, 8092, 4369, 11209-11211, 21100-21199</replaceable></td>
        <td>(ListOpt) List of TCP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True).</td>
      </tr>
      <tr>
        <td><option>udp_ports</option> = <replaceable></replaceable></td>
        <td>(ListOpt) List of UDP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True).</td>
      </tr>
      <tr>
        <td><option>volume_support</option> = <replaceable>True</replaceable></td>
        <td>(BoolOpt) Whether to provision a Cinder volume for datadir.</td>
      </tr>
      <tr>
        <th colspan="2">[couchdb]</th>
      </tr>
      <tr>
        <td><option>backup_incremental_strategy</option> = <replaceable>{}</replaceable></td>
        <td>(DictOpt) Incremental Backup Runner based on the default strategy. For strategies that do not implement an incremental, the runner will use the default full backup.</td>
      </tr>
      <tr>
        <td><option>backup_namespace</option> = <replaceable>None</replaceable></td>
        <td>(StrOpt) Namespace to load backup strategies from.</td>
      </tr>
      <tr>
        <td><option>backup_strategy</option> = <replaceable>None</replaceable></td>
        <td>(StrOpt) Default strategy to perform backups.</td>
      </tr>
      <tr>
        <td><option>device_path</option> = <replaceable>/dev/vdb</replaceable></td>
        <td>(StrOpt) Device path for volume if volume support is enabled.</td>
      </tr>
      <tr>
        <td><option>mount_point</option> = <replaceable>/var/lib/couchdb</replaceable></td>
        <td>(StrOpt) Filesystem path for mounting volumes if volume support is enabled.</td>
      </tr>
      <tr>
        <td><option>replication_strategy</option> = <replaceable>None</replaceable></td>
        <td>(StrOpt) Default strategy for replication.</td>
      </tr>
      <tr>
        <td><option>restore_namespace</option> = <replaceable>None</replaceable></td>
        <td>(StrOpt) Namespace to load restore strategies from.</td>
      </tr>
      <tr>
        <td><option>root_controller</option> = <replaceable>trove.extensions.common.service.DefaultRootController</replaceable></td>
        <td>(StrOpt) Root controller implementation for couchdb.</td>
      </tr>
      <tr>
        <td><option>root_on_create</option> = <replaceable>False</replaceable></td>
        <td>(BoolOpt) 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.</td>
      </tr>
      <tr>
        <td><option>tcp_ports</option> = <replaceable>5984</replaceable></td>
        <td>(ListOpt) List of TCP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True).</td>
      </tr>
      <tr>
        <td><option>udp_ports</option> = <replaceable></replaceable></td>
        <td>(ListOpt) List of UDP ports and/or port ranges to open in the security group (only applicable if trove_security_groups_support is True).</td>
      </tr>
      <tr>
        <td><option>volume_support</option> = <replaceable>True</replaceable></td>
        <td>(BoolOpt) Whether to provision a Cinder volume for datadir.</td>
      </tr>
    </tbody>
  </table>
</para>