A newer version of this documentation is available.

View Latest

Configure Cluster Settings

    The Settings menu sets the global settings for your Couchbase Server instance.

    Full Administrators and Cluster Administrators can configure cluster settings.

    Use the Settings > Cluster tab to configure the cluster name, memory quotas, and index settings. You can define the settings using the Web Console, with the CLI command, or using the REST API.

    settings cluster

    To configure cluster settings using the Web Console:

    1. Select the Couchbase Web Console > Settings menu. By default, the Cluster page is displayed.

    2. Enter the following settings and click Save:

    Cluster Name

    Option Description

    Cluster Name

    The name that was given during the initial setup. You can change it at any time.

    Couchbase Memory Quotas

    The per-node memory that is available to Couchbase services limited to the smallest node in the cluster. These values can be adjusted in the UI, with the CLI or with the REST API.

    Option Description

    Data Service

    The per node memory allocation for the key-value cache used by the data service. At a minimum, it cannot be made smaller than the sum per node bucket quota of all buckets combined.

    GSI Service

    This setting controls the buffer cache size of the index storage layer. The specified memory is pre-allocated as soon as the indexer starts up, and is shared with all indexes created on the node. The total memory usage of the indexer process will be the buffer cache plus the size of various internal data structures and queues.

    FTS Service

    This setting controls the RAM quota for Full Text search. It shows the amount of the main memory allocation for Full Text service per node.

    Advanced Index Settings for Standard and Memory-Optimized Indexes

    Define the Global Secondary Index type as Standard or Memory-Optimized option and then click Show Advanced Index Settings pull-down menu.

    Option Description

    Indexer Threads

    The number of dedicated threads used by the Index Service. The number can be increased on multi-core machines to increase the amount of CPU available to the Indexer. The default is set to 0.

    Max Rollback Points

    The maximum number of the committed rollback points. The default is set to 5.

    Indexer Log Level

    Adjust the logging level from least to most verbose, the options are: Silent, Fatal, Error, Warn, Info, Verbose, Timing, Debug, and Trace. The default is set to Info. It is advised to leave this setting as the default unless Couchbase Support directs you to change it.