update-settings.asciidoc 5.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201
  1. [[cluster-update-settings]]
  2. == Cluster Update Settings
  3. Allows to update cluster wide specific settings. Settings updated can
  4. either be persistent (applied cross restarts) or transient (will not
  5. survive a full cluster restart). Here is an example:
  6. [source,js]
  7. --------------------------------------------------
  8. curl -XPUT localhost:9200/_cluster/settings -d '{
  9. "persistent" : {
  10. "discovery.zen.minimum_master_nodes" : 2
  11. }
  12. }'
  13. --------------------------------------------------
  14. Or:
  15. [source,js]
  16. --------------------------------------------------
  17. curl -XPUT localhost:9200/_cluster/settings -d '{
  18. "transient" : {
  19. "discovery.zen.minimum_master_nodes" : 2
  20. }
  21. }'
  22. --------------------------------------------------
  23. The cluster responds with the settings updated. So the response for the
  24. last example will be:
  25. [source,js]
  26. --------------------------------------------------
  27. {
  28. "persistent" : {},
  29. "transient" : {
  30. "discovery.zen.minimum_master_nodes" : "2"
  31. }
  32. }'
  33. --------------------------------------------------
  34. Cluster wide settings can be returned using:
  35. [source,js]
  36. --------------------------------------------------
  37. curl -XGET localhost:9200/_cluster/settings
  38. --------------------------------------------------
  39. There is a specific list of settings that can be updated, those include:
  40. [float]
  41. [[cluster-settings]]
  42. === Cluster settings
  43. [float]
  44. ==== Routing allocation
  45. [float]
  46. ===== Awareness
  47. `cluster.routing.allocation.awareness.attributes`::
  48. See <<modules-cluster>>.
  49. `cluster.routing.allocation.awareness.force.*`::
  50. See <<modules-cluster>>.
  51. [float]
  52. ===== Balanced Shards
  53. All these values are relative to one another. The first three are used to
  54. compose a three separate weighting functions into one. The cluster is balanced
  55. when no allowed action can bring the weights of each node closer together by
  56. more then the fourth setting. Actions might not be allowed, for instance,
  57. due to forced awareness or allocation filtering.
  58. `cluster.routing.allocation.balance.shard`::
  59. Defines the weight factor for shards allocated on a node
  60. (float). Defaults to `0.45f`. Raising this raises the tendency to
  61. equalize the number of shards across all nodes in the cluster.
  62. `cluster.routing.allocation.balance.index`::
  63. Defines a factor to the number of shards per index allocated
  64. on a specific node (float). Defaults to `0.55f`. Raising this raises the
  65. tendency to equalize the number of shards per index across all nodes in
  66. the cluster.
  67. `cluster.routing.allocation.balance.threshold`::
  68. Minimal optimization value of operations that should be performed (non
  69. negative float). Defaults to `1.0f`. Raising this will cause the cluster
  70. to be less aggressive about optimizing the shard balance.
  71. [float]
  72. ===== Concurrent Rebalance
  73. `cluster.routing.allocation.cluster_concurrent_rebalance`::
  74. Allow to control how many concurrent rebalancing of shards are
  75. allowed cluster wide, and default it to `2` (integer). `-1` for
  76. unlimited. See also <<modules-cluster>>.
  77. [float]
  78. ===== Enable allocation
  79. `cluster.routing.allocation.enable`::
  80. See <<modules-cluster>>.
  81. [float]
  82. ===== Throttling allocation
  83. `cluster.routing.allocation.node_initial_primaries_recoveries`::
  84. See <<modules-cluster>>.
  85. `cluster.routing.allocation.node_concurrent_recoveries`::
  86. See <<modules-cluster>>.
  87. [float]
  88. ===== Filter allocation
  89. `cluster.routing.allocation.include.*`::
  90. See <<modules-cluster>>.
  91. `cluster.routing.allocation.exclude.*`::
  92. See <<modules-cluster>>.
  93. `cluster.routing.allocation.require.*`
  94. See <<modules-cluster>>.
  95. [float]
  96. ==== Metadata
  97. `cluster.blocks.read_only`::
  98. Have the whole cluster read only (indices do not accept write operations), metadata is not allowed to be modified (create or delete indices).
  99. [float]
  100. ==== Discovery
  101. `discovery.zen.minimum_master_nodes`::
  102. See <<modules-discovery-zen>>
  103. `discovery.zen.publish_timeout`::
  104. See <<modules-discovery-zen>>
  105. [float]
  106. ==== Threadpools
  107. `threadpool.*`::
  108. See <<modules-threadpool>>
  109. [float]
  110. [[cluster-index-settings]]
  111. === Index settings
  112. [float]
  113. ==== Index filter cache
  114. `indices.cache.filter.size`::
  115. See <<index-modules-cache>>
  116. [float]
  117. ==== TTL interval
  118. `indices.ttl.interval` (time)::
  119. See <<mapping-ttl-field>>
  120. [float]
  121. ==== Recovery
  122. `indices.recovery.concurrent_streams`::
  123. See <<modules-indices>>
  124. `indices.recovery.concurrent_small_file_streams`::
  125. See <<modules-indices>>
  126. `indices.recovery.file_chunk_size`::
  127. See <<modules-indices>>
  128. `indices.recovery.translog_ops`::
  129. See <<modules-indices>>
  130. `indices.recovery.translog_size`::
  131. See <<modules-indices>>
  132. `indices.recovery.compress`::
  133. See <<modules-indices>>
  134. `indices.recovery.max_bytes_per_sec`::
  135. See <<modules-indices>>
  136. [float]
  137. [[logger]]
  138. === Logger
  139. Logger values can also be updated by setting `logger.` prefix. More
  140. settings will be allowed to be updated.
  141. [float]
  142. === Field data circuit breaker
  143. `indices.breaker.fielddata.limit`::
  144. See <<index-modules-fielddata>>
  145. `indices.breaker.fielddata.overhead`::
  146. See <<index-modules-fielddata>>