update-settings.asciidoc 5.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212
  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. `cluster.routing.allocation.balance.shard`::
  54. Defines the weight factor for shards allocated on a node
  55. (float). Defaults to `0.45f`.
  56. `cluster.routing.allocation.balance.index`::
  57. Defines a factor to the number of shards per index allocated
  58. on a specific node (float). Defaults to `0.5f`.
  59. `cluster.routing.allocation.balance.primary`::
  60. defines a weight factor for the number of primaries of a specific index
  61. allocated on a node (float). `0.05f`.
  62. `cluster.routing.allocation.balance.threshold`::
  63. minimal optimization value of operations that should be performed (non
  64. negative float). Defaults to `1.0f`.
  65. [float]
  66. ===== Concurrent Rebalance
  67. `cluster.routing.allocation.cluster_concurrent_rebalance`::
  68. Allow to control how many concurrent rebalancing of shards are
  69. allowed cluster wide, and default it to `2` (integer). `-1` for
  70. unlimited. See also <<modules-cluster>>.
  71. [float]
  72. ===== Disable allocation
  73. added[1.0.0.RC1]
  74. All the disable allocation settings have been deprecated in favour for
  75. `cluster.routing.allocation.enable` setting.
  76. `cluster.routing.allocation.disable_allocation`::
  77. See <<modules-cluster>>.
  78. `cluster.routing.allocation.disable_replica_allocation`::
  79. See <<modules-cluster>>.
  80. `cluster.routing.allocation.disable_new_allocation`::
  81. See <<modules-cluster>>.
  82. [float]
  83. ===== Enable allocation
  84. `cluster.routing.allocation.enable`::
  85. See <<modules-cluster>>.
  86. [float]
  87. ===== Throttling allocation
  88. `cluster.routing.allocation.node_initial_primaries_recoveries`::
  89. See <<modules-cluster>>.
  90. `cluster.routing.allocation.node_concurrent_recoveries`::
  91. See <<modules-cluster>>.
  92. [float]
  93. ===== Filter allocation
  94. `cluster.routing.allocation.include.*`::
  95. See <<modules-cluster>>.
  96. `cluster.routing.allocation.exclude.*`::
  97. See <<modules-cluster>>.
  98. `cluster.routing.allocation.require.*`
  99. See <<modules-cluster>>.
  100. [float]
  101. ==== Metadata
  102. `cluster.blocks.read_only`::
  103. Have the whole cluster read only (indices do not accept write operations), metadata is not allowed to be modified (create or delete indices).
  104. [float]
  105. ==== Discovery
  106. `discovery.zen.minimum_master_nodes`::
  107. See <<modules-discovery-zen>>
  108. `discovery.zen.publish_timeout` coming[1.1.0, The setting existed before but wasn't dynamic]::
  109. See <<modules-discovery-zen>>
  110. [float]
  111. ==== Threadpools
  112. `threadpool.*`::
  113. See <<modules-threadpool>>
  114. [float]
  115. [[cluster-index-settings]]
  116. === Index settings
  117. [float]
  118. ==== Index filter cache
  119. `indices.cache.filter.size`::
  120. See <<index-modules-cache>>
  121. `indices.cache.filter.expire` (time)::
  122. See <<index-modules-cache>>
  123. [float]
  124. ==== TTL interval
  125. `indices.ttl.interval` (time)::
  126. See <<mapping-ttl-field>>
  127. [float]
  128. ==== Recovery
  129. `indices.recovery.concurrent_streams`::
  130. See <<modules-indices>>
  131. `indices.recovery.file_chunk_size`::
  132. See <<modules-indices>>
  133. `indices.recovery.translog_ops`::
  134. See <<modules-indices>>
  135. `indices.recovery.translog_size`::
  136. See <<modules-indices>>
  137. `indices.recovery.compress`::
  138. See <<modules-indices>>
  139. `indices.recovery.max_bytes_per_sec`::
  140. See <<modules-indices>>
  141. [float]
  142. ==== Store level throttling
  143. `indices.store.throttle.type`::
  144. See <<index-modules-store>>
  145. `indices.store.throttle.max_bytes_per_sec`::
  146. See <<index-modules-store>>
  147. [float]
  148. [[logger]]
  149. === Logger
  150. Logger values can also be updated by setting `logger.` prefix. More
  151. settings will be allowed to be updated.