update-settings.asciidoc 4.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198
  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. `cluster.routing.allocation.disable_allocation`::
  74. See <<modules-cluster>>.
  75. `cluster.routing.allocation.disable_replica_allocation`::
  76. See <<modules-cluster>>.
  77. `cluster.routing.allocation.disable_new_allocation`::
  78. See <<modules-cluster>>.
  79. [float]
  80. ===== Throttling allocation
  81. `cluster.routing.allocation.node_initial_primaries_recoveries`::
  82. See <<modules-cluster>>.
  83. `cluster.routing.allocation.node_concurrent_recoveries`::
  84. See <<modules-cluster>>.
  85. [float]
  86. ===== Filter allocation
  87. `cluster.routing.allocation.include.*`::
  88. See <<modules-cluster>>.
  89. `cluster.routing.allocation.exclude.*`::
  90. See <<modules-cluster>>.
  91. `cluster.routing.allocation.require.*`
  92. See <<modules-cluster>>.
  93. [float]
  94. ==== Metadata
  95. `cluster.blocks.read_only`::
  96. Have the whole cluster read only (indices do not accept write operations), metadata is not allowed to be modified (create or delete indices).
  97. [float]
  98. ==== Discovery
  99. `discovery.zen.minimum_master_nodes`::
  100. See <<modules-discovery-zen>>
  101. [float]
  102. ==== Threadpools
  103. `threadpool.*`::
  104. See <<modules-threadpool>>
  105. [float]
  106. [[cluster-index-settings]]
  107. === Index settings
  108. [float]
  109. ==== Index filter cache
  110. `indices.cache.filter.size`::
  111. See <<index-modules-cache>>
  112. `indices.cache.filter.expire` (time)::
  113. See <<index-modules-cache>>
  114. [float]
  115. ==== TTL interval
  116. `indices.ttl.interval` (time)::
  117. See <<mapping-ttl-field>>
  118. [float]
  119. ==== Recovery
  120. `indices.recovery.concurrent_streams`::
  121. See <<modules-indices>>
  122. `indices.recovery.file_chunk_size`::
  123. See <<modules-indices>>
  124. `indices.recovery.translog_ops`::
  125. See <<modules-indices>>
  126. `indices.recovery.translog_size`::
  127. See <<modules-indices>>
  128. `indices.recovery.compress`::
  129. See <<modules-indices>>
  130. `indices.recovery.max_bytes_per_sec`::
  131. See <<modules-indices>>
  132. [float]
  133. ==== Store level throttling
  134. `indices.store.throttle.type`::
  135. See <<index-modules-store>>
  136. `indices.store.throttle.max_bytes_per_sec`::
  137. See <<index-modules-store>>
  138. [float]
  139. [[logger]]
  140. === Logger
  141. Logger values can also be updated by setting `logger.` prefix. More
  142. settings will be allowed to be updated.