OpenSearch/docs/reference/index-modules/allocation.asciidoc

[[index-modules-allocation]]
== Index Shard Allocation

This module provides per-index settings to control the allocation of shards to
nodes:

* <<shard-allocation-filtering,Shard allocation filtering>>: Controlling which shards are allocated to which nodes.
* <<delayed-allocation,Delayed allocation>>: Delaying allocation of unassigned shards caused by a node leaving.
* <<allocation-total-shards,Total shards per node>>: A hard limit on the number of shards from the same index per node.

include::allocation/filtering.asciidoc[]

include::allocation/delayed.asciidoc[]

include::allocation/prioritization.asciidoc[]

include::allocation/total_shards.asciidoc[]
Migrated documentation into the main repo 2013-08-28 19:24:34 -04:00			`[[index-modules-allocation]]`
			`== Index Shard Allocation`

Docs: Refactored modules and index modules sections 2015-06-22 17:49:45 -04:00			`This module provides per-index settings to control the allocation of shards to`
Docs: Documented delayed allocation settings Relates to: #11712 2015-06-30 07:53:04 -04:00			`nodes:`
Docs: Refactored modules and index modules sections 2015-06-22 17:49:45 -04:00
Docs: Documented delayed allocation settings Relates to: #11712 2015-06-30 07:53:04 -04:00			`* <<shard-allocation-filtering,Shard allocation filtering>>: Controlling which shards are allocated to which nodes.`
			`* <<delayed-allocation,Delayed allocation>>: Delaying allocation of unassigned shards caused by a node leaving.`
			`* <<allocation-total-shards,Total shards per node>>: A hard limit on the number of shards from the same index per node.`
Migrated documentation into the main repo 2013-08-28 19:24:34 -04:00
Docs: Documented delayed allocation settings Relates to: #11712 2015-06-30 07:53:04 -04:00			`include::allocation/filtering.asciidoc[]`
Docs: Refactored modules and index modules sections 2015-06-22 17:49:45 -04:00
Docs: Documented delayed allocation settings Relates to: #11712 2015-06-30 07:53:04 -04:00			`include::allocation/delayed.asciidoc[]`
Docs: Refactored modules and index modules sections 2015-06-22 17:49:45 -04:00
Docs: Documented index prioritization 2015-07-15 12:05:42 -04:00			`include::allocation/prioritization.asciidoc[]`

Docs: Documented delayed allocation settings Relates to: #11712 2015-06-30 07:53:04 -04:00			`include::allocation/total_shards.asciidoc[]`
Docs: Refactored modules and index modules sections 2015-06-22 17:49:45 -04:00

Add AllocationDecider that takes free disk space into account This commit adds two main pieces, the first is a ClusterInfoService that provides a service running on the master nodes that fetches the total/free bytes for each data node in the cluster as well as the sizes of all shards in the cluster. This information is gathered by default every 30 seconds, and can be changed dynamically by setting the `cluster.info.update.interval` setting. This ClusterInfoService can hopefully be used in the future to weight nodes for allocation based on their disk usage, if desired. The second main piece is the DiskThresholdDecider, which can disallow a shard from being allocated to a node, or from remaining on the node depending on configuration parameters. There are three main configuration parameters for the DiskThresholdDecider: `cluster.routing.allocation.disk.threshold_enabled` controls whether the decider is enabled. It defaults to false (disabled). Note that the decider is also disabled for clusters with only a single data node. `cluster.routing.allocation.disk.watermark.low` controls the low watermark for disk usage. It defaults to 0.70, meaning ES will not allocate new shards to nodes once they have more than 70% disk used. It can also be set to an absolute byte value (like 500mb) to prevent ES from allocating shards if less than the configured amount of space is available. `cluster.routing.allocation.disk.watermark.high` controls the high watermark. It defaults to 0.85, meaning ES will attempt to relocate shards to another node if the node disk usage rises above 85%. It can also be set to an absolute byte value (similar to the low watermark) to relocate shards once less than the configured amount of space is available on the node. Closes #3480 2013-08-16 14:20:56 -04:00