WARNING: Version 1.5 of Elasticsearch has passed its EOL date.

This documentation is no longer being maintained and may be removed. If you are running this version, we strongly advise you to upgrade. For the latest information, see the current release documentation.

› ›

Cluster Update Settings

edit

Cluster Update Settings

edit

Allows to update cluster wide specific settings. Settings updated can either be persistent (applied cross restarts) or transient (will not survive a full cluster restart). Here is an example:

curl -XPUT localhost:9200/_cluster/settings -d '{
    "persistent" : {
        "discovery.zen.minimum_master_nodes" : 2
    }
}'

Or:

curl -XPUT localhost:9200/_cluster/settings -d '{
    "transient" : {
        "discovery.zen.minimum_master_nodes" : 2
    }
}'

The cluster responds with the settings updated. So the response for the last example will be:

{
    "persistent" : {},
    "transient" : {
        "discovery.zen.minimum_master_nodes" : "2"
    }
}'

Cluster wide settings can be returned using:

curl -XGET localhost:9200/_cluster/settings

There is a specific list of settings that can be updated, those include:

cluster.routing.allocation.awareness.attributes: See Cluster.
cluster.routing.allocation.awareness.force.*: See Cluster.

Balanced Shards

edit

All these values are relative to one another. The first three are used to compose a three separate weighting functions into one. The cluster is balanced when no allowed action can bring the weights of each node closer together by more then the fourth setting. Actions might not be allowed, for instance, due to forced awareness or allocation filtering.

cluster.routing.allocation.balance.shard: Defines the weight factor for shards allocated on a node (float). Defaults to 0.45f. Raising this raises the tendency to equalize the number of shards across all nodes in the cluster.
cluster.routing.allocation.balance.index: Defines a factor to the number of shards per index allocated on a specific node (float). Defaults to 0.55f. Raising this raises the tendency to equalize the number of shards per index across all nodes in the cluster.
cluster.routing.allocation.balance.primary: Defines a weight factor for the number of primaries of a specific index allocated on a node (float). 0.00f. Raising this raises the tendency to equalize the number of primary shards across all nodes in the cluster. [1.3.8] Deprecated in 1.3.8.
cluster.routing.allocation.balance.threshold: Minimal optimization value of operations that should be performed (non negative float). Defaults to 1.0f. Raising this will cause the cluster to be less aggressive about optimizing the shard balance.

Concurrent Rebalance

edit

cluster.routing.allocation.cluster_concurrent_rebalance: Allow to control how many concurrent rebalancing of shards are allowed cluster wide, and default it to 2 (integer). -1 for unlimited. See also Cluster.

Disable allocation

edit

All the disable allocation settings have been deprecated in favour for cluster.routing.allocation.enable setting.

cluster.routing.allocation.disable_allocation: See Cluster.
cluster.routing.allocation.disable_replica_allocation: See Cluster.
cluster.routing.allocation.disable_new_allocation: See Cluster.

Enable allocation

edit

cluster.routing.allocation.enable: See Cluster.

Throttling allocation

edit

cluster.routing.allocation.node_initial_primaries_recoveries: See Cluster.
cluster.routing.allocation.node_concurrent_recoveries: See Cluster.

Filter allocation

edit

cluster.routing.allocation.include.*: See Cluster.
cluster.routing.allocation.exclude.*: See Cluster.

cluster.routing.allocation.require.* See Cluster.

Metadata

edit

cluster.blocks.read_only: Have the whole cluster read only (indices do not accept write operations), metadata is not allowed to be modified (create or delete indices).